virsh.c 370.1 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 1620
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
                   virSchedParameterPtr param)
1621
{
1622
    const char *data = NULL;
1623 1624 1625 1626 1627 1628

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
        param->type == VIR_DOMAIN_SCHED_FIELD_UINT &&
        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 1640 1641 1642
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
        param->type == VIR_DOMAIN_SCHED_FIELD_UINT &&
        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 1668 1669
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
        case VIR_DOMAIN_SCHED_FIELD_INT:
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
1670
                vshError(ctl, "%s",
1671 1672 1673 1674 1675 1676
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_UINT:
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
1677
                vshError(ctl, "%s",
1678 1679 1680 1681 1682 1683
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_LLONG:
            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 1689 1690
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_ULLONG:
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
1691
                vshError(ctl, "%s",
1692 1693 1694 1695 1696 1697
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_DOUBLE:
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
1698
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
1699 1700 1701 1702 1703
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_BOOLEAN:
            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 1717 1718 1719 1720
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
    virSchedParameterPtr params = NULL;
    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 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
    if (nparams) {
        params = vshMalloc(ctl, sizeof(virSchedParameter)* nparams);

        memset(params, 0, sizeof(virSchedParameter)* nparams);
        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 1803
        for (i = 0; i < nparams; i++){
            switch (params[i].type) {
            case VIR_DOMAIN_SCHED_FIELD_INT:
1804
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1805 1806
                 break;
            case VIR_DOMAIN_SCHED_FIELD_UINT:
1807
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1808 1809
                 break;
            case VIR_DOMAIN_SCHED_FIELD_LLONG:
1810
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1811 1812
                 break;
            case VIR_DOMAIN_SCHED_FIELD_ULLONG:
1813
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1814 1815
                 break;
            case VIR_DOMAIN_SCHED_FIELD_DOUBLE:
1816
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1817 1818
                 break;
            case VIR_DOMAIN_SCHED_FIELD_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 3184
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
    unsigned int i = 0;
    virBlkioParameterPtr 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 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259
            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) {
                case VIR_DOMAIN_BLKIO_PARAM_INT:
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_UINT:
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_LLONG:
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_ULLONG:
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_DOUBLE:
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_BOOLEAN:
                    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 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

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

            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 3324
    int nparams = 0;
    unsigned int i = 0;
    virMemoryParameterPtr 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 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
                case VIR_DOMAIN_MEMORY_PARAM_INT:
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
                case VIR_DOMAIN_MEMORY_PARAM_UINT:
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
                case VIR_DOMAIN_MEMORY_PARAM_LLONG:
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
                case VIR_DOMAIN_MEMORY_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 3413 3414 3415 3416 3417 3418 3419 3420 3421
                    break;
                case VIR_DOMAIN_MEMORY_PARAM_DOUBLE:
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
                case VIR_DOMAIN_MEMORY_PARAM_BOOLEAN:
                    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 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452

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

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

/*
 * "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 已提交
5156
static bool
5157 5158 5159
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
5160
    const char *from = NULL;
E
Eric Blake 已提交
5161
    bool ret = true;
5162 5163
    char *buffer;

5164
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5165
        return false;
5166

5167
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5168
        return false;
5169 5170

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5171
        return false;
5172 5173 5174 5175 5176 5177 5178 5179 5180 5181

    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 已提交
5182
        ret = false;
5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201
    }
    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 已提交
5202
static bool
5203 5204 5205
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5206
    bool ret = true;
5207
    const char *name;
5208

5209
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5210
        return false;
5211 5212

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
5213
        return false;
5214 5215 5216 5217 5218

    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 已提交
5219
        ret = false;
5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240
    }

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

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

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
5252
        return false;
5253 5254 5255

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
5256
        vshPrint(ctl, "%s", dump);
5257 5258
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
5259
        ret = false;
5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278
    }

    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 已提交
5279
static bool
5280 5281 5282 5283 5284 5285
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
5292
        return false;
5293 5294 5295 5296 5297 5298 5299 5300
    }

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

    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 已提交
5329
    return true;
5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346
}


/*
 * "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 已提交
5347
static bool
5348 5349
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5350
    bool ret = false;
5351 5352 5353 5354 5355 5356
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

5357
    if (!vshConnectionUsability(ctl, ctl->conn))
5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383
        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 已提交
5384
        ret = true;
5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410
        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 已提交
5411
    ret = true;
5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429

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


5430
/**************************************************************************/
5431
/*
5432
 * "pool-autostart" command
5433
 */
5434
static const vshCmdInfo info_pool_autostart[] = {
5435
    {"help", N_("autostart a pool")},
5436
    {"desc",
5437
     N_("Configure a pool to be automatically started at boot.")},
5438
    {NULL, NULL}
5439 5440
};

5441
static const vshCmdOptDef opts_pool_autostart[] = {
5442 5443
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5444 5445
    {NULL, 0, 0, NULL}
};
5446

E
Eric Blake 已提交
5447
static bool
5448
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
5449
{
5450
    virStoragePoolPtr pool;
5451
    const char *name;
5452
    int autostart;
5453

5454
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5455
        return false;
5456

5457
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5458
        return false;
5459

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

5462 5463
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
5464
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
5465
        else
5466
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
5467
        virStoragePoolFree(pool);
E
Eric Blake 已提交
5468
        return false;
5469 5470
    }

5471
    if (autostart)
5472
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
5473
    else
5474
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
5475

L
Laine Stump 已提交
5476
    virStoragePoolFree(pool);
E
Eric Blake 已提交
5477
    return true;
5478 5479
}

5480
/*
5481
 * "pool-create" command
5482
 */
5483
static const vshCmdInfo info_pool_create[] = {
5484 5485
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
5486 5487 5488
    {NULL, NULL}
};

5489
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
5490
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
5491
     N_("file containing an XML pool description")},
5492 5493 5494
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5495
static bool
5496
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
5497
{
5498
    virStoragePoolPtr pool;
5499
    const char *from = NULL;
E
Eric Blake 已提交
5500
    bool ret = true;
5501
    char *buffer;
5502

5503
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5504
        return false;
5505

5506
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5507
        return false;
5508

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

5512
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
5513
    VIR_FREE(buffer);
5514 5515 5516 5517

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5518
        virStoragePoolFree(pool);
5519
    } else {
5520
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
5521
        ret = false;
5522 5523
    }
    return ret;
5524 5525
}

5526

5527 5528 5529 5530
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
5531
    {"help", N_("create a device defined "
5532
                          "by an XML file on the node")},
5533
    {"desc", N_("Create a device on the node.  Note that this "
5534 5535 5536 5537 5538 5539 5540
                          "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,
5541
     N_("file containing an XML description of the device")},
5542 5543 5544
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5545
static bool
5546 5547 5548
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
5549
    const char *from = NULL;
E
Eric Blake 已提交
5550
    bool ret = true;
5551 5552
    char *buffer;

5553
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5554
        return false;
5555

5556
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5557
        return false;
5558

5559
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5560
        return false;
5561 5562

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
5563
    VIR_FREE(buffer);
5564 5565 5566 5567

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
5568
        virNodeDeviceFree(dev);
5569
    } else {
5570
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
5571
        ret = false;
5572 5573 5574 5575 5576 5577 5578 5579 5580 5581
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
5582 5583
    {"help", N_("destroy a device on the node")},
    {"desc", N_("Destroy a device on the node.  Note that this "
5584 5585 5586 5587 5588 5589
                          "command destroys devices on the physical host ")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
5590
     N_("name of the device to be destroyed")},
5591 5592 5593
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5594
static bool
5595 5596 5597
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
5598
    bool ret = true;
5599
    const char *name = NULL;
5600

5601
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
5602
        return false;
5603 5604
    }

5605
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
5606
        return false;
5607 5608 5609 5610 5611 5612

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
5613
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
5614
        ret = false;
5615 5616 5617 5618 5619 5620 5621
    }

    virNodeDeviceFree(dev);
    return ret;
}


5622
/*
5623
 * XML Building helper for pool-define-as and pool-create-as
5624
 */
5625
static const vshCmdOptDef opts_pool_X_as[] = {
5626 5627 5628 5629 5630 5631 5632 5633
    {"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")},
5634
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
5635 5636 5637
    {NULL, 0, 0, NULL}
};

5638
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
5639

5640 5641
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
5642
    virBuffer buf = VIR_BUFFER_INITIALIZER;
5643

5644
    if (vshCommandOptString(cmd, "name", &name) <= 0)
5645
        goto cleanup;
5646
    if (vshCommandOptString(cmd, "type", &type) <= 0)
5647 5648
        goto cleanup;

5649 5650 5651 5652 5653
    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 ||
5654 5655
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
5656
        goto cleanup;
5657
    }
5658

5659 5660
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
5661
    if (srcHost || srcPath || srcDev) {
5662
        virBufferAddLit(&buf, "  <source>\n");
5663

5664
        if (srcHost)
5665
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
5666
        if (srcPath)
5667
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
5668
        if (srcDev)
5669
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
5670
        if (srcFormat)
5671
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
5672
        if (srcName)
5673
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
5674 5675

        virBufferAddLit(&buf, "  </source>\n");
5676 5677
    }
    if (target) {
5678
        virBufferAddLit(&buf, "  <target>\n");
5679
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
5680
        virBufferAddLit(&buf, "  </target>\n");
5681
    }
5682 5683 5684 5685
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
5686
        return false;
5687
    }
5688 5689 5690

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
5691
    return true;
5692 5693

cleanup:
5694
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
5695
    return false;
5696 5697 5698 5699 5700 5701
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
5702 5703
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
5704 5705 5706
    {NULL, NULL}
};

E
Eric Blake 已提交
5707
static bool
5708 5709 5710
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
5711 5712
    const char *name;
    char *xml;
5713
    int printXML = vshCommandOptBool(cmd, "print-xml");
5714

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

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

5721
    if (printXML) {
5722
        vshPrint(ctl, "%s", xml);
5723
        VIR_FREE(xml);
5724
    } else {
5725
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
5726
        VIR_FREE(xml);
5727

5728 5729 5730 5731
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
5732
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
5733
            return false;
5734 5735
        }
    }
E
Eric Blake 已提交
5736
    return true;
5737 5738
}

5739

5740
/*
5741
 * "pool-define" command
5742
 */
5743
static const vshCmdInfo info_pool_define[] = {
5744 5745
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
5746 5747 5748
    {NULL, NULL}
};

5749
static const vshCmdOptDef opts_pool_define[] = {
5750
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
5751 5752 5753
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5754
static bool
5755
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
5756
{
5757
    virStoragePoolPtr pool;
5758
    const char *from = NULL;
E
Eric Blake 已提交
5759
    bool ret = true;
5760
    char *buffer;
5761

5762
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5763
        return false;
5764

5765
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5766
        return false;
5767

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

5771
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
5772
    VIR_FREE(buffer);
5773 5774 5775 5776

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5777
        virStoragePoolFree(pool);
5778
    } else {
5779
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
5780
        ret = false;
5781 5782
    }
    return ret;
5783 5784
}

5785

5786 5787 5788
/*
 * "pool-define-as" command
 */
5789
static const vshCmdInfo info_pool_define_as[] = {
5790 5791
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
5792 5793 5794
    {NULL, NULL}
};

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

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

5806
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
5807
        return false;
5808

5809
    if (printXML) {
5810
        vshPrint(ctl, "%s", xml);
5811
        VIR_FREE(xml);
5812
    } else {
5813
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
5814
        VIR_FREE(xml);
5815

5816 5817 5818 5819
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
5820
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
5821
            return false;
5822 5823
        }
    }
E
Eric Blake 已提交
5824
    return true;
5825 5826 5827
}


5828
/*
5829
 * "pool-build" command
5830
 */
5831
static const vshCmdInfo info_pool_build[] = {
5832 5833
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
5834 5835 5836
    {NULL, NULL}
};

5837
static const vshCmdOptDef opts_pool_build[] = {
5838
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5839 5840 5841
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5842
static bool
5843
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
5844
{
5845
    virStoragePoolPtr pool;
E
Eric Blake 已提交
5846
    bool ret = true;
5847
    const char *name;
5848

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

5852
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5853
        return false;
5854

5855
    if (virStoragePoolBuild(pool, 0) == 0) {
5856
        vshPrint(ctl, _("Pool %s built\n"), name);
5857
    } else {
5858
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
5859
        ret = false;
5860 5861
    }

5862 5863
    virStoragePoolFree(pool);

5864 5865 5866
    return ret;
}

5867

5868
/*
5869
 * "pool-destroy" command
5870
 */
5871
static const vshCmdInfo info_pool_destroy[] = {
5872 5873
    {"help", N_("destroy a pool")},
    {"desc", N_("Destroy a given pool.")},
5874 5875 5876
    {NULL, NULL}
};

5877
static const vshCmdOptDef opts_pool_destroy[] = {
5878
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5879 5880 5881
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5882
static bool
5883
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
5884
{
5885
    virStoragePoolPtr pool;
E
Eric Blake 已提交
5886
    bool ret = true;
5887
    const char *name;
5888

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

5892
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5893
        return false;
5894

5895 5896 5897
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
5898
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
5899
        ret = false;
5900 5901
    }

5902
    virStoragePoolFree(pool);
5903 5904 5905
    return ret;
}

5906

5907
/*
5908 5909
 * "pool-delete" command
 */
5910
static const vshCmdInfo info_pool_delete[] = {
5911 5912
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
5913 5914 5915
    {NULL, NULL}
};

5916
static const vshCmdOptDef opts_pool_delete[] = {
5917
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5918 5919 5920
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5921
static bool
5922
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
5923 5924
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
5925
    bool ret = true;
5926
    const char *name;
5927

5928
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5929
        return false;
5930 5931

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5932
        return false;
5933 5934

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
5935
        vshPrint(ctl, _("Pool %s deleted\n"), name);
5936
    } else {
5937
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
5938
        ret = false;
5939 5940
    }

L
Laine Stump 已提交
5941
    virStoragePoolFree(pool);
5942 5943 5944 5945 5946 5947 5948
    return ret;
}


