virsh.c 372.5 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 129
    VSH_OT_DATA,     /* string data (as non-option) */
    VSH_OT_ARGV      /* remaining arguments, opt->name should be "" */
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 155
enum {
    VSH_OFLAG_NONE     = 0,        /* without flags */
    VSH_OFLAG_REQ      = (1 << 0), /* option required */
    VSH_OFLAG_EMPTY_OK = (1 << 1), /* empty string option allowed */
};
K
Karel Zak 已提交
156 157 158 159 160 161 162 163

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

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

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

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

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

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

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

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

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

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

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

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

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

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

282 283 284
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
285
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
286

287
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
288
                                          const char **name, int flag);
K
Karel Zak 已提交
289 290

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

294
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
295
                                            const char **name, int flag);
296 297

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
298 299
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
300 301
                           VSH_BYUUID|VSH_BYNAME)

302
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
303
                                                  const char **name, int flag);
304 305 306 307 308 309

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

310
static virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
311
                                                const char **name, int flag);
312 313 314 315 316 317

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

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

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

326
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
327 328
                                           const char *optname,
                                           const char *pooloptname,
329
                                           const char **name, int flag);
330 331

/* default is lookup by Name and UUID */
332
#define vshCommandOptVol(_ctl, _cmd, _optname, _pooloptname, _name)   \
333 334 335
    vshCommandOptVolBy(_ctl, _cmd, _optname, _pooloptname, _name,     \
                           VSH_BYUUID|VSH_BYNAME)

336
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
337
                                        const char **name);
338

339
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
340
    ATTRIBUTE_FMT_PRINTF(2, 3);
341
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
342
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
343 344

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

347
static int vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason);
K
Karel Zak 已提交
348
static const char *vshDomainStateToString(int state);
349
static const char *vshDomainStateReasonToString(int state, int reason);
350
static const char *vshDomainVcpuStateToString(int state);
E
Eric Blake 已提交
351
static bool vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
K
Karel Zak 已提交
352

353 354 355 356
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

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

366
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
367 368
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
369 370 371 372 373 374 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
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
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443

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;

444
  /* User visible sort, so we want locale-specific case comparison.  */
445 446 447
  return strcasecmp(*sa, *sb);
}

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

    if (last_error->code == VIR_ERR_OK) {
507
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
508 509 510
        goto out;
    }

511
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
512 513 514 515 516 517

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

518 519 520 521 522 523 524 525 526
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;
}

527 528 529 530 531
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

532 533 534 535 536
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

537 538 539 540 541 542
/*
 * 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
 */
543 544 545 546
static void vshCatchDisconnect(int sig, siginfo_t *siginfo,
                               void *context ATTRIBUTE_UNUSED) {
    if ((sig == SIGPIPE) ||
        (SA_SIGINFO && siginfo->si_signo == SIGPIPE))
547 548 549 550 551 552 553 554 555
        disconnected++;
}

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

    if (ctl->conn != NULL) {
        connected = true;
580
        virConnectClose(ctl->conn);
581
    }
582 583 584 585 586 587

    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);
    if (!ctl->conn)
        vshError(ctl, "%s", _("Failed to reconnect to the hypervisor"));
588
    else if (connected)
589 590
        vshError(ctl, "%s", _("Reconnected to the hypervisor"));
    disconnected = 0;
591
    ctl->useGetInfo = false;
592
}
593

K
Karel Zak 已提交
594 595 596 597 598 599
/* ---------------
 * Commands
 * ---------------
 */

/*
600
 * "help" command
K
Karel Zak 已提交
601
 */
602
static const vshCmdInfo info_help[] = {
603
    {"help", N_("print help")},
604 605
    {"desc", N_("Prints global help, command specific help, or help for a\n"
                "    group of related commands")},
606

607
    {NULL, NULL}
K
Karel Zak 已提交
608 609
};

610
static const vshCmdOptDef opts_help[] = {
611
    {"command", VSH_OT_DATA, 0, N_("Prints global help, command specific help, or help for a group of related commands")},
612
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
613 614
};

E
Eric Blake 已提交
615
static bool
616
cmdHelp(vshControl *ctl, const vshCmd *cmd)
617
 {
618
    const char *name = NULL;
619

620
    if (vshCommandOptString(cmd, "command", &name) <= 0) {
621
        const vshCmdGrp *grp;
622
        const vshCmdDef *def;
623

624 625 626 627 628 629 630 631 632 633 634 635 636
        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 已提交
637
        return true;
638
    }
639

E
Eric Blake 已提交
640
    if (vshCmddefSearch(name)) {
641
        return vshCmddefHelp(ctl, name);
E
Eric Blake 已提交
642
    } else if (vshCmdGrpSearch(name)) {
643 644 645
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
E
Eric Blake 已提交
646
        return false;
K
Karel Zak 已提交
647 648 649
    }
}

650 651 652
/*
 * "autostart" command
 */
653
static const vshCmdInfo info_autostart[] = {
654
    {"help", N_("autostart a domain")},
655
    {"desc",
656
     N_("Configure a domain to be automatically started at boot.")},
657 658 659
    {NULL, NULL}
};

660
static const vshCmdOptDef opts_autostart[] = {
661 662
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
663 664 665
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
666
static bool
667
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
668 669
{
    virDomainPtr dom;
670
    const char *name;
671 672
    int autostart;

673
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
674
        return false;
675

J
Jim Meyering 已提交
676
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
677
        return false;
678 679 680 681

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
682
        if (autostart)
683
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
684
        else
685
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
686
        virDomainFree(dom);
E
Eric Blake 已提交
687
        return false;
688 689
    }

690
    if (autostart)
691
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
692
    else
693
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
694

695
    virDomainFree(dom);
E
Eric Blake 已提交
696
    return true;
697 698
}

K
Karel Zak 已提交
699
/*
700
 * "connect" command
K
Karel Zak 已提交
701
 */
702
static const vshCmdInfo info_connect[] = {
703
    {"help", N_("(re)connect to hypervisor")},
704
    {"desc",
705
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
706
    {NULL, NULL}
K
Karel Zak 已提交
707 708
};

709
static const vshCmdOptDef opts_connect[] = {
E
Eric Blake 已提交
710 711
    {"name",     VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("hypervisor connection URI")},
712
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
713
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
714 715
};

E
Eric Blake 已提交
716
static bool
717
cmdConnect(vshControl *ctl, const vshCmd *cmd)
718
{
E
Eric Blake 已提交
719
    bool ro = vshCommandOptBool(cmd, "readonly");
720
    const char *name = NULL;
721

K
Karel Zak 已提交
722
    if (ctl->conn) {
723 724 725
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
E
Eric Blake 已提交
726
            return false;
K
Karel Zak 已提交
727 728 729
        }
        ctl->conn = NULL;
    }
730

731
    VIR_FREE(ctl->name);
732 733
    if (vshCommandOptString(cmd, "name", &name) < 0) {
        vshError(ctl, "%s", _("Please specify valid connection URI"));
E
Eric Blake 已提交
734
        return false;
735
    }
736
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
737

738
    ctl->useGetInfo = false;
E
Eric Blake 已提交
739
    ctl->readonly = ro;
K
Karel Zak 已提交
740

741 742 743
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

E
Eric Blake 已提交
747
    return !!ctl->conn;
K
Karel Zak 已提交
748 749
}

750 751
#ifndef WIN32

752
/*
753
 * "console" command
754
 */
755
static const vshCmdInfo info_console[] = {
756
    {"help", N_("connect to the guest console")},
757
    {"desc",
758
     N_("Connect the virtual serial console for the guest")},
759 760 761
    {NULL, NULL}
};

762
static const vshCmdOptDef opts_console[] = {
763
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
764
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
765 766 767
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
768
static bool
769
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
770
{
E
Eric Blake 已提交
771
    bool ret = false;
772
    int state;
773

774
    if ((state = vshDomainState(ctl, dom, NULL)) < 0) {
775 776 777 778
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

779
    if (state == VIR_DOMAIN_SHUTOFF) {
780 781 782 783
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

784 785
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
    vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
786
    if (vshRunConsole(dom, name) == 0)
E
Eric Blake 已提交
787
        ret = true;
788 789

 cleanup:
790

791 792 793
    return ret;
}

E
Eric Blake 已提交
794
static bool
795 796 797
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
798
    bool ret = false;
799
    const char *name = NULL;
800

801
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
802
        return false;
803 804

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

807 808 809 810
    if (vshCommandOptString(cmd, "devname", &name) < 0) {
        vshError(ctl, "%s", _("Invalid devname"));
        goto cleanup;
    }
811

812
    ret = cmdRunConsole(ctl, dom, name);
813

814
cleanup:
815 816 817 818
    virDomainFree(dom);
    return ret;
}

819 820 821
#endif /* WIN32 */


K
Karel Zak 已提交
822 823 824
/*
 * "list" command
 */
825
static const vshCmdInfo info_list[] = {
826 827
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
828
    {NULL, NULL}
K
Karel Zak 已提交
829 830
};

831
static const vshCmdOptDef opts_list[] = {
832 833
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
834 835 836
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
837

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

849
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
850
        return false;
851

852
    if (active) {
853 854
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
855
            vshError(ctl, "%s", _("Failed to list active domains"));
E
Eric Blake 已提交
856
            return false;
857 858 859 860 861
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
862
                vshError(ctl, "%s", _("Failed to list active domains"));
863
                VIR_FREE(ids);
E
Eric Blake 已提交
864
                return false;
865 866
            }

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

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
881
                vshError(ctl, "%s", _("Failed to list inactive domains"));
882 883
                VIR_FREE(ids);
                VIR_FREE(names);
E
Eric Blake 已提交
884
                return false;
885
            }
886

887
            qsort(&names[0], maxname, sizeof(char*), namesorter);
888
        }
889
    }
890
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
891
    vshPrintExtra(ctl, "----------------------------------\n");
892 893

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

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

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

        /* this kind of work with domains is not atomic operation */
910
        if (!dom) {
911
            VIR_FREE(names[i]);
912
            continue;
913
        }
914

915 916 917 918
        vshPrint(ctl, "%3s %-20s %s\n",
                 "-",
                 names[i],
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
919

920
        virDomainFree(dom);
921
        VIR_FREE(names[i]);
922
    }
923 924
    VIR_FREE(ids);
    VIR_FREE(names);
E
Eric Blake 已提交
925
    return true;
K
Karel Zak 已提交
926 927 928
}

/*
K
Karel Zak 已提交
929
 * "domstate" command
K
Karel Zak 已提交
930
 */
931
static const vshCmdInfo info_domstate[] = {
932 933
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
934
    {NULL, NULL}
K
Karel Zak 已提交
935 936
};

937
static const vshCmdOptDef opts_domstate[] = {
938
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
939
    {"reason", VSH_OT_BOOL, 0, N_("also print reason for the state")},
940
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
941 942
};

E
Eric Blake 已提交
943
static bool
944
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
945
{
K
Karel Zak 已提交
946
    virDomainPtr dom;
E
Eric Blake 已提交
947
    bool ret = true;
948 949
    int showReason = vshCommandOptBool(cmd, "reason");
    int state, reason;
950

951
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
952
        return false;
953

J
Jim Meyering 已提交
954
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
955
        return false;
956

957
    if ((state = vshDomainState(ctl, dom, &reason)) < 0) {
E
Eric Blake 已提交
958
        ret = false;
959 960 961 962 963 964 965 966 967 968 969
        goto cleanup;
    }

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

971
cleanup:
972 973 974 975
    virDomainFree(dom);
    return ret;
}

976 977
/* "domblkstat" command
 */
978
static const vshCmdInfo info_domblkstat[] = {
979 980
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
981 982 983
    {NULL,NULL}
};

984
static const vshCmdOptDef opts_domblkstat[] = {
985 986
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
987 988 989
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
990
static bool
991
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
992 993
{
    virDomainPtr dom;
994
    const char *name = NULL, *device = NULL;
995 996
    struct _virDomainBlockStats stats;

997
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
998
        return false;
999

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

1003
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
L
Laine Stump 已提交
1004
        virDomainFree(dom);
E
Eric Blake 已提交
1005
        return false;
L
Laine Stump 已提交
1006
    }
1007 1008

    if (virDomainBlockStats (dom, device, &stats, sizeof stats) == -1) {
1009
        vshError(ctl, _("Failed to get block stats %s %s"), name, device);
1010
        virDomainFree(dom);
E
Eric Blake 已提交
1011
        return false;
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
    }

    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 已提交
1030
    return true;
1031 1032 1033 1034
}

/* "domifstat" command
 */
1035
static const vshCmdInfo info_domifstat[] = {
1036 1037
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1038 1039 1040
    {NULL,NULL}
};

1041
static const vshCmdOptDef opts_domifstat[] = {
1042 1043
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1044 1045 1046
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1047
static bool
1048
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1049 1050
{
    virDomainPtr dom;
1051
    const char *name = NULL, *device = NULL;
1052 1053
    struct _virDomainInterfaceStats stats;

1054
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1055
        return false;
1056

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

1060
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1061
        virDomainFree(dom);
E
Eric Blake 已提交
1062
        return false;
L
Laine Stump 已提交
1063
    }
1064 1065

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

    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 已提交
1096
    return true;
1097 1098
}

1099 1100 1101
/*
 * "dommemstats" command
 */
1102
static const vshCmdInfo info_dommemstat[] = {
1103 1104
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1105 1106 1107
    {NULL,NULL}
};

1108
static const vshCmdOptDef opts_dommemstat[] = {
1109
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1110 1111 1112
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1113
static bool
1114
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1115 1116
{
    virDomainPtr dom;
1117
    const char *name;
1118 1119 1120
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1121
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1122
        return false;
1123 1124

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1125
        return false;
1126 1127 1128 1129 1130

    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 已提交
1131
        return false;
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
    }

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

    virDomainFree(dom);
E
Eric Blake 已提交
1150
    return true;
1151 1152
}

1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
/*
 * "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 已提交
1168
static bool
1169 1170 1171 1172
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1173
    bool ret = true;
1174
    const char *device = NULL;
1175

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

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

1182
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1183
        virDomainFree(dom);
E
Eric Blake 已提交
1184
        return false;
1185 1186 1187 1188
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1189
        return false;
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
    }

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

1200 1201 1202
/*
 * "suspend" command
 */
1203
static const vshCmdInfo info_suspend[] = {
1204 1205
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1206
    {NULL, NULL}
1207 1208
};

1209
static const vshCmdOptDef opts_suspend[] = {
1210
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1211
    {NULL, 0, 0, NULL}
1212 1213
};

E
Eric Blake 已提交
1214
static bool
1215
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1216
{
1217
    virDomainPtr dom;
1218
    const char *name;
E
Eric Blake 已提交
1219
    bool ret = true;
1220

1221
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1222
        return false;
1223

J
Jim Meyering 已提交
1224
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1225
        return false;
1226 1227

    if (virDomainSuspend(dom) == 0) {
1228
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1229
    } else {
1230
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1231
        ret = false;
1232
    }
1233

1234 1235 1236 1237
    virDomainFree(dom);
    return ret;
}

1238 1239 1240
/*
 * "create" command
 */
1241
static const vshCmdInfo info_create[] = {
1242 1243
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1244 1245 1246
    {NULL, NULL}
};

1247
static const vshCmdOptDef opts_create[] = {
1248
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1249
#ifndef WIN32
1250
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1251
#endif
1252
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1253 1254 1255
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1256
static bool
1257
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1258 1259
{
    virDomainPtr dom;
1260
    const char *from = NULL;
E
Eric Blake 已提交
1261
    bool ret = true;
1262
    char *buffer;
1263
#ifndef WIN32
1264
    int console = vshCommandOptBool(cmd, "console");
1265
#endif
1266
    unsigned int flags = VIR_DOMAIN_NONE;
1267

1268
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1269
        return false;
1270

1271
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1272
        return false;
1273

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

1277 1278 1279 1280
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1281
    VIR_FREE(buffer);
1282

1283
    if (dom != NULL) {
1284
        vshPrint(ctl, _("Domain %s created from %s\n"),
1285
                 virDomainGetName(dom), from);
1286
#ifndef WIN32
1287
        if (console)
1288
            cmdRunConsole(ctl, dom, NULL);
1289
#endif
1290
        virDomainFree(dom);
1291
    } else {
1292
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1293
        ret = false;
1294 1295 1296 1297
    }
    return ret;
}

1298 1299 1300
/*
 * "define" command
 */
1301
static const vshCmdInfo info_define[] = {
1302 1303
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1304 1305 1306
    {NULL, NULL}
};

1307
static const vshCmdOptDef opts_define[] = {
1308
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1309 1310 1311
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1312
static bool
1313
cmdDefine(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

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

1323
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1324
        return false;
1325

1326
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1327
        return false;
1328 1329

    dom = virDomainDefineXML(ctl->conn, buffer);
1330
    VIR_FREE(buffer);
1331

1332
    if (dom != NULL) {
1333
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1334
                 virDomainGetName(dom), from);
1335
        virDomainFree(dom);
1336
    } else {
1337
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1338
        ret = false;
1339 1340 1341 1342 1343 1344 1345
    }
    return ret;
}

/*
 * "undefine" command
 */
1346
static const vshCmdInfo info_undefine[] = {
1347 1348
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1349 1350 1351
    {NULL, NULL}
};

1352
static const vshCmdOptDef opts_undefine[] = {
1353
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1354 1355 1356
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1357
static bool
1358
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1359 1360
{
    virDomainPtr dom;
E
Eric Blake 已提交
1361
    bool ret = true;
1362
    const char *name = NULL;
1363
    int id;
1364

1365
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1366
        return false;
1367

1368
    if (vshCommandOptString(cmd, "domain", &name) <= 0)
E
Eric Blake 已提交
1369
        return false;
1370 1371 1372

    if (name && virStrToLong_i(name, NULL, 10, &id) == 0
        && id >= 0 && (dom = virDomainLookupByID(ctl->conn, id))) {
1373 1374 1375 1376 1377
        vshError(ctl,
                 _("a running domain like %s cannot be undefined;\n"
                   "to undefine, first shutdown then undefine"
                   " using its name or UUID"),
                 name);
1378
        virDomainFree(dom);
E
Eric Blake 已提交
1379
        return false;
1380
    }
J
Jim Meyering 已提交
1381
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
1382
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
1383
        return false;
1384 1385

    if (virDomainUndefine(dom) == 0) {
1386
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1387
    } else {
1388
        vshError(ctl, _("Failed to undefine domain %s"), name);
E
Eric Blake 已提交
1389
        ret = false;
1390 1391
    }

1392
    virDomainFree(dom);
1393 1394 1395 1396 1397 1398 1399
    return ret;
}


/*
 * "start" command
 */
1400
static const vshCmdInfo info_start[] = {
1401
    {"help", N_("start a (previously defined) inactive domain")},
1402 1403 1404
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1405 1406 1407
    {NULL, NULL}
};

1408
static const vshCmdOptDef opts_start[] = {
1409
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1410
#ifndef WIN32
1411
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1412
#endif
E
Eric Blake 已提交
1413
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1414 1415 1416
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1417
static bool
1418
cmdStart(vshControl *ctl, const vshCmd *cmd)
1419 1420
{
    virDomainPtr dom;
E
Eric Blake 已提交
1421
    bool ret = true;
1422
#ifndef WIN32
1423
    int console = vshCommandOptBool(cmd, "console");
1424
#endif
E
Eric Blake 已提交
1425
    unsigned int flags = VIR_DOMAIN_NONE;
1426

1427
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1428
        return false;
1429

1430 1431
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
1432
        return false;
1433 1434

    if (virDomainGetID(dom) != (unsigned int)-1) {
1435
        vshError(ctl, "%s", _("Domain is already active"));
1436
        virDomainFree(dom);
E
Eric Blake 已提交
1437
        return false;
1438 1439
    }

E
Eric Blake 已提交
1440 1441 1442 1443 1444 1445
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;

    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
         : virDomainCreate(dom)) == 0) {
1446
        vshPrint(ctl, _("Domain %s started\n"),
1447
                 virDomainGetName(dom));
1448
#ifndef WIN32
1449
        if (console)
1450
            cmdRunConsole(ctl, dom, NULL);
1451
#endif
1452
    } else {
1453
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
E
Eric Blake 已提交
1454
        ret = false;
1455
    }
1456
    virDomainFree(dom);
1457 1458 1459
    return ret;
}

1460 1461 1462
/*
 * "save" command
 */
1463
static const vshCmdInfo info_save[] = {
1464 1465
    {"help", N_("save a domain state to a file")},
    {"desc", N_("Save a running domain.")},
1466
    {NULL, NULL}
1467 1468
};

1469
static const vshCmdOptDef opts_save[] = {
1470 1471
    {"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")},
1472
    {NULL, 0, 0, NULL}
1473 1474
};

E
Eric Blake 已提交
1475
static bool
1476
cmdSave(vshControl *ctl, const vshCmd *cmd)
1477
{
1478
    virDomainPtr dom;
1479 1480
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1481
    bool ret = true;
1482

1483
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1484
        return false;
1485

1486
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1487
        return false;
1488

J
Jim Meyering 已提交
1489
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1490
        return false;
1491 1492

    if (virDomainSave(dom, to) == 0) {
1493
        vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
1494
    } else {
1495
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
E
Eric Blake 已提交
1496
        ret = false;
1497
    }
1498

1499 1500 1501 1502
    virDomainFree(dom);
    return ret;
}

1503 1504 1505 1506 1507
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1508 1509 1510 1511
    {"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.")},
1512 1513 1514 1515 1516 1517 1518 1519
    {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 已提交
1520
static bool
1521 1522 1523
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1524
    const char *name;
E
Eric Blake 已提交
1525
    bool ret = true;
1526

1527
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1528
        return false;
1529 1530

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1531
        return false;
1532 1533 1534 1535 1536

    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 已提交
1537
        ret = false;
1538 1539 1540 1541 1542 1543
    }

    virDomainFree(dom);
    return ret;
}

1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
/*
 * "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 已提交
1558
static bool
1559 1560 1561
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1562
    const char *name;
E
Eric Blake 已提交
1563
    bool ret = false;
1564 1565
    int hassave;

1566
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1567
        return false;
1568 1569

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1570
        return false;
1571 1572 1573

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1574
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
        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 已提交
1591
    ret = true;
1592 1593 1594 1595 1596 1597

cleanup:
    virDomainFree(dom);
    return ret;
}

1598 1599 1600
/*
 * "schedinfo" command
 */
1601
static const vshCmdInfo info_schedinfo[] = {
1602 1603
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1604 1605 1606
    {NULL, NULL}
};

1607
static const vshCmdOptDef opts_schedinfo[] = {
1608 1609 1610 1611
    {"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")},
1612 1613 1614
    {"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")},
1615 1616 1617
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
1618
static int
1619
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
1620
                   virTypedParameterPtr param)
1621
{
1622
    const char *data = NULL;
1623 1624 1625

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
1626
        param->type == VIR_TYPED_PARAM_UINT &&
1627 1628
        vshCommandOptBool(cmd, "weight")) {
        int val;
1629
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
1630
            vshError(ctl, "%s", _("Invalid value of weight"));
1631
            return -1;
1632
        } else {
1633
            param->value.ui = val;
1634
        }
1635
        return 1;
1636 1637
    }

1638 1639
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
1640
        param->type == VIR_TYPED_PARAM_UINT &&
1641 1642
        vshCommandOptBool(cmd, "cap")) {
        int val;
1643
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
1644
            vshError(ctl, "%s", _("Invalid value of cap"));
1645
            return -1;
1646
        } else {
1647
            param->value.ui = val;
1648
        }
1649
        return 1;
1650
    }
1651

1652
    if (vshCommandOptString(cmd, "set", &data) > 0) {
1653 1654 1655
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
1656
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
1657
            return -1;
1658
        }