/*
 * "pool-refresh" command
 */
5949
static const vshCmdInfo info_pool_refresh[] = {
5950 5951
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
5952 5953 5954
    {NULL, NULL}
};

5955
static const vshCmdOptDef opts_pool_refresh[] = {
5956
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5957 5958 5959
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5960
static bool
5961
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
5962 5963
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
5964
    bool ret = true;
5965
    const char *name;
5966

5967
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5968
        return false;
5969 5970

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5971
        return false;
5972 5973 5974 5975

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
5976
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
5977
        ret = false;
5978 5979 5980 5981 5982 5983 5984 5985 5986 5987
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
5988
static const vshCmdInfo info_pool_dumpxml[] = {
5989 5990
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
5991 5992 5993
    {NULL, NULL}
};

5994
static const vshCmdOptDef opts_pool_dumpxml[] = {
5995
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5996 5997 5998
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5999
static bool
6000
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
6001 6002
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6003
    bool ret = true;
6004 6005
    char *dump;

6006
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6007
        return false;
6008 6009

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6010
        return false;
6011 6012 6013

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
6014
        vshPrint(ctl, "%s", dump);
6015
        VIR_FREE(dump);
6016
    } else {
E
Eric Blake 已提交
6017
        ret = false;
6018 6019 6020 6021 6022 6023 6024 6025 6026 6027
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
6028
static const vshCmdInfo info_pool_list[] = {
6029 6030
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
6031 6032 6033
    {NULL, NULL}
};

6034
static const vshCmdOptDef opts_pool_list[] = {
6035 6036
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
6037
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
6038 6039 6040
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6041
static bool
6042
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6043
{
6044 6045
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
6046 6047
    int i, ret;
    bool functionReturn;
6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063
    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 */
6064
    int all = vshCommandOptBool(cmd, "all");
6065 6066
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
6067 6068 6069
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

6070
    /* Check the connection to libvirtd daemon is still working */
6071
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6072
        return false;
6073

6074
    /* Retrieve the number of active storage pools */
6075
    if (active) {
6076 6077
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
6078
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
6079
            return false;
6080 6081
        }
    }
6082 6083

    /* Retrieve the number of inactive storage pools */
6084
    if (inactive) {
6085 6086
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
6087
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
6088
            return false;
6089
        }
6090
    }
6091

6092 6093
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
6094

6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106
    /* 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 已提交
6107
            return false;
6108 6109 6110
        }
    }

6111 6112 6113 6114 6115 6116 6117 6118
    /* 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 已提交
6119
            return false;
6120 6121
        }
    }
6122

6123 6124 6125 6126 6127 6128 6129 6130 6131 6132
    /* 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]);
6133
        if (!pool) {
6134
            VIR_FREE(poolNames[i]);
6135 6136 6137
            continue;
        }

6138
        /* Retrieve the autostart status of the pool */
6139
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
6140
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
6141
        else
6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159
            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;
        }
6160

6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 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
        /* 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 */
6273 6274 6275
        virStoragePoolFree(pool);
    }

6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293
    /* 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);
6294 6295
        }

6296
        /* Cleanup and return */
E
Eric Blake 已提交
6297
        functionReturn = true;
6298 6299
        goto cleanup;
    }
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 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394
    /* 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 已提交
6395
    functionReturn = true;
6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409
    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 已提交
6410
    functionReturn = false;
6411

6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423
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]);
6424
    }
6425 6426 6427 6428 6429 6430 6431

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

    /* Return the desired value */
    return functionReturn;
6432 6433
}

6434 6435 6436 6437
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
6438 6439
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6440 6441 6442 6443 6444
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6445 6446 6447
     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")},
6448
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
6449 6450 6451
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6452
static bool
6453 6454
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6455
    const char *type = NULL, *host = NULL;
6456 6457
    char *srcSpec = NULL;
    char *srcList;
6458
    const char *initiator = NULL;
6459

6460 6461
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
6462 6463
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
6464
        return false;
6465
    }
6466

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

    if (host) {
6471
        const char *port = NULL;
6472
        virBuffer buf = VIR_BUFFER_INITIALIZER;
6473 6474 6475 6476

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6477
            return false;
6478
        }
6479
        virBufferAddLit(&buf, "<source>\n");
6480
        virBufferAsprintf(&buf, "  <host name='%s'", host);
6481
        if (port)
6482
            virBufferAsprintf(&buf, " port='%s'", port);
6483
        virBufferAddLit(&buf, "/>\n");
6484 6485
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
6486
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
6487 6488
            virBufferAddLit(&buf, "  </initiator>\n");
        }
6489 6490 6491
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
6492
            return false;
6493
        }
6494
        srcSpec = virBufferContentAndReset(&buf);
6495 6496 6497
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6498
    VIR_FREE(srcSpec);
6499
    if (srcList == NULL) {
6500
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
6501
        return false;
6502 6503
    }
    vshPrint(ctl, "%s", srcList);
6504
    VIR_FREE(srcList);
6505

E
Eric Blake 已提交
6506
    return true;
6507 6508 6509 6510 6511 6512 6513
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
6514 6515
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6516 6517 6518 6519 6520
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6521
     N_("type of storage pool sources to discover")},
6522
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
6523
     N_("optional file of source xml to query for pools")},
6524 6525 6526
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6527
static bool
6528 6529
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6530
    const char *type = NULL, *srcSpecFile = NULL;
6531
    char *srcSpec = NULL, *srcList;
6532

6533
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
6534
        return false;
6535

6536 6537
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
6538
        return false;
6539
    }
6540

6541
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6542
        return false;
6543 6544

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
6545
        return false;
6546 6547

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6548
    VIR_FREE(srcSpec);
6549
    if (srcList == NULL) {
6550
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
6551
        return false;
6552 6553
    }
    vshPrint(ctl, "%s", srcList);
6554
    VIR_FREE(srcList);
6555

E
Eric Blake 已提交
6556
    return true;
6557 6558 6559
}


6560 6561 6562
/*
 * "pool-info" command
 */
6563
static const vshCmdInfo info_pool_info[] = {
6564 6565
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
6566 6567 6568
    {NULL, NULL}
};

6569
static const vshCmdOptDef opts_pool_info[] = {
6570
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6571 6572 6573
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6574
static bool
6575
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
6576 6577 6578
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
6579 6580
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
6581
    bool ret = true;
6582 6583
    char uuid[VIR_UUID_STRING_BUFLEN];

6584
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6585
        return false;
6586 6587

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6588
        return false;
6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614

    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;
6615 6616 6617 6618
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
6619 6620
        }

6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636
        /* 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"));

6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648
        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 已提交
6649
        ret = false;
6650 6651 6652 6653 6654 6655 6656 6657 6658 6659
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
6660
static const vshCmdInfo info_pool_name[] = {
6661
    {"help", N_("convert a pool UUID to pool name")},
6662
    {"desc", ""},
6663 6664 6665
    {NULL, NULL}
};

6666
static const vshCmdOptDef opts_pool_name[] = {
6667
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
6668 6669 6670
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6671
static bool
6672
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
6673 6674 6675
{
    virStoragePoolPtr pool;

6676
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6677
        return false;
6678
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6679
                                           VSH_BYUUID)))
E
Eric Blake 已提交
6680
        return false;
6681 6682 6683

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6684
    return true;
6685 6686 6687 6688 6689 6690
}


/*
 * "pool-start" command
 */
6691
static const vshCmdInfo info_pool_start[] = {
6692 6693
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
6694 6695 6696
    {NULL, NULL}
};

6697
static const vshCmdOptDef opts_pool_start[] = {
6698
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
6699 6700 6701
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6702
static bool
6703
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
6704 6705
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6706
    bool ret = true;
6707

6708
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6709
        return false;
6710

6711
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
6712
         return false;
6713 6714 6715 6716 6717

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
6718
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
6719
        ret = false;
6720
    }
L
Laine Stump 已提交
6721 6722

    virStoragePoolFree(pool);
6723 6724 6725 6726
    return ret;
}


6727 6728 6729
/*
 * "vol-create-as" command
 */
6730
static const vshCmdInfo info_vol_create_as[] = {
6731 6732
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
6733 6734 6735
    {NULL, NULL}
};

6736
static const vshCmdOptDef opts_vol_create_as[] = {
6737 6738 6739 6740 6741
    {"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")},
6742 6743
    {"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")},
6744 6745 6746 6747 6748 6749 6750 6751 6752 6753
    {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 已提交
6754
        /* Deliberate fallthrough cases here :-) */
6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774
        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 已提交
6775
static bool
6776
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
6777 6778 6779
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
6780
    char *xml;
6781 6782
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
6783
    unsigned long long capacity, allocation = 0;
6784
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6785

6786
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6787
        return false;
6788 6789 6790

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

6793
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6794 6795
        goto cleanup;

6796
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
6797 6798
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
6799
        vshError(ctl, _("Malformed size %s"), capacityStr);
6800

6801 6802
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
6803
        vshError(ctl, _("Malformed size %s"), allocationStr);
6804

6805 6806 6807 6808 6809 6810 6811
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

6812

6813
    virBufferAddLit(&buf, "<volume>\n");
6814 6815
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
6816
    if (allocationStr)
6817
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
6818 6819

    if (format) {
6820
        virBufferAddLit(&buf, "  <target>\n");
6821
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
6822
        virBufferAddLit(&buf, "  </target>\n");
6823
    }
6824

6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857
    /* 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 已提交
6858
            return false;
6859 6860 6861 6862 6863
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
6864
            return false;
6865 6866 6867 6868
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
6869
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
6870
        if (snapshotStrFormat)
6871
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
6872 6873 6874 6875 6876 6877 6878 6879
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

6881 6882
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
6883
        return false;
6884 6885 6886
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
6887
    VIR_FREE(xml);
6888 6889 6890 6891 6892
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
6893
        return true;
6894
    } else {
6895
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
6896
        return false;
6897 6898 6899
    }

 cleanup:
6900
    virBufferFreeAndReset(&buf);
6901
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6902
    return false;
6903 6904 6905
}


6906 6907 6908
/*
 * "pool-undefine" command
 */
6909
static const vshCmdInfo info_pool_undefine[] = {
6910 6911
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
6912 6913 6914
    {NULL, NULL}
};

6915
static const vshCmdOptDef opts_pool_undefine[] = {
6916
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6917 6918 6919
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6920
static bool
6921
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
6922 6923
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6924
    bool ret = true;
6925
    const char *name;
6926

6927
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6928
        return false;
6929 6930

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6931
        return false;
6932 6933 6934 6935

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

L
Laine Stump 已提交
6940
    virStoragePoolFree(pool);
6941 6942 6943 6944 6945 6946 6947
    return ret;
}


/*
 * "pool-uuid" command
 */
6948
static const vshCmdInfo info_pool_uuid[] = {
6949
    {"help", N_("convert a pool name to pool UUID")},
6950
    {"desc", ""},
6951 6952 6953
    {NULL, NULL}
};

6954
static const vshCmdOptDef opts_pool_uuid[] = {
6955
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
6956 6957 6958
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6959
static bool
6960
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
6961 6962 6963 6964
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

6965
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6966
        return false;
6967 6968

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6969
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6970
        return false;
6971 6972 6973 6974

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

L
Laine Stump 已提交
6977
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6978
    return true;
6979 6980 6981 6982 6983 6984
}


/*
 * "vol-create" command
 */
6985
static const vshCmdInfo info_vol_create[] = {
6986 6987
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
6988 6989 6990
    {NULL, NULL}
};

6991
static const vshCmdOptDef opts_vol_create[] = {
6992 6993
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
6994 6995 6996
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6997
static bool
6998
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
6999 7000 7001
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7002
    const char *from = NULL;
E
Eric Blake 已提交
7003
    bool ret = true;
7004 7005
    char *buffer;

7006
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7007
        return false;
7008 7009

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

7013
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7014
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7015
        return false;
7016 7017 7018
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7019
        virshReportError(ctl);
7020
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7021
        return false;
7022 7023 7024
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
7025
    VIR_FREE(buffer);
7026 7027 7028 7029 7030 7031 7032
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
7033
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
7034
        ret = false;
7035 7036 7037 7038
    }
    return ret;
}

7039 7040 7041 7042
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
7043 7044
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
7045 7046 7047 7048
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
7049 7050 7051
    {"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 已提交
7052
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
7053 7054 7055
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7056
static bool
7057 7058 7059 7060
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
7061
    const char *from = NULL;
E
Eric Blake 已提交
7062
    bool ret = false;
7063 7064
    char *buffer = NULL;

7065
    if (!vshConnectionUsability(ctl, ctl->conn))
7066 7067 7068 7069 7070
        goto cleanup;

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

7071
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7072 7073 7074 7075 7076 7077 7078
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7079
        virshReportError(ctl);
7080 7081 7082 7083 7084 7085 7086 7087 7088
        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 {
7089
        vshError(ctl, _("Failed to create vol from %s"), from);
7090 7091 7092
        goto cleanup;
    }

E
Eric Blake 已提交
7093
    ret = true;
7094
cleanup:
7095
    VIR_FREE(buffer);
7096 7097 7098 7099
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
7100 7101
    if (newvol)
        virStorageVolFree(newvol);
7102 7103 7104 7105
    return ret;
}