1659 1660 1661 1662 1663 1664 1665 1666 1667
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
1668
        case VIR_TYPED_PARAM_INT:
1669
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
1670
                vshError(ctl, "%s",
1671 1672 1673 1674
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
1675
        case VIR_TYPED_PARAM_UINT:
1676
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
1677
                vshError(ctl, "%s",
1678 1679 1680 1681
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
1682
        case VIR_TYPED_PARAM_LLONG:
1683
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
1684
                vshError(ctl, "%s",
J
Jim Meyering 已提交
1685
                         _("Invalid value for parameter, expecting a long long"));
1686 1687 1688
                return -1;
            }
            break;
1689
        case VIR_TYPED_PARAM_ULLONG:
1690
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
1691
                vshError(ctl, "%s",
1692 1693 1694 1695
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
1696
        case VIR_TYPED_PARAM_DOUBLE:
1697
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
1698
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
1699 1700 1701
                return -1;
            }
            break;
1702
        case VIR_TYPED_PARAM_BOOLEAN:
1703
            param->value.b = STREQ(val, "0") ? 0 : 1;
1704
        }
1705
        return 1;
1706
    }
1707

1708 1709
    return 0;
}
1710

1711

E
Eric Blake 已提交
1712
static bool
1713 1714 1715 1716
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
1717
    virTypedParameterPtr params = NULL;
1718 1719 1720
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
1721
    bool ret_val = false;
1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
    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_SCHEDPARAM_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_SCHEDPARAM_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_SCHEDPARAM_LIVE;
    }
1739

1740
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1741
        return false;
1742

1743
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
1744
        return false;
1745 1746 1747

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
1748
    if (schedulertype != NULL){
1749
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
1750
             schedulertype);
1751
        VIR_FREE(schedulertype);
1752
    } else {
1753
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
1754
        goto cleanup;
1755 1756
    }

1757
    if (nparams) {
1758
        params = vshMalloc(ctl, sizeof(*params) * nparams);
1759

1760
        memset(params, 0, sizeof(*params) * nparams);
1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
        ret = virDomainGetSchedulerParameters(dom, params, &nparams);
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
        for (i = 0; i < nparams; i++){
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
1777 1778 1779 1780 1781
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
1782 1783 1784 1785 1786 1787
            if (ret == -1)
                goto cleanup;

            ret = virDomainGetSchedulerParameters(dom, params, &nparams);
            if (ret == -1)
                goto cleanup;
1788 1789 1790 1791
        } 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.  */
1792 1793
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
1794 1795 1796 1797
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
1798 1799
        }

E
Eric Blake 已提交
1800
        ret_val = true;
1801 1802
        for (i = 0; i < nparams; i++){
            switch (params[i].type) {
1803
            case VIR_TYPED_PARAM_INT:
1804
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1805
                 break;
1806
            case VIR_TYPED_PARAM_UINT:
1807
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1808
                 break;
1809
            case VIR_TYPED_PARAM_LLONG:
1810
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1811
                 break;
1812
            case VIR_TYPED_PARAM_ULLONG:
1813
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1814
                 break;
1815
            case VIR_TYPED_PARAM_DOUBLE:
1816
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1817
                 break;
1818
            case VIR_TYPED_PARAM_BOOLEAN:
1819
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
1820 1821
                 break;
            default:
1822
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
1823 1824 1825
            }
        }
    }
1826

1827
 cleanup:
1828
    VIR_FREE(params);
1829
    virDomainFree(dom);
1830
    return ret_val;
1831 1832
}

1833 1834 1835
/*
 * "restore" command
 */
1836
static const vshCmdInfo info_restore[] = {
1837 1838
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
1839
    {NULL, NULL}
1840 1841
};

1842
static const vshCmdOptDef opts_restore[] = {
1843
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
1844
    {NULL, 0, 0, NULL}
1845 1846
};

E
Eric Blake 已提交
1847
static bool
1848
cmdRestore(vshControl *ctl, const vshCmd *cmd)
1849
{
1850
    const char *from = NULL;
E
Eric Blake 已提交
1851
    bool ret = true;
1852

1853
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1854
        return false;
1855

1856
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1857
        return false;
1858 1859

    if (virDomainRestore(ctl->conn, from) == 0) {
1860
        vshPrint(ctl, _("Domain restored from %s\n"), from);
1861
    } else {
1862
        vshError(ctl, _("Failed to restore domain from %s"), from);
E
Eric Blake 已提交
1863
        ret = false;
1864 1865 1866 1867
    }
    return ret;
}

D
Daniel Veillard 已提交
1868 1869 1870
/*
 * "dump" command
 */
1871
static const vshCmdInfo info_dump[] = {
1872 1873
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
1874 1875 1876
    {NULL, NULL}
};

1877
static const vshCmdOptDef opts_dump[] = {
1878 1879 1880 1881
    {"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 已提交
1882 1883 1884
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1885
static bool
1886
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
1887 1888
{
    virDomainPtr dom;
1889 1890
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1891
    bool ret = true;
1892
    int flags = 0;
D
Daniel Veillard 已提交
1893

1894
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1895
        return false;
D
Daniel Veillard 已提交
1896

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

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

P
Paolo Bonzini 已提交
1903 1904
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
1905 1906 1907 1908
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;

    if (virDomainCoreDump(dom, to, flags) == 0) {
1909
        vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
D
Daniel Veillard 已提交
1910
    } else {
1911
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
E
Eric Blake 已提交
1912
        ret = false;
D
Daniel Veillard 已提交
1913 1914 1915 1916 1917 1918
    }

    virDomainFree(dom);
    return ret;
}

1919 1920 1921
/*
 * "resume" command
 */
1922
static const vshCmdInfo info_resume[] = {
1923 1924
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
1925
    {NULL, NULL}
1926 1927
};

1928
static const vshCmdOptDef opts_resume[] = {
1929
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1930
    {NULL, 0, 0, NULL}
1931 1932
};

E
Eric Blake 已提交
1933
static bool
1934
cmdResume(vshControl *ctl, const vshCmd *cmd)
1935
{
1936
    virDomainPtr dom;
E
Eric Blake 已提交
1937
    bool ret = true;
1938
    const char *name;
1939

1940
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1941
        return false;
1942

J
Jim Meyering 已提交
1943
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1944
        return false;
1945 1946

    if (virDomainResume(dom) == 0) {
1947
        vshPrint(ctl, _("Domain %s resumed\n"), name);
1948
    } else {
1949
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
1950
        ret = false;
1951
    }
1952

1953 1954 1955 1956
    virDomainFree(dom);
    return ret;
}

1957 1958 1959
/*
 * "shutdown" command
 */
1960
static const vshCmdInfo info_shutdown[] = {
1961 1962
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
1963
    {NULL, NULL}
1964 1965
};

1966
static const vshCmdOptDef opts_shutdown[] = {
1967
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1968
    {NULL, 0, 0, NULL}
1969 1970
};

E
Eric Blake 已提交
1971
static bool
1972
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
1973
{
1974
    virDomainPtr dom;
E
Eric Blake 已提交
1975
    bool ret = true;
1976
    const char *name;
1977

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

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

    if (virDomainShutdown(dom) == 0) {
1985
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
1986
    } else {
1987
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
1988
        ret = false;
1989
    }
1990

1991 1992 1993 1994
    virDomainFree(dom);
    return ret;
}

1995 1996 1997
/*
 * "reboot" command
 */
1998
static const vshCmdInfo info_reboot[] = {
1999 2000
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
2001 2002 2003
    {NULL, NULL}
};

2004
static const vshCmdOptDef opts_reboot[] = {
2005
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2006 2007 2008
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2009
static bool
2010
cmdReboot(vshControl *ctl, const vshCmd *cmd)
2011 2012
{
    virDomainPtr dom;
E
Eric Blake 已提交
2013
    bool ret = true;
2014
    const char *name;
2015

2016
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2017
        return false;
2018

J
Jim Meyering 已提交
2019
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2020
        return false;
2021 2022

    if (virDomainReboot(dom, 0) == 0) {
2023
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
2024
    } else {
2025
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
2026
        ret = false;
2027 2028 2029 2030 2031 2032
    }

    virDomainFree(dom);
    return ret;
}

2033 2034 2035
/*
 * "destroy" command
 */
2036
static const vshCmdInfo info_destroy[] = {
2037 2038
    {"help", N_("destroy a domain")},
    {"desc", N_("Destroy a given domain.")},
2039
    {NULL, NULL}
2040 2041
};

2042
static const vshCmdOptDef opts_destroy[] = {
2043
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2044
    {NULL, 0, 0, NULL}
2045 2046
};

E
Eric Blake 已提交
2047
static bool
2048
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2049
{
2050
    virDomainPtr dom;
E
Eric Blake 已提交
2051
    bool ret = true;
2052
    const char *name;
2053

2054
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2055
        return false;
2056

J
Jim Meyering 已提交
2057
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2058
        return false;
2059 2060

    if (virDomainDestroy(dom) == 0) {
2061
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2062
    } else {
2063
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
2064
        ret = false;
2065
    }
2066

2067
    virDomainFree(dom);
K
Karel Zak 已提交
2068 2069 2070 2071
    return ret;
}

/*
2072
 * "dominfo" command
K
Karel Zak 已提交
2073
 */
2074
static const vshCmdInfo info_dominfo[] = {
2075 2076
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2077
    {NULL, NULL}
K
Karel Zak 已提交
2078 2079
};

2080
static const vshCmdOptDef opts_dominfo[] = {
2081
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2082
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2083 2084
};

E
Eric Blake 已提交
2085
static bool
2086
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2087
{
K
Karel Zak 已提交
2088 2089
    virDomainInfo info;
    virDomainPtr dom;
2090
    virSecurityModel secmodel;
2091
    virSecurityLabelPtr seclabel;
2092
    int persistent = 0;
E
Eric Blake 已提交
2093 2094
    bool ret = true;
    int autostart;
2095
    unsigned int id;
2096
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2097

2098
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2099
        return false;
K
Karel Zak 已提交
2100

J
Jim Meyering 已提交
2101
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2102
        return false;
2103

2104 2105
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2106
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2107
    else
2108
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2109 2110
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2111
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2112
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2113 2114

    if ((str = virDomainGetOSType(dom))) {
2115
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2116
        VIR_FREE(str);
2117 2118 2119
    }

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

2123
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2124 2125

        if (info.cpuTime != 0) {
2126
            double cpuUsed = info.cpuTime;
2127

2128
            cpuUsed /= 1000000000.0;
2129

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

2133 2134
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2135
                 info.maxMem);
2136
        else
2137
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2138 2139
                 _("no limit"));

2140
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2141 2142
                 info.memory);

K
Karel Zak 已提交
2143
    } else {
E
Eric Blake 已提交
2144
        ret = false;
K
Karel Zak 已提交
2145
    }
2146

2147 2148 2149 2150 2151 2152 2153 2154 2155
    /* 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 */
2156
    if (!virDomainGetAutostart(dom, &autostart)) {
2157
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2158 2159 2160
                 autostart ? _("enable") : _("disable") );
    }

2161 2162 2163
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2164 2165
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
2166
            return false;
2167 2168 2169
        } else {
            virFreeError(last_error);
            last_error = NULL;
2170
        }
2171 2172 2173 2174 2175 2176 2177
    } 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 */
2178
            if (VIR_ALLOC(seclabel) < 0) {
2179
                virDomainFree(dom);
E
Eric Blake 已提交
2180
                return false;
2181 2182 2183 2184 2185
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
2186
                return false;
2187
            } else {
2188
                if (seclabel->label[0] != '\0')
2189
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
2190
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
2191
            }
2192 2193

            VIR_FREE(seclabel);
2194 2195
        }
    }
2196
    virDomainFree(dom);
K
Karel Zak 已提交
2197 2198 2199
    return ret;
}

2200 2201 2202 2203
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2204 2205
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2206 2207 2208 2209
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2210
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2211 2212 2213 2214
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
2215
static bool
2216 2217 2218 2219
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
2220
    bool ret = true;
2221

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2226
        return false;
2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252

    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 已提交
2253
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2254
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2255
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2256
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2257
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2258 2259 2260
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2261
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2262
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2263
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2264
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2265
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2266 2267 2268
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2269
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2270
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2271
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2272
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2273
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2274 2275
        }
    } else {
E
Eric Blake 已提交
2276
        ret = false;
2277 2278 2279 2280 2281 2282
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2283 2284 2285 2286
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2287 2288
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2289 2290 2291 2292
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2293
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2294 2295 2296
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2297
static bool
2298 2299 2300
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2301
    bool ret = true;
2302

2303
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2304
        return false;
2305 2306

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
2310
        ret = false;
2311 2312 2313 2314 2315

    virDomainFree(dom);
    return ret;
}

2316 2317 2318
/*
 * "freecell" command
 */
2319
static const vshCmdInfo info_freecell[] = {
2320 2321
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2322 2323 2324
    {NULL, NULL}
};

2325
static const vshCmdOptDef opts_freecell[] = {
2326
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2327
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
2328 2329 2330
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2331
static bool
2332
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2333
{
W
Wen Congyang 已提交
2334
    bool func_ret = false;
2335
    int ret;
2336
    int cell = -1, cell_given;
2337
    unsigned long long memory;
2338 2339 2340 2341
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
2342
    int all_given;
2343 2344 2345 2346
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
2347

2348

2349
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2350
        return false;
2351

2352 2353 2354 2355
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
2356 2357 2358 2359 2360 2361 2362 2363 2364
    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) {
2365 2366 2367
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2368 2369 2370
            goto cleanup;
        }

2371 2372 2373
        xml = xmlReadDoc((const xmlChar *) cap_xml, "node.xml", NULL,
                          XML_PARSE_NOENT | XML_PARSE_NONET |
                          XML_PARSE_NOWARNING);
2374

2375 2376
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2377 2378 2379
            goto cleanup;
        }

2380 2381 2382 2383 2384
        ctxt = xmlXPathNewContext(xml);
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
2385
            vshError(ctl, "%s", _("could not get information about "
2386
                                  "NUMA topology"));
2387 2388 2389
            goto cleanup;
        }

2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410
        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;
            }
        }

2411
        memory = 0;
2412 2413 2414 2415
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
2416 2417 2418 2419
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
2420
    } else {
2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434
        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));
2435 2436
    }

E
Eric Blake 已提交
2437
    func_ret = true;
2438

2439
cleanup:
2440 2441 2442
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
2443
    VIR_FREE(nodes);
2444 2445 2446
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
2447
    return func_ret;
2448 2449
}

E
Eric Blake 已提交
2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463
/*
 * "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 已提交
2464
static bool
E
Eric Blake 已提交
2465 2466
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
2467
    const char *type = NULL;
E
Eric Blake 已提交
2468 2469
    int vcpus;

2470 2471
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
2472
        return false;
2473
    }
E
Eric Blake 已提交
2474 2475

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2476
        return false;
E
Eric Blake 已提交
2477 2478 2479

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

E
Eric Blake 已提交
2483
    return true;
E
Eric Blake 已提交
2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503
}

/*
 * "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 已提交
2504
static bool
E
Eric Blake 已提交
2505 2506 2507
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2508
    bool ret = true;
E
Eric Blake 已提交
2509 2510 2511 2512 2513 2514 2515 2516 2517 2518
    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 已提交
2519
        return false;
E
Eric Blake 已提交
2520 2521 2522 2523
    }
    if (config && live) {
        vshError(ctl, "%s",
                 _("--config and --live cannot both be specified"));
E
Eric Blake 已提交
2524
        return false;
E
Eric Blake 已提交
2525 2526 2527 2528 2529 2530 2531 2532 2533 2534
    }
    /* 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 已提交
2535
        return false;
E
Eric Blake 已提交
2536 2537 2538
    }

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2542
        return false;
E
Eric Blake 已提交
2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558

    /* 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 |
                                             VIR_DOMAIN_VCPU_CONFIG));
        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;
            }
2559 2560
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
2561 2562 2563 2564 2565
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2566
            ret = false;
E
Eric Blake 已提交
2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586
        } 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 |
                                             VIR_DOMAIN_VCPU_LIVE));
        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 已提交
2587
            ret = false;
E
Eric Blake 已提交
2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623
        } 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)) {
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_VCPU_CONFIG);
        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 已提交
2624
            ret = false;
E
Eric Blake 已提交
2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645
        } 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)) {
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_VCPU_LIVE);
        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 已提交
2646
            ret = false;
E
Eric Blake 已提交
2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660
        } 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;
}

2661 2662 2663
/*
 * "vcpuinfo" command
 */
2664
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
2665
    {"help", N_("detailed domain vcpu information")},
2666
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
2667 2668 2669
    {NULL, NULL}
};

2670
static const vshCmdOptDef opts_vcpuinfo[] = {
2671
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2672 2673 2674
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2675
static bool
2676
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
2677 2678 2679 2680 2681 2682 2683 2684
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
    unsigned char *cpumap;
    int ncpus;
    size_t cpumaplen;
E
Eric Blake 已提交
2685
    bool ret = true;
2686

2687
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2688
        return false;
2689

J
Jim Meyering 已提交
2690
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2691
        return false;
2692 2693 2694

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2695
        return false;
2696 2697 2698 2699
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2700
        return false;
2701 2702
    }

2703
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
2704
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2705
    cpumap = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
2706

2707 2708 2709
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
                                   cpumap, cpumaplen)) >= 0) {
2710
        int n;
2711 2712 2713 2714 2715
        for (n = 0 ; n < ncpus ; n++) {
            unsigned int m;
            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 已提交
2716
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732
            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:"));
            for (m = 0 ; m < VIR_NODEINFO_MAXCPUS(nodeinfo) ; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumap, cpumaplen, n, m) ? 'y' : '-');
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
2733
    } else {
2734
        if (info.state == VIR_DOMAIN_SHUTOFF) {
2735 2736
            vshError(ctl, "%s",
                     _("Domain shut off, virtual CPUs not present."));
2737
        }
E
Eric Blake 已提交
2738
        ret = false;
2739 2740
    }

2741 2742
    VIR_FREE(cpumap);
    VIR_FREE(cpuinfo);
2743 2744 2745 2746 2747 2748 2749
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
2750
static const vshCmdInfo info_vcpupin[] = {
2751 2752
    {"help", N_("control domain vcpu affinity")},
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
2753 2754 2755
    {NULL, NULL}
};

2756
static const vshCmdOptDef opts_vcpupin[] = {
2757
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2758
    {"vcpu", VSH_OT_INT, VSH_OFLAG_REQ, N_("vcpu number")},
2759
    {"cpulist", VSH_OT_DATA, VSH_OFLAG_REQ, N_("host cpu number(s) (comma separated)")},
2760 2761 2762
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2763
static bool
2764
cmdVcpupin(vshControl *ctl, const vshCmd *cmd)
2765 2766 2767 2768 2769
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    int vcpu;
2770
    const char *cpulist = NULL;
E
Eric Blake 已提交
2771
    bool ret = true;
2772 2773
    unsigned char *cpumap;
    int cpumaplen;
2774 2775
    int i;
    enum { expect_num, expect_num_or_comma } state;
2776

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

J
Jim Meyering 已提交
2780
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2781
        return false;
2782

2783
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) <= 0) {
2784
        vshError(ctl, "%s", _("vcpupin: Invalid or missing vCPU number."));
2785
        virDomainFree(dom);
E
Eric Blake 已提交
2786
        return false;
2787 2788
    }

2789
    if (vshCommandOptString(cmd, "cpulist", &cpulist) <= 0) {
2790
        virDomainFree(dom);
E
Eric Blake 已提交
2791
        return false;
2792
    }
2793

2794 2795
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2796
        return false;
2797 2798 2799
    }

    if (virDomainGetInfo(dom, &info) != 0) {
2800
        vshError(ctl, "%s", _("vcpupin: failed to get domain informations."));
2801
        virDomainFree(dom);
E
Eric Blake 已提交
2802
        return false;
2803 2804 2805
    }

    if (vcpu >= info.nrVirtCpu) {
2806
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
2807
        virDomainFree(dom);
E
Eric Blake 已提交
2808
        return false;
2809 2810
    }

2811 2812 2813 2814
    /* Check that the cpulist parameter is a comma-separated list of
     * numbers and give an intelligent error message if not.
     */
    if (cpulist[0] == '\0') {
2815
        vshError(ctl, "%s", _("cpulist: Invalid format. Empty string."));
2816
        virDomainFree (dom);
E
Eric Blake 已提交
2817
        return false;
2818 2819 2820 2821 2822 2823
    }

    state = expect_num;
    for (i = 0; cpulist[i]; i++) {
        switch (state) {
        case expect_num:
2824
          if (!c_isdigit (cpulist[i])) {
2825 2826 2827
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2828
                virDomainFree (dom);
E
Eric Blake 已提交
2829
                return false;
2830 2831 2832 2833 2834 2835
            }
            state = expect_num_or_comma;
            break;
        case expect_num_or_comma:
            if (cpulist[i] == ',')
                state = expect_num;
2836
            else if (!c_isdigit (cpulist[i])) {
2837 2838 2839
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit or comma at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2840
                virDomainFree (dom);
E
Eric Blake 已提交
2841
                return false;
2842 2843 2844 2845
            }
        }
    }
    if (state == expect_num) {
2846 2847 2848
        vshError(ctl, _("cpulist: %s: Invalid format. Trailing comma "
                        "at position %d."),
                 cpulist, i);
2849
        virDomainFree (dom);
E
Eric Blake 已提交
2850
        return false;
2851 2852
    }

2853
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2854
    cpumap = vshCalloc(ctl, 1, cpumaplen);
2855 2856 2857 2858 2859 2860

    do {
        unsigned int cpu = atoi(cpulist);

        if (cpu < VIR_NODEINFO_MAXCPUS(nodeinfo)) {
            VIR_USE_CPU(cpumap, cpu);
2861
        } else {
2862
            vshError(ctl, _("Physical CPU %d doesn't exist."), cpu);
2863
            VIR_FREE(cpumap);
2864
            virDomainFree(dom);
E
Eric Blake 已提交
2865
            return false;
2866
        }
2867
        cpulist = strchr(cpulist, ',');
2868 2869 2870 2871 2872
        if (cpulist)
            cpulist++;
    } while (cpulist);

    if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
E
Eric Blake 已提交
2873
        ret = false;
2874 2875
    }

2876
    VIR_FREE(cpumap);
2877 2878 2879 2880
    virDomainFree(dom);
    return ret;
}

2881 2882 2883
/*
 * "setvcpus" command
 */
2884
static const vshCmdInfo info_setvcpus[] = {
2885 2886
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
2887 2888 2889
    {NULL, NULL}
};

2890
static const vshCmdOptDef opts_setvcpus[] = {
2891
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2892
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
2893 2894 2895
    {"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")},
2896 2897 2898
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2899
static bool
2900
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
2901 2902
{
    virDomainPtr dom;
2903
    int count = 0;
E
Eric Blake 已提交
2904
    bool ret = true;
E
Eric Blake 已提交
2905 2906 2907 2908 2909 2910
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int flags = ((maximum ? VIR_DOMAIN_VCPU_MAXIMUM : 0) |
                 (config ? VIR_DOMAIN_VCPU_CONFIG : 0) |
                 (live ? VIR_DOMAIN_VCPU_LIVE : 0));
2911

2912
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2913
        return false;
2914

J
Jim Meyering 已提交
2915
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2916
        return false;
2917

2918 2919 2920 2921
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
2922

E
Eric Blake 已提交
2923 2924
    if (!flags) {
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
2925
            ret = false;
E
Eric Blake 已提交
2926 2927
        }
    } else {
2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940
        /* 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 已提交
2941
                ret = false;
2942 2943 2944 2945 2946
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
2947
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
2948
            ret = false;
E
Eric Blake 已提交
2949
        }
2950 2951
    }

2952
  cleanup:
2953 2954 2955 2956
    virDomainFree(dom);
    return ret;
}

2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990
/*
 * "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;
}

2991 2992 2993
/*
 * "setmemory" command
 */
2994
static const vshCmdInfo info_setmem[] = {
2995 2996
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
2997 2998 2999
    {NULL, NULL}
};

3000
static const vshCmdOptDef opts_setmem[] = {
3001
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3002
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
3003 3004
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
3005
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3006 3007 3008
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3009
static bool
3010
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
3011 3012
{
    virDomainPtr dom;
3013
    virDomainInfo info;
3014
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
3015
    bool ret = true;
3016 3017
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3018
    int current = vshCommandOptBool(cmd, "current");
3019 3020
    int flags = 0;

3021 3022 3023
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3024
            return false;
3025 3026 3027 3028 3029
        }
        flags = VIR_DOMAIN_MEM_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_MEM_CONFIG;
3030 3031
        if (live)
            flags |= VIR_DOMAIN_MEM_LIVE;
3032 3033 3034
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
3035
    }
3036

3037
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3038
        return false;
3039

J
Jim Meyering 已提交
3040
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3041
        return false;
3042

3043 3044
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3045
        return false;
3046 3047
    }

3048
    if (kilobytes <= 0) {
3049
        virDomainFree(dom);
3050
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
3051
        return false;
3052 3053
    }

3054 3055
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
3056
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
3057
        return false;
3058 3059 3060 3061
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
3062
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
3063
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
3064
        return false;
3065 3066
    }

3067
    if (flags == -1) {
3068
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
3069
            ret = false;
3070 3071 3072
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
3073
            ret = false;
3074
        }
3075 3076 3077 3078 3079 3080 3081 3082 3083
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
3084
static const vshCmdInfo info_setmaxmem[] = {
3085 3086
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
3087 3088 3089
    {NULL, NULL}
};

3090
static const vshCmdOptDef opts_setmaxmem[] = {
3091
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3092
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
3093 3094 3095
    {"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")},
3096 3097 3098
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3099
static bool
3100
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
3101 3102
{
    virDomainPtr dom;
3103
    int kilobytes = 0;
E
Eric Blake 已提交
3104
    bool ret = true;
3105 3106 3107 3108 3109 3110 3111 3112
    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 已提交
3113
            return false;
3114 3115 3116 3117 3118 3119 3120 3121 3122 3123
        }
    } else {
        if (config)
            flags |= VIR_DOMAIN_MEM_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_MEM_LIVE;
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
3124

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

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

3131 3132
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3133
        return false;
3134 3135
    }

3136
    if (kilobytes <= 0) {
3137
        virDomainFree(dom);
3138
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
3139
        return false;
3140 3141
    }

3142 3143 3144
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3145
            ret = false;
3146 3147 3148 3149
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3150
            ret = false;
3151
        }
3152 3153
    }

3154 3155 3156 3157
    virDomainFree(dom);
    return ret;
}

3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176
/*
 * "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]")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3177
static bool
3178 3179 3180 3181 3182 3183
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
    unsigned int i = 0;
3184
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3185
    bool ret = false;
3186 3187

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3188
        return false;
3189 3190

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3191
        return false;
3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217

    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 */
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, 0) != 0) {
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3218
            ret = true;
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230
            goto cleanup;
        }

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

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
3231
                case VIR_TYPED_PARAM_INT:
3232 3233 3234
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
3235
                case VIR_TYPED_PARAM_UINT:
3236 3237 3238
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
3239
                case VIR_TYPED_PARAM_LLONG:
3240 3241 3242
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
3243
                case VIR_TYPED_PARAM_ULLONG:
3244 3245 3246
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
3247
                case VIR_TYPED_PARAM_DOUBLE:
3248 3249 3250
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
3251
                case VIR_TYPED_PARAM_BOOLEAN:
3252 3253 3254 3255 3256 3257 3258 3259
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
3260
        ret = true;
3261 3262 3263 3264 3265 3266
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
3267
            temp->type = VIR_TYPED_PARAM_UINT;
3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
        if (virDomainSetBlkioParameters(dom, params, nparams, 0) != 0)
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
3279
            ret = true;
3280 3281 3282 3283 3284 3285 3286 3287
    }

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

3288 3289 3290 3291
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
3292 3293 3294
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
3295 3296 3297 3298 3299 3300 3301
                "    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")},
3302
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3303
     N_("Max memory in kilobytes")},
3304
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3305
     N_("Memory during contention in kilobytes")},
3306
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3307
     N_("Max memory plus swap in kilobytes")},
3308
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
3309
     N_("Min guaranteed memory in kilobytes")},
3310 3311 3312
    {"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")},
3313 3314 3315
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3316
static bool
3317 3318 3319
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
3320 3321
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
3322 3323
    int nparams = 0;
    unsigned int i = 0;
3324
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3325
    bool ret = false;
3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342
    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_MEMORY_PARAM_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_MEMORY_PARAM_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_MEMORY_PARAM_LIVE;
    }
3343 3344

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3345
        return false;
3346 3347

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

3350 3351 3352 3353 3354 3355 3356 3357 3358
    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;
    }

3359 3360 3361 3362 3363 3364 3365 3366 3367
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

3368 3369 3370
    if (min_guarantee)
        nparams++;

3371 3372
    if (nparams == 0) {
        /* get the number of memory parameters */
3373
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
3374 3375 3376 3377 3378
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

3379 3380
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3381
            ret = true;
3382 3383 3384
            goto cleanup;
        }

3385
        /* now go get all the memory parameters */
E
Eric Blake 已提交
3386
        params = vshCalloc(ctl, nparams, sizeof(*params));
3387
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
3388 3389 3390 3391 3392 3393
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
3394
                case VIR_TYPED_PARAM_INT:
3395 3396 3397
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
3398
                case VIR_TYPED_PARAM_UINT:
3399 3400 3401
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
3402
                case VIR_TYPED_PARAM_LLONG:
3403 3404 3405
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
3406
                case VIR_TYPED_PARAM_ULLONG:
3407 3408 3409 3410 3411
                    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);
3412
                    break;
3413
                case VIR_TYPED_PARAM_DOUBLE:
3414 3415 3416
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
3417
                case VIR_TYPED_PARAM_BOOLEAN:
3418 3419 3420 3421
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
3422
                    vshPrint(ctl, "unimplemented memory parameter type\n");
3423 3424 3425
            }
        }

E
Eric Blake 已提交
3426
        ret = true;
3427 3428
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
3429
        params = vshCalloc(ctl, nparams, sizeof(*params));
3430 3431 3432

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
3433
            temp->type = VIR_TYPED_PARAM_ULLONG;
3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452

            /*
             * 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;
3453
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
3454 3455
                        sizeof(temp->field));
                swap_hard_limit = 0;
3456 3457 3458 3459 3460
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
3461
            }
3462 3463 3464 3465

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
3466
        }
3467
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
3468
            vshError(ctl, "%s", _("Unable to change memory parameters"));
3469
        else
E
Eric Blake 已提交
3470
            ret = true;
3471 3472 3473
    }

  cleanup:
E
Eric Blake 已提交
3474
    VIR_FREE(params);
3475 3476 3477 3478
    virDomainFree(dom);
    return ret;
}

3479 3480 3481
/*
 * "nodeinfo" command
 */
3482
static const vshCmdInfo info_nodeinfo[] = {
3483 3484
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
3485 3486 3487
    {NULL, NULL}
};

E
Eric Blake 已提交
3488
static bool
3489
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3490 3491
{
    virNodeInfo info;
3492

3493
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3494
        return false;
3495 3496

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
3497
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
3498
        return false;
3499 3500 3501 3502 3503 3504 3505 3506 3507 3508
    }
    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 已提交
3509
    return true;
3510 3511
}

3512 3513 3514
/*
 * "capabilities" command
 */
3515
static const vshCmdInfo info_capabilities[] = {
3516 3517
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
3518 3519 3520
    {NULL, NULL}
};

E
Eric Blake 已提交
3521
static bool
3522
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3523 3524 3525
{
    char *caps;

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

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
3530
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
3531
        return false;
3532 3533
    }
    vshPrint (ctl, "%s\n", caps);
3534
    VIR_FREE(caps);
3535

E
Eric Blake 已提交
3536
    return true;
3537 3538
}

3539 3540 3541
/*
 * "dumpxml" command
 */
3542
static const vshCmdInfo info_dumpxml[] = {
3543 3544
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
3545
    {NULL, NULL}
3546 3547
};

3548
static const vshCmdOptDef opts_dumpxml[] = {
3549 3550 3551
    {"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")},
3552
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
3553
    {NULL, 0, 0, NULL}
3554 3555
};

E
Eric Blake 已提交
3556
static bool
3557
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
3558
{
3559
    virDomainPtr dom;
E
Eric Blake 已提交
3560
    bool ret = true;
3561
    char *dump;
3562 3563 3564
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
3565
    int update = vshCommandOptBool(cmd, "update-cpu");
3566 3567 3568 3569 3570

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
3571 3572
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
3573

3574
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3575
        return false;
3576

J
Jim Meyering 已提交
3577
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3578
        return false;
3579

3580
    dump = virDomainGetXMLDesc(dom, flags);
3581
    if (dump != NULL) {
3582
        vshPrint(ctl, "%s", dump);
3583
        VIR_FREE(dump);
3584
    } else {
E
Eric Blake 已提交
3585
        ret = false;
3586
    }
3587

3588 3589 3590 3591
    virDomainFree(dom);
    return ret;
}

3592 3593 3594 3595
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
3596 3597
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
3598 3599 3600 3601
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
3602 3603
    {"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")},
3604 3605 3606
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3607
static bool
3608 3609
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
3610
    bool ret = true;
3611 3612
    const char *format = NULL;
    const char *configFile = NULL;
3613 3614 3615 3616
    char *configData;
    char *xmlData;
    int flags = 0;

3617
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3618
        return false;
3619

3620 3621
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
3622
        return false;
3623

3624
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
3625
        return false;
3626 3627 3628

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
3629
        vshPrint(ctl, "%s", xmlData);
3630
        VIR_FREE(xmlData);
3631
    } else {
E
Eric Blake 已提交
3632
        ret = false;
3633 3634 3635 3636 3637 3638 3639 3640 3641
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
3642 3643
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
3644 3645 3646 3647
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
3648 3649
    {"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")},
3650 3651 3652
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3653
static bool
3654 3655
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
3656
    bool ret = true;
3657 3658
    const char *format = NULL;
    const char *xmlFile = NULL;
3659 3660 3661 3662
    char *configData;
    char *xmlData;
    int flags = 0;

3663
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3664
        return false;
3665

3666 3667
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
3668
        return false;
3669

3670
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
3671
        return false;
3672 3673 3674

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
3675
        vshPrint(ctl, "%s", configData);
3676
        VIR_FREE(configData);
3677
    } else {
E
Eric Blake 已提交
3678
        ret = false;
3679 3680 3681 3682 3683
    }

    return ret;
}

K
Karel Zak 已提交
3684
/*
K
Karel Zak 已提交
3685
 * "domname" command
K
Karel Zak 已提交
3686
 */
3687
static const vshCmdInfo info_domname[] = {
3688
    {"help", N_("convert a domain id or UUID to domain name")},
3689
    {"desc", ""},
3690
    {NULL, NULL}
K
Karel Zak 已提交
3691 3692
};

3693
static const vshCmdOptDef opts_domname[] = {
3694
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
3695
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3696 3697
};

E
Eric Blake 已提交
3698
static bool
3699
cmdDomname(vshControl *ctl, const vshCmd *cmd)
3700
{
K
Karel Zak 已提交
3701 3702
    virDomainPtr dom;

3703
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3704
        return false;
J
Jim Meyering 已提交
3705
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3706
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
3707
        return false;
3708

K
Karel Zak 已提交
3709 3710
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
3711
    return true;
K
Karel Zak 已提交
3712 3713 3714
}

/*
K
Karel Zak 已提交
3715
 * "domid" command
K
Karel Zak 已提交
3716
 */
3717
static const vshCmdInfo info_domid[] = {
3718
    {"help", N_("convert a domain name or UUID to domain id")},
3719
    {"desc", ""},
3720
    {NULL, NULL}
K
Karel Zak 已提交
3721 3722
};

3723
static const vshCmdOptDef opts_domid[] = {
3724
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
3725
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3726 3727
};

E
Eric Blake 已提交
3728
static bool
3729
cmdDomid(vshControl *ctl, const vshCmd *cmd)
3730
{
3731
    virDomainPtr dom;
3732
    unsigned int id;
K
Karel Zak 已提交
3733

3734
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3735
        return false;
J
Jim Meyering 已提交
3736
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3737
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
3738
        return false;
3739

3740 3741
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3742
        vshPrint(ctl, "%s\n", "-");
3743
    else
3744
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
3745
    virDomainFree(dom);
E
Eric Blake 已提交
3746
    return true;
K
Karel Zak 已提交
3747
}
3748

K
Karel Zak 已提交
3749 3750 3751
/*
 * "domuuid" command
 */
3752
static const vshCmdInfo info_domuuid[] = {
3753
    {"help", N_("convert a domain name or id to domain UUID")},
3754
    {"desc", ""},
K
Karel Zak 已提交
3755 3756 3757
    {NULL, NULL}
};

3758
static const vshCmdOptDef opts_domuuid[] = {
3759
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
3760 3761 3762
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3763
static bool
3764
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
3765 3766
{
    virDomainPtr dom;
3767
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
3768

3769
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3770
        return false;
J
Jim Meyering 已提交
3771
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3772
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
3773
        return false;
3774

K
Karel Zak 已提交
3775 3776 3777
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
3778
        vshError(ctl, "%s", _("failed to get domain UUID"));
3779

3780
    virDomainFree(dom);
E
Eric Blake 已提交
3781
    return true;
K
Karel Zak 已提交
3782 3783
}

3784 3785 3786
/*
 * "migrate" command
 */
3787
static const vshCmdInfo info_migrate[] = {
3788 3789
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
3790 3791 3792
    {NULL, NULL}
};

3793
static const vshCmdOptDef opts_migrate[] = {
3794 3795 3796 3797 3798 3799 3800
    {"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")},
3801 3802
    {"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 已提交
3803
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
3804
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3805
    {"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)")},
3806 3807
    {"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 已提交
3808
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
3809 3810 3811
    {NULL, 0, 0, NULL}
};

3812 3813 3814 3815 3816 3817 3818 3819
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
3820
{
3821
    char ret = '1';
3822
    virDomainPtr dom = NULL;
3823 3824 3825 3826
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
    int flags = 0;
3827 3828 3829
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
3830 3831
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;
3832 3833 3834 3835 3836

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
    if (pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask) < 0)
        goto out_sig;
3837
#endif
3838

3839
    if (!vshConnectionUsability (ctl, ctl->conn))
3840
        goto out;
3841

J
Jim Meyering 已提交
3842
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
3843
        goto out;
3844

3845 3846
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
3847 3848
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
3849
        goto out;
3850
    }
3851 3852 3853

    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
3854 3855
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
3856 3857 3858
    if (vshCommandOptBool (cmd, "tunnelled"))
        flags |= VIR_MIGRATE_TUNNELLED;

C
Chris Lalancette 已提交
3859 3860 3861 3862 3863
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

3864 3865 3866
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

3867 3868 3869 3870 3871 3872
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

3873 3874 3875 3876
    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. */
3877

3878
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
3879
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
3880
            goto out;
3881
        }
3882

3883
        if (virDomainMigrateToURI (dom, desturi, flags, dname, 0) == 0)
3884
            ret = '0';
3885 3886 3887 3888 3889 3890
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
3891
        if (!dconn) goto out;
3892 3893 3894 3895

        ddom = virDomainMigrate (dom, dconn, flags, dname, migrateuri, 0);
        if (ddom) {
            virDomainFree(ddom);
3896
            ret = '0';
3897 3898 3899
        }
        virConnectClose (dconn);
    }
3900

3901
out:
3902
#if HAVE_PTHREAD_SIGMASK
3903 3904
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
3905
#endif
3906
    if (dom) virDomainFree (dom);
3907 3908 3909
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933
static void
print_job_progress(unsigned long long remaining, unsigned long long total)
{
    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;
        }
    }

    fprintf(stderr, "\rMigration: [%3d %%]", progress);
}

E
Eric Blake 已提交
3934
static bool
3935 3936 3937 3938 3939
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
3940
    bool functionReturn = false;
3941 3942 3943 3944 3945
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
3946 3947
    virDomainJobInfo jobinfo;
    bool verbose = false;
3948
    int timeout = 0;
W
Wen Congyang 已提交
3949 3950
    struct timeval start, curr;
    bool live_flag = false;
3951
    vshCtrlData data;
3952 3953 3954 3955 3956 3957
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
#endif
3958 3959

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

W
Wen Congyang 已提交
3962 3963 3964
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
3965
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
3966
        live_flag = true;
3967
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984
        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;
        }
    }

3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007
    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 已提交
4008
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
4009
    while (1) {
4010
repoll:
W
Wen Congyang 已提交
4011 4012 4013 4014
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
4015
                    functionReturn = true;
W
Wen Congyang 已提交
4016 4017 4018 4019 4020
                    if (verbose) {
                        /* print [100 %] */
                        print_job_progress(0, 1);
                    }
                } else
W
Wen Congyang 已提交
4021
                    functionReturn = false;
4022
            } else
W
Wen Congyang 已提交
4023
                functionReturn = false;
W
Wen Congyang 已提交
4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
4035
            functionReturn = false;
W
Wen Congyang 已提交
4036 4037 4038
            break;
        }

W
Wen Congyang 已提交
4039 4040 4041 4042 4043 4044 4045 4046 4047
        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 已提交
4048
        if (verbose) {
4049
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
4050
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
4051
#endif
W
Wen Congyang 已提交
4052
            ret = virDomainGetJobInfo(dom, &jobinfo);
4053
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
4054
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
4055
#endif
W
Wen Congyang 已提交
4056 4057
            if (ret == 0)
                print_job_progress(jobinfo.dataRemaining, jobinfo.dataTotal);
4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
4069
    return functionReturn;
4070 4071
}

4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082
/*
 * "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")},
4083
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
4084 4085 4086
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4087
static bool
4088 4089 4090
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
4091
    long long downtime = 0;
E
Eric Blake 已提交
4092
    bool ret = false;
4093

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

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

4100 4101
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
4102 4103 4104 4105 4106 4107 4108
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
4109
    ret = true;
4110 4111 4112 4113 4114 4115

done:
    virDomainFree(dom);
    return ret;
}

4116 4117 4118
/*
 * "net-autostart" command
 */
4119
static const vshCmdInfo info_network_autostart[] = {
4120
    {"help", N_("autostart a network")},
4121
    {"desc",
4122
     N_("Configure a network to be automatically started at boot.")},
4123 4124 4125
    {NULL, NULL}
};

4126
static const vshCmdOptDef opts_network_autostart[] = {
4127 4128
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4129 4130 4131
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4132
static bool
4133
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
4134 4135
{
    virNetworkPtr network;
4136
    const char *name;
4137 4138
    int autostart;

4139
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4140
        return false;
4141

J
Jim Meyering 已提交
4142
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4143
        return false;
4144 4145 4146 4147

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
4148
        if (autostart)
4149
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
4150
        else
4151
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
4152
        virNetworkFree(network);
E
Eric Blake 已提交
4153
        return false;
4154 4155
    }

4156
    if (autostart)
4157
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
4158
    else
4159
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
4160

L
Laine Stump 已提交
4161
    virNetworkFree(network);
E
Eric Blake 已提交
4162
    return true;
4163
}
K
Karel Zak 已提交
4164

4165 4166 4167
/*
 * "net-create" command
 */
4168
static const vshCmdInfo info_network_create[] = {
4169 4170
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
4171 4172 4173
    {NULL, NULL}
};

4174
static const vshCmdOptDef opts_network_create[] = {
4175
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4176 4177 4178
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4179
static bool
4180
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
4181 4182
{
    virNetworkPtr network;
4183
    const char *from = NULL;
E
Eric Blake 已提交
4184
    bool ret = true;
4185
    char *buffer;
4186

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

4190
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4191
        return false;
4192

4193
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4194
        return false;
4195 4196

    network = virNetworkCreateXML(ctl->conn, buffer);
4197
    VIR_FREE(buffer);
4198

4199 4200 4201
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4202
        virNetworkFree(network);
4203
    } else {
4204
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
4205
        ret = false;
4206 4207 4208 4209 4210 4211 4212 4213
    }
    return ret;
}


/*
 * "net-define" command
 */
4214
static const vshCmdInfo info_network_define[] = {
4215 4216
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
4217 4218 4219
    {NULL, NULL}
};

4220
static const vshCmdOptDef opts_network_define[] = {
4221
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4222 4223 4224
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4225
static bool
4226
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
4227 4228
{
    virNetworkPtr network;
4229
    const char *from = NULL;
E
Eric Blake 已提交
4230
    bool ret = true;
4231
    char *buffer;
4232

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

4236
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4237
        return false;
4238

4239
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4240
        return false;
4241 4242

    network = virNetworkDefineXML(ctl->conn, buffer);
4243
    VIR_FREE(buffer);
4244

4245 4246 4247
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4248
        virNetworkFree(network);
4249
    } else {
4250
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
4251
        ret = false;
4252 4253 4254 4255 4256 4257 4258 4259
    }
    return ret;
}


/*
 * "net-destroy" command
 */
4260
static const vshCmdInfo info_network_destroy[] = {
4261 4262
    {"help", N_("destroy a network")},
    {"desc", N_("Destroy a given network.")},
4263 4264 4265
    {NULL, NULL}
};

4266
static const vshCmdOptDef opts_network_destroy[] = {
4267
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4268 4269 4270
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4271
static bool
4272
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
4273 4274
{
    virNetworkPtr network;
E
Eric Blake 已提交
4275
    bool ret = true;
4276
    const char *name;
4277

4278
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4279
        return false;
4280

J
Jim Meyering 已提交
4281
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4282
        return false;
4283 4284 4285 4286

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

4291
    virNetworkFree(network);
4292 4293 4294 4295 4296 4297 4298
    return ret;
}


/*
 * "net-dumpxml" command
 */
4299
static const vshCmdInfo info_network_dumpxml[] = {
4300 4301
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
4302 4303 4304
    {NULL, NULL}
};

4305
static const vshCmdOptDef opts_network_dumpxml[] = {
4306
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4307 4308 4309
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4310
static bool
4311
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
4312 4313
{
    virNetworkPtr network;
E
Eric Blake 已提交
4314
    bool ret = true;
4315 4316
    char *dump;

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

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

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
4325
        vshPrint(ctl, "%s", dump);
4326
        VIR_FREE(dump);
4327
    } else {
E
Eric Blake 已提交
4328
        ret = false;
4329 4330 4331 4332 4333 4334
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348
/*
 * "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 已提交
4349
static bool
O
Osier Yang 已提交
4350 4351 4352 4353 4354 4355 4356 4357 4358 4359
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 已提交
4360
        return false;
O
Osier Yang 已提交
4361 4362 4363

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4364
        return false;
O
Osier Yang 已提交
4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390

    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 已提交
4391
    return true;
O
Osier Yang 已提交
4392
}
4393

4394 4395 4396 4397
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
4398 4399
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
4400 4401 4402 4403
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
4404
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4405 4406 4407
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4408
static bool
4409 4410
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4411
    bool ret = false;
4412 4413 4414 4415 4416
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
4417
    int flags = VIR_INTERFACE_XML_INACTIVE;
4418

4419
    if (!vshConnectionUsability(ctl, ctl->conn))
4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445
        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 已提交
4446
        ret = true;
4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458
        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)) {
4459 4460
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472
        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 已提交
4473
    ret = true;
4474 4475 4476 4477 4478

cleanup:
    if (iface)
        virInterfaceFree (iface);

4479 4480 4481
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
4482 4483 4484

    if (tmp) {
        unlink (tmp);
4485
        VIR_FREE(tmp);
4486 4487 4488 4489 4490
    }

    return ret;
}

4491 4492 4493
/*
 * "net-list" command
 */
4494
static const vshCmdInfo info_network_list[] = {
4495 4496
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
4497 4498 4499
    {NULL, NULL}
};

4500
static const vshCmdOptDef opts_network_list[] = {
4501 4502
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
4503 4504 4505
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4506
static bool
4507
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4508 4509 4510 4511 4512
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
4513
    char **activeNames = NULL, **inactiveNames = NULL;
4514 4515
    inactive |= all;

4516
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4517
        return false;
4518 4519

    if (active) {
4520 4521
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
4522
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
4523
            return false;
4524
        }
4525
        if (maxactive) {
4526
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
4527

4528
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
4529
                                                    maxactive)) < 0) {
4530
                vshError(ctl, "%s", _("Failed to list active networks"));
4531
                VIR_FREE(activeNames);
E
Eric Blake 已提交
4532
                return false;
4533
            }
4534

4535
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
4536
        }
4537 4538
    }
    if (inactive) {
4539 4540
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
4541
            vshError(ctl, "%s", _("Failed to list inactive networks"));
4542
            VIR_FREE(activeNames);
E
Eric Blake 已提交
4543
            return false;
4544
        }