static xmlChar *
7106
makeCloneXML(const char *origxml, const char *newname) {
7107

7108 7109 7110
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140
    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[] = {
7141 7142
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
7143 7144 7145 7146
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
7147 7148
    {"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 已提交
7149
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7150 7151 7152
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7153
static bool
7154 7155 7156 7157
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
7158
    const char *name = NULL;
7159
    char *origxml = NULL;
7160
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
7161
    bool ret = false;
7162

7163
    if (!vshConnectionUsability(ctl, ctl->conn))
7164 7165 7166 7167 7168 7169 7170
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
7171
        vshError(ctl, "%s", _("failed to get parent pool"));
7172 7173 7174
        goto cleanup;
    }

7175
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193
        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 {
7194
        vshError(ctl, _("Failed to clone vol from %s"),
7195 7196 7197 7198
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
7199
    ret = true;
7200 7201

cleanup:
7202
    VIR_FREE(origxml);
7203 7204 7205
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
7206 7207
    if (newvol)
        virStorageVolFree(newvol);
7208 7209 7210 7211 7212
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225

/*
 * "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 已提交
7226
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240
    {"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 已提交
7241
static bool
7242 7243 7244 7245
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7246
    bool ret = false;
7247 7248 7249 7250 7251 7252 7253 7254 7255 7256
    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 已提交
7257
        return false;
7258 7259 7260 7261
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7262
        return false;
7263 7264 7265
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7266
        return false;
7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300
    }

    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 已提交
7301
    ret = true;
7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325

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 已提交
7326
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341
    {"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 已提交
7342
static bool
7343 7344 7345 7346
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7347
    bool ret = false;
7348 7349 7350 7351
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
7352
    bool created = false;
7353 7354

    if (!vshConnectionUsability(ctl, ctl->conn))
7355
        return false;
7356 7357 7358

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7359
        return false;
7360 7361 7362 7363
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7364
        return false;
7365 7366 7367
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
7368
        return false;
7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380

    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;
        }
7381 7382
    } else {
        created = true;
7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406
    }

    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 已提交
7407
    ret = true;
7408 7409

cleanup:
7410
    VIR_FORCE_CLOSE(fd);
7411
    if (!ret && created)
7412 7413 7414 7415 7416 7417 7418 7419 7420
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


7421 7422 7423
/*
 * "vol-delete" command
 */
7424
static const vshCmdInfo info_vol_delete[] = {
7425 7426
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
7427 7428 7429
    {NULL, NULL}
};

7430
static const vshCmdOptDef opts_vol_delete[] = {
7431
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7432
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7433 7434 7435
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7436
static bool
7437
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
7438 7439
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7440
    bool ret = true;
7441
    const char *name;
7442

7443
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7444
        return false;
7445 7446

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7447
        return false;
7448 7449 7450
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
7451
        vshPrint(ctl, _("Vol %s deleted\n"), name);
7452
    } else {
7453
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
7454
        ret = false;
7455 7456
    }

L
Laine Stump 已提交
7457
    virStorageVolFree(vol);
7458 7459 7460 7461
    return ret;
}


D
David Allan 已提交
7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472
/*
 * "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 已提交
7473
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
7474 7475 7476
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7477
static bool
D
David Allan 已提交
7478 7479 7480
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7481
    bool ret = true;
7482
    const char *name;
D
David Allan 已提交
7483

7484
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7485
        return false;
D
David Allan 已提交
7486 7487

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7488
        return false;
D
David Allan 已提交
7489 7490 7491 7492 7493 7494
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
7495
        ret = false;
D
David Allan 已提交
7496 7497 7498 7499 7500 7501 7502
    }

    virStorageVolFree(vol);
    return ret;
}


7503 7504 7505
/*
 * "vol-info" command
 */
7506
static const vshCmdInfo info_vol_info[] = {
7507 7508
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
7509 7510 7511
    {NULL, NULL}
};

7512
static const vshCmdOptDef opts_vol_info[] = {
7513
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7514
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7515 7516 7517
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7518
static bool
7519
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
7520 7521 7522
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
7523
    bool ret = true;
7524

7525
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7526
        return false;
7527 7528

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
7529
        return false;
7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545

    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 已提交
7546
        ret = false;
7547 7548 7549 7550 7551 7552 7553 7554 7555 7556
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
7557
static const vshCmdInfo info_vol_dumpxml[] = {
7558 7559
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
7560 7561 7562
    {NULL, NULL}
};

7563
static const vshCmdOptDef opts_vol_dumpxml[] = {
7564
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7565
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7566 7567 7568
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7569
static bool
7570
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
7571 7572
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7573
    bool ret = true;
7574 7575
    char *dump;

7576
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7577
        return false;
7578 7579

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
7580
        return false;
7581 7582 7583

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
7584
        vshPrint(ctl, "%s", dump);
7585
        VIR_FREE(dump);
7586
    } else {
E
Eric Blake 已提交
7587
        ret = false;
7588 7589 7590 7591 7592 7593 7594 7595 7596 7597
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
7598
static const vshCmdInfo info_vol_list[] = {
7599 7600
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
7601 7602 7603
    {NULL, NULL}
};

7604
static const vshCmdOptDef opts_vol_list[] = {
7605
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7606
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
7607 7608 7609
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7610
static bool
7611
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7612
{
7613
    virStorageVolInfo volumeInfo;
7614 7615
    virStoragePoolPtr pool;
    char **activeNames = NULL;
7616 7617 7618 7619 7620
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
7621 7622
    int ret;
    bool functionReturn;
7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633
    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;
7634

7635
    /* Check the connection to libvirtd daemon is still working */
7636
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7637
        return false;
7638

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

7643 7644
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
7645

7646 7647 7648
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7649
        return false;
7650 7651
    }

7652 7653 7654 7655 7656
    /* 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) {
7657
            vshError(ctl, "%s", _("Failed to list active vols"));
7658
            VIR_FREE(activeNames);
7659
            virStoragePoolFree(pool);
E
Eric Blake 已提交
7660
            return false;
7661 7662
        }

7663 7664 7665 7666 7667
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

7670 7671 7672 7673 7674
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
7675

7676 7677 7678 7679
        /* 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"));
7680 7681
        }

7682 7683 7684 7685 7686 7687 7688 7689 7690
        /* 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 */
7691

7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746
                /* 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;
        }
7747

7748
        /* Cleanup memory allocation */
7749
        virStorageVolFree(vol);
7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767
    }

    /* 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 已提交
7768
        functionReturn = true;
7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799
        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 已提交
7800 7801 7802 7803 7804
    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);
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 7832 7833 7834 7835 7836 7837 7838

    /* 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 已提交
7839
    functionReturn = true;
7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853
    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 已提交
7854
    functionReturn = false;
7855 7856 7857 7858 7859 7860 7861 7862 7863 7864

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);
7865
        VIR_FREE(activeNames[i]);
7866
    }
7867 7868 7869 7870

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
7871
    VIR_FREE(activeNames);
7872
    virStoragePoolFree(pool);
7873 7874 7875

    /* Return the desired value */
    return functionReturn;
7876 7877 7878 7879 7880 7881
}


/*
 * "vol-name" command
 */
7882
static const vshCmdInfo info_vol_name[] = {
7883
    {"help", N_("returns the volume name for a given volume key or path")},
7884
    {"desc", ""},
7885 7886 7887
    {NULL, NULL}
};

7888
static const vshCmdOptDef opts_vol_name[] = {
7889
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
7890 7891 7892
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7893
static bool
7894
cmdVolName(vshControl *ctl, const vshCmd *cmd)
7895 7896 7897
{
    virStorageVolPtr vol;

7898
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7899
        return false;
7900 7901 7902

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
E
Eric Blake 已提交
7903
        return false;
7904 7905 7906

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
7907
    return true;
7908 7909 7910
}


J
Justin Clift 已提交
7911 7912 7913 7914 7915 7916 7917 7918 7919 7920
/*
 * "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[] = {
7921
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
7922 7923 7924 7925
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7926
static bool
J
Justin Clift 已提交
7927 7928 7929 7930
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7931
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
7932 7933

    /* Check the connection to libvirtd daemon is still working */
7934
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7935
        return false;
J
Justin Clift 已提交
7936 7937 7938 7939

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
7940
        return false;
J
Justin Clift 已提交
7941 7942 7943 7944 7945 7946 7947
    }

    /* 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 已提交
7948
        return false;
J
Justin Clift 已提交
7949 7950
    }

7951 7952 7953 7954 7955 7956 7957 7958 7959
    /* 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 已提交
7960 7961 7962 7963

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7964
    return true;
J
Justin Clift 已提交
7965 7966
}

7967 7968 7969 7970

/*
 * "vol-key" command
 */
7971
static const vshCmdInfo info_vol_key[] = {
7972
    {"help", N_("returns the volume key for a given volume name or path")},
7973
    {"desc", ""},
7974 7975 7976
    {NULL, NULL}
};

7977
static const vshCmdOptDef opts_vol_key[] = {
7978
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
7979
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7980 7981 7982
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7983
static bool
7984
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
7985 7986 7987
{
    virStorageVolPtr vol;

7988
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7989
        return false;
7990

7991
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
7992
        return false;
7993 7994 7995

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
7996
    return true;
7997 7998 7999 8000 8001 8002 8003
}



/*
 * "vol-path" command
 */
8004
static const vshCmdInfo info_vol_path[] = {
8005
    {"help", N_("returns the volume path for a given volume name or key")},
8006
    {"desc", ""},
8007 8008 8009
    {NULL, NULL}
};

8010
static const vshCmdOptDef opts_vol_path[] = {
8011
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
8012
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8013 8014 8015
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8016
static bool
8017
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
8018 8019
{
    virStorageVolPtr vol;
8020
    const char *name = NULL;
8021

8022
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8023
        return false;
8024 8025

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8026
        return false;
8027
    }
8028 8029 8030

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8031
    return true;
8032 8033 8034
}


8035 8036 8037 8038
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
8039 8040
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
8041 8042
    {NULL, NULL}
};
8043

8044
static const vshCmdOptDef opts_secret_define[] = {
8045
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
8046 8047
    {NULL, 0, 0, NULL}
};
8048

E
Eric Blake 已提交
8049
static bool
8050 8051
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
8052
    const char *from = NULL;
8053
    char *buffer;
8054
    virSecretPtr res;
8055
    char uuid[VIR_UUID_STRING_BUFLEN];
8056

8057
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8058
        return false;
8059

8060
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8061
        return false;
8062 8063

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
8067
    VIR_FREE(buffer);
8068 8069

    if (res == NULL) {
8070
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
8071
        return false;
8072
    }
8073
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
8074
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
8075
        virSecretFree(res);
E
Eric Blake 已提交
8076
        return false;
8077 8078 8079
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
8080
    return true;
8081 8082 8083 8084 8085 8086
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
8087 8088
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
8089 8090 8091 8092
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
8093
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8094 8095 8096
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8097
static bool
8098 8099 8100
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8101
    bool ret = false;
8102 8103
    char *xml;

8104
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8105
        return false;
8106 8107 8108

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8109
        return false;
8110 8111 8112 8113

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
8114
    vshPrint(ctl, "%s", xml);
8115
    VIR_FREE(xml);
E
Eric Blake 已提交
8116
    ret = true;
8117 8118 8119 8120 8121 8122 8123 8124 8125 8126

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
8127 8128
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
8129 8130 8131 8132
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
8133 8134
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
8135 8136 8137
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8138
static bool
8139 8140 8141 8142
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
8143
    const char *base64 = NULL;
8144
    char *value;
E
Eric Blake 已提交
8145 8146
    int res;
    bool ret = false;
8147

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

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

8155
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
8156 8157 8158
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
8159
        vshError(ctl, "%s", _("Invalid base64 data"));
8160 8161 8162
        goto cleanup;
    }
    if (value == NULL) {
8163
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
8164
        return false;
8165 8166 8167 8168
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
8169
    VIR_FREE(value);
8170 8171

    if (res != 0) {
8172
        vshError(ctl, "%s", _("Failed to set secret value"));
8173 8174 8175
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
8176
    ret = true;
8177 8178 8179 8180 8181 8182 8183 8184 8185 8186

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
8187 8188
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
8189 8190 8191 8192
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
8193
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8194 8195 8196
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8197
static bool
8198 8199 8200 8201 8202 8203
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
8204
    bool ret = false;
8205

8206
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8207
        return false;
8208 8209 8210

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8211
        return false;
8212 8213 8214 8215 8216 8217 8218

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
8219
    VIR_FREE(value);
8220 8221

    if (base64 == NULL) {
8222
        vshError(ctl, "%s", _("Failed to allocate memory"));
8223 8224
        goto cleanup;
    }
8225
    vshPrint(ctl, "%s", base64);
8226
    memset(base64, 0, strlen(base64));
8227
    VIR_FREE(base64);
E
Eric Blake 已提交
8228
    ret = true;
8229 8230 8231 8232 8233 8234 8235 8236 8237 8238

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
8239 8240
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
8241 8242 8243 8244
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
8245
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8246 8247 8248
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8249
static bool
8250 8251 8252
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8253
    bool ret = false;
8254
    const char *uuid;
8255

8256
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8257
        return false;
8258 8259 8260

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
8261
        return false;
8262 8263

    if (virSecretUndefine(secret) < 0) {
8264
        vshError(ctl, _("Failed to delete secret %s"), uuid);
8265 8266 8267
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
8268
    ret = true;
8269 8270 8271 8272 8273 8274 8275 8276 8277 8278

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
8279 8280
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
8281 8282 8283
    {NULL, NULL}
};

E
Eric Blake 已提交
8284
static bool
8285 8286 8287 8288 8289
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

8290
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8291
        return false;
8292 8293 8294

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
8295
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
8296
        return false;
8297 8298 8299 8300 8301
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
8302
        vshError(ctl, "%s", _("Failed to list secrets"));
8303
        VIR_FREE(uuids);
E
Eric Blake 已提交
8304
        return false;
8305 8306 8307 8308
    }

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

8309 8310
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
8311 8312

    for (i = 0; i < maxuuids; i++) {
8313 8314 8315 8316
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
8317
            VIR_FREE(uuids[i]);
8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335
            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);
8336
        VIR_FREE(uuids[i]);
8337
    }
8338
    VIR_FREE(uuids);
E
Eric Blake 已提交
8339
    return true;
8340
}
8341 8342 8343 8344 8345


/*
 * "version" command
 */
8346
static const vshCmdInfo info_version[] = {
8347 8348
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
8349 8350 8351 8352
    {NULL, NULL}
};


E
Eric Blake 已提交
8353
static bool
8354
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365
{
    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;

8366
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8367
        return false;
8368 8369 8370

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
8371
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
8372
        return false;
8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384
    }

    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) {
8385
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
8386
        return false;
8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403
    }
    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) {
8404
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
8405
        return false;
8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418
    }
    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 已提交