4545 4546 4547
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4548 4549 4550
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
4551
                vshError(ctl, "%s", _("Failed to list inactive networks"));
4552 4553
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4554
                return false;
4555
            }
4556

4557 4558
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
4559
    }
4560 4561
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
4562
    vshPrintExtra(ctl, "-----------------------------------------\n");
4563 4564

    for (i = 0; i < maxactive; i++) {
4565 4566
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
4567 4568
        const char *autostartStr;
        int autostart = 0;
4569 4570 4571

        /* this kind of work with networks is not atomic operation */
        if (!network) {
4572
            VIR_FREE(activeNames[i]);
4573
            continue;
4574
        }
4575

4576 4577 4578
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
4579
            autostartStr = autostart ? _("yes") : _("no");
4580 4581 4582 4583 4584

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
4585
        virNetworkFree(network);
4586
        VIR_FREE(activeNames[i]);
4587 4588 4589
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
4590 4591
        const char *autostartStr;
        int autostart = 0;
4592 4593 4594

        /* this kind of work with networks is not atomic operation */
        if (!network) {
4595
            VIR_FREE(inactiveNames[i]);
4596
            continue;
4597
        }
4598

4599 4600 4601
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
4602
            autostartStr = autostart ? _("yes") : _("no");
4603

4604
        vshPrint(ctl, "%-20s %-10s %-10s\n",
4605 4606 4607
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
4608 4609

        virNetworkFree(network);
4610
        VIR_FREE(inactiveNames[i]);
4611
    }
4612 4613
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4614
    return true;
4615 4616 4617 4618 4619 4620
}


/*
 * "net-name" command
 */
4621
static const vshCmdInfo info_network_name[] = {
4622
    {"help", N_("convert a network UUID to network name")},
4623
    {"desc", ""},
4624 4625 4626
    {NULL, NULL}
};

4627
static const vshCmdOptDef opts_network_name[] = {
4628
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
4629 4630 4631
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4632
static bool
4633
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
4634 4635 4636
{
    virNetworkPtr network;

4637
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4638
        return false;
J
Jim Meyering 已提交
4639
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4640
                                           VSH_BYUUID)))
E
Eric Blake 已提交
4641
        return false;
4642 4643 4644

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
4645
    return true;
4646 4647 4648 4649 4650 4651
}


/*
 * "net-start" command
 */
4652
static const vshCmdInfo info_network_start[] = {
4653 4654
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
4655 4656 4657
    {NULL, NULL}
};

4658
static const vshCmdOptDef opts_network_start[] = {
4659
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
4660 4661 4662
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4663
static bool
4664
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
4665 4666
{
    virNetworkPtr network;
E
Eric Blake 已提交
4667
    bool ret = true;
4668

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

J
Jim Meyering 已提交
4672
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
4673
         return false;
4674 4675 4676

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
4677
                 virNetworkGetName(network));
4678
    } else {
4679
        vshError(ctl, _("Failed to start network %s"),
4680
                 virNetworkGetName(network));
E
Eric Blake 已提交
4681
        ret = false;
4682
    }
L
Laine Stump 已提交
4683
    virNetworkFree(network);
4684 4685 4686 4687 4688 4689 4690
    return ret;
}


/*
 * "net-undefine" command
 */
4691
static const vshCmdInfo info_network_undefine[] = {
4692 4693
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
4694 4695 4696
    {NULL, NULL}
};

4697
static const vshCmdOptDef opts_network_undefine[] = {
4698
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4699 4700 4701
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4702
static bool
4703
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
4704 4705
{
    virNetworkPtr network;
E
Eric Blake 已提交
4706
    bool ret = true;
4707
    const char *name;
4708

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

J
Jim Meyering 已提交
4712
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4713
        return false;
4714 4715 4716 4717

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

L
Laine Stump 已提交
4722
    virNetworkFree(network);
4723 4724 4725 4726 4727 4728 4729
    return ret;
}


/*
 * "net-uuid" command
 */
4730
static const vshCmdInfo info_network_uuid[] = {
4731
    {"help", N_("convert a network name to network UUID")},
4732
    {"desc", ""},
4733 4734 4735
    {NULL, NULL}
};

4736
static const vshCmdOptDef opts_network_uuid[] = {
4737
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
4738 4739 4740
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4741
static bool
4742
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
4743 4744 4745 4746
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

4747
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4748
        return false;
4749

J
Jim Meyering 已提交
4750
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4751
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4752
        return false;
4753 4754 4755 4756

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

L
Laine Stump 已提交
4759
    virNetworkFree(network);
E
Eric Blake 已提交
4760
    return true;
4761 4762 4763
}


4764 4765 4766 4767 4768
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
4769 4770
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
4771 4772 4773 4774
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
4775 4776
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
4777 4778
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
4779
static bool
4780 4781 4782 4783 4784 4785 4786 4787 4788
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;

4789
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4790
        return false;
4791 4792 4793 4794

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
4795
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
4796
            return false;
4797 4798 4799 4800 4801 4802
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
4803
                vshError(ctl, "%s", _("Failed to list active interfaces"));
4804
                VIR_FREE(activeNames);
E
Eric Blake 已提交
4805
                return false;
4806 4807 4808 4809 4810 4811 4812 4813
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
4814
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4815
            VIR_FREE(activeNames);
E
Eric Blake 已提交
4816
            return false;
4817 4818 4819 4820
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4821 4822 4823
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
4824
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4825 4826
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4827
                return false;
4828 4829 4830 4831 4832
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
4833 4834
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
4835 4836 4837
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
4838 4839
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
4840 4841 4842

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4843
            VIR_FREE(activeNames[i]);
4844 4845 4846 4847 4848 4849 4850 4851
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4852
        VIR_FREE(activeNames[i]);
4853 4854
    }
    for (i = 0; i < maxinactive; i++) {
4855 4856
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
4857 4858 4859

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4860
            VIR_FREE(inactiveNames[i]);
4861 4862 4863 4864 4865 4866 4867 4868
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4869
        VIR_FREE(inactiveNames[i]);
4870
    }
4871 4872
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4873
    return true;
4874 4875 4876 4877 4878 4879 4880

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
4881
    {"help", N_("convert an interface MAC address to interface name")},
4882 4883 4884 4885 4886
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
4887
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
4888 4889 4890
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4891
static bool
4892 4893 4894 4895
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

4896
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4897
        return false;
4898 4899
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
4900
        return false;
4901 4902 4903

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
4904
    return true;
4905 4906 4907 4908 4909 4910
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
4911
    {"help", N_("convert an interface name to interface MAC address")},
4912 4913 4914 4915 4916
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
4917
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
4918 4919 4920
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4921
static bool
4922 4923 4924 4925
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

4926
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4927
        return false;
4928 4929
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4930
        return false;
4931 4932 4933

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
4934
    return true;
4935 4936 4937 4938 4939 4940
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
4941 4942
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
4943 4944 4945 4946
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
4947 4948
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
4949 4950 4951
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4952
static bool
4953 4954 4955
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
4956
    bool ret = true;
4957
    char *dump;
4958 4959 4960 4961 4962
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
4963

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

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

4970
    dump = virInterfaceGetXMLDesc(iface, flags);
4971
    if (dump != NULL) {
4972
        vshPrint(ctl, "%s", dump);
4973
        VIR_FREE(dump);
4974
    } else {
E
Eric Blake 已提交
4975
        ret = false;
4976 4977 4978 4979 4980 4981 4982 4983 4984 4985
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
4986 4987
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
4988 4989 4990 4991
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
4992
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
4993 4994 4995
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4996
static bool
4997 4998
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
4999
    virInterfacePtr iface;
5000
    const char *from = NULL;
E
Eric Blake 已提交
5001
    bool ret = true;
5002 5003
    char *buffer;

5004
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5005
        return false;
5006

5007
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5008
        return false;
5009 5010

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

5013
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
5014
    VIR_FREE(buffer);
5015

5016
    if (iface != NULL) {
5017
        vshPrint(ctl, _("Interface %s defined from %s\n"),
5018
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
5019
        virInterfaceFree (iface);
5020
    } else {
5021
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
5022
        ret = false;
5023 5024 5025 5026 5027 5028 5029 5030
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
5031 5032
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
5033 5034 5035 5036
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
5037
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5038 5039 5040
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5041
static bool
5042 5043 5044
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5045
    bool ret = true;
5046
    const char *name;
5047

5048
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5049
        return false;
5050 5051

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5052
        return false;
5053 5054 5055 5056

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
5057
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
5058
        ret = false;
5059 5060 5061 5062 5063 5064 5065 5066 5067 5068
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
5069 5070
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
5071 5072 5073 5074
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
5075
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5076 5077 5078
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5079
static bool
5080 5081 5082
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5083
    bool ret = true;
5084
    const char *name;
5085

5086
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5087
        return false;
5088 5089

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5090
        return false;
5091 5092 5093 5094

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
5095
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
5096
        ret = false;
5097 5098 5099 5100 5101 5102 5103 5104 5105 5106
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
5107 5108
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
    {"desc", N_("destroy a physical host interface.")},
5109 5110 5111 5112
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
5113
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5114 5115 5116
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5117
static bool
5118 5119 5120
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5121
    bool ret = true;
5122
    const char *name;
5123

5124
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5125
        return false;
5126 5127

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5128
        return false;
5129 5130 5131 5132

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
5133
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
5134
        ret = false;
5135 5136 5137 5138 5139 5140
    }

    virInterfaceFree(iface);
    return ret;
}

5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225
/*
 * "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;
}
5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240

/*
 * "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 已提交
5241
static bool
5242 5243 5244
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
5245
    const char *from = NULL;
E
Eric Blake 已提交
5246
    bool ret = true;
5247 5248
    char *buffer;

5249
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5250
        return false;
5251

5252
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5253
        return false;
5254 5255

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5256
        return false;
5257 5258 5259 5260 5261 5262 5263 5264 5265 5266

    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 已提交
5267
        ret = false;
5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286
    }
    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 已提交
5287
static bool
5288 5289 5290
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5291
    bool ret = true;
5292
    const char *name;
5293

5294
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5295
        return false;
5296 5297

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
5298
        return false;
5299 5300 5301 5302 5303

    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 已提交
5304
        ret = false;
5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325
    }

    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 已提交
5326
static bool
5327 5328 5329
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5330
    bool ret = true;
5331 5332
    char *dump;

5333
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5334
        return false;
5335 5336

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
5337
        return false;
5338 5339 5340

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
5341
        vshPrint(ctl, "%s", dump);
5342 5343
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
5344
        ret = false;
5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363
    }

    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 已提交
5364
static bool
5365 5366 5367 5368 5369 5370
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

5371
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5372
        return false;
5373 5374 5375 5376

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
5377
        return false;
5378 5379 5380 5381 5382 5383 5384 5385
    }

    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 已提交
5386
        return false;
5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413
    }

    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 已提交
5414
    return true;
5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431
}


/*
 * "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 已提交
5432
static bool
5433 5434
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5435
    bool ret = false;
5436 5437 5438 5439 5440 5441
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

5442
    if (!vshConnectionUsability(ctl, ctl->conn))
5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468
        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 已提交
5469
        ret = true;
5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495
        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 已提交
5496
    ret = true;
5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514

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


5515
/**************************************************************************/
5516
/*
5517
 * "pool-autostart" command
5518
 */
5519
static const vshCmdInfo info_pool_autostart[] = {
5520
    {"help", N_("autostart a pool")},
5521
    {"desc",
5522
     N_("Configure a pool to be automatically started at boot.")},
5523
    {NULL, NULL}
5524 5525
};

5526
static const vshCmdOptDef opts_pool_autostart[] = {
5527 5528
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5529 5530
    {NULL, 0, 0, NULL}
};
5531

E
Eric Blake 已提交
5532
static bool
5533
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
5534
{
5535
    virStoragePoolPtr pool;
5536
    const char *name;
5537
    int autostart;
5538

5539
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5540
        return false;
5541

5542
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5543
        return false;
5544

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

5547 5548
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
5549
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
5550
        else
5551
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
5552
        virStoragePoolFree(pool);
E
Eric Blake 已提交
5553
        return false;
5554 5555
    }

5556
    if (autostart)
5557
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
5558
    else
5559
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
5560

L
Laine Stump 已提交
5561
    virStoragePoolFree(pool);
E
Eric Blake 已提交
5562
    return true;
5563 5564
}

5565
/*
5566
 * "pool-create" command
5567
 */
5568
static const vshCmdInfo info_pool_create[] = {
5569 5570
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
5571 5572 5573
    {NULL, NULL}
};

5574
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
5575
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
5576
     N_("file containing an XML pool description")},
5577 5578 5579
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5580
static bool
5581
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
5582
{
5583
    virStoragePoolPtr pool;
5584
    const char *from = NULL;
E
Eric Blake 已提交
5585
    bool ret = true;
5586
    char *buffer;
5587

5588
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5589
        return false;
5590

5591
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5592
        return false;
5593

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

5597
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
5598
    VIR_FREE(buffer);
5599 5600 5601 5602

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5603
        virStoragePoolFree(pool);
5604
    } else {
5605
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
5606
        ret = false;
5607 5608
    }
    return ret;
5609 5610
}

5611

5612 5613 5614 5615
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
5616
    {"help", N_("create a device defined "
5617
                          "by an XML file on the node")},
5618
    {"desc", N_("Create a device on the node.  Note that this "
5619 5620 5621 5622 5623 5624 5625
                          "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,
5626
     N_("file containing an XML description of the device")},
5627 5628 5629
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5630
static bool
5631 5632 5633
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
5634
    const char *from = NULL;
E
Eric Blake 已提交
5635
    bool ret = true;
5636 5637
    char *buffer;

5638
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5639
        return false;
5640

5641
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5642
        return false;
5643

5644
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5645
        return false;
5646 5647

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
5648
    VIR_FREE(buffer);
5649 5650 5651 5652

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
5653
        virNodeDeviceFree(dev);
5654
    } else {
5655
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
5656
        ret = false;
5657 5658 5659 5660 5661 5662 5663 5664 5665 5666
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
5667 5668
    {"help", N_("destroy a device on the node")},
    {"desc", N_("Destroy a device on the node.  Note that this "
5669 5670 5671 5672 5673 5674
                          "command destroys devices on the physical host ")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
5675
     N_("name of the device to be destroyed")},
5676 5677 5678
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5679
static bool
5680 5681 5682
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
5683
    bool ret = true;
5684
    const char *name = NULL;
5685

5686
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
5687
        return false;
5688 5689
    }

5690
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
5691
        return false;
5692 5693 5694 5695 5696 5697

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
5698
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
5699
        ret = false;
5700 5701 5702 5703 5704 5705 5706
    }

    virNodeDeviceFree(dev);
    return ret;
}


5707
/*
5708
 * XML Building helper for pool-define-as and pool-create-as
5709
 */
5710
static const vshCmdOptDef opts_pool_X_as[] = {
5711 5712 5713 5714 5715 5716 5717 5718
    {"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")},
5719
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
5720 5721 5722
    {NULL, 0, 0, NULL}
};

5723
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
5724

5725 5726
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
5727
    virBuffer buf = VIR_BUFFER_INITIALIZER;
5728

5729
    if (vshCommandOptString(cmd, "name", &name) <= 0)
5730
        goto cleanup;
5731
    if (vshCommandOptString(cmd, "type", &type) <= 0)
5732 5733
        goto cleanup;

5734 5735 5736 5737 5738
    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 ||
5739 5740
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
5741
        goto cleanup;
5742
    }
5743

5744 5745
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
5746
    if (srcHost || srcPath || srcDev) {
5747
        virBufferAddLit(&buf, "  <source>\n");
5748

5749
        if (srcHost)
5750
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
5751
        if (srcPath)
5752
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
5753
        if (srcDev)
5754
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
5755
        if (srcFormat)
5756
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
5757
        if (srcName)
5758
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
5759 5760

        virBufferAddLit(&buf, "  </source>\n");
5761 5762
    }
    if (target) {
5763
        virBufferAddLit(&buf, "  <target>\n");
5764
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
5765
        virBufferAddLit(&buf, "  </target>\n");
5766
    }
5767 5768 5769 5770
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
5771
        return false;
5772
    }
5773 5774 5775

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
5776
    return true;
5777 5778

cleanup:
5779
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
5780
    return false;
5781 5782 5783 5784 5785 5786
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
5787 5788
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
5789 5790 5791
    {NULL, NULL}
};

E
Eric Blake 已提交
5792
static bool
5793 5794 5795
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
5796 5797
    const char *name;
    char *xml;
5798
    int printXML = vshCommandOptBool(cmd, "print-xml");
5799

5800
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5801
        return false;
5802 5803

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

5806
    if (printXML) {
5807
        vshPrint(ctl, "%s", xml);
5808
        VIR_FREE(xml);
5809
    } else {
5810
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
5811
        VIR_FREE(xml);
5812

5813 5814 5815 5816
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
5817
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
5818
            return false;
5819 5820
        }
    }
E
Eric Blake 已提交
5821
    return true;
5822 5823
}

5824

5825
/*
5826
 * "pool-define" command
5827
 */
5828
static const vshCmdInfo info_pool_define[] = {
5829 5830
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
5831 5832 5833
    {NULL, NULL}
};

5834
static const vshCmdOptDef opts_pool_define[] = {
5835
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
5836 5837 5838
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5839
static bool
5840
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
5841
{
5842
    virStoragePoolPtr pool;
5843
    const char *from = NULL;
E
Eric Blake 已提交
5844
    bool ret = true;
5845
    char *buffer;
5846

5847
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5848
        return false;
5849

5850
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5851
        return false;
5852

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

5856
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
5857
    VIR_FREE(buffer);
5858 5859 5860 5861

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5862
        virStoragePoolFree(pool);
5863
    } else {
5864
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
5865
        ret = false;
5866 5867
    }
    return ret;
5868 5869
}

5870

5871 5872 5873
/*
 * "pool-define-as" command
 */
5874
static const vshCmdInfo info_pool_define_as[] = {
5875 5876
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
5877 5878 5879
    {NULL, NULL}
};

E
Eric Blake 已提交
5880
static bool
5881
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
5882 5883
{
    virStoragePoolPtr pool;
5884 5885
    const char *name;
    char *xml;
5886
    int printXML = vshCommandOptBool(cmd, "print-xml");
5887

5888
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5889
        return false;
5890

5891
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
5892
        return false;
5893

5894
    if (printXML) {
5895
        vshPrint(ctl, "%s", xml);
5896
        VIR_FREE(xml);
5897
    } else {
5898
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
5899
        VIR_FREE(xml);
5900

5901 5902 5903 5904
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
5905
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
5906
            return false;
5907 5908
        }
    }
E
Eric Blake 已提交
5909
    return true;
5910 5911 5912
}


5913
/*
5914
 * "pool-build" command
5915
 */
5916
static const vshCmdInfo info_pool_build[] = {
5917 5918
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
5919 5920 5921
    {NULL, NULL}
};

5922
static const vshCmdOptDef opts_pool_build[] = {
5923
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5924 5925 5926
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5927
static bool
5928
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
5929
{
5930
    virStoragePoolPtr pool;
E
Eric Blake 已提交
5931
    bool ret = true;
5932
    const char *name;
5933

5934
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5935
        return false;
5936

5937
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5938
        return false;
5939

5940
    if (virStoragePoolBuild(pool, 0) == 0) {
5941
        vshPrint(ctl, _("Pool %s built\n"), name);
5942
    } else {
5943
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
5944
        ret = false;
5945 5946
    }

5947 5948
    virStoragePoolFree(pool);

5949 5950 5951
    return ret;
}

5952

5953
/*
5954
 * "pool-destroy" command
5955
 */
5956
static const vshCmdInfo info_pool_destroy[] = {
5957 5958
    {"help", N_("destroy a pool")},
    {"desc", N_("Destroy a given pool.")},
5959 5960 5961
    {NULL, NULL}
};

5962
static const vshCmdOptDef opts_pool_destroy[] = {
5963
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5964 5965 5966
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5967
static bool
5968
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
5969
{
5970
    virStoragePoolPtr pool;
E
Eric Blake 已提交
5971
    bool ret = true;
5972
    const char *name;
5973

5974
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5975
        return false;
5976

5977
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5978
        return false;
5979

5980 5981 5982
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
5983
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
5984
        ret = false;
5985 5986
    }

5987
    virStoragePoolFree(pool);
5988 5989 5990
    return ret;
}

5991

5992
/*
5993 5994
 * "pool-delete" command
 */
5995
static const vshCmdInfo info_pool_delete[] = {
5996 5997
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
5998 5999 6000
    {NULL, NULL}
};

6001
static const vshCmdOptDef opts_pool_delete[] = {
6002
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6003 6004 6005
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6006
static bool
6007
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
6008 6009
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6010
    bool ret = true;
6011
    const char *name;
6012

6013
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6014
        return false;
6015 6016

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6017
        return false;
6018 6019

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
6020
        vshPrint(ctl, _("Pool %s deleted\n"), name);
6021
    } else {
6022
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
6023
        ret = false;
6024 6025
    }

L
Laine Stump 已提交
6026
    virStoragePoolFree(pool);
6027 6028 6029 6030 6031 6032 6033
    return ret;
}


/*
 * "pool-refresh" command
 */
6034
static const vshCmdInfo info_pool_refresh[] = {
6035 6036
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
6037 6038 6039
    {NULL, NULL}
};