8419
    return true;
8420 8421
}

8422 8423 8424 8425
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
8426
    {"help", N_("enumerate devices on this host")},
8427
    {"desc", ""},
8428 8429 8430 8431
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
8432 8433
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
8434 8435 8436
    {NULL, 0, 0, NULL}
};

8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458
#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] = '-';
8459 8460
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
8461 8462 8463
    }

    /* Print this device */
8464
    vshPrint(ctl, "%s", indentBuf);
8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487
    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) {
8488
        vshPrint(ctl, "%s", indentBuf);
8489
        vshPrint(ctl, " |\n");
8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511
    }

    /* 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) {
8512
        vshPrint(ctl, "%s", indentBuf);
8513 8514 8515 8516
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
8517
static bool
8518 8519
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
8520
    const char *cap = NULL;
8521
    char **devices;
8522
    int num_devices, i;
8523
    int tree = vshCommandOptBool(cmd, "tree");
8524

8525
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8526
        return false;
8527

8528
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
8529 8530 8531 8532
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
8533
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
8534
        return false;
8535
    } else if (num_devices == 0) {
E
Eric Blake 已提交
8536
        return true;
8537 8538 8539 8540 8541 8542
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
8543
        vshError(ctl, "%s", _("Failed to list node devices"));
8544
        VIR_FREE(devices);
E
Eric Blake 已提交
8545
        return false;
8546
    }
8547
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
8548 8549 8550 8551 8552 8553 8554
    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 已提交
8555
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574
            } 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++) {
8575 8576
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
8577
        }
8578
        VIR_FREE(parents);
8579 8580 8581
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
8582
            VIR_FREE(devices[i]);
8583
        }
8584
    }
8585
    VIR_FREE(devices);
E
Eric Blake 已提交
8586
    return true;
8587 8588 8589 8590 8591 8592
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
8593 8594
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
8595 8596 8597 8598 8599
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
8600
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8601 8602 8603
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8604
static bool
8605 8606
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
8607
    const char *name = NULL;
8608
    virNodeDevicePtr device;
L
Laine Stump 已提交
8609
    char *xml;
8610

8611
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8612
        return false;
8613
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8614
        return false;
8615
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8616
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8617
        return false;
8618 8619
    }

L
Laine Stump 已提交
8620 8621 8622
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
8623
        return false;
L
Laine Stump 已提交
8624 8625 8626
    }

    vshPrint(ctl, "%s\n", xml);
8627
    VIR_FREE(xml);
8628
    virNodeDeviceFree(device);
E
Eric Blake 已提交
8629
    return true;
8630 8631
}

8632 8633 8634 8635
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
8636 8637
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
8638 8639 8640 8641 8642
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
8643
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8644 8645 8646
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8647
static bool
8648 8649
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
8650
    const char *name = NULL;
8651
    virNodeDevicePtr device;
E
Eric Blake 已提交
8652
    bool ret = true;
8653

8654
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8655
        return false;
8656
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8657
        return false;
8658
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8659
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8660
        return false;
8661 8662 8663 8664 8665
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
8666
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
8667
        ret = false;
8668 8669 8670 8671 8672 8673 8674 8675 8676
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
8677 8678
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
8679 8680 8681 8682 8683
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
8684
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8685 8686 8687
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8688
static bool
8689 8690
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
8691
    const char *name = NULL;
8692
    virNodeDevicePtr device;
E
Eric Blake 已提交
8693
    bool ret = true;
8694

8695
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8696
        return false;
8697
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8698
        return false;
8699
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8700
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8701
        return false;
8702 8703 8704 8705 8706
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
8707
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
8708
        ret = false;
8709 8710 8711 8712 8713 8714 8715 8716 8717
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
8718 8719
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
8720 8721 8722 8723 8724
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
8725
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8726 8727 8728
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8729
static bool
8730 8731
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
8732
    const char *name = NULL;
8733
    virNodeDevicePtr device;
E
Eric Blake 已提交
8734
    bool ret = true;
8735

8736
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8737
        return false;
8738
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8739
        return false;
8740
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8741
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8742
        return false;
8743 8744 8745 8746 8747
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
8748
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
8749
        ret = false;
8750 8751 8752 8753 8754
    }
    virNodeDeviceFree(device);
    return ret;
}

8755
/*
E
Eric Blake 已提交
8756
 * "hostname" command
8757
 */
8758
static const vshCmdInfo info_hostname[] = {
8759
    {"help", N_("print the hypervisor hostname")},
8760
    {"desc", ""},
8761 8762 8763
    {NULL, NULL}
};

E
Eric Blake 已提交
8764
static bool
8765
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8766 8767 8768
{
    char *hostname;

8769
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8770
        return false;
8771 8772 8773

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
8774
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
8775
        return false;
8776 8777 8778
    }

    vshPrint (ctl, "%s\n", hostname);
8779
    VIR_FREE(hostname);
8780

E
Eric Blake 已提交
8781
    return true;
8782 8783 8784 8785 8786
}

/*
 * "uri" command
 */
8787
static const vshCmdInfo info_uri[] = {
8788
    {"help", N_("print the hypervisor canonical URI")},
8789
    {"desc", ""},
8790 8791 8792
    {NULL, NULL}
};

E
Eric Blake 已提交
8793
static bool
8794
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8795 8796 8797
{
    char *uri;

8798
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8799
        return false;
8800 8801 8802

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
8803
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
8804
        return false;
8805 8806 8807
    }

    vshPrint (ctl, "%s\n", uri);
8808
    VIR_FREE(uri);
8809

E
Eric Blake 已提交
8810
    return true;
8811 8812
}

E
Eric Blake 已提交
8813 8814 8815 8816 8817 8818 8819 8820 8821 8822
/*
 * "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 已提交
8823
static bool
E
Eric Blake 已提交
8824 8825 8826 8827 8828
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8829
        return false;
E
Eric Blake 已提交
8830 8831 8832 8833

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
8834
        return false;
E
Eric Blake 已提交
8835 8836 8837 8838 8839
    }

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

E
Eric Blake 已提交
8840
    return true;
E
Eric Blake 已提交
8841 8842
}

8843 8844 8845
/*
 * "vncdisplay" command
 */
8846
static const vshCmdInfo info_vncdisplay[] = {
8847 8848
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
8849 8850 8851
    {NULL, NULL}
};

8852
static const vshCmdOptDef opts_vncdisplay[] = {
8853
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8854 8855 8856
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8857
static bool
8858
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
8859 8860 8861 8862 8863
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
8864
    bool ret = false;
8865 8866 8867
    int port = 0;
    char *doc;

8868
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8869
        return false;
8870

J
Jim Meyering 已提交
8871
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
8872
        return false;
8873 8874 8875 8876 8877 8878 8879 8880

    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);
8881
    VIR_FREE(doc);
8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899
    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) ||
8900
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
8901 8902 8903 8904 8905 8906
        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 已提交
8907
    ret = true;
8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
8921
static const vshCmdInfo info_ttyconsole[] = {
8922 8923
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
8924 8925 8926
    {NULL, NULL}
};

8927
static const vshCmdOptDef opts_ttyconsole[] = {
8928
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8929 8930 8931
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8932
static bool
8933
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
8934 8935 8936 8937 8938
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
8939
    bool ret = false;
8940 8941
    char *doc;

8942
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8943
        return false;
8944

J
Jim Meyering 已提交
8945
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
8946
        return false;
8947 8948 8949 8950 8951 8952 8953 8954

    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);
8955
    VIR_FREE(doc);
8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967
    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 已提交
8968
    ret = true;
8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
8981
 */
8982
static const vshCmdInfo info_attach_device[] = {
8983 8984
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
8985 8986 8987
    {NULL, NULL}
};

8988
static const vshCmdOptDef opts_attach_device[] = {
8989 8990 8991
    {"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")},
8992 8993 8994
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8995
static bool
8996
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
8997 8998
{
    virDomainPtr dom;
8999
    const char *from = NULL;
9000
    char *buffer;
W
Wen Congyang 已提交
9001
    int ret;
J
Jim Fehlig 已提交
9002
    unsigned int flags;
9003

9004
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9005
        return false;
9006

J
Jim Meyering 已提交
9007
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9008
        return false;
9009

9010
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9011
        virDomainFree(dom);
E
Eric Blake 已提交
9012
        return false;
9013 9014
    }

9015
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9016
        virshReportError(ctl);
9017
        virDomainFree(dom);
E
Eric Blake 已提交
9018
        return false;
9019
    }
9020

J
Jim Fehlig 已提交
9021 9022 9023 9024 9025 9026 9027 9028
    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);
    }
9029
    VIR_FREE(buffer);
9030 9031

    if (ret < 0) {
9032
        vshError(ctl, _("Failed to attach device from %s"), from);
9033
        virDomainFree(dom);
E
Eric Blake 已提交
9034
        return false;
9035
    } else {
J
Jim Meyering 已提交
9036
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
9037 9038 9039
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9040
    return true;
9041 9042 9043 9044 9045 9046
}


/*
 * "detach-device" command
 */
9047
static const vshCmdInfo info_detach_device[] = {
9048 9049
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
9050 9051 9052
    {NULL, NULL}
};

9053
static const vshCmdOptDef opts_detach_device[] = {
9054 9055 9056
    {"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")},
9057 9058 9059
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9060
static bool
9061
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
9062 9063
{
    virDomainPtr dom;
9064
    const char *from = NULL;
9065
    char *buffer;
W
Wen Congyang 已提交
9066
    int ret;
J
Jim Fehlig 已提交
9067
    unsigned int flags;
9068

9069
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9070
        return false;
9071

J
Jim Meyering 已提交
9072
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9073
        return false;
9074

9075
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9076
        virDomainFree(dom);
E
Eric Blake 已提交
9077
        return false;
9078 9079
    }

9080
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9081
        virshReportError(ctl);
9082
        virDomainFree(dom);
E
Eric Blake 已提交
9083
        return false;
9084
    }
9085

J
Jim Fehlig 已提交
9086 9087 9088 9089 9090 9091 9092 9093
    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);
    }
9094
    VIR_FREE(buffer);
9095 9096

    if (ret < 0) {
9097
        vshError(ctl, _("Failed to detach device from %s"), from);
9098
        virDomainFree(dom);
E
Eric Blake 已提交
9099
        return false;
9100
    } else {
J
Jim Meyering 已提交
9101
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
9102 9103 9104
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9105
    return true;
9106 9107
}

9108

9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121
/*
 * "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")},
9122
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
9123 9124 9125
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9126
static bool
9127 9128 9129
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
9130
    const char *from = NULL;
9131
    char *buffer;
W
Wen Congyang 已提交
9132
    int ret;
9133 9134
    unsigned int flags;

9135
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9136
        return false;
9137 9138

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

9141
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9142
        virDomainFree(dom);
E
Eric Blake 已提交
9143
        return false;
9144 9145 9146
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9147
        virshReportError(ctl);
9148
        virDomainFree(dom);
E
Eric Blake 已提交
9149
        return false;
9150 9151 9152 9153 9154 9155 9156 9157 9158
    }

    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;
    }
9159 9160 9161 9162

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

9163 9164 9165 9166 9167 9168
    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 已提交
9169
        return false;
9170 9171 9172 9173 9174
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9175
    return true;
9176 9177 9178
}


9179 9180 9181
/*
 * "attach-interface" command
 */
9182
static const vshCmdInfo info_attach_interface[] = {
9183 9184
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
9185 9186 9187
    {NULL, NULL}
};

9188
static const vshCmdOptDef opts_attach_interface[] = {
9189 9190 9191 9192 9193 9194
    {"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")},
9195
    {"model", VSH_OT_DATA, 0, N_("model type")},
9196
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
9197 9198 9199
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9200
static bool
9201
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
9202 9203
{
    virDomainPtr dom = NULL;
9204 9205
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
9206
    int typ;
W
Wen Congyang 已提交
9207 9208
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9209
    unsigned int flags;
9210 9211
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9212

9213
    if (!vshConnectionUsability(ctl, ctl->conn))
9214 9215
        goto cleanup;

J
Jim Meyering 已提交
9216
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9217 9218
        goto cleanup;

9219
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9220 9221
        goto cleanup;

9222 9223 9224 9225
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
9226 9227
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
9228
        goto cleanup;
9229
    }
9230 9231

    /* check interface type */
9232
    if (STREQ(type, "network")) {
9233
        typ = 1;
9234
    } else if (STREQ(type, "bridge")) {
9235 9236
        typ = 2;
    } else {
E
Eric Blake 已提交
9237 9238
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
9239 9240 9241 9242
        goto cleanup;
    }

    /* Make XML of interface */
9243
    virBufferAsprintf(&buf, "<interface type='%s'>\n", type);
9244

9245
    if (typ == 1)
9246
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
9247
    else if (typ == 2)
9248
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
9249

9250
    if (target != NULL)
9251
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9252
    if (mac != NULL)
9253
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
9254
    if (script != NULL)
9255
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
9256
    if (model != NULL)
9257
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
9258

9259
    virBufferAddLit(&buf, "</interface>\n");
9260

9261 9262
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
9263
        goto cleanup;
9264 9265
    }

9266
    xml = virBufferContentAndReset(&buf);
9267

J
Jim Fehlig 已提交
9268 9269 9270 9271
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9272
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
9273
    } else {
9274
        ret = virDomainAttachDevice(dom, xml);
9275
    }
9276

9277 9278
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9279
    if (ret != 0) {
L
Laine Stump 已提交
9280
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
9281 9282
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
9283
        functionReturn = true;
J
Jim Fehlig 已提交
9284
    }
9285 9286 9287 9288

 cleanup:
    if (dom)
        virDomainFree(dom);
9289
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
9290
    return functionReturn;
9291 9292 9293 9294 9295
}

/*
 * "detach-interface" command
 */
9296
static const vshCmdInfo info_detach_interface[] = {
9297 9298
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
9299 9300 9301
    {NULL, NULL}
};

9302
static const vshCmdOptDef opts_detach_interface[] = {
9303 9304 9305 9306
    {"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")},
9307 9308 9309
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9310
static bool
9311
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
9312 9313 9314 9315 9316 9317 9318
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
9319
    const char *mac =NULL, *type = NULL;
9320
    char *doc;
9321
    char buf[64];
E
Eric Blake 已提交
9322
    int i = 0, diff_mac;
W
Wen Congyang 已提交
9323 9324
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
9325
    unsigned int flags;
9326

9327
    if (!vshConnectionUsability(ctl, ctl->conn))
9328 9329
        goto cleanup;

J
Jim Meyering 已提交
9330
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9331 9332
        goto cleanup;

9333
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9334 9335
        goto cleanup;

9336 9337
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
9338
        goto cleanup;
9339
    }
9340 9341 9342 9343 9344 9345 9346 9347

    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);
9348
    VIR_FREE(doc);
9349
    if (!xml) {
9350
        vshError(ctl, "%s", _("Failed to get interface information"));
9351 9352 9353 9354
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9355
        vshError(ctl, "%s", _("Failed to get interface information"));
9356 9357 9358
        goto cleanup;
    }

E
Eric Blake 已提交
9359
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
9360 9361 9362
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9363
        vshError(ctl, _("No found interface whose type is %s"), type);
9364 9365 9366
        goto cleanup;
    }

9367 9368 9369 9370 9371 9372
    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;
    }

9373 9374 9375 9376 9377 9378 9379
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9380 9381 9382 9383 9384
            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);
9385 9386 9387 9388 9389 9390 9391
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9392
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
9393 9394 9395 9396 9397
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9398
        vshError(ctl, "%s", _("Failed to allocate memory"));
9399 9400 9401
        goto cleanup;
    }

9402
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
9403
        vshError(ctl, "%s", _("Failed to create XML"));
9404 9405 9406
        goto cleanup;
    }

J
Jim Fehlig 已提交
9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418
    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 已提交
9419
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
9420
    } else {
J
Jim Meyering 已提交
9421
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
9422
        functionReturn = true;
9423
    }
9424 9425 9426 9427

 cleanup:
    if (dom)
        virDomainFree(dom);
9428
    xmlXPathFreeObject(obj);
9429
    xmlXPathFreeContext(ctxt);
9430 9431 9432 9433
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
9434
    return functionReturn;
9435 9436 9437 9438 9439
}

/*
 * "attach-disk" command
 */
9440
static const vshCmdInfo info_attach_disk[] = {
9441 9442
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
9443 9444 9445
    {NULL, NULL}
};

9446
static const vshCmdOptDef opts_attach_disk[] = {
9447 9448 9449 9450 9451 9452 9453 9454
    {"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")},
9455
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
9456 9457 9458
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9459
static bool
9460
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
9461 9462
{
    virDomainPtr dom = NULL;
9463 9464
    const char *source = NULL, *target = NULL, *driver = NULL,
                *subdriver = NULL, *type = NULL, *mode = NULL;
W
Wen Congyang 已提交
9465 9466
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
9467
    unsigned int flags;
9468
    const char *stype = NULL;
9469 9470
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9471

9472
    if (!vshConnectionUsability(ctl, ctl->conn))
9473 9474
        goto cleanup;

J
Jim Meyering 已提交
9475
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9476 9477
        goto cleanup;

9478
    if (vshCommandOptString(cmd, "source", &source) <= 0)
9479 9480
        goto cleanup;

9481
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9482 9483
        goto cleanup;

9484 9485 9486 9487 9488
    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) {
9489
        vshError(ctl, "%s", _("missing option"));
9490 9491
        goto cleanup;
    }
9492

9493 9494
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
9495
            isFile = true;
9496
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
9497
        isFile = true;
9498 9499 9500
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
9501 9502 9503
    }

    if (mode) {
9504
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
9505 9506
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
9507 9508 9509 9510 9511
            goto cleanup;
        }
    }

    /* Make XML of disk */
9512
    virBufferAsprintf(&buf, "<disk type='%s'",
9513 9514
                      (isFile) ? "file" : "block");
    if (type)
9515
        virBufferAsprintf(&buf, " device='%s'", type);
9516 9517
    virBufferAddLit(&buf, ">\n");

9518
    if (driver || subdriver)
9519
        virBufferAsprintf(&buf, "  <driver");
9520 9521

    if (driver)
9522
        virBufferAsprintf(&buf, " name='%s'", driver);
9523
    if (subdriver)
9524
        virBufferAsprintf(&buf, " type='%s'", subdriver);
9525 9526 9527

    if (driver || subdriver)
        virBufferAddLit(&buf, "/>\n");
9528

9529
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
9530 9531
                      (isFile) ? "file" : "dev",
                      source);
9532
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9533
    if (mode)
9534
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
9535 9536

    virBufferAddLit(&buf, "</disk>\n");
9537

9538 9539
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
9540
        return false;
9541 9542
    }

9543
    xml = virBufferContentAndReset(&buf);
9544

J
Jim Fehlig 已提交
9545 9546 9547 9548
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9549
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
9550
    } else {
9551
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
9552
    }
9553

9554 9555
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9556
    if (ret != 0) {
L
Laine Stump 已提交
9557
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
9558 9559
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
9560
        functionReturn = true;
J
Jim Fehlig 已提交
9561
    }
9562 9563 9564 9565

 cleanup:
    if (dom)
        virDomainFree(dom);
9566
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
9567
    return functionReturn;
9568 9569 9570 9571 9572
}

/*
 * "detach-disk" command
 */
9573
static const vshCmdInfo info_detach_disk[] = {
9574 9575
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
9576 9577 9578
    {NULL, NULL}
};

9579
static const vshCmdOptDef opts_detach_disk[] = {
9580 9581 9582
    {"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")},
9583 9584 9585
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9586
static bool
9587
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
9588 9589 9590 9591 9592 9593 9594
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
9595
    const char *target = NULL;
9596
    char *doc;
E
Eric Blake 已提交
9597
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
9598 9599
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9600
    unsigned int flags;
9601

9602
    if (!vshConnectionUsability(ctl, ctl->conn))
9603 9604
        goto cleanup;

J
Jim Meyering 已提交
9605
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9606 9607
        goto cleanup;

9608
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9609 9610 9611 9612 9613 9614 9615 9616 9617
        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);
9618
    VIR_FREE(doc);
9619
    if (!xml) {
9620
        vshError(ctl, "%s", _("Failed to get disk information"));
9621 9622 9623 9624
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9625
        vshError(ctl, "%s", _("Failed to get disk information"));
9626 9627 9628 9629 9630 9631
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9632
        vshError(ctl, "%s", _("Failed to get disk information"));
9633 9634 9635 9636 9637 9638 9639
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9640 9641 9642 9643 9644
            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);
9645 9646 9647 9648 9649 9650 9651
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9652
    vshError(ctl, _("No found disk whose target is %s"), target);
9653 9654 9655 9656 9657
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9658
        vshError(ctl, "%s", _("Failed to allocate memory"));
9659 9660 9661
        goto cleanup;
    }

9662
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
9663
        vshError(ctl, "%s", _("Failed to create XML"));
9664 9665 9666
        goto cleanup;
    }

J
Jim Fehlig 已提交
9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678
    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 已提交
9679
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
9680
    } else {
J
Jim Meyering 已提交
9681
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
9682
        functionReturn = true;
9683
    }
9684 9685

 cleanup:
9686
    xmlXPathFreeObject(obj);
9687
    xmlXPathFreeContext(ctxt);
9688 9689 9690 9691 9692 9693
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
9694
    return functionReturn;
9695 9696
}

9697 9698 9699 9700
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
9701 9702
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
9703 9704 9705 9706
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
9707
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
9708 9709 9710
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9711
static bool
9712 9713
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
9714
    const char *from = NULL;
E
Eric Blake 已提交
9715
    bool ret = true;
9716 9717 9718
    char *buffer;
    int result;

9719
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9720
        return false;
9721

9722
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9723
        return false;
9724 9725

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
9729
    VIR_FREE(buffer);
9730 9731 9732 9733 9734

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
9735
        ret = false;
9736 9737 9738 9739 9740
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
9741
        ret = true;
9742 9743 9744 9745 9746
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
9747
        ret = true;
9748 9749 9750 9751 9752
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
9753
        ret = false;
9754 9755 9756 9757 9758
    }

    return ret;
}

9759 9760 9761 9762
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
9763 9764
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
9765 9766 9767 9768
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
9769
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
9770 9771 9772
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9773
static bool
9774 9775
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
9776
    const char *from = NULL;
E
Eric Blake 已提交
9777
    bool ret = true;
9778 9779 9780 9781 9782
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
9783
    xmlNodePtr node_list;
9784 9785 9786 9787 9788 9789
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

9790
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9791
        return false;
9792

9793
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9794
        return false;
9795 9796

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
9797
        return false;
9798 9799 9800 9801 9802

    doc = xmlNewDoc(NULL);
    if (doc == NULL)
        goto no_memory;

L
Laine Stump 已提交
9803 9804
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
9805 9806
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
9807
        ret = false;
9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843
        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 已提交
9844
        ret = false;
9845 9846 9847 9848 9849 9850 9851 9852
        goto cleanup;
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
9853
        ret = false;
9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870

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 已提交
9871
    ret = false;
9872
    goto cleanup;
9873 9874
}

9875 9876 9877 9878 9879 9880 9881 9882
/* 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;

9883
    ret = vshMalloc(ctl, PATH_MAX);
9884 9885 9886

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
9887 9888
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
9889
    if (fd == -1) {
9890
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
9891
                 strerror(errno));
9892
        VIR_FREE(ret);
9893 9894 9895 9896
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
9897 9898
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
9899
        VIR_FORCE_CLOSE(fd);
9900
        unlink (ret);
9901
        VIR_FREE(ret);
9902 9903
        return NULL;
    }
S
Stefan Berger 已提交
9904
    if (VIR_CLOSE(fd) < 0) {
9905 9906
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
9907
        unlink (ret);
9908
        VIR_FREE(ret);
9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923
        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 已提交
9924 9925 9926 9927
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
9928

9929
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
9930 9931 9932 9933
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
9934

9935 9936 9937 9938 9939
    /* 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 已提交
9940 9941
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
9942
     */
E
Eric Blake 已提交
9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954
    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);
9955 9956
    }

E
Eric Blake 已提交
9957 9958 9959 9960 9961 9962 9963
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
9964
    }
E
Eric Blake 已提交
9965
    ret = 0;
9966

E
Eric Blake 已提交
9967 9968 9969
cleanup:
    virCommandFree(cmd);
    return ret;
9970 9971 9972 9973 9974 9975 9976 9977
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
9978
        vshError(ctl,
9979
                 _("%s: failed to read temporary file: %s"),
9980
                 filename, strerror(errno));
9981 9982 9983 9984 9985
        return NULL;
    }
    return ret;
}

9986

P
Paolo Bonzini 已提交
9987 9988 9989 9990
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
9991 9992
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
9993 9994 9995 9996
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
9997
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
9998 9999 10000
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10001
static bool
10002
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
10003
{
10004
    const char *dir = NULL;
10005
    char *dir_malloced = NULL;
E
Eric Blake 已提交
10006
    bool ret = true;
P
Paolo Bonzini 已提交
10007 10008

    if (!ctl->imode) {
10009
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
10010
        return false;
P
Paolo Bonzini 已提交
10011 10012
    }

10013
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
10014
        uid_t uid = geteuid();
10015
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
10016 10017 10018 10019
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
10020
    if (chdir(dir) == -1) {
10021
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
10022
        ret = false;
P
Paolo Bonzini 已提交
10023 10024
    }

10025
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
10026
    return ret;
P
Paolo Bonzini 已提交
10027 10028 10029 10030 10031 10032
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
10033 10034
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
10035 10036 10037
    {NULL, NULL}
};

E
Eric Blake 已提交
10038
static bool
P
Paolo Bonzini 已提交
10039 10040 10041
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
10042
    bool ret = true;
P
Paolo Bonzini 已提交
10043