6040
static const vshCmdOptDef opts_pool_refresh[] = {
6041
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6042 6043 6044
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6045
static bool
6046
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
6047 6048
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6049
    bool ret = true;
6050
    const char *name;
6051

6052
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6053
        return false;
6054 6055

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6056
        return false;
6057 6058 6059 6060

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
6061
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
6062
        ret = false;
6063 6064 6065 6066 6067 6068 6069 6070 6071 6072
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
6073
static const vshCmdInfo info_pool_dumpxml[] = {
6074 6075
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
6076 6077 6078
    {NULL, NULL}
};

6079
static const vshCmdOptDef opts_pool_dumpxml[] = {
6080
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6081 6082 6083
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6084
static bool
6085
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
6086 6087
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6088
    bool ret = true;
6089 6090
    char *dump;

6091
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6092
        return false;
6093 6094

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6095
        return false;
6096 6097 6098

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
6099
        vshPrint(ctl, "%s", dump);
6100
        VIR_FREE(dump);
6101
    } else {
E
Eric Blake 已提交
6102
        ret = false;
6103 6104 6105 6106 6107 6108 6109 6110 6111 6112
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
6113
static const vshCmdInfo info_pool_list[] = {
6114 6115
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
6116 6117 6118
    {NULL, NULL}
};

6119
static const vshCmdOptDef opts_pool_list[] = {
6120 6121
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
6122
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
6123 6124 6125
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6126
static bool
6127
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6128
{
6129 6130
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
6131 6132
    int i, ret;
    bool functionReturn;
6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148
    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 */
6149
    int all = vshCommandOptBool(cmd, "all");
6150 6151
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
6152 6153 6154
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

6155
    /* Check the connection to libvirtd daemon is still working */
6156
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6157
        return false;
6158

6159
    /* Retrieve the number of active storage pools */
6160
    if (active) {
6161 6162
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
6163
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
6164
            return false;
6165 6166
        }
    }
6167 6168

    /* Retrieve the number of inactive storage pools */
6169
    if (inactive) {
6170 6171
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
6172
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
6173
            return false;
6174
        }
6175
    }
6176

6177 6178
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
6179

6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191
    /* 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 已提交
6192
            return false;
6193 6194 6195
        }
    }

6196 6197 6198 6199 6200 6201 6202 6203
    /* 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 已提交
6204
            return false;
6205 6206
        }
    }
6207

6208 6209 6210 6211 6212 6213 6214 6215 6216 6217
    /* 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]);
6218
        if (!pool) {
6219
            VIR_FREE(poolNames[i]);
6220 6221 6222
            continue;
        }

6223
        /* Retrieve the autostart status of the pool */
6224
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
6225
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
6226
        else
6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244
            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;
        }
6245

6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357
        /* 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 */
6358 6359 6360
        virStoragePoolFree(pool);
    }

6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378
    /* 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);
6379 6380
        }

6381
        /* Cleanup and return */
E
Eric Blake 已提交
6382
        functionReturn = true;
6383 6384
        goto cleanup;
    }
6385

6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479
    /* 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 已提交
6480
    functionReturn = true;
6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494
    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 已提交
6495
    functionReturn = false;
6496

6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508
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]);
6509
    }
6510 6511 6512 6513 6514 6515 6516

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

    /* Return the desired value */
    return functionReturn;
6517 6518
}

6519 6520 6521 6522
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
6523 6524
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6525 6526 6527 6528 6529
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6530 6531 6532
     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")},
6533
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
6534 6535 6536
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6537
static bool
6538 6539
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6540
    const char *type = NULL, *host = NULL;
6541 6542
    char *srcSpec = NULL;
    char *srcList;
6543
    const char *initiator = NULL;
6544

6545 6546
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
6547 6548
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
6549
        return false;
6550
    }
6551

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

    if (host) {
6556
        const char *port = NULL;
6557
        virBuffer buf = VIR_BUFFER_INITIALIZER;
6558 6559 6560 6561

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6562
            return false;
6563
        }
6564
        virBufferAddLit(&buf, "<source>\n");
6565
        virBufferAsprintf(&buf, "  <host name='%s'", host);
6566
        if (port)
6567
            virBufferAsprintf(&buf, " port='%s'", port);
6568
        virBufferAddLit(&buf, "/>\n");
6569 6570
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
6571
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
6572 6573
            virBufferAddLit(&buf, "  </initiator>\n");
        }
6574 6575 6576
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
6577
            return false;
6578
        }
6579
        srcSpec = virBufferContentAndReset(&buf);
6580 6581 6582
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6583
    VIR_FREE(srcSpec);
6584
    if (srcList == NULL) {
6585
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
6586
        return false;
6587 6588
    }
    vshPrint(ctl, "%s", srcList);
6589
    VIR_FREE(srcList);
6590

E
Eric Blake 已提交
6591
    return true;
6592 6593 6594 6595 6596 6597 6598
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
6599 6600
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6601 6602 6603 6604 6605
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6606
     N_("type of storage pool sources to discover")},
6607
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
6608
     N_("optional file of source xml to query for pools")},
6609 6610 6611
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6612
static bool
6613 6614
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6615
    const char *type = NULL, *srcSpecFile = NULL;
6616
    char *srcSpec = NULL, *srcList;
6617

6618
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
6619
        return false;
6620

6621 6622
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
6623
        return false;
6624
    }
6625

6626
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6627
        return false;
6628 6629

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
6630
        return false;
6631 6632

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6633
    VIR_FREE(srcSpec);
6634
    if (srcList == NULL) {
6635
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
6636
        return false;
6637 6638
    }
    vshPrint(ctl, "%s", srcList);
6639
    VIR_FREE(srcList);
6640

E
Eric Blake 已提交
6641
    return true;
6642 6643 6644
}


6645 6646 6647
/*
 * "pool-info" command
 */
6648
static const vshCmdInfo info_pool_info[] = {
6649 6650
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
6651 6652 6653
    {NULL, NULL}
};

6654
static const vshCmdOptDef opts_pool_info[] = {
6655
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6656 6657 6658
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6659
static bool
6660
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
6661 6662 6663
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
6664 6665
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
6666
    bool ret = true;
6667 6668
    char uuid[VIR_UUID_STRING_BUFLEN];

6669
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6670
        return false;
6671 6672

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6673
        return false;
6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699

    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;
6700 6701 6702 6703
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
6704 6705
        }

6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721
        /* 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"));

6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733
        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 已提交
6734
        ret = false;
6735 6736 6737 6738 6739 6740 6741 6742 6743 6744
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
6745
static const vshCmdInfo info_pool_name[] = {
6746
    {"help", N_("convert a pool UUID to pool name")},
6747
    {"desc", ""},
6748 6749 6750
    {NULL, NULL}
};

6751
static const vshCmdOptDef opts_pool_name[] = {
6752
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
6753 6754 6755
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6756
static bool
6757
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
6758 6759 6760
{
    virStoragePoolPtr pool;

6761
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6762
        return false;
6763
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6764
                                           VSH_BYUUID)))
E
Eric Blake 已提交
6765
        return false;
6766 6767 6768

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6769
    return true;
6770 6771 6772 6773 6774 6775
}


/*
 * "pool-start" command
 */
6776
static const vshCmdInfo info_pool_start[] = {
6777 6778
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
6779 6780 6781
    {NULL, NULL}
};

6782
static const vshCmdOptDef opts_pool_start[] = {
6783
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
6784 6785 6786
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6787
static bool
6788
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
6789 6790
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6791
    bool ret = true;
6792

6793
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6794
        return false;
6795

6796
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
6797
         return false;
6798 6799 6800 6801 6802

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
6803
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
6804
        ret = false;
6805
    }
L
Laine Stump 已提交
6806 6807

    virStoragePoolFree(pool);
6808 6809 6810 6811
    return ret;
}


6812 6813 6814
/*
 * "vol-create-as" command
 */
6815
static const vshCmdInfo info_vol_create_as[] = {
6816 6817
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
6818 6819 6820
    {NULL, NULL}
};

6821
static const vshCmdOptDef opts_vol_create_as[] = {
6822 6823 6824 6825 6826
    {"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")},
6827 6828
    {"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")},
6829 6830 6831 6832 6833 6834 6835 6836 6837 6838
    {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 已提交
6839
        /* Deliberate fallthrough cases here :-) */
6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859
        switch (*end) {
        case 'T':
            *val *= 1024;
        case 'G':
            *val *= 1024;
        case 'M':
            *val *= 1024;
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
6860
static bool
6861
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
6862 6863 6864
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
6865
    char *xml;
6866 6867
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
6868
    unsigned long long capacity, allocation = 0;
6869
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6870

6871
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6872
        return false;
6873 6874 6875

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

6878
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6879 6880
        goto cleanup;

6881
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
6882 6883
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
6884
        vshError(ctl, _("Malformed size %s"), capacityStr);
6885

6886 6887
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
6888
        vshError(ctl, _("Malformed size %s"), allocationStr);
6889

6890 6891 6892 6893 6894 6895 6896
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

6897

6898
    virBufferAddLit(&buf, "<volume>\n");
6899 6900
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
6901
    if (allocationStr)
6902
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
6903 6904

    if (format) {
6905
        virBufferAddLit(&buf, "  <target>\n");
6906
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
6907
        virBufferAddLit(&buf, "  </target>\n");
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
    /* 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 已提交
6943
            return false;
6944 6945 6946 6947 6948
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
6949
            return false;
6950 6951 6952 6953
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
6954
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
6955
        if (snapshotStrFormat)
6956
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
6957 6958 6959 6960 6961 6962 6963 6964
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

6966 6967
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
6968
        return false;
6969 6970 6971
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
6972
    VIR_FREE(xml);
6973 6974 6975 6976 6977
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
6978
        return true;
6979
    } else {
6980
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
6981
        return false;
6982 6983 6984
    }

 cleanup:
6985
    virBufferFreeAndReset(&buf);
6986
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6987
    return false;
6988 6989 6990
}


6991 6992 6993
/*
 * "pool-undefine" command
 */
6994
static const vshCmdInfo info_pool_undefine[] = {
6995 6996
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
6997 6998 6999
    {NULL, NULL}
};

7000
static const vshCmdOptDef opts_pool_undefine[] = {
7001
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7002 7003 7004
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7005
static bool
7006
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
7007 7008
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7009
    bool ret = true;
7010
    const char *name;
7011

7012
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7013
        return false;
7014 7015

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7016
        return false;
7017 7018 7019 7020

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

L
Laine Stump 已提交
7025
    virStoragePoolFree(pool);
7026 7027 7028 7029 7030 7031 7032
    return ret;
}


/*
 * "pool-uuid" command
 */
7033
static const vshCmdInfo info_pool_uuid[] = {
7034
    {"help", N_("convert a pool name to pool UUID")},
7035
    {"desc", ""},
7036 7037 7038
    {NULL, NULL}
};

7039
static const vshCmdOptDef opts_pool_uuid[] = {
7040
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
7041 7042 7043
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7044
static bool
7045
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
7046 7047 7048 7049
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

7050
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7051
        return false;
7052 7053

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7054
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7055
        return false;
7056 7057 7058 7059

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

L
Laine Stump 已提交
7062
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7063
    return true;
7064 7065 7066 7067 7068 7069
}


/*
 * "vol-create" command
 */
7070
static const vshCmdInfo info_vol_create[] = {
7071 7072
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
7073 7074 7075
    {NULL, NULL}
};

7076
static const vshCmdOptDef opts_vol_create[] = {
7077 7078
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
7079 7080 7081
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7082
static bool
7083
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
7084 7085 7086
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7087
    const char *from = NULL;
E
Eric Blake 已提交
7088
    bool ret = true;
7089 7090
    char *buffer;

7091
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7092
        return false;
7093 7094

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

7098
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7099
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7100
        return false;
7101 7102 7103
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7104
        virshReportError(ctl);
7105
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7106
        return false;
7107 7108 7109
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
7110
    VIR_FREE(buffer);
7111 7112 7113 7114 7115 7116 7117
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
7118
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
7119
        ret = false;
7120 7121 7122 7123
    }
    return ret;
}

7124 7125 7126 7127
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
7128 7129
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
7130 7131 7132 7133
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
7134 7135 7136
    {"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 已提交
7137
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
7138 7139 7140
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7141
static bool
7142 7143 7144 7145
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
7146
    const char *from = NULL;
E
Eric Blake 已提交
7147
    bool ret = false;
7148 7149
    char *buffer = NULL;

7150
    if (!vshConnectionUsability(ctl, ctl->conn))
7151 7152 7153 7154 7155
        goto cleanup;

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

7156
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7157 7158 7159 7160 7161 7162 7163
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7164
        virshReportError(ctl);
7165 7166 7167 7168 7169 7170 7171 7172 7173
        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 {
7174
        vshError(ctl, _("Failed to create vol from %s"), from);
7175 7176 7177
        goto cleanup;
    }

E
Eric Blake 已提交
7178
    ret = true;
7179
cleanup:
7180
    VIR_FREE(buffer);
7181 7182 7183 7184
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
7185 7186
    if (newvol)
        virStorageVolFree(newvol);
7187 7188 7189 7190
    return ret;
}

static xmlChar *
7191
makeCloneXML(const char *origxml, const char *newname) {
7192

7193 7194 7195
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225
    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[] = {
7226 7227
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
7228 7229 7230 7231
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
7232 7233
    {"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 已提交
7234
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7235 7236 7237
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7238
static bool
7239 7240 7241 7242
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
7243
    const char *name = NULL;
7244
    char *origxml = NULL;
7245
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
7246
    bool ret = false;
7247

7248
    if (!vshConnectionUsability(ctl, ctl->conn))
7249 7250 7251 7252 7253 7254 7255
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
7256
        vshError(ctl, "%s", _("failed to get parent pool"));
7257 7258 7259
        goto cleanup;
    }

7260
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278
        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 {
7279
        vshError(ctl, _("Failed to clone vol from %s"),
7280 7281 7282 7283
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
7284
    ret = true;
7285 7286

cleanup:
7287
    VIR_FREE(origxml);
7288 7289 7290
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
7291 7292
    if (newvol)
        virStorageVolFree(newvol);
7293 7294 7295 7296 7297
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310

/*
 * "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 已提交
7311
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325
    {"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 已提交
7326
static bool
7327 7328 7329 7330
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7331
    bool ret = false;
7332 7333 7334 7335 7336 7337 7338 7339 7340 7341
    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 已提交
7342
        return false;
7343 7344 7345 7346
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7347
        return false;
7348 7349 7350
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7351
        return false;
7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385
    }

    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 已提交
7386
    ret = true;
7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410

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 已提交
7411
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426
    {"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}
};


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

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

E
Eric Blake 已提交
7427
static bool
7428 7429 7430 7431
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7432
    bool ret = false;
7433 7434 7435 7436
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
7437
    bool created = false;
7438 7439

    if (!vshConnectionUsability(ctl, ctl->conn))
7440
        return false;
7441 7442 7443

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7444
        return false;
7445 7446 7447 7448
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7449
        return false;
7450 7451 7452
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
7453
        return false;
7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465

    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;
        }
7466 7467
    } else {
        created = true;
7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491
    }

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

    if (virStreamRecvAll(st, cmdVolDownloadSink, &fd) < 0) {
        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 已提交
7492
    ret = true;
7493 7494

cleanup:
7495
    VIR_FORCE_CLOSE(fd);
7496
    if (!ret && created)
7497 7498 7499 7500 7501 7502 7503 7504 7505
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


7506 7507 7508
/*
 * "vol-delete" command
 */
7509
static const vshCmdInfo info_vol_delete[] = {
7510 7511
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
7512 7513 7514
    {NULL, NULL}
};

7515
static const vshCmdOptDef opts_vol_delete[] = {
7516
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7517
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7518 7519 7520
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7521
static bool
7522
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
7523 7524
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7525
    bool ret = true;
7526
    const char *name;
7527

7528
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7529
        return false;
7530 7531

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7532
        return false;
7533 7534 7535
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
7536
        vshPrint(ctl, _("Vol %s deleted\n"), name);
7537
    } else {
7538
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
7539
        ret = false;
7540 7541
    }

L
Laine Stump 已提交
7542
    virStorageVolFree(vol);
7543 7544 7545 7546
    return ret;
}


D
David Allan 已提交
7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557
/*
 * "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 已提交
7558
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
7559 7560 7561
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7562
static bool
D
David Allan 已提交
7563 7564 7565
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7566
    bool ret = true;
7567
    const char *name;
D
David Allan 已提交
7568

7569
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7570
        return false;
D
David Allan 已提交
7571 7572

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7573
        return false;
D
David Allan 已提交
7574 7575 7576 7577 7578 7579
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
7580
        ret = false;
D
David Allan 已提交
7581 7582 7583 7584 7585 7586 7587
    }

    virStorageVolFree(vol);
    return ret;
}


7588 7589 7590
/*
 * "vol-info" command
 */
7591
static const vshCmdInfo info_vol_info[] = {
7592 7593
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
7594 7595 7596
    {NULL, NULL}
};

7597
static const vshCmdOptDef opts_vol_info[] = {
7598
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7599
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7600 7601 7602
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7603
static bool
7604
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
7605 7606 7607
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
7608
    bool ret = true;
7609

7610
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7611
        return false;
7612 7613

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
7614
        return false;
7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630

    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 已提交
7631
        ret = false;
7632 7633 7634 7635 7636 7637 7638 7639 7640 7641
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
7642
static const vshCmdInfo info_vol_dumpxml[] = {
7643 7644
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
7645 7646 7647
    {NULL, NULL}
};

7648
static const vshCmdOptDef opts_vol_dumpxml[] = {
7649
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7650
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7651 7652 7653
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7654
static bool
7655
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
7656 7657
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7658
    bool ret = true;
7659 7660
    char *dump;

7661
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7662
        return false;
7663 7664

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
7665
        return false;
7666 7667 7668

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
7669
        vshPrint(ctl, "%s", dump);
7670
        VIR_FREE(dump);
7671
    } else {
E
Eric Blake 已提交
7672
        ret = false;
7673 7674 7675 7676 7677 7678 7679 7680 7681 7682
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
7683
static const vshCmdInfo info_vol_list[] = {
7684 7685
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
7686 7687 7688
    {NULL, NULL}
};

7689
static const vshCmdOptDef opts_vol_list[] = {
7690
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7691
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
7692 7693 7694
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7695
static bool
7696
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7697
{
7698
    virStorageVolInfo volumeInfo;
7699 7700
    virStoragePoolPtr pool;
    char **activeNames = NULL;
7701 7702 7703 7704 7705
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
7706 7707
    int ret;
    bool functionReturn;
7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718
    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;
7719

7720
    /* Check the connection to libvirtd daemon is still working */
7721
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7722
        return false;
7723

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

7728 7729
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
7730

7731 7732 7733
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7734
        return false;
7735 7736
    }

7737 7738 7739 7740 7741
    /* 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) {
7742
            vshError(ctl, "%s", _("Failed to list active vols"));
7743
            VIR_FREE(activeNames);
7744
            virStoragePoolFree(pool);
E
Eric Blake 已提交
7745
            return false;
7746 7747
        }

7748 7749 7750 7751 7752
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

7755 7756 7757 7758 7759
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
7760

7761 7762 7763 7764
        /* 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"));
7765 7766
        }

7767 7768 7769 7770 7771 7772 7773 7774 7775
        /* 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 */
7776

7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831
                /* 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;
        }
7832

7833
        /* Cleanup memory allocation */
7834
        virStorageVolFree(vol);
7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852
    }

    /* 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 已提交
7853
        functionReturn = true;
7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884
        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 已提交
7885 7886 7887 7888 7889
    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);
7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923

    /* 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 已提交
7924
    functionReturn = true;
7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938
    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 已提交
7939
    functionReturn = false;
7940 7941 7942 7943 7944 7945 7946 7947 7948 7949

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);
7950
        VIR_FREE(activeNames[i]);
7951
    }
7952 7953 7954 7955

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
7956
    VIR_FREE(activeNames);
7957
    virStoragePoolFree(pool);
7958 7959 7960

    /* Return the desired value */
    return functionReturn;
7961 7962 7963 7964 7965 7966
}


/*
 * "vol-name" command
 */
7967
static const vshCmdInfo info_vol_name[] = {
7968
    {"help", N_("returns the volume name for a given volume key or path")},
7969
    {"desc", ""},
7970 7971 7972
    {NULL, NULL}
};

7973
static const vshCmdOptDef opts_vol_name[] = {
7974
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
7975 7976 7977
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7978
static bool
7979
cmdVolName(vshControl *ctl, const vshCmd *cmd)
7980 7981 7982
{
    virStorageVolPtr vol;

7983
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7984
        return false;
7985 7986 7987

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
E
Eric Blake 已提交
7988
        return false;
7989 7990 7991

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
7992
    return true;
7993 7994 7995
}


J
Justin Clift 已提交
7996 7997 7998 7999 8000 8001 8002 8003 8004 8005
/*
 * "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[] = {
8006
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
8007 8008 8009 8010
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8011
static bool
J
Justin Clift 已提交
8012 8013 8014 8015
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8016
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
8017 8018

    /* Check the connection to libvirtd daemon is still working */
8019
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8020
        return false;
J
Justin Clift 已提交
8021 8022 8023 8024

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
8025
        return false;
J
Justin Clift 已提交
8026 8027 8028 8029 8030 8031 8032
    }

    /* 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 已提交
8033
        return false;
J
Justin Clift 已提交
8034 8035
    }

8036 8037 8038 8039 8040 8041 8042 8043 8044
    /* 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 已提交
8045 8046 8047 8048

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8049
    return true;
J
Justin Clift 已提交
8050 8051
}

8052 8053 8054 8055

/*
 * "vol-key" command
 */
8056
static const vshCmdInfo info_vol_key[] = {
8057
    {"help", N_("returns the volume key for a given volume name or path")},
8058
    {"desc", ""},
8059 8060 8061
    {NULL, NULL}
};

8062
static const vshCmdOptDef opts_vol_key[] = {
8063
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
8064
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8065 8066 8067
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8068
static bool
8069
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
8070 8071 8072
{
    virStorageVolPtr vol;

8073
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8074
        return false;
8075

8076
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8077
        return false;
8078 8079 8080

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8081
    return true;
8082 8083 8084 8085 8086 8087 8088
}



/*
 * "vol-path" command
 */
8089
static const vshCmdInfo info_vol_path[] = {
8090
    {"help", N_("returns the volume path for a given volume name or key")},
8091
    {"desc", ""},
8092 8093 8094
    {NULL, NULL}
};

8095
static const vshCmdOptDef opts_vol_path[] = {
8096
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
8097
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8098 8099 8100
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8101
static bool
8102
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
8103 8104
{
    virStorageVolPtr vol;
8105
    const char *name = NULL;
8106

8107
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8108
        return false;
8109 8110

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8111
        return false;
8112
    }
8113 8114 8115

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8116
    return true;
8117 8118 8119
}


8120 8121 8122 8123
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
8124 8125
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
8126 8127
    {NULL, NULL}
};
8128

8129
static const vshCmdOptDef opts_secret_define[] = {
8130
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
8131 8132
    {NULL, 0, 0, NULL}
};
8133

E
Eric Blake 已提交
8134
static bool
8135 8136
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
8137
    const char *from = NULL;
8138
    char *buffer;
8139
    virSecretPtr res;
8140
    char uuid[VIR_UUID_STRING_BUFLEN];
8141

8142
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8143
        return false;
8144

8145
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8146
        return false;
8147 8148

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
8152
    VIR_FREE(buffer);
8153 8154

    if (res == NULL) {
8155
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
8156
        return false;
8157
    }
8158
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
8159
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
8160
        virSecretFree(res);
E
Eric Blake 已提交
8161
        return false;
8162 8163 8164
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
8165
    return true;
8166 8167 8168 8169 8170 8171
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
8172 8173
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
8174 8175 8176 8177
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
8178
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8179 8180 8181
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8182
static bool
8183 8184 8185
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8186
    bool ret = false;
8187 8188
    char *xml;

8189
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8190
        return false;
8191 8192 8193

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8194
        return false;
8195 8196 8197 8198

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
8199
    vshPrint(ctl, "%s", xml);
8200
    VIR_FREE(xml);
E
Eric Blake 已提交
8201
    ret = true;
8202 8203 8204 8205 8206 8207 8208 8209 8210 8211

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
8212 8213
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
8214 8215 8216 8217
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
8218 8219
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
8220 8221 8222
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8223
static bool
8224 8225 8226 8227
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
8228
    const char *base64 = NULL;
8229
    char *value;
E
Eric Blake 已提交
8230 8231
    int res;
    bool ret = false;
8232

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

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

8240
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
8241 8242 8243
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
8244
        vshError(ctl, "%s", _("Invalid base64 data"));
8245 8246 8247
        goto cleanup;
    }
    if (value == NULL) {
8248
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
8249
        return false;
8250 8251 8252 8253
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
8254
    VIR_FREE(value);
8255 8256

    if (res != 0) {
8257
        vshError(ctl, "%s", _("Failed to set secret value"));
8258 8259 8260
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
8261
    ret = true;
8262 8263 8264 8265 8266 8267 8268 8269 8270 8271

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
8272 8273
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
8274 8275 8276 8277
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
8278
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8279 8280 8281
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8282
static bool
8283 8284 8285 8286 8287 8288
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
8289
    bool ret = false;
8290

8291
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8292
        return false;
8293 8294 8295

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8296
        return false;
8297 8298 8299 8300 8301 8302 8303

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
8304
    VIR_FREE(value);
8305 8306

    if (base64 == NULL) {
8307
        vshError(ctl, "%s", _("Failed to allocate memory"));
8308 8309
        goto cleanup;
    }
8310
    vshPrint(ctl, "%s", base64);
8311
    memset(base64, 0, strlen(base64));
8312
    VIR_FREE(base64);
E
Eric Blake 已提交
8313
    ret = true;
8314 8315 8316 8317 8318 8319 8320 8321 8322 8323

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
8324 8325
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
8326 8327 8328 8329
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
8330
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8331 8332 8333
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8334
static bool
8335 8336 8337
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8338
    bool ret = false;
8339
    const char *uuid;
8340

8341
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8342
        return false;
8343 8344 8345

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
8346
        return false;
8347 8348

    if (virSecretUndefine(secret) < 0) {
8349
        vshError(ctl, _("Failed to delete secret %s"), uuid);
8350 8351 8352
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
8353
    ret = true;
8354 8355 8356 8357 8358 8359 8360 8361 8362 8363

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
8364 8365
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
8366 8367 8368
    {NULL, NULL}
};

E
Eric Blake 已提交
8369
static bool
8370 8371 8372 8373 8374
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

8375
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8376
        return false;
8377 8378 8379

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
8380
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
8381
        return false;
8382 8383 8384 8385 8386
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
8387
        vshError(ctl, "%s", _("Failed to list secrets"));
8388
        VIR_FREE(uuids);
E
Eric Blake 已提交
8389
        return false;
8390 8391 8392 8393
    }

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

8394 8395
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
8396 8397

    for (i = 0; i < maxuuids; i++) {
8398 8399 8400 8401
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
8402
            VIR_FREE(uuids[i]);
8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420
            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);
8421
        VIR_FREE(uuids[i]);
8422
    }
8423
    VIR_FREE(uuids);
E
Eric Blake 已提交
8424
    return true;
8425
}
8426 8427 8428 8429 8430


/*
 * "version" command
 */
8431
static const vshCmdInfo info_version[] = {
8432 8433
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
8434 8435 8436 8437
    {NULL, NULL}
};


E
Eric Blake 已提交
8438
static bool
8439
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

8451
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8452
        return false;
8453 8454 8455

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
8456
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
8457
        return false;
8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469
    }

    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) {
8470
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
8471
        return false;
8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488
    }
    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) {
8489
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
8490
        return false;
8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503
    }
    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);
    }