10044 10045
    cwd = getcwd(NULL, 0);
    if (!cwd) {
10046 10047
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
10048 10049
        ret = false;
    } else {
P
Paolo Bonzini 已提交
10050
        vshPrint (ctl, _("%s\n"), cwd);
10051 10052
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
10053

10054
    return ret;
P
Paolo Bonzini 已提交
10055 10056
}

E
Eric Blake 已提交
10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075
/*
 * "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 已提交
10076
static bool
E
Eric Blake 已提交
10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121
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 已提交
10122
        return false;
E
Eric Blake 已提交
10123 10124 10125 10126 10127
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
10128
    return true;
E
Eric Blake 已提交
10129 10130
}

10131 10132 10133 10134
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
10135 10136
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
10137 10138 10139 10140
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
10141
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10142 10143 10144 10145 10146 10147
    {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 已提交
10148
static bool
10149 10150
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
10151
    bool ret = false;
10152 10153 10154 10155 10156
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
10157
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
10158

10159
    if (!vshConnectionUsability(ctl, ctl->conn))
10160 10161
        goto cleanup;

J
Jim Meyering 已提交
10162
    dom = vshCommandOptDomain (ctl, cmd, NULL);
10163 10164 10165 10166
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
10167
    doc = virDomainGetXMLDesc (dom, flags);
10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185
    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 已提交
10186
        ret = true;
10187 10188 10189 10190 10191 10192 10193
        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.
     */
10194
    doc_reread = virDomainGetXMLDesc (dom, flags);
10195 10196 10197 10198
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
10199 10200
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212
        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 已提交
10213
    ret = true;
10214 10215 10216 10217 10218

 cleanup:
    if (dom)
        virDomainFree (dom);

10219 10220 10221
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
10222 10223 10224

    if (tmp) {
        unlink (tmp);
10225
        VIR_FREE(tmp);
10226 10227 10228 10229 10230
    }

    return ret;
}

10231

10232 10233 10234 10235
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
10236 10237
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
10238 10239 10240 10241
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
10242
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
10243 10244 10245 10246 10247 10248 10249 10250 10251 10252
    {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[] = {
10253 10254
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
10255 10256 10257 10258
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
10259
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10260 10261 10262 10263 10264 10265
    {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 已提交
10266 10267 10268
/*
 * "quit" command
 */
10269
static const vshCmdInfo info_quit[] = {
10270
    {"help", N_("quit this interactive terminal")},
10271
    {"desc", ""},
10272
    {NULL, NULL}
K
Karel Zak 已提交
10273 10274
};

E
Eric Blake 已提交
10275
static bool
10276
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10277
{
E
Eric Blake 已提交
10278 10279
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
10280 10281
}

10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296
/*
 * "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 已提交
10297
static bool
10298 10299 10300
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10301
    bool ret = false;
10302
    const char *from = NULL;
10303 10304 10305 10306 10307 10308 10309
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

10310
    if (!vshConnectionUsability(ctl, ctl->conn))
10311 10312 10313 10314 10315 10316
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10317
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
10318
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362
    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 已提交
10363
    ret = true;
10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393

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 已提交
10394
static bool
10395 10396 10397
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10398
    bool ret = false;
10399 10400 10401
    int current;
    virDomainSnapshotPtr snapshot = NULL;

10402
    if (!vshConnectionUsability(ctl, ctl->conn))
10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425
        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 已提交
10426
    ret = true;
10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450

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 已提交
10451
static bool
10452 10453 10454
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10455
    bool ret = false;
10456 10457
    int numsnaps;
    char **names = NULL;
10458
    int actual = 0;
10459 10460 10461 10462 10463 10464
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
10465 10466
    long long creation_longlong;
    time_t creation_time_t;
10467 10468 10469
    char timestr[100];
    struct tm time_info;

10470
    if (!vshConnectionUsability(ctl, ctl->conn))
10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

10482 10483
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524

    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;
10525 10526
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
10527
                continue;
10528 10529 10530 10531 10532 10533
            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);
10534
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
10535 10536 10537 10538 10539

            vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
        }
    }

E
Eric Blake 已提交
10540
    ret = true;
10541 10542 10543 10544 10545 10546 10547 10548 10549 10550

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);
10551 10552
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574
    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 已提交
10575
static bool
10576 10577 10578
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10579
    bool ret = false;
10580
    const char *name = NULL;
10581 10582 10583
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

10584
    if (!vshConnectionUsability(ctl, ctl->conn))
10585 10586 10587 10588 10589 10590
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10591
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10592 10593 10594 10595 10596 10597 10598 10599 10600 10601
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

10602
    vshPrint(ctl, "%s", xml);
10603

E
Eric Blake 已提交
10604
    ret = true;
10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
10617
 * "snapshot-revert" command
10618
 */
10619
static const vshCmdInfo info_snapshot_revert[] = {
10620 10621 10622 10623 10624
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

10625
static const vshCmdOptDef opts_snapshot_revert[] = {
10626 10627 10628 10629 10630
    {"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 已提交
10631
static bool
10632
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
10633 10634
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10635
    bool ret = false;
10636
    const char *name = NULL;
10637 10638
    virDomainSnapshotPtr snapshot = NULL;

10639
    if (!vshConnectionUsability(ctl, ctl->conn))
10640 10641 10642 10643 10644 10645
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10646
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10647 10648 10649 10650 10651 10652 10653 10654 10655
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    if (virDomainRevertToSnapshot(snapshot, 0) < 0)
        goto cleanup;

E
Eric Blake 已提交
10656
    ret = true;
10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682

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 已提交
10683
static bool
10684 10685 10686
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10687
    bool ret = false;
10688
    const char *name = NULL;
10689 10690 10691
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

10692
    if (!vshConnectionUsability(ctl, ctl->conn))
10693 10694 10695 10696 10697 10698
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10699
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711
        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 已提交
10712
    ret = true;
10713 10714 10715 10716 10717 10718 10719 10720 10721 10722

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734
/*
 * "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")},
10735
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
10736 10737 10738
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10739
static bool
10740 10741 10742
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10743
    bool ret = false;
10744
    const char *monitor_cmd = NULL;
10745
    char *result = NULL;
10746
    unsigned int flags = 0;
10747 10748 10749 10750 10751 10752 10753 10754

    if (!vshConnectionUsability(ctl, ctl->conn))
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10755
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
10756 10757 10758 10759
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

10760 10761 10762 10763
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
10764 10765 10766 10767
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
10768
    ret = true;
10769 10770 10771 10772 10773 10774 10775 10776 10777

cleanup:
    VIR_FREE(result);
    if (dom)
        virDomainFree(dom);

    return ret;
}

10778
static const vshCmdDef domManagementCmds[] = {
10779 10780 10781 10782 10783 10784 10785 10786
    {"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},
10787
#ifndef WIN32
10788
    {"console", cmdConsole, opts_console, info_console, 0},
10789
#endif
10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841
    {"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}
10842 10843 10844
};

static const vshCmdDef domMonitoringCmds[] = {
10845 10846 10847 10848 10849 10850 10851 10852
    {"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}
10853 10854 10855
};

static const vshCmdDef storagePoolCmds[] = {
10856
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
10857
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
10858
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879
     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}
10880 10881 10882
};

static const vshCmdDef storageVolCmds[] = {
10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900
    {"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}
10901
};
10902

10903
static const vshCmdDef networkCmds[] = {
10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922
    {"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}
10923
};
10924

10925
static const vshCmdDef nodedevCmds[] = {
10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940
    {"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}
10941 10942 10943
};

static const vshCmdDef ifaceCmds[] = {
10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962
    {"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},
    {NULL, NULL, NULL, NULL, 0}
10963
};
10964

10965
static const vshCmdDef nwfilterCmds[] = {
10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976
    {"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}
10977
};
10978

10979
static const vshCmdDef secretCmds[] = {
10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991
    {"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}
10992
};
10993

10994
static const vshCmdDef virshCmds[] = {
10995 10996 10997 10998 10999 11000 11001
    {"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}
11002
};
11003

11004
static const vshCmdDef snapshotCmds[] = {
11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017
    {"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}
11018
};
11019

11020
static const vshCmdDef hostAndHypervisorCmds[] = {
11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031
    {"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 已提交
11032 11033
};

11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050
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 已提交
11051 11052 11053 11054
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
11055
static const char *
11056
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
11057
{
11058
    const vshCmdInfo *info;
11059

K
Karel Zak 已提交
11060
    for (info = cmd->info; info && info->name; info++) {
11061
        if (STREQ(info->name, name))
K
Karel Zak 已提交
11062 11063 11064 11065 11066
            return info->data;
    }
    return NULL;
}

11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098
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;
}

11099
static const vshCmdOptDef *
11100 11101
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
11102
{
11103 11104 11105 11106
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
11107

11108 11109 11110 11111 11112 11113
        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 已提交
11114
            return opt;
11115 11116 11117 11118 11119
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
11120 11121 11122
    return NULL;
}

11123
static const vshCmdOptDef *
11124 11125
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
11126
{
11127
    int i;
11128
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
11129

11130 11131 11132 11133 11134 11135 11136 11137 11138 11139
    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 已提交
11140 11141
}

11142 11143 11144
/*
 * Checks for required options
 */
11145
static int
11146 11147
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
11148
{
11149
    const vshCmdDef *def = cmd->def;
11150 11151 11152 11153 11154 11155 11156 11157 11158
    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];
11159

11160 11161 11162 11163 11164
            vshError(ctl,
                     opt->type == VSH_OT_DATA ?
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
11165 11166
        }
    }
11167
    return -1;
11168 11169
}

11170
static const vshCmdDef *
11171 11172
vshCmddefSearch(const char *cmdname)
{
11173
    const vshCmdGrp *g;
11174
    const vshCmdDef *c;
11175

11176 11177
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
11178
            if (STREQ(c->name, cmdname))
11179 11180 11181 11182
                return c;
        }
    }

K
Karel Zak 已提交
11183 11184 11185
    return NULL;
}

11186 11187 11188 11189 11190 11191
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
11192
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
11193 11194 11195 11196 11197 11198
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
11199
static bool
11200 11201 11202 11203 11204 11205 11206
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 已提交
11207
        return false;
11208 11209 11210 11211 11212 11213 11214 11215 11216 11217
    } 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 已提交
11218
    return true;
11219 11220
}

E
Eric Blake 已提交
11221
static bool
11222
vshCmddefHelp(vshControl *ctl, const char *cmdname)
11223
{
11224
    const vshCmdDef *def = vshCmddefSearch(cmdname);
11225

K
Karel Zak 已提交
11226
    if (!def) {
11227
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
11228
        return false;
11229
    } else {
E
Eric Blake 已提交
11230 11231
        const char *desc = _(vshCmddefGetInfo(def, "desc"));
        const char *help = _(vshCmddefGetInfo(def, "help"));
11232
        char buf[256];
11233 11234 11235 11236 11237 11238
        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 已提交
11239
            return false;
11240
        }
K
Karel Zak 已提交
11241

11242
        fputs(_("  NAME\n"), stdout);
11243 11244
        fprintf(stdout, "    %s - %s\n", def->name, help);

11245 11246 11247 11248 11249
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
11250
                const char *fmt = "%s";
11251 11252
                switch (opt->type) {
                case VSH_OT_BOOL:
11253
                    fmt = "[--%s]";
11254 11255
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
11256
                    /* xgettext:c-format */
11257 11258
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
11259 11260
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
11261 11262
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
11263 11264
                    break;
                case VSH_OT_DATA:
11265
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
11266 11267 11268 11269 11270 11271
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
                    fmt = _("[<string>]...");
                    break;
                default:
11272
                    assert(0);
11273
                }
11274
                fputc(' ', stdout);
E
Eric Blake 已提交
11275
                fprintf(stdout, fmt, opt->name);
11276
            }
K
Karel Zak 已提交
11277
        }
11278 11279 11280
        fputc('\n', stdout);

        if (desc[0]) {
11281
            /* Print the description only if it's not empty.  */
11282
            fputs(_("\n  DESCRIPTION\n"), stdout);
K
Karel Zak 已提交
11283 11284
            fprintf(stdout, "    %s\n", desc);
        }
11285

K
Karel Zak 已提交
11286
        if (def->opts) {
11287
            const vshCmdOptDef *opt;
11288
            fputs(_("\n  OPTIONS\n"), stdout);
11289
            for (opt = def->opts; opt->name; opt++) {
11290 11291
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
11292
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
11293 11294
                    break;
                case VSH_OT_INT:
11295 11296 11297
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
11298 11299
                    break;
                case VSH_OT_STRING:
11300
                    /* OT_STRING should never be VSH_OFLAG_REQ */
11301
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
11302 11303
                    break;
                case VSH_OT_DATA:
11304 11305
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
11306 11307 11308 11309 11310 11311 11312
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
                    continue;
                default:
                    assert(0);
                }
11313

E
Eric Blake 已提交
11314
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
11315
            }
K
Karel Zak 已提交
11316 11317 11318
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
11319
    return true;
K
Karel Zak 已提交
11320 11321 11322 11323 11324 11325
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
11326 11327 11328
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
11329 11330
    vshCmdOpt *a = arg;

11331
    while (a) {
K
Karel Zak 已提交
11332
        vshCmdOpt *tmp = a;
11333

K
Karel Zak 已提交
11334 11335
        a = a->next;

11336 11337
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
11338 11339 11340 11341
    }
}