E
Eric Blake 已提交
8504
    return true;
8505 8506
}

8507 8508 8509 8510
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
8511
    {"help", N_("enumerate devices on this host")},
8512
    {"desc", ""},
8513 8514 8515 8516
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
8517 8518
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
8519 8520 8521
    {NULL, 0, 0, NULL}
};

8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543
#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] = '-';
8544 8545
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
8546 8547 8548
    }

    /* Print this device */
8549
    vshPrint(ctl, "%s", indentBuf);
8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572
    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) {
8573
        vshPrint(ctl, "%s", indentBuf);
8574
        vshPrint(ctl, " |\n");
8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596
    }

    /* 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) {
8597
        vshPrint(ctl, "%s", indentBuf);
8598 8599 8600 8601
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
8602
static bool
8603 8604
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
8605
    const char *cap = NULL;
8606
    char **devices;
8607
    int num_devices, i;
8608
    int tree = vshCommandOptBool(cmd, "tree");
8609

8610
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8611
        return false;
8612

8613
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
8614 8615 8616 8617
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
8618
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
8619
        return false;
8620
    } else if (num_devices == 0) {
E
Eric Blake 已提交
8621
        return true;
8622 8623 8624 8625 8626 8627
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
8628
        vshError(ctl, "%s", _("Failed to list node devices"));
8629
        VIR_FREE(devices);
E
Eric Blake 已提交
8630
        return false;
8631
    }
8632
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
8633 8634 8635 8636 8637 8638 8639
    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 已提交
8640
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659
            } 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++) {
8660 8661
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
8662
        }
8663
        VIR_FREE(parents);
8664 8665 8666
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
8667
            VIR_FREE(devices[i]);
8668
        }
8669
    }
8670
    VIR_FREE(devices);
E
Eric Blake 已提交
8671
    return true;
8672 8673 8674 8675 8676 8677
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
8678 8679
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
8680 8681 8682 8683 8684
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
8685
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8686 8687 8688
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8689
static bool
8690 8691
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
8692
    const char *name = NULL;
8693
    virNodeDevicePtr device;
L
Laine Stump 已提交
8694
    char *xml;
8695

8696
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8697
        return false;
8698
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8699
        return false;
8700
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8701
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8702
        return false;
8703 8704
    }

L
Laine Stump 已提交
8705 8706 8707
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
8708
        return false;
L
Laine Stump 已提交
8709 8710 8711
    }

    vshPrint(ctl, "%s\n", xml);
8712
    VIR_FREE(xml);
8713
    virNodeDeviceFree(device);
E
Eric Blake 已提交
8714
    return true;
8715 8716
}

8717 8718 8719 8720
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
8721 8722
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
8723 8724 8725 8726 8727
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
8728
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8729 8730 8731
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8732
static bool
8733 8734
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
8735
    const char *name = NULL;
8736
    virNodeDevicePtr device;
E
Eric Blake 已提交
8737
    bool ret = true;
8738

8739
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8740
        return false;
8741
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8742
        return false;
8743
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8744
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8745
        return false;
8746 8747 8748 8749 8750
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
8751
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
8752
        ret = false;
8753 8754 8755 8756 8757 8758 8759 8760 8761
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
8762 8763
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
8764 8765 8766 8767 8768
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
8769
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8770 8771 8772
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8773
static bool
8774 8775
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
8776
    const char *name = NULL;
8777
    virNodeDevicePtr device;
E
Eric Blake 已提交
8778
    bool ret = true;
8779

8780
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8781
        return false;
8782
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8783
        return false;
8784
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8785
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8786
        return false;
8787 8788 8789 8790 8791
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
8792
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
8793
        ret = false;
8794 8795 8796 8797 8798 8799 8800 8801 8802
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
8803 8804
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
8805 8806 8807 8808 8809
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
8810
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8811 8812 8813
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8814
static bool
8815 8816
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
8817
    const char *name = NULL;
8818
    virNodeDevicePtr device;
E
Eric Blake 已提交
8819
    bool ret = true;
8820

8821
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8822
        return false;
8823
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8824
        return false;
8825
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8826
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8827
        return false;
8828 8829 8830 8831 8832
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
8833
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
8834
        ret = false;
8835 8836 8837 8838 8839
    }
    virNodeDeviceFree(device);
    return ret;
}

8840
/*
E
Eric Blake 已提交
8841
 * "hostname" command
8842
 */
8843
static const vshCmdInfo info_hostname[] = {
8844
    {"help", N_("print the hypervisor hostname")},
8845
    {"desc", ""},
8846 8847 8848
    {NULL, NULL}
};

E
Eric Blake 已提交
8849
static bool
8850
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8851 8852 8853
{
    char *hostname;

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

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
8859
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
8860
        return false;
8861 8862 8863
    }

    vshPrint (ctl, "%s\n", hostname);
8864
    VIR_FREE(hostname);
8865

E
Eric Blake 已提交
8866
    return true;
8867 8868 8869 8870 8871
}

/*
 * "uri" command
 */
8872
static const vshCmdInfo info_uri[] = {
8873
    {"help", N_("print the hypervisor canonical URI")},
8874
    {"desc", ""},
8875 8876 8877
    {NULL, NULL}
};

E
Eric Blake 已提交
8878
static bool
8879
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8880 8881 8882
{
    char *uri;

8883
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8884
        return false;
8885 8886 8887

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
8888
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
8889
        return false;
8890 8891 8892
    }

    vshPrint (ctl, "%s\n", uri);
8893
    VIR_FREE(uri);
8894

E
Eric Blake 已提交
8895
    return true;
8896 8897
}

E
Eric Blake 已提交
8898 8899 8900 8901 8902 8903 8904 8905 8906 8907
/*
 * "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 已提交
8908
static bool
E
Eric Blake 已提交
8909 8910 8911 8912 8913
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

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

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
8919
        return false;
E
Eric Blake 已提交
8920 8921 8922 8923 8924
    }

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

E
Eric Blake 已提交
8925
    return true;
E
Eric Blake 已提交
8926 8927
}

8928 8929 8930
/*
 * "vncdisplay" command
 */
8931
static const vshCmdInfo info_vncdisplay[] = {
8932 8933
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
8934 8935 8936
    {NULL, NULL}
};

8937
static const vshCmdOptDef opts_vncdisplay[] = {
8938
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8939 8940 8941
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8942
static bool
8943
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
8944 8945 8946 8947 8948
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
8949
    bool ret = false;
8950 8951 8952
    int port = 0;
    char *doc;

8953
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8954
        return false;
8955

J
Jim Meyering 已提交
8956
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
8957
        return false;
8958 8959 8960 8961 8962 8963 8964 8965

    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);
8966
    VIR_FREE(doc);
8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984
    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) ||
8985
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
8986 8987 8988 8989 8990 8991
        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 已提交
8992
    ret = true;
8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
9006
static const vshCmdInfo info_ttyconsole[] = {
9007 9008
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
9009 9010 9011
    {NULL, NULL}
};

9012
static const vshCmdOptDef opts_ttyconsole[] = {
9013
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9014 9015 9016
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9017
static bool
9018
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
9019 9020 9021 9022 9023
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9024
    bool ret = false;
9025 9026
    char *doc;

9027
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9028
        return false;
9029

J
Jim Meyering 已提交
9030
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9031
        return false;
9032 9033 9034 9035 9036 9037 9038 9039

    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);
9040
    VIR_FREE(doc);
9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052
    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 已提交
9053
    ret = true;
9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
9066
 */
9067
static const vshCmdInfo info_attach_device[] = {
9068 9069
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
9070 9071 9072
    {NULL, NULL}
};

9073
static const vshCmdOptDef opts_attach_device[] = {
9074 9075 9076
    {"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")},
9077 9078 9079
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9080
static bool
9081
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
9082 9083
{
    virDomainPtr dom;
9084
    const char *from = NULL;
9085
    char *buffer;
W
Wen Congyang 已提交
9086
    int ret;
J
Jim Fehlig 已提交
9087
    unsigned int flags;
9088

9089
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9090
        return false;
9091

J
Jim Meyering 已提交
9092
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9093
        return false;
9094

9095
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9096
        virDomainFree(dom);
E
Eric Blake 已提交
9097
        return false;
9098 9099
    }

9100
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9101
        virshReportError(ctl);
9102
        virDomainFree(dom);
E
Eric Blake 已提交
9103
        return false;
9104
    }
9105

J
Jim Fehlig 已提交
9106 9107 9108 9109 9110 9111 9112 9113
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
           flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
9114
    VIR_FREE(buffer);
9115 9116

    if (ret < 0) {
9117
        vshError(ctl, _("Failed to attach device from %s"), from);
9118
        virDomainFree(dom);
E
Eric Blake 已提交
9119
        return false;
9120
    } else {
J
Jim Meyering 已提交
9121
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
9122 9123 9124
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9125
    return true;
9126 9127 9128 9129 9130 9131
}


/*
 * "detach-device" command
 */
9132
static const vshCmdInfo info_detach_device[] = {
9133 9134
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
9135 9136 9137
    {NULL, NULL}
};

9138
static const vshCmdOptDef opts_detach_device[] = {
9139 9140 9141
    {"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")},
9142 9143 9144
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9145
static bool
9146
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
9147 9148
{
    virDomainPtr dom;
9149
    const char *from = NULL;
9150
    char *buffer;
W
Wen Congyang 已提交
9151
    int ret;
J
Jim Fehlig 已提交
9152
    unsigned int flags;
9153

9154
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9155
        return false;
9156

J
Jim Meyering 已提交
9157
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9158
        return false;
9159

9160
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9161
        virDomainFree(dom);
E
Eric Blake 已提交
9162
        return false;
9163 9164
    }

9165
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9166
        virshReportError(ctl);
9167
        virDomainFree(dom);
E
Eric Blake 已提交
9168
        return false;
9169
    }
9170

J
Jim Fehlig 已提交
9171 9172 9173 9174 9175 9176 9177 9178
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
           flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
9179
    VIR_FREE(buffer);
9180 9181

    if (ret < 0) {
9182
        vshError(ctl, _("Failed to detach device from %s"), from);
9183
        virDomainFree(dom);
E
Eric Blake 已提交
9184
        return false;
9185
    } else {
J
Jim Meyering 已提交
9186
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
9187 9188 9189
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9190
    return true;
9191 9192
}

9193

9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206
/*
 * "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")},
9207
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
9208 9209 9210
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9211
static bool
9212 9213 9214
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
9215
    const char *from = NULL;
9216
    char *buffer;
W
Wen Congyang 已提交
9217
    int ret;
9218 9219
    unsigned int flags;

9220
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9221
        return false;
9222 9223

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

9226
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9227
        virDomainFree(dom);
E
Eric Blake 已提交
9228
        return false;
9229 9230 9231
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9232
        virshReportError(ctl);
9233
        virDomainFree(dom);
E
Eric Blake 已提交
9234
        return false;
9235 9236 9237 9238 9239 9240 9241 9242 9243
    }

    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
           flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
    } else {
        flags = VIR_DOMAIN_DEVICE_MODIFY_LIVE;
    }
9244 9245 9246 9247

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

9248 9249 9250 9251 9252 9253
    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 已提交
9254
        return false;
9255 9256 9257 9258 9259
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9260
    return true;
9261 9262 9263
}


9264 9265 9266
/*
 * "attach-interface" command
 */
9267
static const vshCmdInfo info_attach_interface[] = {
9268 9269
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
9270 9271 9272
    {NULL, NULL}
};

9273
static const vshCmdOptDef opts_attach_interface[] = {
9274 9275 9276 9277 9278 9279
    {"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")},
9280
    {"model", VSH_OT_DATA, 0, N_("model type")},
9281
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
9282 9283 9284
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9285
static bool
9286
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
9287 9288
{
    virDomainPtr dom = NULL;
9289 9290
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
9291
    int typ;
W
Wen Congyang 已提交
9292 9293
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9294
    unsigned int flags;
9295 9296
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9297

9298
    if (!vshConnectionUsability(ctl, ctl->conn))
9299 9300
        goto cleanup;

J
Jim Meyering 已提交
9301
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9302 9303
        goto cleanup;

9304
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9305 9306
        goto cleanup;

9307 9308 9309 9310
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
9311 9312
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
9313
        goto cleanup;
9314
    }
9315 9316

    /* check interface type */
9317
    if (STREQ(type, "network")) {
9318
        typ = 1;
9319
    } else if (STREQ(type, "bridge")) {
9320 9321
        typ = 2;
    } else {
E
Eric Blake 已提交
9322 9323
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
9324 9325 9326 9327
        goto cleanup;
    }

    /* Make XML of interface */
9328
    virBufferAsprintf(&buf, "<interface type='%s'>\n", type);
9329

9330
    if (typ == 1)
9331
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
9332
    else if (typ == 2)
9333
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
9334

9335
    if (target != NULL)
9336
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9337
    if (mac != NULL)
9338
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
9339
    if (script != NULL)
9340
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
9341
    if (model != NULL)
9342
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
9343

9344
    virBufferAddLit(&buf, "</interface>\n");
9345

9346 9347
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
9348
        goto cleanup;
9349 9350
    }

9351
    xml = virBufferContentAndReset(&buf);
9352

J
Jim Fehlig 已提交
9353 9354 9355 9356
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9357
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
9358
    } else {
9359
        ret = virDomainAttachDevice(dom, xml);
9360
    }
9361

9362 9363
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9364
    if (ret != 0) {
L
Laine Stump 已提交
9365
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
9366 9367
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
9368
        functionReturn = true;
J
Jim Fehlig 已提交
9369
    }
9370 9371 9372 9373

 cleanup:
    if (dom)
        virDomainFree(dom);
9374
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
9375
    return functionReturn;
9376 9377 9378 9379 9380
}

/*
 * "detach-interface" command
 */
9381
static const vshCmdInfo info_detach_interface[] = {
9382 9383
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
9384 9385 9386
    {NULL, NULL}
};

9387
static const vshCmdOptDef opts_detach_interface[] = {
9388 9389 9390 9391
    {"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")},
9392 9393 9394
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9395
static bool
9396
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
9397 9398 9399 9400 9401 9402 9403
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
9404
    const char *mac =NULL, *type = NULL;
9405
    char *doc;
9406
    char buf[64];
E
Eric Blake 已提交
9407
    int i = 0, diff_mac;
W
Wen Congyang 已提交
9408 9409
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
9410
    unsigned int flags;
9411

9412
    if (!vshConnectionUsability(ctl, ctl->conn))
9413 9414
        goto cleanup;

J
Jim Meyering 已提交
9415
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9416 9417
        goto cleanup;

9418
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9419 9420
        goto cleanup;

9421 9422
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
9423
        goto cleanup;
9424
    }
9425 9426 9427 9428 9429 9430 9431 9432

    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);
9433
    VIR_FREE(doc);
9434
    if (!xml) {
9435
        vshError(ctl, "%s", _("Failed to get interface information"));
9436 9437 9438 9439
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9440
        vshError(ctl, "%s", _("Failed to get interface information"));
9441 9442 9443
        goto cleanup;
    }

E
Eric Blake 已提交
9444
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
9445 9446 9447
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9448
        vshError(ctl, _("No found interface whose type is %s"), type);
9449 9450 9451
        goto cleanup;
    }

9452 9453 9454 9455 9456 9457
    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;
    }

9458 9459 9460 9461 9462 9463 9464
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9465 9466 9467 9468 9469
            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);
9470 9471 9472 9473 9474 9475 9476
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9477
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
9478 9479 9480 9481 9482
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9483
        vshError(ctl, "%s", _("Failed to allocate memory"));
9484 9485 9486
        goto cleanup;
    }

9487
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
9488
        vshError(ctl, "%s", _("Failed to create XML"));
9489 9490 9491
        goto cleanup;
    }

J
Jim Fehlig 已提交
9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
9504
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
9505
    } else {
J
Jim Meyering 已提交
9506
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
9507
        functionReturn = true;
9508
    }
9509 9510 9511 9512

 cleanup:
    if (dom)
        virDomainFree(dom);
9513
    xmlXPathFreeObject(obj);
9514
    xmlXPathFreeContext(ctxt);
9515 9516 9517 9518
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
9519
    return functionReturn;
9520 9521 9522 9523 9524
}

/*
 * "attach-disk" command
 */
9525
static const vshCmdInfo info_attach_disk[] = {
9526 9527
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
9528 9529 9530
    {NULL, NULL}
};

9531
static const vshCmdOptDef opts_attach_disk[] = {
9532 9533 9534 9535 9536 9537 9538 9539
    {"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")},
9540
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
9541 9542 9543
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9544
static bool
9545
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
9546 9547
{
    virDomainPtr dom = NULL;
9548 9549
    const char *source = NULL, *target = NULL, *driver = NULL,
                *subdriver = NULL, *type = NULL, *mode = NULL;
W
Wen Congyang 已提交
9550 9551
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
9552
    unsigned int flags;
9553
    const char *stype = NULL;
9554 9555
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9556

9557
    if (!vshConnectionUsability(ctl, ctl->conn))
9558 9559
        goto cleanup;

J
Jim Meyering 已提交
9560
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9561 9562
        goto cleanup;

9563
    if (vshCommandOptString(cmd, "source", &source) <= 0)
9564 9565
        goto cleanup;

9566
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9567 9568
        goto cleanup;

9569 9570 9571 9572 9573
    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) {
9574
        vshError(ctl, "%s", _("missing option"));
9575 9576
        goto cleanup;
    }
9577

9578 9579
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
9580
            isFile = true;
9581
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
9582
        isFile = true;
9583 9584 9585
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
9586 9587 9588
    }

    if (mode) {
9589
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
9590 9591
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
9592 9593 9594 9595 9596
            goto cleanup;
        }
    }

    /* Make XML of disk */
9597
    virBufferAsprintf(&buf, "<disk type='%s'",
9598 9599
                      (isFile) ? "file" : "block");
    if (type)
9600
        virBufferAsprintf(&buf, " device='%s'", type);
9601 9602
    virBufferAddLit(&buf, ">\n");

9603
    if (driver || subdriver)
9604
        virBufferAsprintf(&buf, "  <driver");
9605 9606

    if (driver)
9607
        virBufferAsprintf(&buf, " name='%s'", driver);
9608
    if (subdriver)
9609
        virBufferAsprintf(&buf, " type='%s'", subdriver);
9610 9611 9612

    if (driver || subdriver)
        virBufferAddLit(&buf, "/>\n");
9613

9614
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
9615 9616
                      (isFile) ? "file" : "dev",
                      source);
9617
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9618
    if (mode)
9619
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
9620 9621

    virBufferAddLit(&buf, "</disk>\n");
9622

9623 9624
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
9625
        return false;
9626 9627
    }

9628
    xml = virBufferContentAndReset(&buf);
9629

J
Jim Fehlig 已提交
9630 9631 9632 9633
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9634
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
9635
    } else {
9636
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
9637
    }
9638

9639 9640
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9641
    if (ret != 0) {
L
Laine Stump 已提交
9642
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
9643 9644
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
9645
        functionReturn = true;
J
Jim Fehlig 已提交
9646
    }
9647 9648 9649 9650

 cleanup:
    if (dom)
        virDomainFree(dom);
9651
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
9652
    return functionReturn;
9653 9654 9655 9656 9657
}

/*
 * "detach-disk" command
 */
9658
static const vshCmdInfo info_detach_disk[] = {
9659 9660
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
9661 9662 9663
    {NULL, NULL}
};

9664
static const vshCmdOptDef opts_detach_disk[] = {
9665 9666 9667
    {"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")},
9668 9669 9670
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9671
static bool
9672
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
9673 9674 9675 9676 9677 9678 9679
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
9680
    const char *target = NULL;
9681
    char *doc;
E
Eric Blake 已提交
9682
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
9683 9684
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9685
    unsigned int flags;
9686

9687
    if (!vshConnectionUsability(ctl, ctl->conn))
9688 9689
        goto cleanup;

J
Jim Meyering 已提交
9690
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9691 9692
        goto cleanup;

9693
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9694 9695 9696 9697 9698 9699 9700 9701 9702
        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);
9703
    VIR_FREE(doc);
9704
    if (!xml) {
9705
        vshError(ctl, "%s", _("Failed to get disk information"));
9706 9707 9708 9709
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9710
        vshError(ctl, "%s", _("Failed to get disk information"));
9711 9712 9713 9714 9715 9716
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9717
        vshError(ctl, "%s", _("Failed to get disk information"));
9718 9719 9720 9721 9722 9723 9724
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9725 9726 9727 9728 9729
            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);
9730 9731 9732 9733 9734 9735 9736
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9737
    vshError(ctl, _("No found disk whose target is %s"), target);
9738 9739 9740 9741 9742
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9743
        vshError(ctl, "%s", _("Failed to allocate memory"));
9744 9745 9746
        goto cleanup;
    }

9747
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
9748
        vshError(ctl, "%s", _("Failed to create XML"));
9749 9750 9751
        goto cleanup;
    }

J
Jim Fehlig 已提交
9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
9764
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
9765
    } else {
J
Jim Meyering 已提交
9766
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
9767
        functionReturn = true;
9768
    }
9769 9770

 cleanup:
9771
    xmlXPathFreeObject(obj);
9772
    xmlXPathFreeContext(ctxt);
9773 9774 9775 9776 9777 9778
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
9779
    return functionReturn;
9780 9781
}

9782 9783 9784 9785
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
9786 9787
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
9788 9789 9790 9791
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
9792
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
9793 9794 9795
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9796
static bool
9797 9798
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
9799
    const char *from = NULL;
E
Eric Blake 已提交
9800
    bool ret = true;
9801 9802 9803
    char *buffer;
    int result;

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

9807
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9808
        return false;
9809 9810

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
9814
    VIR_FREE(buffer);
9815 9816 9817 9818 9819

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
9820
        ret = false;
9821 9822 9823 9824 9825
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
9826
        ret = true;
9827 9828 9829 9830 9831
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
9832
        ret = true;
9833 9834 9835 9836 9837
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
9838
        ret = false;
9839 9840 9841 9842 9843
    }

    return ret;
}

9844 9845 9846 9847
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
9848 9849
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
9850 9851 9852 9853
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
9854
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
9855 9856 9857
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9858
static bool
9859 9860
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
9861
    const char *from = NULL;
E
Eric Blake 已提交
9862
    bool ret = true;
9863 9864 9865 9866 9867
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
9868
    xmlNodePtr node_list;
9869 9870 9871 9872 9873 9874
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

9875
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9876
        return false;
9877

9878
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9879
        return false;
9880 9881

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
9882
        return false;
9883 9884 9885 9886 9887

    doc = xmlNewDoc(NULL);
    if (doc == NULL)
        goto no_memory;

L
Laine Stump 已提交
9888 9889
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
9890 9891
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
9892
        ret = false;
9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928
        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 已提交
9929
        ret = false;
9930 9931 9932 9933 9934 9935 9936 9937
        goto cleanup;
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
9938
        ret = false;
9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955

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 已提交
9956
    ret = false;
9957
    goto cleanup;
9958 9959
}

9960 9961 9962 9963 9964 9965 9966 9967
/* 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;

9968
    ret = vshMalloc(ctl, PATH_MAX);
9969 9970 9971

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
9972 9973
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
9974
    if (fd == -1) {
9975
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
9976
                 strerror(errno));
9977
        VIR_FREE(ret);
9978 9979 9980 9981
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
9982 9983
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
9984
        VIR_FORCE_CLOSE(fd);
9985
        unlink (ret);
9986
        VIR_FREE(ret);
9987 9988
        return NULL;
    }
S
Stefan Berger 已提交
9989
    if (VIR_CLOSE(fd) < 0) {
9990 9991
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
9992
        unlink (ret);
9993
        VIR_FREE(ret);
9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008
        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 已提交
10009 10010 10011 10012
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
10013

10014
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
10015 10016 10017 10018
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
10019

10020 10021 10022 10023 10024
    /* 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 已提交
10025 10026
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
10027
     */
E
Eric Blake 已提交
10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039
    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);
10040 10041
    }

E
Eric Blake 已提交
10042 10043 10044 10045 10046 10047 10048
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
10049
    }
E
Eric Blake 已提交
10050
    ret = 0;
10051

E
Eric Blake 已提交
10052 10053 10054
cleanup:
    virCommandFree(cmd);
    return ret;
10055 10056 10057 10058 10059 10060 10061 10062
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
10063
        vshError(ctl,
10064
                 _("%s: failed to read temporary file: %s"),
10065
                 filename, strerror(errno));
10066 10067 10068 10069 10070
        return NULL;
    }
    return ret;
}

10071

P
Paolo Bonzini 已提交
10072 10073 10074 10075
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
10076 10077
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
10078 10079 10080 10081
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
10082
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
10083 10084 10085
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10086
static bool
10087
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
10088
{
10089
    const char *dir = NULL;
10090
    char *dir_malloced = NULL;
E
Eric Blake 已提交
10091
    bool ret = true;
P
Paolo Bonzini 已提交
10092 10093

    if (!ctl->imode) {
10094
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
10095
        return false;
P
Paolo Bonzini 已提交
10096 10097
    }

10098
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
10099
        uid_t uid = geteuid();
10100
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
10101 10102 10103 10104
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
10105
    if (chdir(dir) == -1) {
10106
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
10107
        ret = false;
P
Paolo Bonzini 已提交
10108 10109
    }

10110
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
10111
    return ret;
P
Paolo Bonzini 已提交
10112 10113 10114 10115 10116 10117
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
10118 10119
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
10120 10121 10122
    {NULL, NULL}
};

E
Eric Blake 已提交
10123
static bool
P
Paolo Bonzini 已提交
10124 10125 10126
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
10127
    bool ret = true;
P
Paolo Bonzini 已提交
10128

10129 10130
    cwd = getcwd(NULL, 0);
    if (!cwd) {
10131 10132
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
10133 10134
        ret = false;
    } else {
P
Paolo Bonzini 已提交
10135
        vshPrint (ctl, _("%s\n"), cwd);
10136 10137
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
10138

10139
    return ret;
P
Paolo Bonzini 已提交
10140 10141
}

E
Eric Blake 已提交
10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160
/*
 * "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")},
    {"", VSH_OT_ARGV, 0, N_("arguments to echo")},
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
10161
static bool
E
Eric Blake 已提交
10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

    while ((arg = vshCommandOptArgv(cmd, count)) != NULL) {
        bool close_quote = false;
        char *q;

        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 已提交
10207
        return false;
E
Eric Blake 已提交
10208 10209 10210 10211 10212
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
10213
    return true;
E
Eric Blake 已提交
10214 10215
}

10216 10217 10218 10219
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
10220 10221
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
10222 10223 10224 10225
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
10226
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10227 10228 10229 10230 10231 10232
    {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 已提交
10233
static bool
10234 10235
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
10236
    bool ret = false;
10237 10238 10239 10240 10241
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
10242
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
10243

10244
    if (!vshConnectionUsability(ctl, ctl->conn))
10245 10246
        goto cleanup;

J
Jim Meyering 已提交
10247
    dom = vshCommandOptDomain (ctl, cmd, NULL);
10248 10249 10250 10251
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
10252
    doc = virDomainGetXMLDesc (dom, flags);
10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270
    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 已提交
10271
        ret = true;
10272 10273 10274 10275 10276 10277 10278
        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.
     */
10279
    doc_reread = virDomainGetXMLDesc (dom, flags);
10280 10281 10282 10283
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
10284 10285
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297
        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 已提交
10298
    ret = true;
10299 10300 10301 10302 10303

 cleanup:
    if (dom)
        virDomainFree (dom);

10304 10305 10306
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
10307 10308 10309

    if (tmp) {
        unlink (tmp);
10310
        VIR_FREE(tmp);
10311 10312 10313 10314 10315
    }

    return ret;
}

10316

10317 10318 10319 10320
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
10321 10322
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
10323 10324 10325 10326
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
10327
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
10328 10329 10330 10331 10332 10333 10334 10335 10336 10337
    {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[] = {
10338 10339
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
10340 10341 10342 10343
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
10344
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10345 10346 10347 10348 10349 10350
    {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 已提交
10351 10352 10353
/*
 * "quit" command
 */
10354
static const vshCmdInfo info_quit[] = {
10355
    {"help", N_("quit this interactive terminal")},
10356
    {"desc", ""},
10357
    {NULL, NULL}
K
Karel Zak 已提交
10358 10359
};

E
Eric Blake 已提交
10360
static bool
10361
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10362
{
E
Eric Blake 已提交
10363 10364
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
10365 10366
}

10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
    {"help", N_("Create a snapshot")},
    {"desc", N_("Snapshot create")},
    {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 已提交
10382
static bool
10383 10384 10385
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10386
    bool ret = false;
10387
    const char *from = NULL;
10388 10389 10390 10391 10392 10393 10394
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

10395
    if (!vshConnectionUsability(ctl, ctl->conn))
10396 10397 10398 10399 10400 10401
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10402
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
10403
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447
    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 已提交
10448
    ret = true;
10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478

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

/*
 * "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 已提交
10479
static bool
10480 10481 10482
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10483
    bool ret = false;
10484 10485 10486
    int current;
    virDomainSnapshotPtr snapshot = NULL;

10487
    if (!vshConnectionUsability(ctl, ctl->conn))
10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510
        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 已提交
10511
    ret = true;
10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535

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 已提交
10536
static bool
10537 10538 10539
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10540
    bool ret = false;
10541 10542
    int numsnaps;
    char **names = NULL;
10543
    int actual = 0;
10544 10545 10546 10547 10548 10549
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
10550 10551
    long long creation_longlong;
    time_t creation_time_t;
10552 10553 10554
    char timestr[100];
    struct tm time_info;

10555
    if (!vshConnectionUsability(ctl, ctl->conn))
10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

10567 10568
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609

    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;
10610 10611
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
10612
                continue;
10613 10614 10615 10616 10617 10618
            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);
10619
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
10620 10621 10622 10623 10624

            vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
        }
    }

E
Eric Blake 已提交
10625
    ret = true;
10626 10627 10628 10629 10630 10631 10632 10633 10634 10635

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);
10636 10637
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659
    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 已提交
10660
static bool
10661 10662 10663
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10664
    bool ret = false;
10665
    const char *name = NULL;
10666 10667 10668
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

10669
    if (!vshConnectionUsability(ctl, ctl->conn))
10670 10671 10672 10673 10674 10675
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10676
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10677 10678 10679 10680 10681 10682 10683 10684 10685 10686
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

10687
    vshPrint(ctl, "%s", xml);
10688

E
Eric Blake 已提交
10689
    ret = true;
10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
10702
 * "snapshot-revert" command
10703
 */
10704
static const vshCmdInfo info_snapshot_revert[] = {
10705 10706 10707 10708 10709
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

10710
static const vshCmdOptDef opts_snapshot_revert[] = {
10711 10712 10713 10714 10715
    {"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 已提交
10716
static bool
10717
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
10718 10719
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10720
    bool ret = false;
10721
    const char *name = NULL;
10722 10723
    virDomainSnapshotPtr snapshot = NULL;

10724
    if (!vshConnectionUsability(ctl, ctl->conn))
10725 10726 10727 10728 10729 10730
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10731
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10732 10733 10734 10735 10736 10737 10738 10739 10740
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    if (virDomainRevertToSnapshot(snapshot, 0) < 0)
        goto cleanup;

E
Eric Blake 已提交
10741
    ret = true;
10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767

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 已提交
10768
static bool
10769 10770 10771
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10772
    bool ret = false;
10773
    const char *name = NULL;
10774 10775 10776
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

10777
    if (!vshConnectionUsability(ctl, ctl->conn))
10778 10779 10780 10781 10782 10783
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10784
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796
        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 已提交
10797
    ret = true;
10798 10799 10800 10801 10802 10803 10804 10805 10806 10807

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819
/*
 * "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")},
10820
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
10821 10822 10823
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10824
static bool
10825 10826 10827
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10828
    bool ret = false;
10829
    const char *monitor_cmd = NULL;
10830
    char *result = NULL;
10831
    unsigned int flags = 0;
10832 10833 10834 10835 10836 10837 10838 10839

    if (!vshConnectionUsability(ctl, ctl->conn))
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10840
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
10841 10842 10843 10844
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

10845 10846 10847 10848
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
10849 10850 10851 10852
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
10853
    ret = true;
10854 10855 10856 10857 10858 10859 10860 10861 10862

cleanup:
    VIR_FREE(result);
    if (dom)
        virDomainFree(dom);

    return ret;
}

10863
static const vshCmdDef domManagementCmds[] = {
10864 10865 10866 10867 10868 10869 10870 10871
    {"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},
10872
#ifndef WIN32
10873
    {"console", cmdConsole, opts_console, info_console, 0},
10874
#endif
10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926
    {"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},
    {"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},
    {"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},
    {"vcpupin", cmdVcpupin, opts_vcpupin, info_vcpupin, 0},
    {"version", cmdVersion, NULL, info_version, 0},
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
10927 10928 10929
};

static const vshCmdDef domMonitoringCmds[] = {
10930 10931 10932 10933 10934 10935 10936 10937
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
    {"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}
10938 10939 10940
};

static const vshCmdDef storagePoolCmds[] = {
10941
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
10942
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
10943
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964
     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}
10965 10966 10967
};

static const vshCmdDef storageVolCmds[] = {
10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985
    {"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}
10986
};
10987

10988
static const vshCmdDef networkCmds[] = {
10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007
    {"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}
11008
};
11009

11010
static const vshCmdDef nodedevCmds[] = {
11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025
    {"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}
11026 11027 11028
};

static const vshCmdDef ifaceCmds[] = {
11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046
    {"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},
    {"iface-start", cmdInterfaceStart, opts_interface_start,
     info_interface_start, 0},
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine,
     info_interface_undefine, 0},
11047 11048 11049 11050 11051 11052
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
11053
    {NULL, NULL, NULL, NULL, 0}
11054
};
11055

11056
static const vshCmdDef nwfilterCmds[] = {
11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067
    {"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}
11068
};
11069

11070
static const vshCmdDef secretCmds[] = {
11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082
    {"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}
11083
};
11084

11085
static const vshCmdDef virshCmds[] = {
11086 11087 11088 11089 11090 11091 11092
    {"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}
11093
};
11094

11095
static const vshCmdDef snapshotCmds[] = {
11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
    {"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}
11109
};
11110

11111
static const vshCmdDef hostAndHypervisorCmds[] = {
11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122
    {"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},
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
    {"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 已提交
11123 11124
};

11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141
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 已提交
11142 11143 11144 11145
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
11146
static const char *
11147
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
11148
{
11149
    const vshCmdInfo *info;
11150

K
Karel Zak 已提交
11151
    for (info = cmd->info; info && info->name; info++) {
11152
        if (STREQ(info->name, name))
K
Karel Zak 已提交
11153 11154 11155 11156 11157
            return info->data;
    }
    return NULL;
}

11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189
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;
        }
        *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;
}

11190
static const vshCmdOptDef *
11191 11192
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
11193
{
11194 11195 11196 11197
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
11198

11199 11200 11201 11202 11203 11204
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
            *opts_seen |= 1 << i;
K
Karel Zak 已提交
11205
            return opt;
11206 11207 11208 11209 11210
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
11211 11212 11213
    return NULL;
}

11214
static const vshCmdOptDef *
11215 11216
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
11217
{
11218
    int i;
11219
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
11220

11221 11222 11223 11224 11225 11226 11227 11228 11229 11230
    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 已提交
11231 11232
}

11233 11234 11235
/*
 * Checks for required options
 */
11236
static int
11237 11238
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
11239
{
11240
    const vshCmdDef *def = cmd->def;
11241 11242 11243 11244 11245 11246 11247 11248 11249
    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];
11250

11251 11252 11253 11254 11255
            vshError(ctl,
                     opt->type == VSH_OT_DATA ?
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
11256 11257
        }
    }
11258
    return -1;
11259 11260
}

11261
static const vshCmdDef *
11262 11263
vshCmddefSearch(const char *cmdname)
{
11264
    const vshCmdGrp *g;
11265
    const vshCmdDef *c;
11266

11267 11268
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
11269
            if (STREQ(c->name, cmdname))
11270 11271 11272 11273
                return c;
        }
    }

K
Karel Zak 已提交
11274 11275 11276
    return NULL;
}

11277 11278 11279 11280 11281 11282
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
11283
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
11284 11285 11286 11287 11288 11289
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
11290
static bool
11291 11292 11293 11294 11295 11296 11297
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 已提交
11298
        return false;
11299 11300 11301 11302 11303 11304 11305 11306 11307 11308
    } 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 已提交
11309
    return true;
11310 11311
}

E
Eric Blake 已提交
11312
static bool
11313
vshCmddefHelp(vshControl *ctl, const char *cmdname)
11314
{
11315
    const vshCmdDef *def = vshCmddefSearch(cmdname);
11316

K
Karel Zak 已提交
11317
    if (!def) {
11318
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
11319
        return false;
11320
    } else {
E
Eric Blake 已提交
11321 11322
        const char *desc = _(vshCmddefGetInfo(def, "desc"));
        const char *help = _(vshCmddefGetInfo(def, "help"));
11323
        char buf[256];
11324 11325 11326 11327 11328 11329
        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 已提交
11330
            return false;
11331
        }
K
Karel Zak 已提交
11332

11333
        fputs(_("  NAME\n"), stdout);
11334 11335
        fprintf(stdout, "    %s - %s\n", def->name, help);

11336 11337 11338 11339 11340
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
11341
                const char *fmt = "%s";
11342 11343
                switch (opt->type) {
                case VSH_OT_BOOL:
11344
                    fmt = "[--%s]";
11345 11346
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
11347
                    /* xgettext:c-format */
11348 11349
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
11350 11351
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
11352 11353
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
11354 11355
                    break;
                case VSH_OT_DATA:
11356
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
11357 11358 11359 11360 11361 11362
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
                    fmt = _("[<string>]...");
                    break;
                default:
11363
                    assert(0);
11364
                }
11365
                fputc(' ', stdout);
E
Eric Blake 已提交
11366
                fprintf(stdout, fmt, opt->name);
11367
            }
K
Karel Zak 已提交
11368
        }
11369 11370 11371
        fputc('\n', stdout);

        if (desc[0]) {
11372
            /* Print the description only if it's not empty.  */
11373
            fputs(_("\n  DESCRIPTION\n"), stdout);
K
Karel Zak 已提交
11374 11375
            fprintf(stdout, "    %s\n", desc);
        }
11376

K
Karel Zak 已提交
11377
        if (def->opts) {
11378
            const vshCmdOptDef *opt;
11379
            fputs(_("\n  OPTIONS\n"), stdout);
11380
            for (opt = def->opts; opt->name; opt++) {
11381 11382
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
11383
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
11384 11385
                    break;
                case VSH_OT_INT:
11386 11387 11388
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
11389 11390
                    break;
                case VSH_OT_STRING:
11391
                    /* OT_STRING should never be VSH_OFLAG_REQ */
11392
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
11393 11394
                    break;
                case VSH_OT_DATA:
11395 11396
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
11397 11398 11399 11400 11401 11402 11403
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
                    continue;
                default:
                    assert(0);
                }
11404

E
Eric Blake 已提交
11405
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
11406
            }
K
Karel Zak 已提交
11407 11408 11409
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
11410
    return true;
K
Karel Zak 已提交
11411 11412 11413 11414 11415 11416
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
11417 11418 11419
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
11420 11421
    vshCmdOpt *a = arg;

11422
    while (a) {
K
Karel Zak 已提交
11423
        vshCmdOpt *tmp = a;
11424

K
Karel Zak 已提交
11425 11426
        a = a->next;

11427 11428
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
11429 11430 11431 11432
    }
}

static void
11433
vshCommandFree(vshCmd *cmd)
11434
{
K
Karel Zak 已提交
11435 11436
    vshCmd *c = cmd;

11437
    while (c) {
K
Karel Zak 已提交
11438
        vshCmd *tmp = c;
11439

K
Karel Zak 已提交
11440 11441 11442 11443
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
11444
        VIR_FREE(tmp);
K
Karel Zak 已提交
11445 11446 11447 11448 11449 11450 11451
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
11452
vshCommandOpt(const vshCmd *cmd, const char *name)
11453
{
K
Karel Zak 已提交
11454
    vshCmdOpt *opt = cmd->opts;
11455 11456

    while (opt) {
11457
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
11458 11459 11460 11461 11462 11463 11464
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
11465 11466 11467 11468 11469 11470 11471 11472 11473
 * @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 已提交
11474 11475
 */
static int
11476
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
11477
{
K
Karel Zak 已提交
11478
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11479
    int ret = 0, num;
11480
    char *end_p = NULL;
11481

11482
    if ((arg != NULL) && (arg->data != NULL)) {
11483 11484 11485 11486 11487 11488
        num = strtol(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11489
    }
11490
    return ret;
K
Karel Zak 已提交
11491 11492
}

11493 11494 11495 11496 11497 11498
/*
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
11499 11500
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11501 11502
    int ret = 0;
    unsigned long num;
11503 11504 11505
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
11506 11507 11508 11509 11510 11511
        num = strtoul(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11512
    }
11513
    return ret;
11514 11515
}

K
Karel Zak 已提交
11516 11517
/*
 * Returns option as STRING
11518
 * See vshCommandOptInt()
K
Karel Zak 已提交
11519
 */
11520 11521
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
11522
{
K
Karel Zak 已提交
11523
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11524 11525 11526
    int ret = 0;

    if (arg && arg->data) {
E
Eric Blake 已提交
11527 11528 11529 11530
        if (*arg->data
            || (arg->def && (arg->def->flag & VSH_OFLAG_EMPTY_OK))) {
            *value = arg->data;
            ret = 1;
11531 11532
        } else if (arg->def && ((arg->def->flag) & VSH_OFLAG_REQ)) {
            vshError(NULL, _("Missing required option '%s'"), name);
E
Eric Blake 已提交
11533 11534 11535 11536
            ret = -1;
        } else {
            /* Treat "--option ''" as if option had not been specified. */
            ret = 0;
11537 11538
        }
    }
11539

11540
    return ret;
K
Karel Zak 已提交
11541 11542
}

11543 11544
/*
 * Returns option as long long
11545
 * See vshCommandOptInt()
11546
 */
11547 11548 11549
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
11550 11551
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11552 11553
    int ret = 0;
    long long num;
11554 11555
    char *end_p = NULL;

11556 11557 11558 11559 11560 11561 11562 11563 11564
    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;
11565 11566
}

11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587
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 已提交
11588
/*
E
Eric Blake 已提交
11589
 * Returns true/false if the option exists
K
Karel Zak 已提交
11590
 */
E
Eric Blake 已提交
11591
static bool
11592
vshCommandOptBool(const vshCmd *cmd, const char *name)
11593
{
E
Eric Blake 已提交
11594
    return vshCommandOpt(cmd, name) != NULL;
K
Karel Zak 已提交
11595 11596
}

11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617
/*
 * Returns the COUNT argv argument, or NULL after last argument.
 *
 * Requires that a VSH_OT_ARGV option with the name "" be last in the
 * list of supported options in CMD->def->opts.
 */
static char *
vshCommandOptArgv(const vshCmd *cmd, int count)
{
    vshCmdOpt *opt = cmd->opts;

    while (opt) {
        if (opt->def && opt->def->type == VSH_OT_ARGV) {
            if (count-- == 0)
                return opt->data;
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635
/* 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)
11636
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
11637 11638 11639
                 cmd->def->name, optname);
    return found;
}
11640

K
Karel Zak 已提交
11641
static virDomainPtr
J
Jim Meyering 已提交
11642
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
11643
                      const char **name, int flag)
11644
{
K
Karel Zak 已提交
11645
    virDomainPtr dom = NULL;
11646
    const char *n = NULL;
K
Karel Zak 已提交
11647
    int id;
J
Jim Meyering 已提交
11648 11649 11650
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11651

11652
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11653 11654
        return NULL;

K
Karel Zak 已提交
11655
    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
11656 11657
             cmd->def->name, optname, n);

K
Karel Zak 已提交
11658 11659
    if (name)
        *name = n;
11660

K
Karel Zak 已提交
11661
    /* try it by ID */
11662
    if (flag & VSH_BYID) {
11663
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
11664 11665 11666 11667
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
11668
    }
K
Karel Zak 已提交
11669
    /* try it by UUID */
11670
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
11671
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
11672
                 cmd->def->name, optname);
K
Karel Zak 已提交
11673
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
11674
    }
K
Karel Zak 已提交
11675
    /* try it by NAME */
11676
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11677
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
11678
                 cmd->def->name, optname);
K
Karel Zak 已提交
11679
        dom = virDomainLookupByName(ctl->conn, n);
11680
    }
K
Karel Zak 已提交
11681

11682
    if (!dom)
11683
        vshError(ctl, _("failed to get domain '%s'"), n);
11684

K
Karel Zak 已提交
11685 11686 11687
    return dom;
}

11688
static virNetworkPtr
J
Jim Meyering 已提交
11689
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
11690
                       const char **name, int flag)
11691 11692
{
    virNetworkPtr network = NULL;
11693
    const char *n = NULL;
J
Jim Meyering 已提交
11694 11695 11696
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11697

11698
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11699 11700 11701 11702 11703 11704 11705 11706 11707
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
11708
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
11709
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
11710
                 cmd->def->name, optname);
11711 11712 11713 11714
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11715
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
11716 11717 11718 11719 11720
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
11721
        vshError(ctl, _("failed to get network '%s'"), n);
11722 11723 11724 11725

    return network;
}