static void
11342
vshCommandFree(vshCmd *cmd)
11343
{
K
Karel Zak 已提交
11344 11345
    vshCmd *c = cmd;

11346
    while (c) {
K
Karel Zak 已提交
11347
        vshCmd *tmp = c;
11348

K
Karel Zak 已提交
11349 11350 11351 11352
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
11353
        VIR_FREE(tmp);
K
Karel Zak 已提交
11354 11355 11356 11357 11358 11359 11360
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
11361
vshCommandOpt(const vshCmd *cmd, const char *name)
11362
{
K
Karel Zak 已提交
11363
    vshCmdOpt *opt = cmd->opts;
11364 11365

    while (opt) {
11366
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
11367 11368 11369 11370 11371 11372 11373
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
11374 11375 11376 11377 11378 11379 11380 11381 11382
 * @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 已提交
11383 11384
 */
static int
11385
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
11386
{
K
Karel Zak 已提交
11387
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11388
    int ret = 0, num;
11389
    char *end_p = NULL;
11390

11391
    if ((arg != NULL) && (arg->data != NULL)) {
11392 11393 11394 11395 11396 11397
        num = strtol(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11398
    }
11399
    return ret;
K
Karel Zak 已提交
11400 11401
}

11402 11403 11404 11405 11406 11407
/*
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
11408 11409
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11410 11411
    int ret = 0;
    unsigned long num;
11412 11413 11414
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
11415 11416 11417 11418 11419 11420
        num = strtoul(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11421
    }
11422
    return ret;
11423 11424
}

K
Karel Zak 已提交
11425 11426
/*
 * Returns option as STRING
11427
 * See vshCommandOptInt()
K
Karel Zak 已提交
11428
 */
11429 11430
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
11431
{
K
Karel Zak 已提交
11432
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11433 11434 11435
    int ret = 0;

    if (arg && arg->data) {
E
Eric Blake 已提交
11436 11437 11438 11439
        if (*arg->data
            || (arg->def && (arg->def->flag & VSH_OFLAG_EMPTY_OK))) {
            *value = arg->data;
            ret = 1;
11440 11441
        } else if (arg->def && ((arg->def->flag) & VSH_OFLAG_REQ)) {
            vshError(NULL, _("Missing required option '%s'"), name);
E
Eric Blake 已提交
11442 11443 11444 11445
            ret = -1;
        } else {
            /* Treat "--option ''" as if option had not been specified. */
            ret = 0;
11446 11447
        }
    }
11448

11449
    return ret;
K
Karel Zak 已提交
11450 11451
}

11452 11453
/*
 * Returns option as long long
11454
 * See vshCommandOptInt()
11455
 */
11456 11457 11458
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
11459 11460
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11461 11462
    int ret = 0;
    long long num;
11463 11464
    char *end_p = NULL;

11465 11466 11467 11468 11469 11470 11471 11472 11473
    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;
11474 11475
}

11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496
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 已提交
11497
/*
E
Eric Blake 已提交
11498
 * Returns true/false if the option exists
K
Karel Zak 已提交
11499
 */
E
Eric Blake 已提交
11500
static bool
11501
vshCommandOptBool(const vshCmd *cmd, const char *name)
11502
{
E
Eric Blake 已提交
11503
    return vshCommandOpt(cmd, name) != NULL;
K
Karel Zak 已提交
11504 11505
}

11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526
/*
 * 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 已提交
11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544
/* 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)
11545
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
11546 11547 11548
                 cmd->def->name, optname);
    return found;
}
11549

K
Karel Zak 已提交
11550
static virDomainPtr
J
Jim Meyering 已提交
11551
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
11552
                      const char **name, int flag)
11553
{
K
Karel Zak 已提交
11554
    virDomainPtr dom = NULL;
11555
    const char *n = NULL;
K
Karel Zak 已提交
11556
    int id;
J
Jim Meyering 已提交
11557 11558 11559
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11560

11561
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11562 11563
        return NULL;

K
Karel Zak 已提交
11564
    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
11565 11566
             cmd->def->name, optname, n);

K
Karel Zak 已提交
11567 11568
    if (name)
        *name = n;
11569

K
Karel Zak 已提交
11570
    /* try it by ID */
11571
    if (flag & VSH_BYID) {
11572
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
11573 11574 11575 11576
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
11577
    }
K
Karel Zak 已提交
11578
    /* try it by UUID */
11579
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
11580
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
11581
                 cmd->def->name, optname);
K
Karel Zak 已提交
11582
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
11583
    }
K
Karel Zak 已提交
11584
    /* try it by NAME */
11585
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11586
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
11587
                 cmd->def->name, optname);
K
Karel Zak 已提交
11588
        dom = virDomainLookupByName(ctl->conn, n);
11589
    }
K
Karel Zak 已提交
11590

11591
    if (!dom)
11592
        vshError(ctl, _("failed to get domain '%s'"), n);
11593

K
Karel Zak 已提交
11594 11595 11596
    return dom;
}

11597
static virNetworkPtr
J
Jim Meyering 已提交
11598
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
11599
                       const char **name, int flag)
11600 11601
{
    virNetworkPtr network = NULL;
11602
    const char *n = NULL;
J
Jim Meyering 已提交
11603 11604 11605
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11606

11607
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11608 11609 11610 11611 11612 11613 11614 11615 11616
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
11617
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
11618
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
11619
                 cmd->def->name, optname);
11620 11621 11622 11623
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11624
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
11625 11626 11627 11628 11629
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
11630
        vshError(ctl, _("failed to get network '%s'"), n);
11631 11632 11633 11634

    return network;
}

11635 11636 11637

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
11638
                        const char **name, int flag)
11639 11640
{
    virNWFilterPtr nwfilter = NULL;
11641
    const char *n = NULL;
11642 11643 11644 11645
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11646
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673
        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;
}

11674 11675
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
11676
                         const char **name, int flag)
11677 11678
{
    virInterfacePtr iface = NULL;
11679
    const char *n = NULL;
11680 11681 11682 11683
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11684
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11685 11686 11687 11688 11689 11690 11691 11692 11693
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
11694
    if ((flag & VSH_BYNAME)) {
11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706
        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)
11707
        vshError(ctl, _("failed to get interface '%s'"), n);
11708 11709 11710 11711

    return iface;
}

11712
static virStoragePoolPtr
11713
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
11714
                    const char **name, int flag)
11715 11716
{
    virStoragePoolPtr pool = NULL;
11717
    const char *n = NULL;
11718

11719
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11720 11721 11722 11723 11724 11725 11726 11727 11728
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
11729
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
11730
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
11731
                 cmd->def->name, optname);
11732 11733 11734
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
11735
    if (pool == NULL && (flag & VSH_BYNAME)) {
11736 11737 11738 11739 11740 11741
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
11742
        vshError(ctl, _("failed to get pool '%s'"), n);
11743 11744 11745 11746 11747

    return pool;
}

static virStorageVolPtr
11748
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
11749 11750
                   const char *optname,
                   const char *pooloptname,
11751
                   const char **name, int flag)
11752 11753 11754
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
11755
    const char *n = NULL, *p = NULL;
11756

11757
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11758 11759
        return NULL;

11760 11761
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
11762
        return NULL;
11763
    }
11764 11765 11766 11767 11768 11769 11770 11771 11772 11773

    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;

11774
    /* try it by name */
11775
    if (pool && (flag & VSH_BYNAME)) {
11776
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
11777 11778 11779
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
11780
    /* try it by key */
11781 11782 11783 11784 11785
    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);
    }
11786
    /* try it by path */
11787 11788 11789 11790 11791 11792 11793
    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)
11794
        vshError(ctl, _("failed to get vol '%s'"), n);
11795 11796 11797 11798 11799 11800 11801

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

11802
static virSecretPtr
11803
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
11804 11805
{
    virSecretPtr secret = NULL;
11806
    const char *n = NULL;
11807 11808 11809 11810 11811
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11812
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11813 11814 11815 11816 11817 11818 11819 11820 11821 11822
        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)
11823
        vshError(ctl, _("failed to get secret '%s'"), n);
11824 11825 11826 11827

    return secret;
}

K
Karel Zak 已提交
11828 11829 11830
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
11831
static bool
11832
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
11833
{
E
Eric Blake 已提交
11834
    bool ret = true;
11835 11836

    while (cmd) {
K
Karel Zak 已提交
11837
        struct timeval before, after;
11838
        bool enable_timing = ctl->timing;
11839

11840 11841
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
11842 11843
            vshReconnect(ctl);

11844
        if (enable_timing)
K
Karel Zak 已提交
11845
            GETTIMEOFDAY(&before);
11846

K
Karel Zak 已提交
11847 11848
        ret = cmd->def->handler(ctl, cmd);

11849
        if (enable_timing)
K
Karel Zak 已提交
11850
            GETTIMEOFDAY(&after);
11851

11852
        if (!ret)
J
John Levon 已提交
11853 11854
            virshReportError(ctl);

11855
        /* try to automatically catch disconnections */
11856
        if (!ret &&
11857 11858 11859 11860 11861 11862 11863 11864 11865
            ((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);

11866
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
11867 11868
            return ret;

11869
        if (enable_timing)
11870
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
11871 11872
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
11873
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
11874 11875 11876 11877 11878 11879
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
11880
 * Command parsing
K
Karel Zak 已提交
11881 11882 11883
 * ---------------
 */

11884 11885 11886 11887 11888 11889 11890 11891 11892 11893
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 已提交
11894
    /* vshCommandStringGetArg() */
11895
    char *pos;
L
Lai Jiangshan 已提交
11896 11897 11898
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
11899 11900
} vshCommandParser;

E
Eric Blake 已提交
11901
static bool
11902
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
11903
{
K
Karel Zak 已提交
11904 11905 11906
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
11907

K
Karel Zak 已提交
11908 11909 11910 11911
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
11912

11913
    while (1) {
K
Karel Zak 已提交
11914
        vshCmdOpt *last = NULL;
11915
        const vshCmdDef *cmd = NULL;
11916
        vshCommandToken tk;
L
Lai Jiangshan 已提交
11917
        bool data_only = false;
11918 11919 11920
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
11921

K
Karel Zak 已提交
11922
        first = NULL;
11923

11924
        while (1) {
11925
            const vshCmdOptDef *opt = NULL;
11926

K
Karel Zak 已提交
11927
            tkdata = NULL;
11928
            tk = parser->getNextArg(ctl, parser, &tkdata);
11929 11930

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
11931
                goto syntaxError;
H
Hu Tao 已提交
11932 11933
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
11934
                break;
H
Hu Tao 已提交
11935
            }
11936 11937

            if (cmd == NULL) {
K
Karel Zak 已提交
11938 11939
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
11940
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
11941
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
11942
                }
11943 11944 11945 11946 11947 11948 11949
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
11950
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
11951 11952 11953 11954
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
11955 11956 11957 11958 11959
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
11960 11961
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
11962
                    VIR_FREE(optstr);
K
Karel Zak 已提交
11963 11964
                    goto syntaxError;
                }
11965
                VIR_FREE(tkdata);
K
Karel Zak 已提交
11966 11967 11968

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
11969 11970 11971
                    if (optstr)
                        tkdata = optstr;
                    else
11972
                        tk = parser->getNextArg(ctl, parser, &tkdata);
11973
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
11974
                        goto syntaxError;
11975
                    if (tk != VSH_TK_ARG) {
11976
                        vshError(ctl,
11977
                                 _("expected syntax: --%s <%s>"),
11978 11979
                                 opt->name,
                                 opt->type ==
11980
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
11981 11982
                        goto syntaxError;
                    }
11983
                    opts_need_arg &= ~opts_seen;
11984 11985 11986 11987 11988 11989 11990 11991
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
11992
                }
L
Lai Jiangshan 已提交
11993 11994 11995 11996
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
11997
            } else {
L
Lai Jiangshan 已提交
11998
get_data:
11999 12000
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
12001
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
12002 12003 12004 12005 12006
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
12007
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
12008

K
Karel Zak 已提交
12009 12010 12011 12012
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
12013

K
Karel Zak 已提交
12014 12015 12016 12017 12018
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
12019

K
Karel Zak 已提交
12020
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
12021 12022
                         cmd->name,
                         opt->name,
12023 12024
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
12025 12026
            }
        }
12027

D
Daniel Veillard 已提交
12028
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
12029
        if (cmd) {
12030
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
12031

K
Karel Zak 已提交
12032 12033 12034 12035
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

12036
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
12037
                VIR_FREE(c);
12038
                goto syntaxError;
12039
            }
12040

K
Karel Zak 已提交
12041 12042 12043 12044 12045 12046
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
12047 12048 12049

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
12050
    }
12051

E
Eric Blake 已提交
12052
    return true;
K
Karel Zak 已提交
12053

12054
 syntaxError:
12055
    if (ctl->cmd) {
K
Karel Zak 已提交
12056
        vshCommandFree(ctl->cmd);
12057 12058
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
12059 12060
    if (first)
        vshCommandOptFree(first);
12061
    VIR_FREE(tkdata);
E
Eric Blake 已提交
12062
    return false;
K
Karel Zak 已提交
12063 12064
}

12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082
/* --------------------
 * 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 已提交
12083 12084
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
12085 12086 12087 12088
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
12089
        return false;
12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161

    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 已提交
12162 12163
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
12164 12165 12166 12167
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
12168
        return false;
12169 12170 12171 12172 12173 12174

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
12175
/* ---------------
12176
 * Misc utils
K
Karel Zak 已提交
12177 12178
 * ---------------
 */
12179 12180 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
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 已提交
12207
static const char *
12208 12209
vshDomainStateToString(int state)
{
12210
    switch ((virDomainState) state) {
12211
    case VIR_DOMAIN_RUNNING:
12212
        return N_("running");
12213
    case VIR_DOMAIN_BLOCKED:
12214
        return N_("idle");
12215
    case VIR_DOMAIN_PAUSED:
12216
        return N_("paused");
12217
    case VIR_DOMAIN_SHUTDOWN:
12218
        return N_("in shutdown");
12219
    case VIR_DOMAIN_SHUTOFF:
12220
        return N_("shut off");
12221
    case VIR_DOMAIN_CRASHED:
12222
        return N_("crashed");
12223
    case VIR_DOMAIN_NOSTATE:
12224
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
12225
    }
12226
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
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 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329
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");
}

12330 12331 12332 12333
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
12334
    case VIR_VCPU_OFFLINE:
12335
        return N_("offline");
12336
    case VIR_VCPU_BLOCKED:
12337
        return N_("idle");
12338
    case VIR_VCPU_RUNNING:
12339
        return N_("running");
12340
    default:
12341
        ;/*FALLTHROUGH*/
12342
    }