11726 11727 11728

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
11729
                        const char **name, int flag)
11730 11731
{
    virNWFilterPtr nwfilter = NULL;
11732
    const char *n = NULL;
11733 11734 11735 11736
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11737
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764
        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;
}

11765 11766
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
11767
                         const char **name, int flag)
11768 11769
{
    virInterfacePtr iface = NULL;
11770
    const char *n = NULL;
11771 11772 11773 11774
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11775
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11776 11777 11778 11779 11780 11781 11782 11783 11784
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
11785
    if ((flag & VSH_BYNAME)) {
11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797
        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)
11798
        vshError(ctl, _("failed to get interface '%s'"), n);
11799 11800 11801 11802

    return iface;
}

11803
static virStoragePoolPtr
11804
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
11805
                    const char **name, int flag)
11806 11807
{
    virStoragePoolPtr pool = NULL;
11808
    const char *n = NULL;
11809

11810
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11811 11812 11813 11814 11815 11816 11817 11818 11819
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
11820
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
11821
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
11822
                 cmd->def->name, optname);
11823 11824 11825
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
11826
    if (pool == NULL && (flag & VSH_BYNAME)) {
11827 11828 11829 11830 11831 11832
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
11833
        vshError(ctl, _("failed to get pool '%s'"), n);
11834 11835 11836 11837 11838

    return pool;
}

static virStorageVolPtr
11839
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
11840 11841
                   const char *optname,
                   const char *pooloptname,
11842
                   const char **name, int flag)
11843 11844 11845
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
11846
    const char *n = NULL, *p = NULL;
11847

11848
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11849 11850
        return NULL;

11851 11852
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
11853
        return NULL;
11854
    }
11855 11856 11857 11858 11859 11860 11861 11862 11863 11864

    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;

11865
    /* try it by name */
11866
    if (pool && (flag & VSH_BYNAME)) {
11867
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
11868 11869 11870
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
11871
    /* try it by key */
11872 11873 11874 11875 11876
    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);
    }
11877
    /* try it by path */
11878 11879 11880 11881 11882 11883 11884
    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)
11885
        vshError(ctl, _("failed to get vol '%s'"), n);
11886 11887 11888 11889 11890 11891 11892

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

11893
static virSecretPtr
11894
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
11895 11896
{
    virSecretPtr secret = NULL;
11897
    const char *n = NULL;
11898 11899 11900 11901 11902
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11903
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11904 11905 11906 11907 11908 11909 11910 11911 11912 11913
        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)
11914
        vshError(ctl, _("failed to get secret '%s'"), n);
11915 11916 11917 11918

    return secret;
}

K
Karel Zak 已提交
11919 11920 11921
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
11922
static bool
11923
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
11924
{
E
Eric Blake 已提交
11925
    bool ret = true;
11926 11927

    while (cmd) {
K
Karel Zak 已提交
11928
        struct timeval before, after;
11929
        bool enable_timing = ctl->timing;
11930

11931 11932
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
11933 11934
            vshReconnect(ctl);

11935
        if (enable_timing)
K
Karel Zak 已提交
11936
            GETTIMEOFDAY(&before);
11937

K
Karel Zak 已提交
11938 11939
        ret = cmd->def->handler(ctl, cmd);

11940
        if (enable_timing)
K
Karel Zak 已提交
11941
            GETTIMEOFDAY(&after);
11942

11943
        if (!ret)
J
John Levon 已提交
11944 11945
            virshReportError(ctl);

11946
        /* try to automatically catch disconnections */
11947
        if (!ret &&
11948 11949 11950 11951 11952 11953 11954 11955 11956
            ((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);

11957
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
11958 11959
            return ret;

11960
        if (enable_timing)
11961
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
11962 11963
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
11964
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
11965 11966 11967 11968 11969 11970
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
11971
 * Command parsing
K
Karel Zak 已提交
11972 11973 11974
 * ---------------
 */

11975 11976 11977 11978 11979 11980 11981 11982 11983 11984
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 已提交
11985
    /* vshCommandStringGetArg() */
11986
    char *pos;
L
Lai Jiangshan 已提交
11987 11988 11989
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
11990 11991
} vshCommandParser;

E
Eric Blake 已提交
11992
static bool
11993
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
11994
{
K
Karel Zak 已提交
11995 11996 11997
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
11998

K
Karel Zak 已提交
11999 12000 12001 12002
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
12003

12004
    while (1) {
K
Karel Zak 已提交
12005
        vshCmdOpt *last = NULL;
12006
        const vshCmdDef *cmd = NULL;
12007
        vshCommandToken tk;
L
Lai Jiangshan 已提交
12008
        bool data_only = false;
12009 12010 12011
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
12012

K
Karel Zak 已提交
12013
        first = NULL;
12014

12015
        while (1) {
12016
            const vshCmdOptDef *opt = NULL;
12017

K
Karel Zak 已提交
12018
            tkdata = NULL;
12019
            tk = parser->getNextArg(ctl, parser, &tkdata);
12020 12021

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
12022
                goto syntaxError;
H
Hu Tao 已提交
12023 12024
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
12025
                break;
H
Hu Tao 已提交
12026
            }
12027 12028

            if (cmd == NULL) {
K
Karel Zak 已提交
12029 12030
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
12031
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
12032
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
12033
                }
12034 12035 12036 12037 12038 12039 12040
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
12041
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
12042 12043 12044 12045
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
12046 12047 12048 12049 12050
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
12051 12052
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
12053
                    VIR_FREE(optstr);
K
Karel Zak 已提交
12054 12055
                    goto syntaxError;
                }
12056
                VIR_FREE(tkdata);
K
Karel Zak 已提交
12057 12058 12059

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
12060 12061 12062
                    if (optstr)
                        tkdata = optstr;
                    else
12063
                        tk = parser->getNextArg(ctl, parser, &tkdata);
12064
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
12065
                        goto syntaxError;
12066
                    if (tk != VSH_TK_ARG) {
12067
                        vshError(ctl,
12068
                                 _("expected syntax: --%s <%s>"),
12069 12070
                                 opt->name,
                                 opt->type ==
12071
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
12072 12073
                        goto syntaxError;
                    }
12074
                    opts_need_arg &= ~opts_seen;
12075 12076 12077 12078 12079 12080 12081 12082
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
12083
                }
L
Lai Jiangshan 已提交
12084 12085 12086 12087
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
12088
            } else {
L
Lai Jiangshan 已提交
12089
get_data:
12090 12091
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
12092
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
12093 12094 12095 12096 12097
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
12098
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
12099

K
Karel Zak 已提交
12100 12101 12102 12103
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
12104

K
Karel Zak 已提交
12105 12106 12107 12108 12109
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
12110

K
Karel Zak 已提交
12111
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
12112 12113
                         cmd->name,
                         opt->name,
12114 12115
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
12116 12117
            }
        }
12118

D
Daniel Veillard 已提交
12119
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
12120
        if (cmd) {
12121
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
12122

K
Karel Zak 已提交
12123 12124 12125 12126
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

12127
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
12128
                VIR_FREE(c);
12129
                goto syntaxError;
12130
            }
12131

K
Karel Zak 已提交
12132 12133 12134 12135 12136 12137
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
12138 12139 12140

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
12141
    }
12142

E
Eric Blake 已提交
12143
    return true;
K
Karel Zak 已提交
12144

12145
 syntaxError:
12146
    if (ctl->cmd) {
K
Karel Zak 已提交
12147
        vshCommandFree(ctl->cmd);
12148 12149
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
12150 12151
    if (first)
        vshCommandOptFree(first);
12152
    VIR_FREE(tkdata);
E
Eric Blake 已提交
12153
    return false;
K
Karel Zak 已提交
12154 12155
}

12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173
/* --------------------
 * 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 已提交
12174 12175
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
12176 12177 12178 12179
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
12180
        return false;
12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252

    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 已提交
12253 12254
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
12255 12256 12257 12258
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
12259
        return false;
12260 12261 12262 12263 12264 12265

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
12266
/* ---------------
12267
 * Misc utils
K
Karel Zak 已提交
12268 12269
 * ---------------
 */
12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297
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 已提交
12298
static const char *
12299 12300
vshDomainStateToString(int state)
{
12301
    switch ((virDomainState) state) {
12302
    case VIR_DOMAIN_RUNNING:
12303
        return N_("running");
12304
    case VIR_DOMAIN_BLOCKED:
12305
        return N_("idle");
12306
    case VIR_DOMAIN_PAUSED:
12307
        return N_("paused");
12308
    case VIR_DOMAIN_SHUTDOWN:
12309
        return N_("in shutdown");
12310
    case VIR_DOMAIN_SHUTOFF:
12311
        return N_("shut off");
12312
    case VIR_DOMAIN_CRASHED:
12313
        return N_("crashed");
12314
    case VIR_DOMAIN_NOSTATE:
12315
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
12316
    }
12317
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
12318 12319
}

12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420
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");
}

12421 12422 12423 12424
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
12425
    case VIR_VCPU_OFFLINE:
12426
        return N_("offline");
12427
    case VIR_VCPU_BLOCKED:
12428
        return N_("idle");
12429
    case VIR_VCPU_RUNNING:
12430
        return N_("running");
12431
    default:
12432
        ;/*FALLTHROUGH*/
12433
    }
12434
    return N_("no state");
12435 12436
}

E
Eric Blake 已提交
12437
static bool
12438
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
12439
{
12440 12441
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
12442 12443
     */
    if (!conn) {
12444
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
12445
        return false;
K
Karel Zak 已提交
12446
    }
E
Eric Blake 已提交
12447
    return true;
K
Karel Zak 已提交
12448 12449
}

K
Karel Zak 已提交
12450
static void
12451
vshDebug(vshControl *ctl, int level, const char *format, ...)
12452
{
K
Karel Zak 已提交
12453
    va_list ap;
12454
    char *str;
K
Karel Zak 已提交
12455

12456 12457 12458 12459
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
12460 12461 12462 12463
    if (level > ctl->debug)
        return;

    va_start(ap, format);
12464 12465 12466 12467 12468
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
12469
    va_end(ap);
12470 12471
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
12472 12473 12474
}

static void
12475
vshPrintExtra(vshControl *ctl, const char *format, ...)
12476
{
K
Karel Zak 已提交
12477
    va_list ap;
12478
    char *str;
12479

12480
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
12481
        return;
12482

K
Karel Zak 已提交
12483
    va_start(ap, format);
12484 12485 12486 12487 12488
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
12489
    va_end(ap);
12490
    fputs(str, stdout);
12491
    VIR_FREE(str);
K
Karel Zak 已提交
12492 12493
}

K
Karel Zak 已提交
12494

K
Karel Zak 已提交
12495
static void
12496
vshError(vshControl *ctl, const char *format, ...)
12497
{
K
Karel Zak 已提交
12498
    va_list ap;
12499
    char *str;
12500

12501 12502 12503 12504 12505
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
12506

12507
    fputs(_("error: "), stderr);
12508

K
Karel Zak 已提交
12509
    va_start(ap, format);
12510 12511 12512
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
12513 12514
    va_end(ap);

12515 12516
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
12517 12518
}

12519

K
Karel Zak 已提交
12520
/*
12521
 * Initialize connection.
K
Karel Zak 已提交
12522
 */
E
Eric Blake 已提交
12523
static bool
12524
vshInit(vshControl *ctl)
12525
{
12526 12527
    char *debugEnv;

K
Karel Zak 已提交
12528
    if (ctl->conn)
E
Eric Blake 已提交
12529
        return false;
K
Karel Zak 已提交
12530

12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551
    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);
        }
    }

12552 12553
    vshOpenLogFile(ctl);

12554 12555
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
12556

12557 12558 12559
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

12560
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
12561
        return false;
12562

12563 12564 12565 12566
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
12567

12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578
        /* 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;
        }
12579
    }
K
Karel Zak 已提交
12580

E
Eric Blake 已提交
12581
    return true;
K
Karel Zak 已提交
12582 12583
}

12584 12585
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604
/**
 * 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:
12605
                vshError(ctl, "%s",
J
Jim Meyering 已提交
12606
                         _("failed to get the log file information"));
12607
                exit(EXIT_FAILURE);
12608 12609 12610
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
12611 12612
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
12613 12614 12615 12616
        }
    }

    /* log file open */
12617
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
12618
        vshError(ctl, "%s",
J
Jim Meyering 已提交
12619
                 _("failed to open the log file. check the log file path"));
12620
        exit(EXIT_FAILURE);
12621 12622 12623 12624 12625 12626 12627 12628 12629
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
12630 12631
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
12632
{
12633 12634 12635
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649
    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);
12650
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
12651 12652 12653 12654 12655 12656
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
12657 12658
                      SIGN_NAME,
                      (int) getpid());
12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678
    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;
    }
12679 12680 12681
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
12682

12683 12684
    if (virBufferError(&buf))
        goto error;
12685

12686 12687 12688 12689 12690
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
12691
    }
12692

12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703
    /* 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);
12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
12715 12716 12717
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
12718 12719 12720
    }

    if (ctl->logfile) {
12721
        VIR_FREE(ctl->logfile);
12722 12723 12724 12725
        ctl->logfile = NULL;
    }
}

12726
#ifdef USE_READLINE
12727

K
Karel Zak 已提交
12728 12729 12730 12731 12732
/* -----------------
 * Readline stuff
 * -----------------
 */

12733
/*
K
Karel Zak 已提交
12734 12735
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
12736
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
12737 12738
 */
static char *
12739 12740
vshReadlineCommandGenerator(const char *text, int state)
{
12741
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
12742
    const char *name;
12743 12744
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
12745 12746

    if (!state) {
12747 12748
        grp_list_index = 0;
        cmd_list_index = 0;
12749
        len = strlen(text);
K
Karel Zak 已提交
12750 12751
    }

12752 12753
    grp = cmdGroups;

K
Karel Zak 已提交
12754
    /* Return the next name which partially matches from the
12755
     * command list.
K
Karel Zak 已提交
12756
     */
12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770
    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 已提交
12771 12772 12773 12774 12775 12776 12777
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
12778 12779
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
12780
    static int list_index, len;
12781
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
12782
    const char *name;
K
Karel Zak 已提交
12783 12784 12785 12786 12787 12788 12789 12790 12791

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

12792
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
12793
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
12794 12795 12796

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
12797
        len = strlen(text);
12798
        VIR_FREE(cmdname);
K
Karel Zak 已提交
12799 12800 12801 12802
    }

    if (!cmd)
        return NULL;
12803

12804 12805 12806
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
12807
    while ((name = cmd->opts[list_index].name)) {
12808
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
12809
        char *res;
12810

K
Karel Zak 已提交
12811
        list_index++;
12812

K
Karel Zak 已提交
12813
        if (opt->type == VSH_OT_DATA)
K
Karel Zak 已提交
12814 12815
            /* ignore non --option */
            continue;
12816

K
Karel Zak 已提交
12817
        if (len > 2) {
12818
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
12819 12820
                continue;
        }
12821
        res = vshMalloc(NULL, strlen(name) + 3);
12822
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
12823 12824 12825 12826 12827 12828 12829 12830
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
12831 12832 12833
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
12834 12835
    char **matches = (char **) NULL;

12836
    if (start == 0)
K
Karel Zak 已提交
12837
        /* command name generator */
12838
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
12839 12840
    else
        /* commands options */
12841
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
12842 12843 12844 12845
    return matches;
}


12846 12847
static int
vshReadlineInit(vshControl *ctl)
12848
{
12849 12850
    char *userdir = NULL;

K
Karel Zak 已提交
12851 12852 12853 12854 12855
    /* 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;
12856 12857 12858

    /* Limit the total size of the history buffer */
    stifle_history(500);
12859 12860

    /* Prepare to read/write history from/to the ~/.virsh/history file */
12861
    userdir = virGetUserDirectory(getuid());
12862

12863 12864
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
12865
        return -1;
12866
    }
12867 12868 12869

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12870
        VIR_FREE(userdir);
12871 12872 12873 12874 12875
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12876
        VIR_FREE(userdir);
12877 12878 12879
        return -1;
    }

12880
    VIR_FREE(userdir);
12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898

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

12899 12900
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
12901 12902
}

12903 12904 12905 12906 12907 12908
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

12909
#else /* !USE_READLINE */
12910

12911 12912 12913 12914 12915 12916 12917
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

12918
static void
12919
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942
{
    /* 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);
}

12943
#endif /* !USE_READLINE */
12944

K
Karel Zak 已提交
12945
/*
J
Jim Meyering 已提交
12946
 * Deinitialize virsh
K
Karel Zak 已提交
12947
 */
E
Eric Blake 已提交
12948
static bool
12949
vshDeinit(vshControl *ctl)
12950
{
12951
    vshReadlineDeinit(ctl);
12952
    vshCloseLogFile(ctl);
12953
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
12954
    if (ctl->conn) {
12955 12956 12957
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
12958 12959
        }
    }
D
Daniel P. Berrange 已提交
12960 12961
    virResetLastError();

E
Eric Blake 已提交
12962
    return true;
K
Karel Zak 已提交
12963
}
12964

K
Karel Zak 已提交
12965 12966 12967 12968
/*
 * Print usage
 */
static void
12969
vshUsage(void)
12970
{
12971
    const vshCmdGrp *grp;
12972
    const vshCmdDef *cmd;
12973

L
Lai Jiangshan 已提交
12974 12975
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
12976 12977 12978
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
12979
                      "    -d | --debug <num>      debug level [0-4]\n"
12980 12981 12982 12983
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
12984
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
12985
                      "    -V | --version=long     version and full options\n\n"
12986
                      "  commands (non interactive mode):\n\n"), progname, progname);
12987

12988 12989
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
12990

12991 12992 12993 12994 12995 12996 12997 12998 12999
        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"));
13000 13001 13002
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
13003 13004
}

13005 13006 13007 13008 13009 13010 13011 13012 13013 13014
/*
 * 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 已提交
13015 13016
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
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 13050 13051
#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 已提交
13052
    vshPrint(ctl, "%s", _(" Networking:"));
13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078
#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 已提交
13079
    vshPrint(ctl, "%s", _(" Storage:"));
13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102
#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 已提交
13103
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
13104
#ifdef WITH_SECDRIVER_APPARMOR
13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127
    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 已提交
13128 13129 13130 13131
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
13132
static bool
13133
vshParseArgv(vshControl *ctl, int argc, char **argv)
13134
{
13135 13136
    bool help = false;
    int arg;
K
Karel Zak 已提交
13137
    struct option opt[] = {
E
Eric Blake 已提交
13138 13139 13140 13141 13142 13143 13144 13145 13146
        {"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}
13147 13148
    };

13149 13150 13151
    /* 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. */
13152
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
13153
        switch (arg) {
13154
        case 'd':
D
Daniel Veillard 已提交
13155
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
13156
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
13157 13158
                exit(EXIT_FAILURE);
            }
13159 13160
            break;
        case 'h':
13161
            help = true;
13162 13163
            break;
        case 'q':
E
Eric Blake 已提交
13164
            ctl->quiet = true;
13165 13166
            break;
        case 't':
E
Eric Blake 已提交
13167
            ctl->timing = true;
13168 13169 13170 13171
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
13172 13173 13174 13175 13176 13177
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
13178 13179 13180
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
13181
        case 'r':
E
Eric Blake 已提交
13182
            ctl->readonly = true;
13183
            break;
13184 13185 13186
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
13187
        default:
13188 13189
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
13190 13191 13192 13193
        }
    }

    if (help) {
13194 13195
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
13196 13197
            exit(EXIT_FAILURE);
        }
13198 13199 13200

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
13201
        exit(EXIT_SUCCESS);
13202 13203
    }

13204
    if (argc > optind) {
K
Karel Zak 已提交
13205
        /* parse command */
E
Eric Blake 已提交
13206
        ctl->imode = false;
13207 13208 13209
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
13210
        } else {
13211
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
13212 13213
        }
    }
E
Eric Blake 已提交
13214
    return true;
K
Karel Zak 已提交
13215 13216
}

13217 13218 13219 13220
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
13221
    char *defaultConn;
E
Eric Blake 已提交
13222
    bool ret = true;
K
Karel Zak 已提交
13223

13224 13225 13226
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
13227
    ctl->debug = -1;            /* Initialize log level */
13228

13229 13230
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
13231
        /* failure to setup locale is not fatal */
13232
    }
13233
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
13234
        perror("bindtextdomain");
E
Eric Blake 已提交
13235
        return EXIT_FAILURE;
13236
    }
13237
    if (!textdomain(PACKAGE)) {
13238
        perror("textdomain");
E
Eric Blake 已提交
13239
        return EXIT_FAILURE;
13240 13241
    }

13242 13243 13244 13245 13246
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

13247
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
13248 13249 13250
        progname = argv[0];
    else
        progname++;
13251

13252
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
13253
        ctl->name = vshStrdup(ctl, defaultConn);
13254 13255
    }

D
Daniel P. Berrange 已提交
13256 13257
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
13258
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
13259
    }
13260

D
Daniel P. Berrange 已提交
13261 13262
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
13263
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
13264
    }
13265

K
Karel Zak 已提交
13266
    if (!ctl->imode) {
13267
        ret = vshCommandRun(ctl, ctl->cmd);
13268
    } else {
K
Karel Zak 已提交
13269 13270
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
13271
            vshPrint(ctl,
13272
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
13273
                     progname);
J
Jim Meyering 已提交
13274
            vshPrint(ctl, "%s",
13275
                     _("Type:  'help' for help with commands\n"
13276
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
13277
        }
13278 13279 13280 13281 13282 13283

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
13284
        do {
13285
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
13286
            ctl->cmdstr =
13287
                vshReadline(ctl, prompt);
13288 13289
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
13290
            if (*ctl->cmdstr) {
13291
#if USE_READLINE
K
Karel Zak 已提交
13292
                add_history(ctl->cmdstr);
13293
#endif
13294
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
13295 13296
                    vshCommandRun(ctl, ctl->cmd);
            }
13297
            VIR_FREE(ctl->cmdstr);
13298
        } while (ctl->imode);
K
Karel Zak 已提交
13299

13300 13301
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
13302
    }
13303

K
Karel Zak 已提交
13304 13305
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
13306
}