12343
    return N_("no state");
12344 12345
}

E
Eric Blake 已提交
12346
static bool
12347
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
12348
{
12349 12350
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
12351 12352
     */
    if (!conn) {
12353
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
12354
        return false;
K
Karel Zak 已提交
12355
    }
E
Eric Blake 已提交
12356
    return true;
K
Karel Zak 已提交
12357 12358
}

K
Karel Zak 已提交
12359
static void
12360
vshDebug(vshControl *ctl, int level, const char *format, ...)
12361
{
K
Karel Zak 已提交
12362
    va_list ap;
12363
    char *str;
K
Karel Zak 已提交
12364

12365 12366 12367 12368
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
12369 12370 12371 12372
    if (level > ctl->debug)
        return;

    va_start(ap, format);
12373 12374 12375 12376 12377
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
12378
    va_end(ap);
12379 12380
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
12381 12382 12383
}

static void
12384
vshPrintExtra(vshControl *ctl, const char *format, ...)
12385
{
K
Karel Zak 已提交
12386
    va_list ap;
12387
    char *str;
12388

12389
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
12390
        return;
12391

K
Karel Zak 已提交
12392
    va_start(ap, format);
12393 12394 12395 12396 12397
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
12398
    va_end(ap);
12399
    fputs(str, stdout);
12400
    VIR_FREE(str);
K
Karel Zak 已提交
12401 12402
}

K
Karel Zak 已提交
12403

K
Karel Zak 已提交
12404
static void
12405
vshError(vshControl *ctl, const char *format, ...)
12406
{
K
Karel Zak 已提交
12407
    va_list ap;
12408
    char *str;
12409

12410 12411 12412 12413 12414
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
12415

12416
    fputs(_("error: "), stderr);
12417

K
Karel Zak 已提交
12418
    va_start(ap, format);
12419 12420 12421
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
12422 12423
    va_end(ap);

12424 12425
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
12426 12427
}

12428

K
Karel Zak 已提交
12429
/*
12430
 * Initialize connection.
K
Karel Zak 已提交
12431
 */
E
Eric Blake 已提交
12432
static bool
12433
vshInit(vshControl *ctl)
12434
{
12435 12436
    char *debugEnv;

K
Karel Zak 已提交
12437
    if (ctl->conn)
E
Eric Blake 已提交
12438
        return false;
K
Karel Zak 已提交
12439

12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460
    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);
        }
    }

12461 12462
    vshOpenLogFile(ctl);

12463 12464
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
12465

12466 12467 12468
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

12469
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
12470
        return false;
12471

12472 12473 12474 12475
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
12476

12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487
        /* 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;
        }
12488
    }
K
Karel Zak 已提交
12489

E
Eric Blake 已提交
12490
    return true;
K
Karel Zak 已提交
12491 12492
}

12493 12494
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513
/**
 * 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:
12514
                vshError(ctl, "%s",
J
Jim Meyering 已提交
12515
                         _("failed to get the log file information"));
12516
                exit(EXIT_FAILURE);
12517 12518 12519
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
12520 12521
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
12522 12523 12524 12525
        }
    }

    /* log file open */
12526
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
12527
        vshError(ctl, "%s",
J
Jim Meyering 已提交
12528
                 _("failed to open the log file. check the log file path"));
12529
        exit(EXIT_FAILURE);
12530 12531 12532 12533 12534 12535 12536 12537 12538
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
12539 12540
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
12541
{
12542 12543 12544
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558
    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);
12559
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
12560 12561 12562 12563 12564 12565
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
12566 12567
                      SIGN_NAME,
                      (int) getpid());
12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587
    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;
    }
12588 12589 12590
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
12591

12592 12593
    if (virBufferError(&buf))
        goto error;
12594

12595 12596 12597 12598 12599
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
12600
    }
12601

12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612
    /* 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);
12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
12624 12625 12626
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
12627 12628 12629
    }

    if (ctl->logfile) {
12630
        VIR_FREE(ctl->logfile);
12631 12632 12633 12634
        ctl->logfile = NULL;
    }
}

12635
#ifdef USE_READLINE
12636

K
Karel Zak 已提交
12637 12638 12639 12640 12641
/* -----------------
 * Readline stuff
 * -----------------
 */

12642
/*
K
Karel Zak 已提交
12643 12644
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
12645
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
12646 12647
 */
static char *
12648 12649
vshReadlineCommandGenerator(const char *text, int state)
{
12650
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
12651
    const char *name;
12652 12653
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
12654 12655

    if (!state) {
12656 12657
        grp_list_index = 0;
        cmd_list_index = 0;
12658
        len = strlen(text);
K
Karel Zak 已提交
12659 12660
    }

12661 12662
    grp = cmdGroups;

K
Karel Zak 已提交
12663
    /* Return the next name which partially matches from the
12664
     * command list.
K
Karel Zak 已提交
12665
     */
12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679
    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 已提交
12680 12681 12682 12683 12684 12685 12686
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
12687 12688
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
12689
    static int list_index, len;
12690
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
12691
    const char *name;
K
Karel Zak 已提交
12692 12693 12694 12695 12696 12697 12698 12699 12700

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

12701
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
12702
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
12703 12704 12705

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
12706
        len = strlen(text);
12707
        VIR_FREE(cmdname);
K
Karel Zak 已提交
12708 12709 12710 12711
    }

    if (!cmd)
        return NULL;
12712

12713 12714 12715
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
12716
    while ((name = cmd->opts[list_index].name)) {
12717
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
12718
        char *res;
12719

K
Karel Zak 已提交
12720
        list_index++;
12721

K
Karel Zak 已提交
12722
        if (opt->type == VSH_OT_DATA)
K
Karel Zak 已提交
12723 12724
            /* ignore non --option */
            continue;
12725

K
Karel Zak 已提交
12726
        if (len > 2) {
12727
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
12728 12729
                continue;
        }
12730
        res = vshMalloc(NULL, strlen(name) + 3);
12731
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
12732 12733 12734 12735 12736 12737 12738 12739
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
12740 12741 12742
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
12743 12744
    char **matches = (char **) NULL;

12745
    if (start == 0)
K
Karel Zak 已提交
12746
        /* command name generator */
12747
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
12748 12749
    else
        /* commands options */
12750
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
12751 12752 12753 12754
    return matches;
}


12755 12756
static int
vshReadlineInit(vshControl *ctl)
12757
{
12758 12759
    char *userdir = NULL;

K
Karel Zak 已提交
12760 12761 12762 12763 12764
    /* 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;
12765 12766 12767

    /* Limit the total size of the history buffer */
    stifle_history(500);
12768 12769

    /* Prepare to read/write history from/to the ~/.virsh/history file */
12770
    userdir = virGetUserDirectory(getuid());
12771

12772 12773
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
12774
        return -1;
12775
    }
12776 12777 12778

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12779
        VIR_FREE(userdir);
12780 12781 12782 12783 12784
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12785
        VIR_FREE(userdir);
12786 12787 12788
        return -1;
    }

12789
    VIR_FREE(userdir);
12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807

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

12808 12809
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
12810 12811
}

12812 12813 12814 12815 12816 12817
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

12818
#else /* !USE_READLINE */
12819

12820 12821 12822 12823 12824 12825 12826
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

12827
static void
12828
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851
{
    /* 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);
}

12852
#endif /* !USE_READLINE */
12853

K
Karel Zak 已提交
12854
/*
J
Jim Meyering 已提交
12855
 * Deinitialize virsh
K
Karel Zak 已提交
12856
 */
E
Eric Blake 已提交
12857
static bool
12858
vshDeinit(vshControl *ctl)
12859
{
12860
    vshReadlineDeinit(ctl);
12861
    vshCloseLogFile(ctl);
12862
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
12863
    if (ctl->conn) {
12864 12865 12866
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
12867 12868
        }
    }
D
Daniel P. Berrange 已提交
12869 12870
    virResetLastError();

E
Eric Blake 已提交
12871
    return true;
K
Karel Zak 已提交
12872
}
12873

K
Karel Zak 已提交
12874 12875 12876 12877
/*
 * Print usage
 */
static void
12878
vshUsage(void)
12879
{
12880
    const vshCmdGrp *grp;
12881
    const vshCmdDef *cmd;
12882

L
Lai Jiangshan 已提交
12883 12884
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
12885 12886 12887
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
12888
                      "    -d | --debug <num>      debug level [0-4]\n"
12889 12890 12891 12892
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
12893
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
12894
                      "    -V | --version=long     version and full options\n\n"
12895
                      "  commands (non interactive mode):\n\n"), progname, progname);
12896

12897 12898
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
12899

12900 12901 12902 12903 12904 12905 12906 12907 12908
        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"));
12909 12910 12911
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
12912 12913
}

12914 12915 12916 12917 12918 12919 12920 12921 12922 12923
/*
 * 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 已提交
12924 12925
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960
#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 已提交
12961
    vshPrint(ctl, "%s", _(" Networking:"));
12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987
#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 已提交
12988
    vshPrint(ctl, "%s", _(" Storage:"));
12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011
#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 已提交
13012
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
13013
#ifdef WITH_SECDRIVER_APPARMOR
13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036
    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 已提交
13037 13038 13039 13040
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
13041
static bool
13042
vshParseArgv(vshControl *ctl, int argc, char **argv)
13043
{
13044 13045
    bool help = false;
    int arg;
K
Karel Zak 已提交
13046
    struct option opt[] = {
E
Eric Blake 已提交
13047 13048 13049 13050 13051 13052 13053 13054 13055
        {"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}
13056 13057
    };

13058 13059 13060
    /* 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. */
13061
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
13062
        switch (arg) {
13063
        case 'd':
D
Daniel Veillard 已提交
13064
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
13065
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
13066 13067
                exit(EXIT_FAILURE);
            }
13068 13069
            break;
        case 'h':
13070
            help = true;
13071 13072
            break;
        case 'q':
E
Eric Blake 已提交
13073
            ctl->quiet = true;
13074 13075
            break;
        case 't':
E
Eric Blake 已提交
13076
            ctl->timing = true;
13077 13078 13079 13080
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
13081 13082 13083 13084 13085 13086
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
13087 13088 13089
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
13090
        case 'r':
E
Eric Blake 已提交
13091
            ctl->readonly = true;
13092
            break;
13093 13094 13095
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
13096
        default:
13097 13098
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
13099 13100 13101 13102
        }
    }

    if (help) {
13103 13104
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
13105 13106
            exit(EXIT_FAILURE);
        }
13107 13108 13109

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
13110
        exit(EXIT_SUCCESS);
13111 13112
    }

13113
    if (argc > optind) {
K
Karel Zak 已提交
13114
        /* parse command */
E
Eric Blake 已提交
13115
        ctl->imode = false;
13116 13117 13118
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
13119
        } else {
13120
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
13121 13122
        }
    }
E
Eric Blake 已提交
13123
    return true;
K
Karel Zak 已提交
13124 13125
}

13126 13127 13128 13129
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
13130
    char *defaultConn;
E
Eric Blake 已提交
13131
    bool ret = true;
K
Karel Zak 已提交
13132

13133 13134 13135
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
13136
    ctl->debug = -1;            /* Initialize log level */
13137

13138 13139
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
13140
        /* failure to setup locale is not fatal */
13141
    }
13142
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
13143
        perror("bindtextdomain");
E
Eric Blake 已提交
13144
        return EXIT_FAILURE;
13145
    }
13146
    if (!textdomain(PACKAGE)) {
13147
        perror("textdomain");
E
Eric Blake 已提交
13148
        return EXIT_FAILURE;
13149 13150
    }

13151 13152 13153 13154 13155
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

13156
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
13157 13158 13159
        progname = argv[0];
    else
        progname++;
13160

13161
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
13162
        ctl->name = vshStrdup(ctl, defaultConn);
13163 13164
    }

D
Daniel P. Berrange 已提交
13165 13166
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
13167
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
13168
    }
13169

D
Daniel P. Berrange 已提交
13170 13171
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
13172
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
13173
    }
13174

K
Karel Zak 已提交
13175
    if (!ctl->imode) {
13176
        ret = vshCommandRun(ctl, ctl->cmd);
13177
    } else {
K
Karel Zak 已提交
13178 13179
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
13180
            vshPrint(ctl,
13181
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
13182
                     progname);
J
Jim Meyering 已提交
13183
            vshPrint(ctl, "%s",
13184
                     _("Type:  'help' for help with commands\n"
13185
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
13186
        }
13187 13188 13189 13190 13191 13192

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
13193
        do {
13194
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
13195
            ctl->cmdstr =
13196
                vshReadline(ctl, prompt);
13197 13198
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
13199
            if (*ctl->cmdstr) {
13200
#if USE_READLINE
K
Karel Zak 已提交
13201
                add_history(ctl->cmdstr);
13202
#endif
13203
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
13204 13205
                    vshCommandRun(ctl, ctl->cmd);
            }
13206
            VIR_FREE(ctl->cmdstr);
13207
        } while (ctl->imode);
K
Karel Zak 已提交
13208

13209 13210
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
13211
    }
13212

K
Karel Zak 已提交
13213 13214
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
13215
}