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

13
#include <config.h>
14

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

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

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

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

static char *progname;

#ifndef TRUE
65 66
# define TRUE 1
# define FALSE 0
K
Karel Zak 已提交
67 68
#endif

69 70
#define VIRSH_MAX_XML_FILE 10*1024*1024

K
Karel Zak 已提交
71 72 73 74 75 76 77 78
#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)

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

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

/*
127
 * vshCmdOptType - command option type
128
 */
K
Karel Zak 已提交
129
typedef enum {
130 131 132
    VSH_OT_BOOL,     /* optional boolean option */
    VSH_OT_STRING,   /* optional string option */
    VSH_OT_INT,      /* optional or mandatory int option */
133 134
    VSH_OT_DATA,     /* string data (as non-option) */
    VSH_OT_ARGV      /* remaining arguments, opt->name should be "" */
K
Karel Zak 已提交
135 136
} vshCmdOptType;

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
/*
 * 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 已提交
153 154 155
/*
 * Command Option Flags
 */
E
Eric Blake 已提交
156 157 158 159 160
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 已提交
161 162 163 164 165 166 167 168

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

/*
 * vshCmdInfo -- information about command
 */
169 170 171
typedef struct {
    const char *name;           /* name of information */
    const char *data;           /* information */
K
Karel Zak 已提交
172 173 174 175 176
} vshCmdInfo;

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

/*
 * vshCmdOpt - command options
 */
typedef struct vshCmdOpt {
188
    const vshCmdOptDef *def;    /* pointer to relevant option */
189 190
    char *data;                 /* allocated data */
    struct vshCmdOpt *next;
K
Karel Zak 已提交
191 192 193 194 195
} vshCmdOpt;

/*
 * vshCmdDef - command definition
 */
196 197
typedef struct {
    const char *name;
198
    int (*handler) (vshControl *, const vshCmd *);    /* command handler */
199 200
    const vshCmdOptDef *opts;   /* definition of command options */
    const vshCmdInfo *info;     /* details about command */
K
Karel Zak 已提交
201 202 203 204 205 206
} vshCmdDef;

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

/*
 * vshControl
 */
typedef struct __vshControl {
K
Karel Zak 已提交
216
    char *name;                 /* connection name */
217
    virConnectPtr conn;         /* connection to hypervisor (MAY BE NULL) */
218 219 220 221 222 223
    vshCmd *cmd;                /* the current command */
    char *cmdstr;               /* string with command */
    int imode;                  /* interactive mode? */
    int quiet;                  /* quiet mode */
    int debug;                  /* print debug messages? */
    int timing;                 /* print timing info? */
224 225 226
    int readonly;               /* connect readonly (first time only, not
                                 * during explicit connect command)
                                 */
227 228
    char *logfile;              /* log file name */
    int log_fd;                 /* log file descriptor */
229 230
    char *historydir;           /* readline history directory name */
    char *historyfile;          /* readline history file name */
K
Karel Zak 已提交
231
} __vshControl;
232

233 234 235 236 237
typedef struct vshCmdGrp {
    const char *name;
    const char *keyword; /* help keyword */
    const vshCmdDef *commands;
} vshCmdGrp;
238

239
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
240

241 242
static void vshError(vshControl *ctl, const char *format, ...)
    ATTRIBUTE_FMT_PRINTF(2, 3);
243 244
static int vshInit(vshControl *ctl);
static int vshDeinit(vshControl *ctl);
245
static void vshUsage(void);
246
static void vshOpenLogFile(vshControl *ctl);
247 248
static void vshOutputLogFile(vshControl *ctl, int log_level, const char *format, va_list ap)
    ATTRIBUTE_FMT_PRINTF(3, 0);
249
static void vshCloseLogFile(vshControl *ctl);
K
Karel Zak 已提交
250

251
static int vshParseArgv(vshControl *ctl, int argc, char **argv);
K
Karel Zak 已提交
252

253
static const char *vshCmddefGetInfo(const vshCmdDef *cmd, const char *info);
254
static const vshCmdDef *vshCmddefSearch(const char *cmdname);
255
static int vshCmddefHelp(vshControl *ctl, const char *name);
256 257
static const vshCmdGrp *vshCmdGrpSearch(const char *grpname);
static int vshCmdGrpHelp(vshControl *ctl, const char *name);
K
Karel Zak 已提交
258

259
static vshCmdOpt *vshCommandOpt(const vshCmd *cmd, const char *name);
260 261 262 263 264 265 266 267 268 269 270
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;
271 272 273
static int vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                                  unsigned long long *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
274
static int vshCommandOptBool(const vshCmd *cmd, const char *name);
275
static char *vshCommandOptArgv(const vshCmd *cmd, int count);
K
Karel Zak 已提交
276

277 278 279
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
280
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
281

282
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
283
                                          const char **name, int flag);
K
Karel Zak 已提交
284 285

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

289
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
290
                                            const char **name, int flag);
291 292

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
293 294
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
295 296
                           VSH_BYUUID|VSH_BYNAME)

297
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
298
                                                  const char **name, int flag);
299 300 301 302 303 304

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

305
static virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
306
                                                const char **name, int flag);
307 308 309 310 311 312

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

313
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
314
                            const char *optname, const char **name, int flag);
315 316 317 318 319 320

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

321
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
322 323
                                           const char *optname,
                                           const char *pooloptname,
324
                                           const char **name, int flag);
325 326

/* default is lookup by Name and UUID */
327
#define vshCommandOptVol(_ctl, _cmd, _optname, _pooloptname, _name)   \
328 329 330
    vshCommandOptVolBy(_ctl, _cmd, _optname, _pooloptname, _name,     \
                           VSH_BYUUID|VSH_BYNAME)

331
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
332
                                        const char **name);
333

334
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
335
    ATTRIBUTE_FMT_PRINTF(2, 3);
336
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
337
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
338 339

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

K
Karel Zak 已提交
342
static const char *vshDomainStateToString(int state);
343
static const char *vshDomainVcpuStateToString(int state);
344
static int vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
K
Karel Zak 已提交
345

346 347 348 349
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

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

359
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
360 361
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
362 363 364 365 366 367 368 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
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
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436

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;

437
  /* User visible sort, so we want locale-specific case comparison.  */
438 439 440
  return strcasecmp(*sa, *sb);
}

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

    if (last_error->code == VIR_ERR_OK) {
500
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
501 502 503
        goto out;
    }

504
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
505 506 507 508 509 510

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

511 512 513 514 515 516 517 518 519
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;
}

520 521 522 523 524
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

525 526 527 528 529
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

530 531 532 533 534 535
/*
 * 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
 */
536 537 538 539
static void vshCatchDisconnect(int sig, siginfo_t *siginfo,
                               void *context ATTRIBUTE_UNUSED) {
    if ((sig == SIGPIPE) ||
        (SA_SIGINFO && siginfo->si_signo == SIGPIPE))
540 541 542 543 544 545 546 547 548
        disconnected++;
}

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

    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);
    if (!ctl->conn)
        vshError(ctl, "%s", _("Failed to reconnect to the hypervisor"));
    else
        vshError(ctl, "%s", _("Reconnected to the hypervisor"));
    disconnected = 0;
}
580

K
Karel Zak 已提交
581 582 583 584 585 586
/* ---------------
 * Commands
 * ---------------
 */

/*
587
 * "help" command
K
Karel Zak 已提交
588
 */
589
static const vshCmdInfo info_help[] = {
590
    {"help", N_("print help")},
591 592
    {"desc", N_("Prints global help, command specific help, or help for a\n"
                "    group of related commands")},
593

594
    {NULL, NULL}
K
Karel Zak 已提交
595 596
};

597
static const vshCmdOptDef opts_help[] = {
598
    {"command", VSH_OT_DATA, 0, N_("Prints global help, command specific help, or help for a group of related commands")},
599
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
600 601 602
};

static int
603
cmdHelp(vshControl *ctl, const vshCmd *cmd)
604
 {
605
    const char *name = NULL;
606

607
    if (vshCommandOptString(cmd, "command", &name) <= 0) {
608
        const vshCmdGrp *grp;
609
        const vshCmdDef *def;
610

611 612 613 614 615 616 617 618 619 620 621 622 623
        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");
        }

624 625
        return TRUE;
    }
626

E
Eric Blake 已提交
627
    if (vshCmddefSearch(name)) {
628
        return vshCmddefHelp(ctl, name);
E
Eric Blake 已提交
629
    } else if (vshCmdGrpSearch(name)) {
630 631 632 633
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
        return FALSE;
K
Karel Zak 已提交
634 635 636
    }
}

637 638 639
/*
 * "autostart" command
 */
640
static const vshCmdInfo info_autostart[] = {
641
    {"help", N_("autostart a domain")},
642
    {"desc",
643
     N_("Configure a domain to be automatically started at boot.")},
644 645 646
    {NULL, NULL}
};

647
static const vshCmdOptDef opts_autostart[] = {
648 649
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
650 651 652 653
    {NULL, 0, 0, NULL}
};

static int
654
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
655 656
{
    virDomainPtr dom;
657
    const char *name;
658 659
    int autostart;

660
    if (!vshConnectionUsability(ctl, ctl->conn))
661 662
        return FALSE;

J
Jim Meyering 已提交
663
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
664 665 666 667 668
        return FALSE;

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
669
        if (autostart)
670
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
671
        else
672
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
673 674 675 676
        virDomainFree(dom);
        return FALSE;
    }

677
    if (autostart)
678
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
679
    else
680
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
681

682
    virDomainFree(dom);
683 684 685
    return TRUE;
}

K
Karel Zak 已提交
686
/*
687
 * "connect" command
K
Karel Zak 已提交
688
 */
689
static const vshCmdInfo info_connect[] = {
690
    {"help", N_("(re)connect to hypervisor")},
691
    {"desc",
692
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
693
    {NULL, NULL}
K
Karel Zak 已提交
694 695
};

696
static const vshCmdOptDef opts_connect[] = {
E
Eric Blake 已提交
697 698
    {"name",     VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("hypervisor connection URI")},
699
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
700
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
701 702 703
};

static int
704
cmdConnect(vshControl *ctl, const vshCmd *cmd)
705
{
K
Karel Zak 已提交
706
    int ro = vshCommandOptBool(cmd, "readonly");
707
    const char *name = NULL;
708

K
Karel Zak 已提交
709
    if (ctl->conn) {
710 711 712
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
713 714 715 716
            return FALSE;
        }
        ctl->conn = NULL;
    }
717

718
    VIR_FREE(ctl->name);
719 720
    if (vshCommandOptString(cmd, "name", &name) < 0) {
        vshError(ctl, "%s", _("Please specify valid connection URI"));
721
        return FALSE;
722
    }
723
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
724

725 726 727 728 729
    if (!ro) {
        ctl->readonly = 0;
    } else {
        ctl->readonly = 1;
    }
K
Karel Zak 已提交
730

731 732 733
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

K
Karel Zak 已提交
737 738 739
    return ctl->conn ? TRUE : FALSE;
}

740 741
#ifndef WIN32

742
/*
743
 * "console" command
744
 */
745
static const vshCmdInfo info_console[] = {
746
    {"help", N_("connect to the guest console")},
747
    {"desc",
748
     N_("Connect the virtual serial console for the guest")},
749 750 751
    {NULL, NULL}
};

752
static const vshCmdOptDef opts_console[] = {
753
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
754
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
755 756 757 758
    {NULL, 0, 0, NULL}
};

static int
759
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
760 761
{
    int ret = FALSE;
762
    virDomainInfo dominfo;
763

764 765 766 767 768 769 770 771 772 773
    if (virDomainGetInfo(dom, &dominfo) < 0) {
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

    if (dominfo.state == VIR_DOMAIN_SHUTOFF) {
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

774 775
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
    vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
776
    if (vshRunConsole(dom, name) == 0)
777
        ret = TRUE;
778 779

 cleanup:
780

781 782 783
    return ret;
}

784 785 786 787
static int
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
788
    int ret = FALSE;
789
    const char *name = NULL;
790

791
    if (!vshConnectionUsability(ctl, ctl->conn))
792 793 794 795 796
        return FALSE;

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;

797 798 799 800
    if (vshCommandOptString(cmd, "devname", &name) < 0) {
        vshError(ctl, "%s", _("Invalid devname"));
        goto cleanup;
    }
801

802
    ret = cmdRunConsole(ctl, dom, name);
803

804
cleanup:
805 806 807 808
    virDomainFree(dom);
    return ret;
}

809 810 811
#endif /* WIN32 */


K
Karel Zak 已提交
812 813 814
/*
 * "list" command
 */
815
static const vshCmdInfo info_list[] = {
816 817
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
818
    {NULL, NULL}
K
Karel Zak 已提交
819 820
};

821
static const vshCmdOptDef opts_list[] = {
822 823
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
824 825 826
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
827 828

static int
829
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
830
{
831 832 833 834
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
835
    char **names = NULL;
836 837
    int maxname = 0;
    inactive |= all;
K
Karel Zak 已提交
838

839
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
840
        return FALSE;
841

842
    if (active) {
843 844
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
845
            vshError(ctl, "%s", _("Failed to list active domains"));
846 847 848 849 850 851
            return FALSE;
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
852
                vshError(ctl, "%s", _("Failed to list active domains"));
853
                VIR_FREE(ids);
854 855 856
                return FALSE;
            }

857
            qsort(&ids[0], maxid, sizeof(int), idsorter);
858
        }
859 860
    }
    if (inactive) {
861 862
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
863
            vshError(ctl, "%s", _("Failed to list inactive domains"));
864
            VIR_FREE(ids);
865
            return FALSE;
866
        }
867 868 869 870
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
871
                vshError(ctl, "%s", _("Failed to list inactive domains"));
872 873
                VIR_FREE(ids);
                VIR_FREE(names);
874 875
                return FALSE;
            }
876

877
            qsort(&names[0], maxname, sizeof(char*), namesorter);
878
        }
879
    }
880
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
881
    vshPrintExtra(ctl, "----------------------------------\n");
882 883

    for (i = 0; i < maxid; i++) {
K
Karel Zak 已提交
884 885
        virDomainInfo info;
        virDomainPtr dom = virDomainLookupByID(ctl->conn, ids[i]);
886
        const char *state;
887 888

        /* this kind of work with domains is not atomic operation */
K
Karel Zak 已提交
889 890
        if (!dom)
            continue;
891 892 893 894

        if (virDomainGetInfo(dom, &info) < 0)
            state = _("no state");
        else
E
Eric Blake 已提交
895
            state = _(vshDomainStateToString(info.state));
896

K
Karel Zak 已提交
897
        vshPrint(ctl, "%3d %-20s %s\n",
898 899
                 virDomainGetID(dom),
                 virDomainGetName(dom),
900
                 state);
901
        virDomainFree(dom);
K
Karel Zak 已提交
902
    }
903 904 905
    for (i = 0; i < maxname; i++) {
        virDomainInfo info;
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);
906
        const char *state;
907 908

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

        if (virDomainGetInfo(dom, &info) < 0)
            state = _("no state");
        else
E
Eric Blake 已提交
917
            state = _(vshDomainStateToString(info.state));
918 919

        vshPrint(ctl, "%3s %-20s %s\n", "-", names[i], state);
920

921
        virDomainFree(dom);
922
        VIR_FREE(names[i]);
923
    }
924 925
    VIR_FREE(ids);
    VIR_FREE(names);
K
Karel Zak 已提交
926 927 928 929
    return TRUE;
}

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

938
static const vshCmdOptDef opts_domstate[] = {
939
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
940
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
941 942 943
};

static int
944
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
945
{
946
    virDomainInfo info;
K
Karel Zak 已提交
947
    virDomainPtr dom;
K
Karel Zak 已提交
948
    int ret = TRUE;
949

950
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
951
        return FALSE;
952

J
Jim Meyering 已提交
953
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
K
Karel Zak 已提交
954
        return FALSE;
955 956

    if (virDomainGetInfo(dom, &info) == 0)
K
Karel Zak 已提交
957
        vshPrint(ctl, "%s\n",
E
Eric Blake 已提交
958
                 _(vshDomainStateToString(info.state)));
K
Karel Zak 已提交
959 960
    else
        ret = FALSE;
961

962 963 964 965
    virDomainFree(dom);
    return ret;
}

966 967
/* "domblkstat" command
 */
968
static const vshCmdInfo info_domblkstat[] = {
969 970
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
971 972 973
    {NULL,NULL}
};

974
static const vshCmdOptDef opts_domblkstat[] = {
975 976
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
977 978 979 980
    {NULL, 0, 0, NULL}
};

static int
981
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
982 983
{
    virDomainPtr dom;
984
    const char *name = NULL, *device = NULL;
985 986
    struct _virDomainBlockStats stats;

987
    if (!vshConnectionUsability (ctl, ctl->conn))
988 989
        return FALSE;

J
Jim Meyering 已提交
990
    if (!(dom = vshCommandOptDomain (ctl, cmd, &name)))
991 992
        return FALSE;

993
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
L
Laine Stump 已提交
994
        virDomainFree(dom);
995
        return FALSE;
L
Laine Stump 已提交
996
    }
997 998

    if (virDomainBlockStats (dom, device, &stats, sizeof stats) == -1) {
999
        vshError(ctl, _("Failed to get block stats %s %s"), name, device);
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
        virDomainFree(dom);
        return FALSE;
    }

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

/* "domifstat" command
 */
1025
static const vshCmdInfo info_domifstat[] = {
1026 1027
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1028 1029 1030
    {NULL,NULL}
};

1031
static const vshCmdOptDef opts_domifstat[] = {
1032 1033
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1034 1035 1036 1037
    {NULL, 0, 0, NULL}
};

static int
1038
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1039 1040
{
    virDomainPtr dom;
1041
    const char *name = NULL, *device = NULL;
1042 1043
    struct _virDomainInterfaceStats stats;

1044
    if (!vshConnectionUsability (ctl, ctl->conn))
1045 1046
        return FALSE;

J
Jim Meyering 已提交
1047
    if (!(dom = vshCommandOptDomain (ctl, cmd, &name)))
1048 1049
        return FALSE;

1050
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1051
        virDomainFree(dom);
1052
        return FALSE;
L
Laine Stump 已提交
1053
    }
1054 1055

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1056
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
        virDomainFree(dom);
        return FALSE;
    }

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

1089 1090 1091
/*
 * "dommemstats" command
 */
1092
static const vshCmdInfo info_dommemstat[] = {
1093 1094
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1095 1096 1097
    {NULL,NULL}
};

1098
static const vshCmdOptDef opts_dommemstat[] = {
1099
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1100 1101 1102 1103
    {NULL, 0, 0, NULL}
};

static int
1104
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1105 1106
{
    virDomainPtr dom;
1107
    const char *name;
1108 1109 1110
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1111
    if (!vshConnectionUsability(ctl, ctl->conn))
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
        return FALSE;

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

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

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

1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
/*
 * "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}
};

static int
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
    int ret = TRUE;
1164
    const char *device = NULL;
1165

1166
    if (!vshConnectionUsability(ctl, ctl->conn))
1167 1168 1169 1170 1171
        return FALSE;

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;

1172
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
        virDomainFree(dom);
        return FALSE;
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
        return FALSE;
    }

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

1190 1191 1192
/*
 * "suspend" command
 */
1193
static const vshCmdInfo info_suspend[] = {
1194 1195
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1196
    {NULL, NULL}
1197 1198
};

1199
static const vshCmdOptDef opts_suspend[] = {
1200
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1201
    {NULL, 0, 0, NULL}
1202 1203 1204
};

static int
1205
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1206
{
1207
    virDomainPtr dom;
1208
    const char *name;
K
Karel Zak 已提交
1209
    int ret = TRUE;
1210

1211
    if (!vshConnectionUsability(ctl, ctl->conn))
1212 1213
        return FALSE;

J
Jim Meyering 已提交
1214
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1215
        return FALSE;
1216 1217

    if (virDomainSuspend(dom) == 0) {
1218
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1219
    } else {
1220
        vshError(ctl, _("Failed to suspend domain %s"), name);
1221 1222
        ret = FALSE;
    }
1223

1224 1225 1226 1227
    virDomainFree(dom);
    return ret;
}

1228 1229 1230
/*
 * "create" command
 */
1231
static const vshCmdInfo info_create[] = {
1232 1233
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1234 1235 1236
    {NULL, NULL}
};

1237
static const vshCmdOptDef opts_create[] = {
1238
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1239
#ifndef WIN32
1240
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1241
#endif
1242
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1243 1244 1245 1246
    {NULL, 0, 0, NULL}
};

static int
1247
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1248 1249
{
    virDomainPtr dom;
1250
    const char *from = NULL;
1251
    int ret = TRUE;
1252
    char *buffer;
1253
#ifndef WIN32
1254
    int console = vshCommandOptBool(cmd, "console");
1255
#endif
1256
    unsigned int flags = VIR_DOMAIN_NONE;
1257

1258
    if (!vshConnectionUsability(ctl, ctl->conn))
1259 1260
        return FALSE;

1261
    if (vshCommandOptString(cmd, "file", &from) <= 0)
1262 1263
        return FALSE;

1264 1265
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
1266

1267 1268 1269 1270
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1271
    VIR_FREE(buffer);
1272

1273
    if (dom != NULL) {
1274
        vshPrint(ctl, _("Domain %s created from %s\n"),
1275
                 virDomainGetName(dom), from);
1276
#ifndef WIN32
1277
        if (console)
1278
            cmdRunConsole(ctl, dom, NULL);
1279
#endif
1280
        virDomainFree(dom);
1281
    } else {
1282
        vshError(ctl, _("Failed to create domain from %s"), from);
1283 1284 1285 1286 1287
        ret = FALSE;
    }
    return ret;
}

1288 1289 1290
/*
 * "define" command
 */
1291
static const vshCmdInfo info_define[] = {
1292 1293
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1294 1295 1296
    {NULL, NULL}
};

1297
static const vshCmdOptDef opts_define[] = {
1298
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1299 1300 1301 1302
    {NULL, 0, 0, NULL}
};

static int
1303
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1304 1305
{
    virDomainPtr dom;
1306
    const char *from = NULL;
1307
    int ret = TRUE;
1308
    char *buffer;
1309

1310
    if (!vshConnectionUsability(ctl, ctl->conn))
1311 1312
        return FALSE;

1313
    if (vshCommandOptString(cmd, "file", &from) <= 0)
1314 1315
        return FALSE;

1316 1317
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
1318 1319

    dom = virDomainDefineXML(ctl->conn, buffer);
1320
    VIR_FREE(buffer);
1321

1322
    if (dom != NULL) {
1323
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1324
                 virDomainGetName(dom), from);
1325
        virDomainFree(dom);
1326
    } else {
1327
        vshError(ctl, _("Failed to define domain from %s"), from);
1328 1329 1330 1331 1332 1333 1334 1335
        ret = FALSE;
    }
    return ret;
}

/*
 * "undefine" command
 */
1336
static const vshCmdInfo info_undefine[] = {
1337 1338
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1339 1340 1341
    {NULL, NULL}
};

1342
static const vshCmdOptDef opts_undefine[] = {
1343
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1344 1345 1346 1347
    {NULL, 0, 0, NULL}
};

static int
1348
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1349 1350 1351
{
    virDomainPtr dom;
    int ret = TRUE;
1352
    const char *name = NULL;
1353
    int id;
1354

1355
    if (!vshConnectionUsability(ctl, ctl->conn))
1356 1357
        return FALSE;

1358
    if (vshCommandOptString(cmd, "domain", &name) <= 0)
1359 1360 1361 1362
        return FALSE;

    if (name && virStrToLong_i(name, NULL, 10, &id) == 0
        && id >= 0 && (dom = virDomainLookupByID(ctl->conn, id))) {
1363 1364 1365 1366 1367
        vshError(ctl,
                 _("a running domain like %s cannot be undefined;\n"
                   "to undefine, first shutdown then undefine"
                   " using its name or UUID"),
                 name);
1368 1369 1370
        virDomainFree(dom);
        return FALSE;
    }
J
Jim Meyering 已提交
1371
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
1372
                                      VSH_BYNAME|VSH_BYUUID)))
1373 1374 1375
        return FALSE;

    if (virDomainUndefine(dom) == 0) {
1376
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1377
    } else {
1378
        vshError(ctl, _("Failed to undefine domain %s"), name);
1379 1380 1381
        ret = FALSE;
    }

1382
    virDomainFree(dom);
1383 1384 1385 1386 1387 1388 1389
    return ret;
}


/*
 * "start" command
 */
1390
static const vshCmdInfo info_start[] = {
1391
    {"help", N_("start a (previously defined) inactive domain")},
1392 1393 1394
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1395 1396 1397
    {NULL, NULL}
};

1398
static const vshCmdOptDef opts_start[] = {
1399
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1400
#ifndef WIN32
1401
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1402
#endif
E
Eric Blake 已提交
1403
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1404 1405 1406 1407
    {NULL, 0, 0, NULL}
};

static int
1408
cmdStart(vshControl *ctl, const vshCmd *cmd)
1409 1410 1411
{
    virDomainPtr dom;
    int ret = TRUE;
1412
#ifndef WIN32
1413
    int console = vshCommandOptBool(cmd, "console");
1414
#endif
E
Eric Blake 已提交
1415
    unsigned int flags = VIR_DOMAIN_NONE;
1416

1417
    if (!vshConnectionUsability(ctl, ctl->conn))
1418 1419
        return FALSE;

1420 1421
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
1422 1423 1424
        return FALSE;

    if (virDomainGetID(dom) != (unsigned int)-1) {
1425
        vshError(ctl, "%s", _("Domain is already active"));
1426
        virDomainFree(dom);
1427 1428 1429
        return FALSE;
    }

E
Eric Blake 已提交
1430 1431 1432 1433 1434 1435
    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) {
1436
        vshPrint(ctl, _("Domain %s started\n"),
1437
                 virDomainGetName(dom));
1438
#ifndef WIN32
1439
        if (console)
1440
            cmdRunConsole(ctl, dom, NULL);
1441
#endif
1442
    } else {
1443
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
1444 1445
        ret = FALSE;
    }
1446
    virDomainFree(dom);
1447 1448 1449
    return ret;
}

1450 1451 1452
/*
 * "save" command
 */
1453
static const vshCmdInfo info_save[] = {
1454 1455
    {"help", N_("save a domain state to a file")},
    {"desc", N_("Save a running domain.")},
1456
    {NULL, NULL}
1457 1458
};

1459
static const vshCmdOptDef opts_save[] = {
1460 1461
    {"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")},
1462
    {NULL, 0, 0, NULL}
1463 1464 1465
};

static int
1466
cmdSave(vshControl *ctl, const vshCmd *cmd)
1467
{
1468
    virDomainPtr dom;
1469 1470
    const char *name = NULL;
    const char *to = NULL;
1471
    int ret = TRUE;
1472

1473
    if (!vshConnectionUsability(ctl, ctl->conn))
1474 1475
        return FALSE;

1476
    if (vshCommandOptString(cmd, "file", &to) <= 0)
1477
        return FALSE;
1478

J
Jim Meyering 已提交
1479
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1480
        return FALSE;
1481 1482

    if (virDomainSave(dom, to) == 0) {
1483
        vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
1484
    } else {
1485
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
1486 1487
        ret = FALSE;
    }
1488

1489 1490 1491 1492
    virDomainFree(dom);
    return ret;
}

1493 1494 1495 1496 1497
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1498 1499 1500 1501
    {"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.")},
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
    {NULL, NULL}
};

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

static int
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1514
    const char *name;
1515 1516
    int ret = TRUE;

1517
    if (!vshConnectionUsability(ctl, ctl->conn))
1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
        return FALSE;

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

    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);
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551
/*
 * "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}
};

static int
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1552
    const char *name;
1553 1554 1555
    int ret = FALSE;
    int hassave;

1556
    if (!vshConnectionUsability(ctl, ctl->conn))
1557 1558 1559 1560 1561 1562 1563
        return FALSE;

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

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1564
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
        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);

    ret = TRUE;

cleanup:
    virDomainFree(dom);
    return ret;
}

1588 1589 1590
/*
 * "schedinfo" command
 */
1591
static const vshCmdInfo info_schedinfo[] = {
1592 1593
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1594 1595 1596
    {NULL, NULL}
};

1597
static const vshCmdOptDef opts_schedinfo[] = {
1598 1599 1600 1601
    {"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")},
1602 1603 1604 1605
    {NULL, 0, 0, NULL}
};

static int
1606 1607
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
                   virSchedParameterPtr param)
1608
{
1609
    const char *data = NULL;
1610 1611 1612 1613 1614 1615

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
        param->type == VIR_DOMAIN_SCHED_FIELD_UINT &&
        vshCommandOptBool(cmd, "weight")) {
        int val;
1616
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
1617
            vshError(ctl, "%s", _("Invalid value of weight"));
1618
            return -1;
1619
        } else {
1620
            param->value.ui = val;
1621
        }
1622
        return 1;
1623 1624
    }

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

1639
    if (vshCommandOptString(cmd, "set", &data) > 0) {
1640 1641 1642
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
1643
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
1644
            return -1;
1645
        }
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656
        *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) {
1657
                vshError(ctl, "%s",
1658 1659 1660 1661 1662 1663
                         _("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) {
1664
                vshError(ctl, "%s",
1665 1666 1667 1668 1669 1670
                         _("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) {
1671
                vshError(ctl, "%s",
J
Jim Meyering 已提交
1672
                         _("Invalid value for parameter, expecting a long long"));
1673 1674 1675 1676 1677
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_ULLONG:
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
1678
                vshError(ctl, "%s",
1679 1680 1681 1682 1683 1684
                         _("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) {
1685
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
1686 1687 1688 1689 1690
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_BOOLEAN:
            param->value.b = STREQ(val, "0") ? 0 : 1;
1691
        }
1692
        return 1;
1693
    }
1694

1695 1696
    return 0;
}
1697

1698

1699 1700 1701 1702 1703 1704 1705 1706 1707 1708
static int
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
    virSchedParameterPtr params = NULL;
    int nparams = 0;
    int update = 0;
    int i, ret;
    int ret_val = FALSE;
1709

1710
    if (!vshConnectionUsability(ctl, ctl->conn))
1711
        return FALSE;
1712

1713 1714
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;
1715 1716 1717 1718

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
    if (schedulertype!= NULL){
1719
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
1720
             schedulertype);
1721
        VIR_FREE(schedulertype);
1722
    } else {
1723
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
1724
        goto cleanup;
1725 1726
    }

1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753
    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) {
            ret = virDomainSetSchedulerParameters(dom, params, nparams);
            if (ret == -1)
                goto cleanup;

            ret = virDomainGetSchedulerParameters(dom, params, &nparams);
            if (ret == -1)
                goto cleanup;
1754 1755 1756 1757
        } 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.  */
1758 1759
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
1760 1761 1762 1763
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
1764 1765 1766
        }

        ret_val = TRUE;
1767 1768 1769
        for (i = 0; i < nparams; i++){
            switch (params[i].type) {
            case VIR_DOMAIN_SCHED_FIELD_INT:
1770
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1771 1772
                 break;
            case VIR_DOMAIN_SCHED_FIELD_UINT:
1773
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1774 1775
                 break;
            case VIR_DOMAIN_SCHED_FIELD_LLONG:
1776
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1777 1778
                 break;
            case VIR_DOMAIN_SCHED_FIELD_ULLONG:
1779
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1780 1781
                 break;
            case VIR_DOMAIN_SCHED_FIELD_DOUBLE:
1782
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1783 1784
                 break;
            case VIR_DOMAIN_SCHED_FIELD_BOOLEAN:
1785
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
1786 1787
                 break;
            default:
1788
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
1789 1790 1791
            }
        }
    }
1792

1793
 cleanup:
1794
    VIR_FREE(params);
1795
    virDomainFree(dom);
1796
    return ret_val;
1797 1798
}

1799 1800 1801
/*
 * "restore" command
 */
1802
static const vshCmdInfo info_restore[] = {
1803 1804
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
1805
    {NULL, NULL}
1806 1807
};

1808
static const vshCmdOptDef opts_restore[] = {
1809
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
1810
    {NULL, 0, 0, NULL}
1811 1812 1813
};

static int
1814
cmdRestore(vshControl *ctl, const vshCmd *cmd)
1815
{
1816
    const char *from = NULL;
1817
    int ret = TRUE;
1818

1819
    if (!vshConnectionUsability(ctl, ctl->conn))
1820 1821
        return FALSE;

1822
    if (vshCommandOptString(cmd, "file", &from) <= 0)
1823
        return FALSE;
1824 1825

    if (virDomainRestore(ctl->conn, from) == 0) {
1826
        vshPrint(ctl, _("Domain restored from %s\n"), from);
1827
    } else {
1828
        vshError(ctl, _("Failed to restore domain from %s"), from);
1829 1830 1831 1832 1833
        ret = FALSE;
    }
    return ret;
}

D
Daniel Veillard 已提交
1834 1835 1836
/*
 * "dump" command
 */
1837
static const vshCmdInfo info_dump[] = {
1838 1839
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
1840 1841 1842
    {NULL, NULL}
};

1843
static const vshCmdOptDef opts_dump[] = {
1844 1845 1846 1847
    {"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 已提交
1848 1849 1850 1851
    {NULL, 0, 0, NULL}
};

static int
1852
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
1853 1854
{
    virDomainPtr dom;
1855 1856
    const char *name = NULL;
    const char *to = NULL;
D
Daniel Veillard 已提交
1857
    int ret = TRUE;
1858
    int flags = 0;
D
Daniel Veillard 已提交
1859

1860
    if (!vshConnectionUsability(ctl, ctl->conn))
D
Daniel Veillard 已提交
1861 1862
        return FALSE;

1863
    if (vshCommandOptString(cmd, "file", &to) <= 0)
D
Daniel Veillard 已提交
1864 1865
        return FALSE;

J
Jim Meyering 已提交
1866
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
D
Daniel Veillard 已提交
1867 1868
        return FALSE;

P
Paolo Bonzini 已提交
1869 1870
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
1871 1872 1873 1874
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;

    if (virDomainCoreDump(dom, to, flags) == 0) {
1875
        vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
D
Daniel Veillard 已提交
1876
    } else {
1877
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
D
Daniel Veillard 已提交
1878 1879 1880 1881 1882 1883 1884
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

1885 1886 1887
/*
 * "resume" command
 */
1888
static const vshCmdInfo info_resume[] = {
1889 1890
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
1891
    {NULL, NULL}
1892 1893
};

1894
static const vshCmdOptDef opts_resume[] = {
1895
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1896
    {NULL, 0, 0, NULL}
1897 1898 1899
};

static int
1900
cmdResume(vshControl *ctl, const vshCmd *cmd)
1901
{
1902
    virDomainPtr dom;
K
Karel Zak 已提交
1903
    int ret = TRUE;
1904
    const char *name;
1905

1906
    if (!vshConnectionUsability(ctl, ctl->conn))
1907 1908
        return FALSE;

J
Jim Meyering 已提交
1909
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1910
        return FALSE;
1911 1912

    if (virDomainResume(dom) == 0) {
1913
        vshPrint(ctl, _("Domain %s resumed\n"), name);
1914
    } else {
1915
        vshError(ctl, _("Failed to resume domain %s"), name);
1916 1917
        ret = FALSE;
    }
1918

1919 1920 1921 1922
    virDomainFree(dom);
    return ret;
}

1923 1924 1925
/*
 * "shutdown" command
 */
1926
static const vshCmdInfo info_shutdown[] = {
1927 1928
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
1929
    {NULL, NULL}
1930 1931
};

1932
static const vshCmdOptDef opts_shutdown[] = {
1933
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1934
    {NULL, 0, 0, NULL}
1935 1936 1937
};

static int
1938
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
1939
{
1940 1941
    virDomainPtr dom;
    int ret = TRUE;
1942
    const char *name;
1943

1944
    if (!vshConnectionUsability(ctl, ctl->conn))
1945 1946
        return FALSE;

J
Jim Meyering 已提交
1947
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1948
        return FALSE;
1949 1950

    if (virDomainShutdown(dom) == 0) {
1951
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
1952
    } else {
1953
        vshError(ctl, _("Failed to shutdown domain %s"), name);
1954 1955
        ret = FALSE;
    }
1956

1957 1958 1959 1960
    virDomainFree(dom);
    return ret;
}

1961 1962 1963
/*
 * "reboot" command
 */
1964
static const vshCmdInfo info_reboot[] = {
1965 1966
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
1967 1968 1969
    {NULL, NULL}
};

1970
static const vshCmdOptDef opts_reboot[] = {
1971
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1972 1973 1974 1975
    {NULL, 0, 0, NULL}
};

static int
1976
cmdReboot(vshControl *ctl, const vshCmd *cmd)
1977 1978 1979
{
    virDomainPtr dom;
    int ret = TRUE;
1980
    const char *name;
1981

1982
    if (!vshConnectionUsability(ctl, ctl->conn))
1983 1984
        return FALSE;

J
Jim Meyering 已提交
1985
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1986 1987 1988
        return FALSE;

    if (virDomainReboot(dom, 0) == 0) {
1989
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
1990
    } else {
1991
        vshError(ctl, _("Failed to reboot domain %s"), name);
1992 1993 1994 1995 1996 1997 1998
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

1999 2000 2001
/*
 * "destroy" command
 */
2002
static const vshCmdInfo info_destroy[] = {
2003 2004
    {"help", N_("destroy a domain")},
    {"desc", N_("Destroy a given domain.")},
2005
    {NULL, NULL}
2006 2007
};

2008
static const vshCmdOptDef opts_destroy[] = {
2009
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2010
    {NULL, 0, 0, NULL}
2011 2012 2013
};

static int
2014
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2015
{
2016
    virDomainPtr dom;
K
Karel Zak 已提交
2017
    int ret = TRUE;
2018
    const char *name;
2019

2020
    if (!vshConnectionUsability(ctl, ctl->conn))
2021 2022
        return FALSE;

J
Jim Meyering 已提交
2023
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
2024
        return FALSE;
2025 2026

    if (virDomainDestroy(dom) == 0) {
2027
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2028
    } else {
2029
        vshError(ctl, _("Failed to destroy domain %s"), name);
2030 2031
        ret = FALSE;
    }
2032

2033
    virDomainFree(dom);
K
Karel Zak 已提交
2034 2035 2036 2037
    return ret;
}

/*
2038
 * "dominfo" command
K
Karel Zak 已提交
2039
 */
2040
static const vshCmdInfo info_dominfo[] = {
2041 2042
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2043
    {NULL, NULL}
K
Karel Zak 已提交
2044 2045
};

2046
static const vshCmdOptDef opts_dominfo[] = {
2047
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2048
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2049 2050 2051
};

static int
2052
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2053
{
K
Karel Zak 已提交
2054 2055
    virDomainInfo info;
    virDomainPtr dom;
2056
    virSecurityModel secmodel;
2057
    virSecurityLabelPtr seclabel;
2058
    int persistent = 0;
2059
    int ret = TRUE, autostart;
2060
    unsigned int id;
2061
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2062

2063
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
2064 2065
        return FALSE;

J
Jim Meyering 已提交
2066
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
K
Karel Zak 已提交
2067
        return FALSE;
2068

2069 2070
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2071
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2072
    else
2073
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2074 2075
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2076
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2077
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2078 2079

    if ((str = virDomainGetOSType(dom))) {
2080
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2081
        VIR_FREE(str);
2082 2083 2084
    }

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

2088
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2089 2090

        if (info.cpuTime != 0) {
2091
            double cpuUsed = info.cpuTime;
2092

2093
            cpuUsed /= 1000000000.0;
2094

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

2098 2099
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2100
                 info.maxMem);
2101
        else
2102
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2103 2104
                 _("no limit"));

2105
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2106 2107
                 info.memory);

K
Karel Zak 已提交
2108 2109 2110
    } else {
        ret = FALSE;
    }
2111

2112 2113 2114 2115 2116 2117 2118 2119 2120
    /* 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 */
2121
    if (!virDomainGetAutostart(dom, &autostart)) {
2122
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2123 2124 2125
                 autostart ? _("enable") : _("disable") );
    }

2126 2127 2128
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2129 2130 2131
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
            return FALSE;
2132 2133 2134
        } else {
            virFreeError(last_error);
            last_error = NULL;
2135
        }
2136 2137 2138 2139 2140 2141 2142
    } 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 */
2143
            if (VIR_ALLOC(seclabel) < 0) {
2144 2145
                virDomainFree(dom);
                return FALSE;
2146 2147 2148 2149 2150 2151
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
                return FALSE;
2152
            } else {
2153
                if (seclabel->label[0] != '\0')
2154
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
2155
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
2156
            }
2157 2158

            VIR_FREE(seclabel);
2159 2160
        }
    }
2161
    virDomainFree(dom);
K
Karel Zak 已提交
2162 2163 2164
    return ret;
}

2165 2166 2167 2168
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2169 2170
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2171 2172 2173 2174
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2175
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2176 2177 2178 2179 2180 2181 2182 2183 2184
    {NULL, 0, 0, NULL}
};


static int
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
L
Laine Stump 已提交
2185
    int ret = TRUE;
2186

2187
    if (!vshConnectionUsability(ctl, ctl->conn))
2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217
        return FALSE;

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;

    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 已提交
2218
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2219
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2220
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2221
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2222
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2223 2224 2225
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2226
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2227
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2228
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2229
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2230
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2231 2232 2233
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2234
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2235
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2236
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2237
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2238
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2239 2240 2241 2242 2243 2244 2245 2246 2247
        }
    } else {
        ret = FALSE;
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2248 2249 2250 2251
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2252 2253
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2254 2255 2256 2257
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2258
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2259 2260 2261 2262 2263 2264 2265 2266 2267
    {NULL, 0, 0, NULL}
};

static int
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int ret = TRUE;

2268
    if (!vshConnectionUsability(ctl, ctl->conn))
2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
        return FALSE;

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;

    if (virDomainAbortJob(dom) < 0)
        ret = FALSE;

    virDomainFree(dom);
    return ret;
}

2281 2282 2283
/*
 * "freecell" command
 */
2284
static const vshCmdInfo info_freecell[] = {
2285 2286
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2287 2288 2289
    {NULL, NULL}
};

2290
static const vshCmdOptDef opts_freecell[] = {
2291
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2292
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
2293 2294 2295 2296
    {NULL, 0, 0, NULL}
};

static int
2297
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2298
{
2299
    int func_ret = FALSE;
2300
    int ret;
2301
    int cell = -1, cell_given;
2302
    unsigned long long memory;
2303 2304 2305 2306
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
2307
    int all_given;
2308 2309 2310 2311
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
2312

2313

2314
    if (!vshConnectionUsability(ctl, ctl->conn))
2315 2316
        return FALSE;

2317 2318 2319 2320
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
2321 2322 2323 2324 2325 2326 2327 2328 2329
    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) {
2330 2331 2332
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2333 2334 2335
            goto cleanup;
        }

2336 2337 2338
        xml = xmlReadDoc((const xmlChar *) cap_xml, "node.xml", NULL,
                          XML_PARSE_NOENT | XML_PARSE_NONET |
                          XML_PARSE_NOWARNING);
2339

2340 2341
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2342 2343 2344
            goto cleanup;
        }

2345 2346 2347 2348 2349
        ctxt = xmlXPathNewContext(xml);
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
2350
            vshError(ctl, "%s", _("could not get information about "
2351
                                  "NUMA topology"));
2352 2353 2354
            goto cleanup;
        }

2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375
        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;
            }
        }

2376
        memory = 0;
2377 2378 2379 2380
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
2381 2382 2383 2384
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
2385
    } else {
2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399
        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));
2400 2401
    }

2402
    func_ret = TRUE;
2403

2404
cleanup:
2405 2406 2407
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
2408
    VIR_FREE(nodes);
2409 2410 2411
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
2412
    return func_ret;
2413 2414
}

E
Eric Blake 已提交
2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431
/*
 * "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}
};

static int
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
2432
    const char *type = NULL;
E
Eric Blake 已提交
2433 2434
    int vcpus;

2435 2436
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
2437
        return FALSE;
2438
    }
E
Eric Blake 已提交
2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523

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

    vcpus = virConnectGetMaxVcpus(ctl->conn, type);
    if (vcpus < 0)
        return FALSE;
    vshPrint(ctl, "%d\n", vcpus);

    return TRUE;
}

/*
 * "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}
};

static int
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int ret = TRUE;
    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"));
        return FALSE;
    }
    if (config && live) {
        vshError(ctl, "%s",
                 _("--config and --live cannot both be specified"));
        return FALSE;
    }
    /* 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");
        return FALSE;
    }

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;

    /* 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;
            }
2524 2525
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 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 2624 2625
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
            ret = FALSE;
        } 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);
            ret = FALSE;
        } 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);
            ret = FALSE;
        } 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);
            ret = FALSE;
        } 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;
}

2626 2627 2628
/*
 * "vcpuinfo" command
 */
2629
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
2630
    {"help", N_("detailed domain vcpu information")},
2631
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
2632 2633 2634
    {NULL, NULL}
};

2635
static const vshCmdOptDef opts_vcpuinfo[] = {
2636
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2637 2638 2639 2640
    {NULL, 0, 0, NULL}
};

static int
2641
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
    unsigned char *cpumap;
    int ncpus;
    size_t cpumaplen;
    int ret = TRUE;

2652
    if (!vshConnectionUsability(ctl, ctl->conn))
2653 2654
        return FALSE;

J
Jim Meyering 已提交
2655
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2656 2657 2658 2659
        return FALSE;

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
2660
        return FALSE;
2661 2662 2663 2664 2665 2666 2667
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
        return FALSE;
    }

2668
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
2669
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2670
    cpumap = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
2671

2672 2673 2674
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
                                   cpumap, cpumaplen)) >= 0) {
2675
        int n;
2676 2677 2678 2679 2680
        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 已提交
2681
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697
            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");
            }
        }
2698
    } else {
2699
        if (info.state == VIR_DOMAIN_SHUTOFF) {
2700 2701
            vshError(ctl, "%s",
                     _("Domain shut off, virtual CPUs not present."));
2702
        }
2703 2704 2705
        ret = FALSE;
    }

2706 2707
    VIR_FREE(cpumap);
    VIR_FREE(cpuinfo);
2708 2709 2710 2711 2712 2713 2714
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
2715
static const vshCmdInfo info_vcpupin[] = {
2716 2717
    {"help", N_("control domain vcpu affinity")},
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
2718 2719 2720
    {NULL, NULL}
};

2721
static const vshCmdOptDef opts_vcpupin[] = {
2722
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2723
    {"vcpu", VSH_OT_INT, VSH_OFLAG_REQ, N_("vcpu number")},
2724
    {"cpulist", VSH_OT_DATA, VSH_OFLAG_REQ, N_("host cpu number(s) (comma separated)")},
2725 2726 2727 2728
    {NULL, 0, 0, NULL}
};

static int
2729
cmdVcpupin(vshControl *ctl, const vshCmd *cmd)
2730 2731 2732 2733 2734
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    int vcpu;
2735
    const char *cpulist = NULL;
2736 2737 2738
    int ret = TRUE;
    unsigned char *cpumap;
    int cpumaplen;
2739 2740
    int i;
    enum { expect_num, expect_num_or_comma } state;
2741

2742
    if (!vshConnectionUsability(ctl, ctl->conn))
2743 2744
        return FALSE;

J
Jim Meyering 已提交
2745
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2746 2747
        return FALSE;

2748
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) <= 0) {
2749
        vshError(ctl, "%s", _("vcpupin: Invalid or missing vCPU number."));
2750 2751 2752 2753
        virDomainFree(dom);
        return FALSE;
    }

2754
    if (vshCommandOptString(cmd, "cpulist", &cpulist) <= 0) {
2755 2756 2757
        virDomainFree(dom);
        return FALSE;
    }
2758

2759 2760 2761 2762 2763 2764
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
        return FALSE;
    }

    if (virDomainGetInfo(dom, &info) != 0) {
2765
        vshError(ctl, "%s", _("vcpupin: failed to get domain informations."));
2766 2767 2768 2769 2770
        virDomainFree(dom);
        return FALSE;
    }

    if (vcpu >= info.nrVirtCpu) {
2771
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
2772 2773 2774 2775
        virDomainFree(dom);
        return FALSE;
    }

2776 2777 2778 2779
    /* Check that the cpulist parameter is a comma-separated list of
     * numbers and give an intelligent error message if not.
     */
    if (cpulist[0] == '\0') {
2780
        vshError(ctl, "%s", _("cpulist: Invalid format. Empty string."));
2781 2782 2783 2784 2785 2786 2787 2788
        virDomainFree (dom);
        return FALSE;
    }

    state = expect_num;
    for (i = 0; cpulist[i]; i++) {
        switch (state) {
        case expect_num:
2789
          if (!c_isdigit (cpulist[i])) {
2790 2791 2792
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2793 2794 2795 2796 2797 2798 2799 2800
                virDomainFree (dom);
                return FALSE;
            }
            state = expect_num_or_comma;
            break;
        case expect_num_or_comma:
            if (cpulist[i] == ',')
                state = expect_num;
2801
            else if (!c_isdigit (cpulist[i])) {
2802 2803 2804
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit or comma at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2805 2806 2807 2808 2809 2810
                virDomainFree (dom);
                return FALSE;
            }
        }
    }
    if (state == expect_num) {
2811 2812 2813
        vshError(ctl, _("cpulist: %s: Invalid format. Trailing comma "
                        "at position %d."),
                 cpulist, i);
2814 2815 2816 2817
        virDomainFree (dom);
        return FALSE;
    }

2818
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2819
    cpumap = vshCalloc(ctl, 1, cpumaplen);
2820 2821 2822 2823 2824 2825

    do {
        unsigned int cpu = atoi(cpulist);

        if (cpu < VIR_NODEINFO_MAXCPUS(nodeinfo)) {
            VIR_USE_CPU(cpumap, cpu);
2826
        } else {
2827
            vshError(ctl, _("Physical CPU %d doesn't exist."), cpu);
2828
            VIR_FREE(cpumap);
2829 2830
            virDomainFree(dom);
            return FALSE;
2831
        }
2832
        cpulist = strchr(cpulist, ',');
2833 2834 2835 2836 2837 2838 2839 2840
        if (cpulist)
            cpulist++;
    } while (cpulist);

    if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
        ret = FALSE;
    }

2841
    VIR_FREE(cpumap);
2842 2843 2844 2845
    virDomainFree(dom);
    return ret;
}

2846 2847 2848
/*
 * "setvcpus" command
 */
2849
static const vshCmdInfo info_setvcpus[] = {
2850 2851
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
2852 2853 2854
    {NULL, NULL}
};

2855
static const vshCmdOptDef opts_setvcpus[] = {
2856
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2857
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
2858 2859 2860
    {"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")},
2861 2862 2863 2864
    {NULL, 0, 0, NULL}
};

static int
2865
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
2866 2867 2868 2869
{
    virDomainPtr dom;
    int count;
    int ret = TRUE;
E
Eric Blake 已提交
2870 2871 2872 2873 2874 2875
    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));
2876

2877
    if (!vshConnectionUsability(ctl, ctl->conn))
2878 2879
        return FALSE;

J
Jim Meyering 已提交
2880
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2881 2882
        return FALSE;

2883 2884 2885 2886
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
2887

E
Eric Blake 已提交
2888 2889 2890 2891 2892
    if (!flags) {
        if (virDomainSetVcpus(dom, count) != 0) {
            ret = FALSE;
        }
    } else {
2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911
        /* 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"));
                ret = FALSE;
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
2912 2913 2914
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
            ret = FALSE;
        }
2915 2916
    }

2917
  cleanup:
2918 2919 2920 2921 2922 2923 2924
    virDomainFree(dom);
    return ret;
}

/*
 * "setmemory" command
 */
2925
static const vshCmdInfo info_setmem[] = {
2926 2927
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
2928 2929 2930
    {NULL, NULL}
};

2931
static const vshCmdOptDef opts_setmem[] = {
2932
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2933
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
2934 2935
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
2936
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
2937 2938 2939 2940
    {NULL, 0, 0, NULL}
};

static int
2941
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
2942 2943
{
    virDomainPtr dom;
2944
    virDomainInfo info;
2945
    unsigned long kilobytes = 0;
2946
    int ret = TRUE;
2947 2948
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
2949
    int current = vshCommandOptBool(cmd, "current");
2950 2951
    int flags = 0;

2952 2953 2954 2955 2956 2957 2958 2959 2960
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
            return FALSE;
        }
        flags = VIR_DOMAIN_MEM_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_MEM_CONFIG;
2961 2962
        if (live)
            flags |= VIR_DOMAIN_MEM_LIVE;
2963 2964 2965
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
2966
    }
2967

2968
    if (!vshConnectionUsability(ctl, ctl->conn))
2969 2970
        return FALSE;

J
Jim Meyering 已提交
2971
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2972 2973
        return FALSE;

2974 2975 2976 2977 2978
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
        return FALSE;
    }

2979
    if (kilobytes <= 0) {
2980
        virDomainFree(dom);
2981
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
2982 2983 2984
        return FALSE;
    }

2985 2986
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
2987
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
2988 2989 2990 2991 2992
        return FALSE;
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
2993
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
2994
                 kilobytes, info.maxMem);
2995 2996 2997
        return FALSE;
    }

2998
    if (flags == -1) {
2999 3000 3001 3002 3003 3004 3005
        if (virDomainSetMemory(dom, kilobytes) != 0) {
            ret = FALSE;
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            ret = FALSE;
        }
3006 3007 3008 3009 3010 3011 3012 3013 3014
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
3015
static const vshCmdInfo info_setmaxmem[] = {
3016 3017
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
3018 3019 3020
    {NULL, NULL}
};

3021
static const vshCmdOptDef opts_setmaxmem[] = {
3022
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3023
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
3024 3025 3026
    {"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")},
3027 3028 3029 3030
    {NULL, 0, 0, NULL}
};

static int
3031
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
3032 3033
{
    virDomainPtr dom;
3034
    virDomainInfo info;
3035
    int kilobytes = 0;
3036
    int ret = TRUE;
3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055
    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"));
            return FALSE;
        }
    } else {
        if (config)
            flags |= VIR_DOMAIN_MEM_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_MEM_LIVE;
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
3056

3057
    if (!vshConnectionUsability(ctl, ctl->conn))
3058 3059
        return FALSE;

J
Jim Meyering 已提交
3060
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
3061 3062
        return FALSE;

3063 3064 3065 3066 3067
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
        return FALSE;
    }

3068
    if (kilobytes <= 0) {
3069
        virDomainFree(dom);
3070
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
3071 3072 3073
        return FALSE;
    }

3074 3075
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
3076
        vshError(ctl, "%s", _("Unable to verify current MemorySize"));
3077 3078 3079
        return FALSE;
    }

3080 3081 3082 3083 3084 3085 3086 3087 3088 3089
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
            ret = FALSE;
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
            ret = FALSE;
        }
3090 3091
    }

3092 3093 3094 3095
    virDomainFree(dom);
    return ret;
}

3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225
/*
 * "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}
};

static int
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
    unsigned int i = 0;
    virBlkioParameterPtr params = NULL, temp = NULL;
    int ret = FALSE;

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;

    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 */
            ret = TRUE;
            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");
            }
        }

        ret = TRUE;
    } 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
            ret = TRUE;
    }

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

3226 3227 3228 3229
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
3230 3231 3232
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
3233 3234 3235 3236 3237 3238 3239
                "    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")},
3240
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3241
     N_("Max memory in kilobytes")},
3242
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3243
     N_("Memory during contention in kilobytes")},
3244
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3245
     N_("Max memory plus swap in kilobytes")},
3246
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
3247
     N_("Min guaranteed memory in kilobytes")},
3248 3249 3250 3251 3252 3253 3254
    {NULL, 0, 0, NULL}
};

static int
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
3255 3256
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267
    int nparams = 0;
    unsigned int i = 0;
    virMemoryParameterPtr params = NULL, temp = NULL;
    int ret = FALSE;

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;

3268 3269 3270 3271 3272 3273 3274 3275 3276
    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;
    }

3277 3278 3279 3280 3281 3282 3283 3284 3285
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

3286 3287 3288
    if (min_guarantee)
        nparams++;

3289 3290
    if (nparams == 0) {
        /* get the number of memory parameters */
3291
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, 0) != 0) {
3292 3293 3294 3295 3296
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

3297 3298 3299 3300 3301 3302
        if (nparams == 0) {
            /* nothing to output */
            ret = TRUE;
            goto cleanup;
        }

3303
        /* now go get all the memory parameters */
E
Eric Blake 已提交
3304
        params = vshCalloc(ctl, nparams, sizeof(*params));
3305
        if (virDomainGetMemoryParameters(dom, params, &nparams, 0) != 0) {
3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324
            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:
3325 3326 3327 3328 3329
                    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);
3330 3331 3332 3333 3334 3335 3336 3337 3338 3339
                    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:
3340
                    vshPrint(ctl, "unimplemented memory parameter type\n");
3341 3342 3343 3344 3345 3346
            }
        }

        ret = TRUE;
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
3347
        params = vshCalloc(ctl, nparams, sizeof(*params));
3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370

        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;
3371
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
3372 3373
                        sizeof(temp->field));
                swap_hard_limit = 0;
3374 3375 3376 3377 3378
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
3379
            }
3380 3381 3382 3383

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
3384 3385
        }
        if (virDomainSetMemoryParameters(dom, params, nparams, 0) != 0)
3386
            vshError(ctl, "%s", _("Unable to change memory parameters"));
3387 3388 3389 3390 3391
        else
            ret = TRUE;
    }

  cleanup:
E
Eric Blake 已提交
3392
    VIR_FREE(params);
3393 3394 3395 3396
    virDomainFree(dom);
    return ret;
}

3397 3398 3399
/*
 * "nodeinfo" command
 */
3400
static const vshCmdInfo info_nodeinfo[] = {
3401 3402
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
3403 3404 3405 3406
    {NULL, NULL}
};

static int
3407
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3408 3409
{
    virNodeInfo info;
3410

3411
    if (!vshConnectionUsability(ctl, ctl->conn))
3412 3413 3414
        return FALSE;

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
3415
        vshError(ctl, "%s", _("failed to get node information"));
3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426
        return FALSE;
    }
    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);

3427 3428 3429
    return TRUE;
}

3430 3431 3432
/*
 * "capabilities" command
 */
3433
static const vshCmdInfo info_capabilities[] = {
3434 3435
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
3436 3437 3438 3439
    {NULL, NULL}
};

static int
3440
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3441 3442 3443
{
    char *caps;

3444
    if (!vshConnectionUsability(ctl, ctl->conn))
3445 3446 3447
        return FALSE;

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
3448
        vshError(ctl, "%s", _("failed to get capabilities"));
3449 3450 3451
        return FALSE;
    }
    vshPrint (ctl, "%s\n", caps);
3452
    VIR_FREE(caps);
3453 3454 3455 3456

    return TRUE;
}

3457 3458 3459
/*
 * "dumpxml" command
 */
3460
static const vshCmdInfo info_dumpxml[] = {
3461 3462
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
3463
    {NULL, NULL}
3464 3465
};

3466
static const vshCmdOptDef opts_dumpxml[] = {
3467 3468 3469
    {"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")},
3470
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
3471
    {NULL, 0, 0, NULL}
3472 3473 3474
};

static int
3475
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
3476
{
3477
    virDomainPtr dom;
K
Karel Zak 已提交
3478
    int ret = TRUE;
3479
    char *dump;
3480 3481 3482
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
3483
    int update = vshCommandOptBool(cmd, "update-cpu");
3484 3485 3486 3487 3488

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
3489 3490
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
3491

3492
    if (!vshConnectionUsability(ctl, ctl->conn))
3493 3494
        return FALSE;

J
Jim Meyering 已提交
3495
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
3496
        return FALSE;
3497

3498
    dump = virDomainGetXMLDesc(dom, flags);
3499
    if (dump != NULL) {
3500
        vshPrint(ctl, "%s", dump);
3501
        VIR_FREE(dump);
3502 3503 3504
    } else {
        ret = FALSE;
    }
3505

3506 3507 3508 3509
    virDomainFree(dom);
    return ret;
}

3510 3511 3512 3513
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
3514 3515
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
3516 3517 3518 3519
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
3520 3521
    {"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")},
3522 3523 3524 3525 3526 3527 3528
    {NULL, 0, 0, NULL}
};

static int
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
    int ret = TRUE;
3529 3530
    const char *format = NULL;
    const char *configFile = NULL;
3531 3532 3533 3534
    char *configData;
    char *xmlData;
    int flags = 0;

3535
    if (!vshConnectionUsability(ctl, ctl->conn))
3536 3537
        return FALSE;

3538 3539 3540
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
        return FALSE;
3541

3542
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
3543 3544 3545 3546
        return FALSE;

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
3547
        vshPrint(ctl, "%s", xmlData);
3548
        VIR_FREE(xmlData);
3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559
    } else {
        ret = FALSE;
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
3560 3561
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
3562 3563 3564 3565
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
3566 3567
    {"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")},
3568 3569 3570 3571 3572 3573 3574
    {NULL, 0, 0, NULL}
};

static int
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
    int ret = TRUE;
3575 3576
    const char *format = NULL;
    const char *xmlFile = NULL;
3577 3578 3579 3580
    char *configData;
    char *xmlData;
    int flags = 0;

3581
    if (!vshConnectionUsability(ctl, ctl->conn))
3582 3583
        return FALSE;

3584 3585 3586
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
        return FALSE;
3587

3588
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
3589 3590 3591 3592
        return FALSE;

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
3593
        vshPrint(ctl, "%s", configData);
3594
        VIR_FREE(configData);
3595 3596 3597 3598 3599 3600 3601
    } else {
        ret = FALSE;
    }

    return ret;
}

K
Karel Zak 已提交
3602
/*
K
Karel Zak 已提交
3603
 * "domname" command
K
Karel Zak 已提交
3604
 */
3605
static const vshCmdInfo info_domname[] = {
3606
    {"help", N_("convert a domain id or UUID to domain name")},
3607
    {"desc", ""},
3608
    {NULL, NULL}
K
Karel Zak 已提交
3609 3610
};

3611
static const vshCmdOptDef opts_domname[] = {
3612
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
3613
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3614 3615 3616
};

static int
3617
cmdDomname(vshControl *ctl, const vshCmd *cmd)
3618
{
K
Karel Zak 已提交
3619 3620
    virDomainPtr dom;

3621
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3622
        return FALSE;
J
Jim Meyering 已提交
3623
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3624
                                      VSH_BYID|VSH_BYUUID)))
K
Karel Zak 已提交
3625
        return FALSE;
3626

K
Karel Zak 已提交
3627 3628
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
K
Karel Zak 已提交
3629 3630 3631 3632
    return TRUE;
}

/*
K
Karel Zak 已提交
3633
 * "domid" command
K
Karel Zak 已提交
3634
 */
3635
static const vshCmdInfo info_domid[] = {
3636
    {"help", N_("convert a domain name or UUID to domain id")},
3637
    {"desc", ""},
3638
    {NULL, NULL}
K
Karel Zak 已提交
3639 3640
};

3641
static const vshCmdOptDef opts_domid[] = {
3642
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
3643
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3644 3645 3646
};

static int
3647
cmdDomid(vshControl *ctl, const vshCmd *cmd)
3648
{
3649
    virDomainPtr dom;
3650
    unsigned int id;
K
Karel Zak 已提交
3651

3652
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3653
        return FALSE;
J
Jim Meyering 已提交
3654
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3655
                                      VSH_BYNAME|VSH_BYUUID)))
K
Karel Zak 已提交
3656
        return FALSE;
3657

3658 3659
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3660
        vshPrint(ctl, "%s\n", "-");
3661
    else
3662
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
3663 3664 3665
    virDomainFree(dom);
    return TRUE;
}
3666

K
Karel Zak 已提交
3667 3668 3669
/*
 * "domuuid" command
 */
3670
static const vshCmdInfo info_domuuid[] = {
3671
    {"help", N_("convert a domain name or id to domain UUID")},
3672
    {"desc", ""},
K
Karel Zak 已提交
3673 3674 3675
    {NULL, NULL}
};

3676
static const vshCmdOptDef opts_domuuid[] = {
3677
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
3678 3679 3680 3681
    {NULL, 0, 0, NULL}
};

static int
3682
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
3683 3684
{
    virDomainPtr dom;
3685
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
3686

3687
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3688
        return FALSE;
J
Jim Meyering 已提交
3689
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3690
                                      VSH_BYNAME|VSH_BYID)))
K
Karel Zak 已提交
3691
        return FALSE;
3692

K
Karel Zak 已提交
3693 3694 3695
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
3696
        vshError(ctl, "%s", _("failed to get domain UUID"));
3697

3698
    virDomainFree(dom);
K
Karel Zak 已提交
3699 3700 3701
    return TRUE;
}

3702 3703 3704
/*
 * "migrate" command
 */
3705
static const vshCmdInfo info_migrate[] = {
3706 3707
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
3708 3709 3710
    {NULL, NULL}
};

3711
static const vshCmdOptDef opts_migrate[] = {
3712 3713 3714 3715 3716 3717 3718
    {"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")},
3719 3720
    {"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 已提交
3721
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
3722
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3723
    {"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)")},
3724 3725
    {"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 已提交
3726
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
3727 3728 3729
    {NULL, 0, 0, NULL}
};

3730 3731 3732 3733 3734 3735 3736 3737
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
3738
{
3739
    char ret = '1';
3740
    virDomainPtr dom = NULL;
3741 3742 3743 3744
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
    int flags = 0;
3745 3746 3747
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
3748 3749
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;
3750 3751 3752 3753 3754

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

3757
    if (!vshConnectionUsability (ctl, ctl->conn))
3758
        goto out;
3759

J
Jim Meyering 已提交
3760
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
3761
        goto out;
3762

3763 3764
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
3765 3766
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
3767
        goto out;
3768
    }
3769 3770 3771

    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
3772 3773
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
3774 3775 3776
    if (vshCommandOptBool (cmd, "tunnelled"))
        flags |= VIR_MIGRATE_TUNNELLED;

C
Chris Lalancette 已提交
3777 3778 3779 3780 3781
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

3782 3783 3784
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

3785 3786 3787 3788 3789 3790
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

3791 3792 3793 3794
    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. */
3795

3796
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
3797
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
3798
            goto out;
3799
        }
3800

3801
        if (virDomainMigrateToURI (dom, desturi, flags, dname, 0) == 0)
3802
            ret = '0';
3803 3804 3805 3806 3807 3808
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
3809
        if (!dconn) goto out;
3810 3811 3812 3813

        ddom = virDomainMigrate (dom, dconn, flags, dname, migrateuri, 0);
        if (ddom) {
            virDomainFree(ddom);
3814
            ret = '0';
3815 3816 3817
        }
        virConnectClose (dconn);
    }
3818

3819
out:
3820
#if HAVE_PTHREAD_SIGMASK
3821 3822
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
3823
#endif
3824
    if (dom) virDomainFree (dom);
3825 3826 3827
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851
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);
}

3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862
static int
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
3863 3864
    virDomainJobInfo jobinfo;
    bool verbose = false;
3865
    int timeout = 0;
W
Wen Congyang 已提交
3866 3867
    struct timeval start, curr;
    bool live_flag = false;
3868
    vshCtrlData data;
3869 3870 3871 3872 3873 3874
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
#endif
3875 3876 3877 3878

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;

W
Wen Congyang 已提交
3879 3880 3881
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
3882 3883
    if (vshCommandOptBool (cmd, "live"))
        live_flag = TRUE;
3884
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901
        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;
        }
    }

3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924
    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 已提交
3925
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
3926
    while (1) {
3927
repoll:
W
Wen Congyang 已提交
3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
                    ret = TRUE;
                    if (verbose) {
                        /* print [100 %] */
                        print_job_progress(0, 1);
                    }
                } else
                    ret = FALSE;
3939
            } else
W
Wen Congyang 已提交
3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955
                ret = FALSE;
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    ret = FALSE;
                    intCaught = 0;
                } else
                    goto repoll;
            }
            break;
        }

W
Wen Congyang 已提交
3956 3957 3958 3959 3960 3961 3962 3963 3964
        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 已提交
3965
        if (verbose) {
3966
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
3967
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
3968
#endif
W
Wen Congyang 已提交
3969
            ret = virDomainGetJobInfo(dom, &jobinfo);
3970
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
3971
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
3972
#endif
W
Wen Congyang 已提交
3973 3974
            if (ret == 0)
                print_job_progress(jobinfo.dataRemaining, jobinfo.dataTotal);
3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
3986 3987 3988
    return ret;
}

3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999
/*
 * "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")},
4000
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
4001 4002 4003 4004 4005 4006 4007
    {NULL, 0, 0, NULL}
};

static int
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
4008
    long long downtime = 0;
4009 4010
    int ret = FALSE;

4011
    if (!vshConnectionUsability(ctl, ctl->conn))
4012 4013 4014 4015 4016
        return FALSE;

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;

4017 4018
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

    ret = TRUE;

done:
    virDomainFree(dom);
    return ret;
}

4033 4034 4035
/*
 * "net-autostart" command
 */
4036
static const vshCmdInfo info_network_autostart[] = {
4037
    {"help", N_("autostart a network")},
4038
    {"desc",
4039
     N_("Configure a network to be automatically started at boot.")},
4040 4041 4042
    {NULL, NULL}
};

4043
static const vshCmdOptDef opts_network_autostart[] = {
4044 4045
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4046 4047 4048 4049
    {NULL, 0, 0, NULL}
};

static int
4050
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
4051 4052
{
    virNetworkPtr network;
4053
    const char *name;
4054 4055
    int autostart;

4056
    if (!vshConnectionUsability(ctl, ctl->conn))
4057 4058
        return FALSE;

J
Jim Meyering 已提交
4059
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
4060 4061 4062 4063 4064
        return FALSE;

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
4065
        if (autostart)
4066
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
4067
        else
4068
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
4069 4070 4071 4072
        virNetworkFree(network);
        return FALSE;
    }

4073
    if (autostart)
4074
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
4075
    else
4076
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
4077

L
Laine Stump 已提交
4078
    virNetworkFree(network);
4079 4080
    return TRUE;
}
K
Karel Zak 已提交
4081

4082 4083 4084
/*
 * "net-create" command
 */
4085
static const vshCmdInfo info_network_create[] = {
4086 4087
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
4088 4089 4090
    {NULL, NULL}
};

4091
static const vshCmdOptDef opts_network_create[] = {
4092
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4093 4094 4095 4096
    {NULL, 0, 0, NULL}
};

static int
4097
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
4098 4099
{
    virNetworkPtr network;
4100
    const char *from = NULL;
4101
    int ret = TRUE;
4102
    char *buffer;
4103

4104
    if (!vshConnectionUsability(ctl, ctl->conn))
4105 4106
        return FALSE;

4107
    if (vshCommandOptString(cmd, "file", &from) <= 0)
4108 4109
        return FALSE;

4110 4111
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
4112 4113

    network = virNetworkCreateXML(ctl->conn, buffer);
4114
    VIR_FREE(buffer);
4115

4116 4117 4118
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4119
        virNetworkFree(network);
4120
    } else {
4121
        vshError(ctl, _("Failed to create network from %s"), from);
4122 4123 4124 4125 4126 4127 4128 4129 4130
        ret = FALSE;
    }
    return ret;
}


/*
 * "net-define" command
 */
4131
static const vshCmdInfo info_network_define[] = {
4132 4133
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
4134 4135 4136
    {NULL, NULL}
};

4137
static const vshCmdOptDef opts_network_define[] = {
4138
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4139 4140 4141 4142
    {NULL, 0, 0, NULL}
};

static int
4143
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
4144 4145
{
    virNetworkPtr network;
4146
    const char *from = NULL;
4147
    int ret = TRUE;
4148
    char *buffer;
4149

4150
    if (!vshConnectionUsability(ctl, ctl->conn))
4151 4152
        return FALSE;

4153
    if (vshCommandOptString(cmd, "file", &from) <= 0)
4154 4155
        return FALSE;

4156 4157
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
4158 4159

    network = virNetworkDefineXML(ctl->conn, buffer);
4160
    VIR_FREE(buffer);
4161

4162 4163 4164
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4165
        virNetworkFree(network);
4166
    } else {
4167
        vshError(ctl, _("Failed to define network from %s"), from);
4168 4169 4170 4171 4172 4173 4174 4175 4176
        ret = FALSE;
    }
    return ret;
}


/*
 * "net-destroy" command
 */
4177
static const vshCmdInfo info_network_destroy[] = {
4178 4179
    {"help", N_("destroy a network")},
    {"desc", N_("Destroy a given network.")},
4180 4181 4182
    {NULL, NULL}
};

4183
static const vshCmdOptDef opts_network_destroy[] = {
4184
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4185 4186 4187 4188
    {NULL, 0, 0, NULL}
};

static int
4189
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
4190 4191 4192
{
    virNetworkPtr network;
    int ret = TRUE;
4193
    const char *name;
4194

4195
    if (!vshConnectionUsability(ctl, ctl->conn))
4196 4197
        return FALSE;

J
Jim Meyering 已提交
4198
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
4199 4200 4201 4202 4203
        return FALSE;

    if (virNetworkDestroy(network) == 0) {
        vshPrint(ctl, _("Network %s destroyed\n"), name);
    } else {
4204
        vshError(ctl, _("Failed to destroy network %s"), name);
4205 4206 4207
        ret = FALSE;
    }

4208
    virNetworkFree(network);
4209 4210 4211 4212 4213 4214 4215
    return ret;
}


/*
 * "net-dumpxml" command
 */
4216
static const vshCmdInfo info_network_dumpxml[] = {
4217 4218
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
4219 4220 4221
    {NULL, NULL}
};

4222
static const vshCmdOptDef opts_network_dumpxml[] = {
4223
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4224 4225 4226 4227
    {NULL, 0, 0, NULL}
};

static int
4228
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
4229 4230 4231 4232 4233
{
    virNetworkPtr network;
    int ret = TRUE;
    char *dump;

4234
    if (!vshConnectionUsability(ctl, ctl->conn))
4235 4236
        return FALSE;

J
Jim Meyering 已提交
4237
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
4238 4239 4240 4241
        return FALSE;

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
4242
        vshPrint(ctl, "%s", dump);
4243
        VIR_FREE(dump);
4244 4245 4246 4247 4248 4249 4250 4251
    } else {
        ret = FALSE;
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309
/*
 * "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}
};

static int
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))
        return FALSE;

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
        return FALSE;

    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);
    return TRUE;
}
4310

4311 4312 4313 4314
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
4315 4316
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
4317 4318 4319 4320
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
4321
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
    int ret = FALSE;
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
4334
    int flags = VIR_INTERFACE_XML_INACTIVE;
4335

4336
    if (!vshConnectionUsability(ctl, ctl->conn))
4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375
        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));
        ret = TRUE;
        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)) {
4376 4377
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395
        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));

    ret = TRUE;

cleanup:
    if (iface)
        virInterfaceFree (iface);

4396 4397 4398
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
4399 4400 4401

    if (tmp) {
        unlink (tmp);
4402
        VIR_FREE(tmp);
4403 4404 4405 4406 4407
    }

    return ret;
}

4408 4409 4410
/*
 * "net-list" command
 */
4411
static const vshCmdInfo info_network_list[] = {
4412 4413
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
4414 4415 4416
    {NULL, NULL}
};

4417
static const vshCmdOptDef opts_network_list[] = {
4418 4419
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
4420 4421 4422 4423
    {NULL, 0, 0, NULL}
};

static int
4424
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4425 4426 4427 4428 4429
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
4430
    char **activeNames = NULL, **inactiveNames = NULL;
4431 4432
    inactive |= all;

4433
    if (!vshConnectionUsability(ctl, ctl->conn))
4434 4435 4436
        return FALSE;

    if (active) {
4437 4438
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
4439
            vshError(ctl, "%s", _("Failed to list active networks"));
4440
            return FALSE;
4441
        }
4442
        if (maxactive) {
4443
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
4444

4445
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
4446
                                                    maxactive)) < 0) {
4447
                vshError(ctl, "%s", _("Failed to list active networks"));
4448
                VIR_FREE(activeNames);
4449 4450
                return FALSE;
            }
4451

4452
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
4453
        }
4454 4455
    }
    if (inactive) {
4456 4457
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
4458
            vshError(ctl, "%s", _("Failed to list inactive networks"));
4459
            VIR_FREE(activeNames);
4460
            return FALSE;
4461
        }
4462 4463 4464
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4465 4466 4467
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
4468
                vshError(ctl, "%s", _("Failed to list inactive networks"));
4469 4470
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
4471 4472
                return FALSE;
            }
4473

4474 4475
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
4476
    }
4477 4478
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
4479
    vshPrintExtra(ctl, "-----------------------------------------\n");
4480 4481

    for (i = 0; i < maxactive; i++) {
4482 4483
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
4484 4485
        const char *autostartStr;
        int autostart = 0;
4486 4487 4488

        /* this kind of work with networks is not atomic operation */
        if (!network) {
4489
            VIR_FREE(activeNames[i]);
4490
            continue;
4491
        }
4492

4493 4494 4495
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
4496
            autostartStr = autostart ? _("yes") : _("no");
4497 4498 4499 4500 4501

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
4502
        virNetworkFree(network);
4503
        VIR_FREE(activeNames[i]);
4504 4505 4506
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
4507 4508
        const char *autostartStr;
        int autostart = 0;
4509 4510 4511

        /* this kind of work with networks is not atomic operation */
        if (!network) {
4512
            VIR_FREE(inactiveNames[i]);
4513
            continue;
4514
        }
4515

4516 4517 4518
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
4519
            autostartStr = autostart ? _("yes") : _("no");
4520

4521
        vshPrint(ctl, "%-20s %-10s %-10s\n",
4522 4523 4524
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
4525 4526

        virNetworkFree(network);
4527
        VIR_FREE(inactiveNames[i]);
4528
    }
4529 4530
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
4531 4532 4533 4534 4535 4536 4537
    return TRUE;
}


/*
 * "net-name" command
 */
4538
static const vshCmdInfo info_network_name[] = {
4539
    {"help", N_("convert a network UUID to network name")},
4540
    {"desc", ""},
4541 4542 4543
    {NULL, NULL}
};

4544
static const vshCmdOptDef opts_network_name[] = {
4545
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
4546 4547 4548 4549
    {NULL, 0, 0, NULL}
};

static int
4550
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
4551 4552 4553
{
    virNetworkPtr network;

4554
    if (!vshConnectionUsability(ctl, ctl->conn))
4555
        return FALSE;
J
Jim Meyering 已提交
4556
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4557
                                           VSH_BYUUID)))
4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568
        return FALSE;

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
    return TRUE;
}


/*
 * "net-start" command
 */
4569
static const vshCmdInfo info_network_start[] = {
4570 4571
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
4572 4573 4574
    {NULL, NULL}
};

4575
static const vshCmdOptDef opts_network_start[] = {
4576
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
4577 4578 4579 4580
    {NULL, 0, 0, NULL}
};

static int
4581
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
4582 4583 4584 4585
{
    virNetworkPtr network;
    int ret = TRUE;

4586
    if (!vshConnectionUsability(ctl, ctl->conn))
4587 4588
        return FALSE;

J
Jim Meyering 已提交
4589
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
4590
         return FALSE;
4591 4592 4593

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
4594
                 virNetworkGetName(network));
4595
    } else {
4596
        vshError(ctl, _("Failed to start network %s"),
4597
                 virNetworkGetName(network));
4598 4599
        ret = FALSE;
    }
L
Laine Stump 已提交
4600
    virNetworkFree(network);
4601 4602 4603 4604 4605 4606 4607
    return ret;
}


/*
 * "net-undefine" command
 */
4608
static const vshCmdInfo info_network_undefine[] = {
4609 4610
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
4611 4612 4613
    {NULL, NULL}
};

4614
static const vshCmdOptDef opts_network_undefine[] = {
4615
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4616 4617 4618 4619
    {NULL, 0, 0, NULL}
};

static int
4620
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
4621 4622 4623
{
    virNetworkPtr network;
    int ret = TRUE;
4624
    const char *name;
4625

4626
    if (!vshConnectionUsability(ctl, ctl->conn))
4627 4628
        return FALSE;

J
Jim Meyering 已提交
4629
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
4630 4631 4632 4633 4634
        return FALSE;

    if (virNetworkUndefine(network) == 0) {
        vshPrint(ctl, _("Network %s has been undefined\n"), name);
    } else {
4635
        vshError(ctl, _("Failed to undefine network %s"), name);
4636 4637 4638
        ret = FALSE;
    }

L
Laine Stump 已提交
4639
    virNetworkFree(network);
4640 4641 4642 4643 4644 4645 4646
    return ret;
}


/*
 * "net-uuid" command
 */
4647
static const vshCmdInfo info_network_uuid[] = {
4648
    {"help", N_("convert a network name to network UUID")},
4649
    {"desc", ""},
4650 4651 4652
    {NULL, NULL}
};

4653
static const vshCmdOptDef opts_network_uuid[] = {
4654
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
4655 4656 4657 4658
    {NULL, 0, 0, NULL}
};

static int
4659
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
4660 4661 4662 4663
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

4664
    if (!vshConnectionUsability(ctl, ctl->conn))
4665 4666
        return FALSE;

J
Jim Meyering 已提交
4667
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4668
                                           VSH_BYNAME)))
4669 4670 4671 4672 4673
        return FALSE;

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

L
Laine Stump 已提交
4676
    virNetworkFree(network);
4677 4678 4679 4680
    return TRUE;
}


4681 4682 4683 4684 4685
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
4686 4687
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
4688 4689 4690 4691
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
4692 4693
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705
    {NULL, 0, 0, NULL}
};
static int
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;

4706
    if (!vshConnectionUsability(ctl, ctl->conn))
4707 4708 4709 4710 4711
        return FALSE;

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
4712
            vshError(ctl, "%s", _("Failed to list active interfaces"));
4713 4714 4715 4716 4717 4718 4719
            return FALSE;
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
4720
                vshError(ctl, "%s", _("Failed to list active interfaces"));
4721
                VIR_FREE(activeNames);
4722 4723 4724 4725 4726 4727 4728 4729 4730
                return FALSE;
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
4731
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4732
            VIR_FREE(activeNames);
4733 4734 4735 4736 4737
            return FALSE;
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4738 4739 4740
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
4741
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4742 4743
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
4744 4745 4746 4747 4748 4749
                return FALSE;
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
4750 4751
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
4752 4753 4754
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
4755 4756
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
4757 4758 4759

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4760
            VIR_FREE(activeNames[i]);
4761 4762 4763 4764 4765 4766 4767 4768
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4769
        VIR_FREE(activeNames[i]);
4770 4771
    }
    for (i = 0; i < maxinactive; i++) {
4772 4773
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
4774 4775 4776

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4777
            VIR_FREE(inactiveNames[i]);
4778 4779 4780 4781 4782 4783 4784 4785
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4786
        VIR_FREE(inactiveNames[i]);
4787
    }
4788 4789
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
4790 4791 4792 4793 4794 4795 4796 4797
    return TRUE;

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
4798
    {"help", N_("convert an interface MAC address to interface name")},
4799 4800 4801 4802 4803
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
4804
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
4805 4806 4807 4808 4809 4810 4811 4812
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

4813
    if (!vshConnectionUsability(ctl, ctl->conn))
4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827
        return FALSE;
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
        return FALSE;

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
    return TRUE;
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
4828
    {"help", N_("convert an interface name to interface MAC address")},
4829 4830 4831 4832 4833
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
4834
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
4835 4836 4837 4838 4839 4840 4841 4842
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

4843
    if (!vshConnectionUsability(ctl, ctl->conn))
4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857
        return FALSE;
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
        return FALSE;

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
    return TRUE;
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
4858 4859
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
4860 4861 4862 4863
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
4864 4865
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
4866 4867 4868 4869 4870 4871 4872 4873 4874
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
    int ret = TRUE;
    char *dump;
4875 4876 4877 4878 4879
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
4880

4881
    if (!vshConnectionUsability(ctl, ctl->conn))
4882 4883 4884 4885 4886
        return FALSE;

    if (!(iface = vshCommandOptInterface(ctl, cmd, NULL)))
        return FALSE;

4887
    dump = virInterfaceGetXMLDesc(iface, flags);
4888
    if (dump != NULL) {
4889
        vshPrint(ctl, "%s", dump);
4890
        VIR_FREE(dump);
4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902
    } else {
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
4903 4904
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
4905 4906 4907 4908
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
4909
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
4910 4911 4912 4913 4914 4915
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
4916
    virInterfacePtr iface;
4917
    const char *from = NULL;
4918 4919 4920
    int ret = TRUE;
    char *buffer;

4921
    if (!vshConnectionUsability(ctl, ctl->conn))
4922 4923
        return FALSE;

4924
    if (vshCommandOptString(cmd, "file", &from) <= 0)
4925 4926 4927 4928 4929
        return FALSE;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;

4930
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
4931
    VIR_FREE(buffer);
4932

4933
    if (iface != NULL) {
4934
        vshPrint(ctl, _("Interface %s defined from %s\n"),
4935
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
4936
        virInterfaceFree (iface);
4937
    } else {
4938
        vshError(ctl, _("Failed to define interface from %s"), from);
4939 4940 4941 4942 4943 4944 4945 4946 4947
        ret = FALSE;
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
4948 4949
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
4950 4951 4952 4953
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
4954
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4955 4956 4957 4958 4959 4960 4961 4962
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
    int ret = TRUE;
4963
    const char *name;
4964

4965
    if (!vshConnectionUsability(ctl, ctl->conn))
4966 4967 4968 4969 4970 4971 4972 4973
        return FALSE;

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
        return FALSE;

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
4974
        vshError(ctl, _("Failed to undefine interface %s"), name);
4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
4986 4987
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
4988 4989 4990 4991
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
4992
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4993 4994 4995 4996 4997 4998 4999 5000
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
    int ret = TRUE;
5001
    const char *name;
5002

5003
    if (!vshConnectionUsability(ctl, ctl->conn))
5004 5005 5006 5007 5008 5009 5010 5011
        return FALSE;

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
        return FALSE;

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
5012
        vshError(ctl, _("Failed to start interface %s"), name);
5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
5024 5025
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
    {"desc", N_("destroy a physical host interface.")},
5026 5027 5028 5029
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
5030
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5031 5032 5033 5034 5035 5036 5037 5038
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
    int ret = TRUE;
5039
    const char *name;
5040

5041
    if (!vshConnectionUsability(ctl, ctl->conn))
5042 5043 5044 5045 5046 5047 5048 5049
        return FALSE;

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
        return FALSE;

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
5050
        vshError(ctl, _("Failed to destroy interface %s"), name);
5051 5052 5053 5054 5055 5056 5057
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076

/*
 * "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}
};

static int
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
5077
    const char *from = NULL;
5078 5079 5080
    int ret = TRUE;
    char *buffer;

5081
    if (!vshConnectionUsability(ctl, ctl->conn))
5082 5083
        return FALSE;

5084
    if (vshCommandOptString(cmd, "file", &from) <= 0)
5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123
        return FALSE;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;

    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);
        ret = FALSE;
    }
    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}
};

static int
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
    int ret = TRUE;
5124
    const char *name;
5125

5126
    if (!vshConnectionUsability(ctl, ctl->conn))
5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164
        return FALSE;

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
        return FALSE;

    if (virNWFilterUndefine(nwfilter) == 0) {
        vshPrint(ctl, _("Network filter %s undefined\n"), name);
    } else {
        vshError(ctl, _("Failed to undefine network filter %s"), name);
        ret = FALSE;
    }

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

static int
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
    int ret = TRUE;
    char *dump;

5165
    if (!vshConnectionUsability(ctl, ctl->conn))
5166 5167 5168 5169 5170 5171 5172
        return FALSE;

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
        return FALSE;

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
5173
        vshPrint(ctl, "%s", dump);
5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202
        VIR_FREE(dump);
    } else {
        ret = FALSE;
    }

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

static int
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

5203
    if (!vshConnectionUsability(ctl, ctl->conn))
5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273
        return FALSE;

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
        return FALSE;
    }

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

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


/*
 * "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}
};

static int
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
    int ret = FALSE;
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

5274
    if (!vshConnectionUsability(ctl, ctl->conn))
5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 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 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346
        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));
        ret = TRUE;
        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));

    ret = TRUE;

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


5347
/**************************************************************************/
5348
/*
5349
 * "pool-autostart" command
5350
 */
5351
static const vshCmdInfo info_pool_autostart[] = {
5352
    {"help", N_("autostart a pool")},
5353
    {"desc",
5354
     N_("Configure a pool to be automatically started at boot.")},
5355
    {NULL, NULL}
5356 5357
};

5358
static const vshCmdOptDef opts_pool_autostart[] = {
5359 5360
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5361 5362
    {NULL, 0, 0, NULL}
};
5363 5364

static int
5365
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
5366
{
5367
    virStoragePoolPtr pool;
5368
    const char *name;
5369
    int autostart;
5370

5371
    if (!vshConnectionUsability(ctl, ctl->conn))
5372
        return FALSE;
5373

5374
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
5375 5376
        return FALSE;

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

5379 5380
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
5381
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
5382
        else
5383
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
5384
        virStoragePoolFree(pool);
5385 5386 5387
        return FALSE;
    }

5388
    if (autostart)
5389
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
5390
    else
5391
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
5392

L
Laine Stump 已提交
5393
    virStoragePoolFree(pool);
5394 5395 5396
    return TRUE;
}

5397
/*
5398
 * "pool-create" command
5399
 */
5400
static const vshCmdInfo info_pool_create[] = {
5401 5402
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
5403 5404 5405
    {NULL, NULL}
};

5406
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
5407
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
5408
     N_("file containing an XML pool description")},
5409 5410 5411
    {NULL, 0, 0, NULL}
};

5412
static int
5413
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
5414
{
5415
    virStoragePoolPtr pool;
5416
    const char *from = NULL;
5417 5418
    int ret = TRUE;
    char *buffer;
5419

5420
    if (!vshConnectionUsability(ctl, ctl->conn))
5421 5422
        return FALSE;

5423
    if (vshCommandOptString(cmd, "file", &from) <= 0)
5424 5425
        return FALSE;

5426 5427
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
5428

5429
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
5430
    VIR_FREE(buffer);
5431 5432 5433 5434

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5435
        virStoragePoolFree(pool);
5436
    } else {
5437
        vshError(ctl, _("Failed to create pool from %s"), from);
5438 5439 5440
        ret = FALSE;
    }
    return ret;
5441 5442
}

5443

5444 5445 5446 5447
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
5448
    {"help", N_("create a device defined "
5449
                          "by an XML file on the node")},
5450
    {"desc", N_("Create a device on the node.  Note that this "
5451 5452 5453 5454 5455 5456 5457
                          "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,
5458
     N_("file containing an XML description of the device")},
5459 5460 5461 5462 5463 5464 5465
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
5466
    const char *from = NULL;
5467 5468 5469
    int ret = TRUE;
    char *buffer;

5470
    if (!vshConnectionUsability(ctl, ctl->conn))
5471 5472
        return FALSE;

5473
    if (vshCommandOptString(cmd, "file", &from) <= 0)
5474 5475
        return FALSE;

5476
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
5477 5478 5479
        return FALSE;

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
5480
    VIR_FREE(buffer);
5481 5482 5483 5484

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
5485
        virNodeDeviceFree(dev);
5486
    } else {
5487
        vshError(ctl, _("Failed to create node device from %s"), from);
5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498
        ret = FALSE;
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
5499 5500
    {"help", N_("destroy a device on the node")},
    {"desc", N_("Destroy a device on the node.  Note that this "
5501 5502 5503 5504 5505 5506
                          "command destroys devices on the physical host ")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
5507
     N_("name of the device to be destroyed")},
5508 5509 5510 5511 5512 5513 5514 5515
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
    int ret = TRUE;
5516
    const char *name = NULL;
5517

5518
    if (!vshConnectionUsability(ctl, ctl->conn)) {
5519 5520 5521
        return FALSE;
    }

5522
    if (vshCommandOptString(cmd, "name", &name) <= 0)
5523 5524 5525 5526 5527 5528 5529
        return FALSE;

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
5530
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
5531 5532 5533 5534 5535 5536 5537 5538
        ret = FALSE;
    }

    virNodeDeviceFree(dev);
    return ret;
}


5539
/*
5540
 * XML Building helper for pool-define-as and pool-create-as
5541
 */
5542
static const vshCmdOptDef opts_pool_X_as[] = {
5543 5544 5545 5546 5547 5548 5549 5550
    {"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")},
5551
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
5552 5553 5554
    {NULL, 0, 0, NULL}
};

5555
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
5556

5557 5558
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
5559
    virBuffer buf = VIR_BUFFER_INITIALIZER;
5560

5561
    if (vshCommandOptString(cmd, "name", &name) <= 0)
5562
        goto cleanup;
5563
    if (vshCommandOptString(cmd, "type", &type) <= 0)
5564 5565
        goto cleanup;

5566 5567 5568 5569 5570
    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 ||
5571 5572
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
5573
        goto cleanup;
5574
    }
5575

5576 5577
    virBufferVSprintf(&buf, "<pool type='%s'>\n", type);
    virBufferVSprintf(&buf, "  <name>%s</name>\n", name);
5578
    if (srcHost || srcPath || srcDev) {
5579
        virBufferAddLit(&buf, "  <source>\n");
5580

5581 5582
        if (srcHost)
            virBufferVSprintf(&buf, "    <host name='%s'/>\n", srcHost);
5583 5584 5585 5586
        if (srcPath)
            virBufferVSprintf(&buf, "    <dir path='%s'/>\n", srcPath);
        if (srcDev)
            virBufferVSprintf(&buf, "    <device path='%s'/>\n", srcDev);
5587 5588
        if (srcFormat)
            virBufferVSprintf(&buf, "    <format type='%s'/>\n", srcFormat);
5589 5590
        if (srcName)
            virBufferVSprintf(&buf, "    <name>%s</name>\n", srcName);
5591 5592

        virBufferAddLit(&buf, "  </source>\n");
5593 5594
    }
    if (target) {
5595 5596 5597
        virBufferAddLit(&buf, "  <target>\n");
        virBufferVSprintf(&buf, "    <path>%s</path>\n", target);
        virBufferAddLit(&buf, "  </target>\n");
5598
    }
5599 5600 5601 5602 5603 5604
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
    }
5605 5606 5607 5608 5609 5610

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
    return TRUE;

cleanup:
5611
    virBufferFreeAndReset(&buf);
5612 5613 5614 5615 5616 5617 5618
    return FALSE;
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
5619 5620
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
5621 5622 5623 5624 5625 5626 5627
    {NULL, NULL}
};

static int
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
5628 5629
    const char *name;
    char *xml;
5630
    int printXML = vshCommandOptBool(cmd, "print-xml");
5631

5632
    if (!vshConnectionUsability(ctl, ctl->conn))
5633 5634 5635 5636
        return FALSE;

    if (!buildPoolXML(cmd, &name, &xml))
        return FALSE;
5637

5638
    if (printXML) {
5639
        vshPrint(ctl, "%s", xml);
5640
        VIR_FREE(xml);
5641
    } else {
5642
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
5643
        VIR_FREE(xml);
5644

5645 5646 5647 5648
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
5649
            vshError(ctl, _("Failed to create pool %s"), name);
5650 5651 5652 5653
            return FALSE;
        }
    }
    return TRUE;
5654 5655
}

5656

5657
/*
5658
 * "pool-define" command
5659
 */
5660
static const vshCmdInfo info_pool_define[] = {
5661 5662
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
5663 5664 5665
    {NULL, NULL}
};

5666
static const vshCmdOptDef opts_pool_define[] = {
5667
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
5668 5669 5670
    {NULL, 0, 0, NULL}
};

5671
static int
5672
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
5673
{
5674
    virStoragePoolPtr pool;
5675
    const char *from = NULL;
5676 5677
    int ret = TRUE;
    char *buffer;
5678

5679
    if (!vshConnectionUsability(ctl, ctl->conn))
5680 5681
        return FALSE;

5682
    if (vshCommandOptString(cmd, "file", &from) <= 0)
5683 5684
        return FALSE;

5685 5686
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
5687

5688
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
5689
    VIR_FREE(buffer);
5690 5691 5692 5693

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5694
        virStoragePoolFree(pool);
5695
    } else {
5696
        vshError(ctl, _("Failed to define pool from %s"), from);
5697 5698 5699
        ret = FALSE;
    }
    return ret;
5700 5701
}

5702

5703 5704 5705
/*
 * "pool-define-as" command
 */
5706
static const vshCmdInfo info_pool_define_as[] = {
5707 5708
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
5709 5710 5711 5712
    {NULL, NULL}
};

static int
5713
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
5714 5715
{
    virStoragePoolPtr pool;
5716 5717
    const char *name;
    char *xml;
5718
    int printXML = vshCommandOptBool(cmd, "print-xml");
5719

5720
    if (!vshConnectionUsability(ctl, ctl->conn))
5721 5722
        return FALSE;

5723
    if (!buildPoolXML(cmd, &name, &xml))
5724 5725
        return FALSE;

5726
    if (printXML) {
5727
        vshPrint(ctl, "%s", xml);
5728
        VIR_FREE(xml);
5729
    } else {
5730
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
5731
        VIR_FREE(xml);
5732

5733 5734 5735 5736
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
5737
            vshError(ctl, _("Failed to define pool %s"), name);
5738 5739 5740 5741
            return FALSE;
        }
    }
    return TRUE;
5742 5743 5744
}


5745
/*
5746
 * "pool-build" command
5747
 */
5748
static const vshCmdInfo info_pool_build[] = {
5749 5750
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
5751 5752 5753
    {NULL, NULL}
};

5754
static const vshCmdOptDef opts_pool_build[] = {
5755
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5756 5757 5758 5759
    {NULL, 0, 0, NULL}
};

static int
5760
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
5761
{
5762 5763
    virStoragePoolPtr pool;
    int ret = TRUE;
5764
    const char *name;
5765

5766
    if (!vshConnectionUsability(ctl, ctl->conn))
5767 5768
        return FALSE;

5769
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
5770 5771
        return FALSE;

5772
    if (virStoragePoolBuild(pool, 0) == 0) {
5773
        vshPrint(ctl, _("Pool %s built\n"), name);
5774
    } else {
5775
        vshError(ctl, _("Failed to build pool %s"), name);
5776
        ret = FALSE;
5777 5778
    }

5779 5780
    virStoragePoolFree(pool);

5781 5782 5783
    return ret;
}

5784

5785
/*
5786
 * "pool-destroy" command
5787
 */
5788
static const vshCmdInfo info_pool_destroy[] = {
5789 5790
    {"help", N_("destroy a pool")},
    {"desc", N_("Destroy a given pool.")},
5791 5792 5793
    {NULL, NULL}
};

5794
static const vshCmdOptDef opts_pool_destroy[] = {
5795
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5796 5797 5798 5799
    {NULL, 0, 0, NULL}
};

static int
5800
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
5801
{
5802 5803
    virStoragePoolPtr pool;
    int ret = TRUE;
5804
    const char *name;
5805

5806
    if (!vshConnectionUsability(ctl, ctl->conn))
5807 5808
        return FALSE;

5809
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
5810 5811
        return FALSE;

5812 5813 5814
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
5815
        vshError(ctl, _("Failed to destroy pool %s"), name);
5816
        ret = FALSE;
5817 5818
    }

5819
    virStoragePoolFree(pool);
5820 5821 5822
    return ret;
}

5823

5824
/*
5825 5826
 * "pool-delete" command
 */
5827
static const vshCmdInfo info_pool_delete[] = {
5828 5829
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
5830 5831 5832
    {NULL, NULL}
};

5833
static const vshCmdOptDef opts_pool_delete[] = {
5834
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5835 5836 5837 5838
    {NULL, 0, 0, NULL}
};

static int
5839
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
5840 5841 5842
{
    virStoragePoolPtr pool;
    int ret = TRUE;
5843
    const char *name;
5844

5845
    if (!vshConnectionUsability(ctl, ctl->conn))
5846 5847 5848 5849 5850 5851
        return FALSE;

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
        return FALSE;

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
5852
        vshPrint(ctl, _("Pool %s deleted\n"), name);
5853
    } else {
5854
        vshError(ctl, _("Failed to delete pool %s"), name);
5855 5856 5857
        ret = FALSE;
    }

L
Laine Stump 已提交
5858
    virStoragePoolFree(pool);
5859 5860 5861 5862 5863 5864 5865
    return ret;
}


/*
 * "pool-refresh" command
 */
5866
static const vshCmdInfo info_pool_refresh[] = {
5867 5868
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
5869 5870 5871
    {NULL, NULL}
};

5872
static const vshCmdOptDef opts_pool_refresh[] = {
5873
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5874 5875 5876 5877
    {NULL, 0, 0, NULL}
};

static int
5878
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
5879 5880 5881
{
    virStoragePoolPtr pool;
    int ret = TRUE;
5882
    const char *name;
5883

5884
    if (!vshConnectionUsability(ctl, ctl->conn))
5885 5886 5887 5888 5889 5890 5891 5892
        return FALSE;

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
        return FALSE;

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
5893
        vshError(ctl, _("Failed to refresh pool %s"), name);
5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904
        ret = FALSE;
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
5905
static const vshCmdInfo info_pool_dumpxml[] = {
5906 5907
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
5908 5909 5910
    {NULL, NULL}
};

5911
static const vshCmdOptDef opts_pool_dumpxml[] = {
5912
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5913 5914 5915 5916
    {NULL, 0, 0, NULL}
};

static int
5917
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
5918 5919 5920 5921 5922
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *dump;

5923
    if (!vshConnectionUsability(ctl, ctl->conn))
5924 5925 5926 5927 5928 5929 5930
        return FALSE;

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
        return FALSE;

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
5931
        vshPrint(ctl, "%s", dump);
5932
        VIR_FREE(dump);
5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944
    } else {
        ret = FALSE;
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
5945
static const vshCmdInfo info_pool_list[] = {
5946 5947
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
5948 5949 5950
    {NULL, NULL}
};

5951
static const vshCmdOptDef opts_pool_list[] = {
5952 5953
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
5954
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
5955 5956 5957 5958
    {NULL, 0, 0, NULL}
};

static int
5959
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5960
{
5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979
    virStoragePoolInfo info;
    char **poolNames = NULL;
    int i, functionReturn, ret;
    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 */
5980
    int all = vshCommandOptBool(cmd, "all");
5981 5982
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
5983 5984 5985
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

5986
    /* Check the connection to libvirtd daemon is still working */
5987
    if (!vshConnectionUsability(ctl, ctl->conn))
5988 5989
        return FALSE;

5990
    /* Retrieve the number of active storage pools */
5991
    if (active) {
5992 5993
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
5994
            vshError(ctl, "%s", _("Failed to list active pools"));
5995 5996 5997
            return FALSE;
        }
    }
5998 5999

    /* Retrieve the number of inactive storage pools */
6000
    if (inactive) {
6001 6002
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
6003
            vshError(ctl, "%s", _("Failed to list inactive pools"));
6004 6005
            return FALSE;
        }
6006
    }
6007

6008 6009
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
6010

6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023
    /* 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);
            return FALSE;
6024 6025 6026
        }
    }

6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037
    /* 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);
            return FALSE;
        }
    }
6038

6039 6040 6041 6042 6043 6044 6045 6046 6047 6048
    /* 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]);
6049
        if (!pool) {
6050
            VIR_FREE(poolNames[i]);
6051 6052 6053
            continue;
        }

6054
        /* Retrieve the autostart status of the pool */
6055
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
6056
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
6057
        else
6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075
            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;
        }
6076

6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 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
        /* 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 */
6189 6190 6191
        virStoragePoolFree(pool);
    }

6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209
    /* 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);
6210 6211
        }

6212 6213 6214 6215
        /* Cleanup and return */
        functionReturn = TRUE;
        goto cleanup;
    }
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 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326
    /* 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 */
    functionReturn = TRUE;
    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);
    }
    functionReturn = FALSE;
6327

6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339
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]);
6340
    }
6341 6342 6343 6344 6345 6346 6347

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

    /* Return the desired value */
    return functionReturn;
6348 6349
}

6350 6351 6352 6353
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
6354 6355
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6356 6357 6358 6359 6360
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6361 6362 6363
     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")},
6364
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
6365 6366 6367 6368 6369 6370
    {NULL, 0, 0, NULL}
};

static int
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6371
    const char *type = NULL, *host = NULL;
6372 6373
    char *srcSpec = NULL;
    char *srcList;
6374
    const char *initiator = NULL;
6375

6376 6377
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
6378 6379
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
6380
        return FALSE;
6381
    }
6382

6383
    if (!vshConnectionUsability(ctl, ctl->conn))
6384 6385 6386
        return FALSE;

    if (host) {
6387
        const char *port = NULL;
6388
        virBuffer buf = VIR_BUFFER_INITIALIZER;
6389 6390 6391 6392 6393 6394

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
            return FALSE;
        }
6395
        virBufferAddLit(&buf, "<source>\n");
6396
        virBufferVSprintf(&buf, "  <host name='%s'", host);
6397 6398 6399
        if (port)
            virBufferVSprintf(&buf, " port='%s'", port);
        virBufferAddLit(&buf, "/>\n");
6400 6401 6402 6403 6404
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
            virBufferVSprintf(&buf, "    <iqn name='%s'/>\n", initiator);
            virBufferAddLit(&buf, "  </initiator>\n");
        }
6405 6406 6407
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
6408 6409
            return FALSE;
        }
6410
        srcSpec = virBufferContentAndReset(&buf);
6411 6412 6413
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6414
    VIR_FREE(srcSpec);
6415
    if (srcList == NULL) {
6416
        vshError(ctl, _("Failed to find any %s pool sources"), type);
6417 6418 6419
        return FALSE;
    }
    vshPrint(ctl, "%s", srcList);
6420
    VIR_FREE(srcList);
6421 6422 6423 6424 6425 6426 6427 6428 6429

    return TRUE;
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
6430 6431
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6432 6433 6434 6435 6436
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6437
     N_("type of storage pool sources to discover")},
6438
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
6439
     N_("optional file of source xml to query for pools")},
6440 6441 6442 6443 6444 6445
    {NULL, 0, 0, NULL}
};

static int
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6446
    const char *type = NULL, *srcSpecFile = NULL;
6447
    char *srcSpec = NULL, *srcList;
6448

6449 6450 6451
    if (vshCommandOptString(cmd, "type", &type) <= 0)
        return FALSE;

6452 6453
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
6454
        return FALSE;
6455
    }
6456

6457
    if (!vshConnectionUsability(ctl, ctl->conn))
6458 6459 6460 6461 6462 6463
        return FALSE;

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
        return FALSE;

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6464
    VIR_FREE(srcSpec);
6465
    if (srcList == NULL) {
6466
        vshError(ctl, _("Failed to find any %s pool sources"), type);
6467 6468 6469
        return FALSE;
    }
    vshPrint(ctl, "%s", srcList);
6470
    VIR_FREE(srcList);
6471 6472 6473 6474 6475

    return TRUE;
}


6476 6477 6478
/*
 * "pool-info" command
 */
6479
static const vshCmdInfo info_pool_info[] = {
6480 6481
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
6482 6483 6484
    {NULL, NULL}
};

6485
static const vshCmdOptDef opts_pool_info[] = {
6486
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6487 6488 6489 6490
    {NULL, 0, 0, NULL}
};

static int
6491
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
6492 6493 6494
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
6495 6496
    int autostart = 0;
    int persistent = 0;
6497 6498 6499
    int ret = TRUE;
    char uuid[VIR_UUID_STRING_BUFLEN];

6500
    if (!vshConnectionUsability(ctl, ctl->conn))
6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530
        return FALSE;

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
        return FALSE;

    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;
6531 6532 6533 6534
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
6535 6536
        }

6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552
        /* 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"));

6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575
        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 {
        ret = FALSE;
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
6576
static const vshCmdInfo info_pool_name[] = {
6577
    {"help", N_("convert a pool UUID to pool name")},
6578
    {"desc", ""},
6579 6580 6581
    {NULL, NULL}
};

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

static int
6588
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
6589 6590 6591
{
    virStoragePoolPtr pool;

6592
    if (!vshConnectionUsability(ctl, ctl->conn))
6593 6594
        return FALSE;
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6595
                                           VSH_BYUUID)))
6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606
        return FALSE;

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
    return TRUE;
}


/*
 * "pool-start" command
 */
6607
static const vshCmdInfo info_pool_start[] = {
6608 6609
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
6610 6611 6612
    {NULL, NULL}
};

6613
static const vshCmdOptDef opts_pool_start[] = {
6614
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
6615 6616 6617 6618
    {NULL, 0, 0, NULL}
};

static int
6619
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
6620 6621 6622 6623
{
    virStoragePoolPtr pool;
    int ret = TRUE;

6624
    if (!vshConnectionUsability(ctl, ctl->conn))
6625 6626
        return FALSE;

6627
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
6628 6629 6630 6631 6632 6633
         return FALSE;

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
6634
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
6635 6636
        ret = FALSE;
    }
L
Laine Stump 已提交
6637 6638

    virStoragePoolFree(pool);
6639 6640 6641 6642
    return ret;
}


6643 6644 6645
/*
 * "vol-create-as" command
 */
6646
static const vshCmdInfo info_vol_create_as[] = {
6647 6648
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
6649 6650 6651
    {NULL, NULL}
};

6652
static const vshCmdOptDef opts_vol_create_as[] = {
6653 6654 6655 6656 6657
    {"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")},
6658 6659
    {"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")},
6660 6661 6662 6663 6664 6665 6666 6667 6668 6669
    {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 已提交
6670
        /* Deliberate fallthrough cases here :-) */
6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691
        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;
}

static int
6692
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
6693 6694 6695
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
6696
    char *xml;
6697 6698
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
6699
    unsigned long long capacity, allocation = 0;
6700
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6701

6702
    if (!vshConnectionUsability(ctl, ctl->conn))
6703 6704 6705 6706 6707 6708
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
                                     VSH_BYNAME)))
        return FALSE;

6709
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6710 6711
        goto cleanup;

6712
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
6713 6714
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
6715
        vshError(ctl, _("Malformed size %s"), capacityStr);
6716

6717 6718
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
6719
        vshError(ctl, _("Malformed size %s"), allocationStr);
6720

6721 6722 6723 6724 6725 6726 6727
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

6728

6729 6730 6731 6732 6733
    virBufferAddLit(&buf, "<volume>\n");
    virBufferVSprintf(&buf, "  <name>%s</name>\n", name);
    virBufferVSprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
    if (allocationStr)
        virBufferVSprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
6734 6735

    if (format) {
6736
        virBufferAddLit(&buf, "  <target>\n");
6737
        virBufferVSprintf(&buf, "    <format type='%s'/>\n",format);
6738
        virBufferAddLit(&buf, "  </target>\n");
6739
    }
6740

6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795
    /* 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);
            return FALSE;
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
            return FALSE;
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
        virBufferVSprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
        if (snapshotStrFormat)
            virBufferVSprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

6797 6798 6799 6800 6801 6802
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
6803
    VIR_FREE(xml);
6804 6805 6806 6807 6808 6809 6810
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
        return TRUE;
    } else {
6811
        vshError(ctl, _("Failed to create vol %s"), name);
6812 6813 6814 6815
        return FALSE;
    }

 cleanup:
6816
    virBufferFreeAndReset(&buf);
6817 6818 6819 6820 6821
    virStoragePoolFree(pool);
    return FALSE;
}


6822 6823 6824
/*
 * "pool-undefine" command
 */
6825
static const vshCmdInfo info_pool_undefine[] = {
6826 6827
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
6828 6829 6830
    {NULL, NULL}
};

6831
static const vshCmdOptDef opts_pool_undefine[] = {
6832
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6833 6834 6835 6836
    {NULL, 0, 0, NULL}
};

static int
6837
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
6838 6839 6840
{
    virStoragePoolPtr pool;
    int ret = TRUE;
6841
    const char *name;
6842

6843
    if (!vshConnectionUsability(ctl, ctl->conn))
6844 6845 6846 6847 6848 6849 6850 6851
        return FALSE;

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
        return FALSE;

    if (virStoragePoolUndefine(pool) == 0) {
        vshPrint(ctl, _("Pool %s has been undefined\n"), name);
    } else {
6852
        vshError(ctl, _("Failed to undefine pool %s"), name);
6853 6854 6855
        ret = FALSE;
    }

L
Laine Stump 已提交
6856
    virStoragePoolFree(pool);
6857 6858 6859 6860 6861 6862 6863
    return ret;
}


/*
 * "pool-uuid" command
 */
6864
static const vshCmdInfo info_pool_uuid[] = {
6865
    {"help", N_("convert a pool name to pool UUID")},
6866
    {"desc", ""},
6867 6868 6869
    {NULL, NULL}
};

6870
static const vshCmdOptDef opts_pool_uuid[] = {
6871
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
6872 6873 6874 6875
    {NULL, 0, 0, NULL}
};

static int
6876
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
6877 6878 6879 6880
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

6881
    if (!vshConnectionUsability(ctl, ctl->conn))
6882 6883 6884
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6885
                                           VSH_BYNAME)))
6886 6887 6888 6889 6890
        return FALSE;

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

L
Laine Stump 已提交
6893
    virStoragePoolFree(pool);
6894 6895 6896 6897 6898 6899 6900
    return TRUE;
}


/*
 * "vol-create" command
 */
6901
static const vshCmdInfo info_vol_create[] = {
6902 6903
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
6904 6905 6906
    {NULL, NULL}
};

6907
static const vshCmdOptDef opts_vol_create[] = {
6908 6909
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
6910 6911 6912 6913
    {NULL, 0, 0, NULL}
};

static int
6914
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
6915 6916 6917
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
6918
    const char *from = NULL;
6919 6920 6921
    int ret = TRUE;
    char *buffer;

6922
    if (!vshConnectionUsability(ctl, ctl->conn))
6923 6924 6925
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6926
                                           VSH_BYNAME)))
6927 6928
        return FALSE;

6929
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
6930 6931 6932 6933 6934
        virStoragePoolFree(pool);
        return FALSE;
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
6935
        virshReportError(ctl);
6936 6937 6938 6939 6940
        virStoragePoolFree(pool);
        return FALSE;
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
6941
    VIR_FREE(buffer);
6942 6943 6944 6945 6946 6947 6948
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
6949
        vshError(ctl, _("Failed to create vol from %s"), from);
6950 6951 6952 6953 6954
        ret = FALSE;
    }
    return ret;
}

6955 6956 6957 6958
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
6959 6960
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
6961 6962 6963 6964
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
6965 6966 6967
    {"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 已提交
6968
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
6969 6970 6971 6972 6973 6974 6975 6976
    {NULL, 0, 0, NULL}
};

static int
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
6977
    const char *from = NULL;
6978 6979 6980
    int ret = FALSE;
    char *buffer = NULL;

6981
    if (!vshConnectionUsability(ctl, ctl->conn))
6982 6983 6984 6985 6986
        goto cleanup;

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

6987
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
6988 6989 6990 6991 6992 6993 6994
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
6995
        virshReportError(ctl);
6996 6997 6998 6999 7000 7001 7002 7003 7004
        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 {
7005
        vshError(ctl, _("Failed to create vol from %s"), from);
7006 7007 7008 7009 7010
        goto cleanup;
    }

    ret = TRUE;
cleanup:
7011
    VIR_FREE(buffer);
7012 7013 7014 7015
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
7016 7017
    if (newvol)
        virStorageVolFree(newvol);
7018 7019 7020 7021
    return ret;
}

static xmlChar *
7022
makeCloneXML(const char *origxml, const char *newname) {
7023

7024 7025 7026
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056
    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[] = {
7057 7058
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
7059 7060 7061 7062
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
7063 7064
    {"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 已提交
7065
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7066 7067 7068 7069 7070 7071 7072 7073
    {NULL, 0, 0, NULL}
};

static int
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
7074
    const char *name = NULL;
7075
    char *origxml = NULL;
7076 7077 7078
    xmlChar *newxml = NULL;
    int ret = FALSE;

7079
    if (!vshConnectionUsability(ctl, ctl->conn))
7080 7081 7082 7083 7084 7085 7086
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
7087
        vshError(ctl, "%s", _("failed to get parent pool"));
7088 7089 7090
        goto cleanup;
    }

7091
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109
        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 {
7110
        vshError(ctl, _("Failed to clone vol from %s"),
7111 7112 7113 7114 7115 7116 7117
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

    ret = TRUE;

cleanup:
7118
    VIR_FREE(origxml);
7119 7120 7121
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
7122 7123
    if (newvol)
        virStorageVolFree(newvol);
7124 7125 7126 7127 7128
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141

/*
 * "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 已提交
7142
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241
    {"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);
}

static int
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
    int ret = FALSE;
    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"));
        return FALSE;
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
        return FALSE;
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
        return FALSE;
    }

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

    ret = TRUE;

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 已提交
7242
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 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 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335
    {"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);
}

static int
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
    int ret = FALSE;
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
    bool created = true;

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

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
        return FALSE;
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
        return FALSE;
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
        return FALSE;

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

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

    ret = TRUE;

cleanup:
    if (ret == FALSE && created)
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    VIR_FORCE_CLOSE(fd);
    return ret;
}


7336 7337 7338
/*
 * "vol-delete" command
 */
7339
static const vshCmdInfo info_vol_delete[] = {
7340 7341
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
7342 7343 7344
    {NULL, NULL}
};

7345
static const vshCmdOptDef opts_vol_delete[] = {
7346
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7347
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7348 7349 7350 7351
    {NULL, 0, 0, NULL}
};

static int
7352
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
7353 7354 7355
{
    virStorageVolPtr vol;
    int ret = TRUE;
7356
    const char *name;
7357

7358
    if (!vshConnectionUsability(ctl, ctl->conn))
7359 7360 7361 7362 7363 7364 7365
        return FALSE;

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
        return FALSE;
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
7366
        vshPrint(ctl, _("Vol %s deleted\n"), name);
7367
    } else {
7368
        vshError(ctl, _("Failed to delete vol %s"), name);
7369 7370 7371
        ret = FALSE;
    }

L
Laine Stump 已提交
7372
    virStorageVolFree(vol);
7373 7374 7375 7376
    return ret;
}


D
David Allan 已提交
7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387
/*
 * "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 已提交
7388
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
7389 7390 7391 7392 7393 7394 7395 7396
    {NULL, 0, 0, NULL}
};

static int
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
    int ret = TRUE;
7397
    const char *name;
D
David Allan 已提交
7398

7399
    if (!vshConnectionUsability(ctl, ctl->conn))
D
David Allan 已提交
7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417
        return FALSE;

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
        return FALSE;
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
        ret = FALSE;
    }

    virStorageVolFree(vol);
    return ret;
}


7418 7419 7420
/*
 * "vol-info" command
 */
7421
static const vshCmdInfo info_vol_info[] = {
7422 7423
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
7424 7425 7426
    {NULL, NULL}
};

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

static int
7434
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
7435 7436 7437 7438 7439
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
    int ret = TRUE;

7440
    if (!vshConnectionUsability(ctl, ctl->conn))
7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471
        return FALSE;

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        return FALSE;

    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 {
        ret = FALSE;
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
7472
static const vshCmdInfo info_vol_dumpxml[] = {
7473 7474
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
7475 7476 7477
    {NULL, NULL}
};

7478
static const vshCmdOptDef opts_vol_dumpxml[] = {
7479
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7480
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7481 7482 7483 7484
    {NULL, 0, 0, NULL}
};

static int
7485
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
7486 7487 7488 7489 7490
{
    virStorageVolPtr vol;
    int ret = TRUE;
    char *dump;

7491
    if (!vshConnectionUsability(ctl, ctl->conn))
7492 7493 7494 7495 7496 7497 7498
        return FALSE;

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        return FALSE;

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
7499
        vshPrint(ctl, "%s", dump);
7500
        VIR_FREE(dump);
7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512
    } else {
        ret = FALSE;
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
7513
static const vshCmdInfo info_vol_list[] = {
7514 7515
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
7516 7517 7518
    {NULL, NULL}
};

7519
static const vshCmdOptDef opts_vol_list[] = {
7520
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7521
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
7522 7523 7524 7525
    {NULL, 0, 0, NULL}
};

static int
7526
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7527
{
7528
    virStorageVolInfo volumeInfo;
7529 7530
    virStoragePoolPtr pool;
    char **activeNames = NULL;
7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
    int ret, functionReturn;
    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;
7548

7549
    /* Check the connection to libvirtd daemon is still working */
7550
    if (!vshConnectionUsability(ctl, ctl->conn))
7551 7552
        return FALSE;

7553
    /* Look up the pool information given to us by the user */
7554 7555 7556
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
        return FALSE;

7557 7558
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
7559

7560 7561 7562 7563 7564 7565
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
        return FALSE;
    }

7566 7567 7568 7569 7570
    /* 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) {
7571
            vshError(ctl, "%s", _("Failed to list active vols"));
7572
            VIR_FREE(activeNames);
7573 7574 7575 7576
            virStoragePoolFree(pool);
            return FALSE;
        }

7577 7578 7579 7580 7581
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

7584 7585 7586 7587 7588
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
7589

7590 7591 7592 7593
        /* 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"));
7594 7595
        }

7596 7597 7598 7599 7600 7601 7602 7603 7604
        /* 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 */
7605

7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660
                /* 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;
        }
7661

7662
        /* Cleanup memory allocation */
7663
        virStorageVolFree(vol);
7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713
    }

    /* 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 */
        functionReturn = TRUE;
        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 已提交
7714 7715 7716 7717 7718
    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);
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 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778

    /* 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 */
    functionReturn = TRUE;
    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);
    }
    functionReturn = FALSE;

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);
7779
        VIR_FREE(activeNames[i]);
7780
    }
7781 7782 7783 7784

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
7785
    VIR_FREE(activeNames);
7786
    virStoragePoolFree(pool);
7787 7788 7789

    /* Return the desired value */
    return functionReturn;
7790 7791 7792 7793 7794 7795
}


/*
 * "vol-name" command
 */
7796
static const vshCmdInfo info_vol_name[] = {
7797
    {"help", N_("returns the volume name for a given volume key or path")},
7798
    {"desc", ""},
7799 7800 7801
    {NULL, NULL}
};

7802
static const vshCmdOptDef opts_vol_name[] = {
7803
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
7804 7805 7806 7807
    {NULL, 0, 0, NULL}
};

static int
7808
cmdVolName(vshControl *ctl, const vshCmd *cmd)
7809 7810 7811
{
    virStorageVolPtr vol;

7812
    if (!vshConnectionUsability(ctl, ctl->conn))
7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824
        return FALSE;

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
        return FALSE;

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
    return TRUE;
}


J
Justin Clift 已提交
7825 7826 7827 7828 7829 7830 7831 7832 7833 7834
/*
 * "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[] = {
7835
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
7836 7837 7838 7839 7840 7841 7842 7843 7844
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

static int
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7845
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
7846 7847

    /* Check the connection to libvirtd daemon is still working */
7848
    if (!vshConnectionUsability(ctl, ctl->conn))
J
Justin Clift 已提交
7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864
        return FALSE;

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
        return FALSE;
    }

    /* 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);
        return FALSE;
    }

7865 7866 7867 7868 7869 7870 7871 7872 7873
    /* 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 已提交
7874 7875 7876 7877 7878 7879 7880

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
    return TRUE;
}

7881 7882 7883 7884

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

7891
static const vshCmdOptDef opts_vol_key[] = {
7892
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
7893
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7894 7895 7896 7897
    {NULL, 0, 0, NULL}
};

static int
7898
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
7899 7900 7901
{
    virStorageVolPtr vol;

7902
    if (!vshConnectionUsability(ctl, ctl->conn))
7903 7904
        return FALSE;

7905
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917
        return FALSE;

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
    return TRUE;
}



/*
 * "vol-path" command
 */
7918
static const vshCmdInfo info_vol_path[] = {
7919
    {"help", N_("returns the volume path for a given volume name or key")},
7920
    {"desc", ""},
7921 7922 7923
    {NULL, NULL}
};

7924
static const vshCmdOptDef opts_vol_path[] = {
7925
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
7926
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7927 7928 7929 7930
    {NULL, 0, 0, NULL}
};

static int
7931
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
7932 7933
{
    virStorageVolPtr vol;
7934
    const char *name = NULL;
7935

7936
    if (!vshConnectionUsability(ctl, ctl->conn))
7937
        return FALSE;
7938 7939

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
7940
        return FALSE;
7941
    }
7942 7943 7944 7945 7946 7947 7948

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
    return TRUE;
}


7949 7950 7951 7952
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
7953 7954
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
7955 7956
    {NULL, NULL}
};
7957

7958
static const vshCmdOptDef opts_secret_define[] = {
7959
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
7960 7961
    {NULL, 0, 0, NULL}
};
7962

7963 7964 7965
static int
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
7966
    const char *from = NULL;
7967
    char *buffer;
7968
    virSecretPtr res;
7969
    char uuid[VIR_UUID_STRING_BUFLEN];
7970

7971
    if (!vshConnectionUsability(ctl, ctl->conn))
7972 7973
        return FALSE;

7974
    if (vshCommandOptString(cmd, "file", &from) <= 0)
7975 7976 7977 7978 7979 7980
        return FALSE;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;

    res = virSecretDefineXML(ctl->conn, buffer, 0);
7981
    VIR_FREE(buffer);
7982 7983

    if (res == NULL) {
7984
        vshError(ctl, _("Failed to set attributes from %s"), from);
7985 7986
        return FALSE;
    }
7987
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
7988
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000
        virSecretFree(res);
        return FALSE;
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
    return TRUE;
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
8001 8002
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
8003 8004 8005 8006
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
8007
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8008 8009 8010 8011 8012 8013 8014 8015 8016 8017
    {NULL, 0, 0, NULL}
};

static int
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    int ret = FALSE;
    char *xml;

8018
    if (!vshConnectionUsability(ctl, ctl->conn))
8019 8020 8021 8022 8023 8024 8025 8026 8027
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
        return FALSE;

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
8028
    vshPrint(ctl, "%s", xml);
8029
    VIR_FREE(xml);
8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
8041 8042
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
8043 8044 8045 8046
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
8047 8048
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
8049 8050 8051 8052 8053 8054 8055 8056
    {NULL, 0, 0, NULL}
};

static int
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
8057
    const char *base64 = NULL;
8058
    char *value;
8059
    int res, ret = FALSE;
8060

8061
    if (!vshConnectionUsability(ctl, ctl->conn))
8062 8063 8064 8065 8066 8067
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
        return FALSE;

8068
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
8069 8070 8071
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
8072
        vshError(ctl, "%s", _("Invalid base64 data"));
8073 8074 8075
        goto cleanup;
    }
    if (value == NULL) {
8076
        vshError(ctl, "%s", _("Failed to allocate memory"));
8077 8078 8079 8080 8081
        return FALSE;
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
8082
    VIR_FREE(value);
8083 8084

    if (res != 0) {
8085
        vshError(ctl, "%s", _("Failed to set secret value"));
8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
8100 8101
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
8102 8103 8104 8105
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
8106
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118
    {NULL, 0, 0, NULL}
};

static int
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
    int ret = FALSE;

8119
    if (!vshConnectionUsability(ctl, ctl->conn))
8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
        return FALSE;

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
8132
    VIR_FREE(value);
8133 8134

    if (base64 == NULL) {
8135
        vshError(ctl, "%s", _("Failed to allocate memory"));
8136 8137
        goto cleanup;
    }
8138
    vshPrint(ctl, "%s", base64);
8139
    memset(base64, 0, strlen(base64));
8140
    VIR_FREE(base64);
8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
8152 8153
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
8154 8155 8156 8157
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
8158
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8159 8160 8161 8162 8163 8164 8165 8166
    {NULL, 0, 0, NULL}
};

static int
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    int ret = FALSE;
8167
    const char *uuid;
8168

8169
    if (!vshConnectionUsability(ctl, ctl->conn))
8170 8171 8172 8173 8174 8175 8176
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
        return FALSE;

    if (virSecretUndefine(secret) < 0) {
8177
        vshError(ctl, _("Failed to delete secret %s"), uuid);
8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
8192 8193
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
8194 8195 8196 8197 8198 8199 8200 8201 8202
    {NULL, NULL}
};

static int
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

8203
    if (!vshConnectionUsability(ctl, ctl->conn))
8204 8205 8206 8207
        return FALSE;

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
8208
        vshError(ctl, "%s", _("Failed to list secrets"));
8209 8210 8211 8212 8213 8214
        return FALSE;
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
8215
        vshError(ctl, "%s", _("Failed to list secrets"));
8216
        VIR_FREE(uuids);
8217 8218 8219 8220 8221
        return FALSE;
    }

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

8222 8223
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
8224 8225

    for (i = 0; i < maxuuids; i++) {
8226 8227 8228 8229
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
8230
            VIR_FREE(uuids[i]);
8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248
            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);
8249
        VIR_FREE(uuids[i]);
8250
    }
8251
    VIR_FREE(uuids);
8252 8253
    return TRUE;
}
8254 8255 8256 8257 8258


/*
 * "version" command
 */
8259
static const vshCmdInfo info_version[] = {
8260 8261
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
8262 8263 8264 8265 8266
    {NULL, NULL}
};


static int
8267
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278
{
    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;

8279
    if (!vshConnectionUsability(ctl, ctl->conn))
8280 8281 8282 8283
        return FALSE;

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
8284
        vshError(ctl, "%s", _("failed to get hypervisor type"));
8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297
        return FALSE;
    }

    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) {
8298
        vshError(ctl, "%s", _("failed to get the library version"));
8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316
        return FALSE;
    }
    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) {
8317
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334
        return FALSE;
    }
    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);
    }
    return TRUE;
}

8335 8336 8337 8338
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
8339
    {"help", N_("enumerate devices on this host")},
8340
    {"desc", ""},
8341 8342 8343 8344
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
8345 8346
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
8347 8348 8349
    {NULL, 0, 0, NULL}
};

8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371
#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] = '-';
8372 8373
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
8374 8375 8376
    }

    /* Print this device */
8377
    vshPrint(ctl, "%s", indentBuf);
8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400
    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) {
8401
        vshPrint(ctl, "%s", indentBuf);
8402
        vshPrint(ctl, " |\n");
8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424
    }

    /* 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) {
8425
        vshPrint(ctl, "%s", indentBuf);
8426 8427 8428 8429
        vshPrint(ctl, "\n");
    }
}

8430 8431 8432
static int
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
8433
    const char *cap = NULL;
8434
    char **devices;
8435
    int num_devices, i;
8436
    int tree = vshCommandOptBool(cmd, "tree");
8437

8438
    if (!vshConnectionUsability(ctl, ctl->conn))
8439 8440
        return FALSE;

8441
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
8442 8443 8444 8445
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
8446
        vshError(ctl, "%s", _("Failed to count node devices"));
8447 8448 8449 8450 8451 8452 8453 8454 8455
        return FALSE;
    } else if (num_devices == 0) {
        return TRUE;
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
8456
        vshError(ctl, "%s", _("Failed to list node devices"));
8457
        VIR_FREE(devices);
8458 8459
        return FALSE;
    }
8460
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
8461 8462 8463 8464 8465 8466 8467
    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 已提交
8468
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487
            } 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++) {
8488 8489
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
8490
        }
8491
        VIR_FREE(parents);
8492 8493 8494
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
8495
            VIR_FREE(devices[i]);
8496
        }
8497
    }
8498
    VIR_FREE(devices);
8499 8500 8501 8502 8503 8504 8505
    return TRUE;
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
8506 8507
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
8508 8509 8510 8511 8512
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
8513
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8514 8515 8516 8517 8518 8519
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
8520
    const char *name = NULL;
8521
    virNodeDevicePtr device;
L
Laine Stump 已提交
8522
    char *xml;
8523

8524
    if (!vshConnectionUsability(ctl, ctl->conn))
8525
        return FALSE;
8526
    if (vshCommandOptString(cmd, "device", &name) <= 0)
8527 8528
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8529
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
8530 8531 8532
        return FALSE;
    }

L
Laine Stump 已提交
8533 8534 8535 8536 8537 8538 8539
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
        return FALSE;
    }

    vshPrint(ctl, "%s\n", xml);
8540
    VIR_FREE(xml);
8541 8542 8543 8544
    virNodeDeviceFree(device);
    return TRUE;
}

8545 8546 8547 8548
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
8549 8550
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
8551 8552 8553 8554 8555
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
8556
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8557 8558 8559 8560 8561 8562
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
8563
    const char *name = NULL;
8564 8565 8566
    virNodeDevicePtr device;
    int ret = TRUE;

8567
    if (!vshConnectionUsability(ctl, ctl->conn))
8568
        return FALSE;
8569
    if (vshCommandOptString(cmd, "device", &name) <= 0)
8570 8571
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8572
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
8573 8574 8575 8576 8577 8578
        return FALSE;
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
8579
        vshError(ctl, _("Failed to dettach device %s"), name);
8580 8581 8582 8583 8584 8585 8586 8587 8588 8589
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
8590 8591
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
8592 8593 8594 8595 8596
    {NULL, NULL}
};


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

static int
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
8604
    const char *name = NULL;
8605 8606 8607
    virNodeDevicePtr device;
    int ret = TRUE;

8608
    if (!vshConnectionUsability(ctl, ctl->conn))
8609
        return FALSE;
8610
    if (vshCommandOptString(cmd, "device", &name) <= 0)
8611 8612
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8613
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
8614 8615 8616 8617 8618 8619
        return FALSE;
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
8620
        vshError(ctl, _("Failed to re-attach device %s"), name);
8621 8622 8623 8624 8625 8626 8627 8628 8629 8630
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
8631 8632
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
8633 8634 8635 8636 8637
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
8638
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8639 8640 8641 8642 8643 8644
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
8645
    const char *name = NULL;
8646 8647 8648
    virNodeDevicePtr device;
    int ret = TRUE;

8649
    if (!vshConnectionUsability(ctl, ctl->conn))
8650
        return FALSE;
8651
    if (vshCommandOptString(cmd, "device", &name) <= 0)
8652 8653
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8654
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
8655 8656 8657 8658 8659 8660
        return FALSE;
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
8661
        vshError(ctl, _("Failed to reset device %s"), name);
8662 8663 8664 8665 8666 8667
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

8668
/*
E
Eric Blake 已提交
8669
 * "hostname" command
8670
 */
8671
static const vshCmdInfo info_hostname[] = {
8672
    {"help", N_("print the hypervisor hostname")},
8673
    {"desc", ""},
8674 8675 8676 8677
    {NULL, NULL}
};

static int
8678
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8679 8680 8681
{
    char *hostname;

8682
    if (!vshConnectionUsability(ctl, ctl->conn))
8683 8684 8685 8686
        return FALSE;

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
8687
        vshError(ctl, "%s", _("failed to get hostname"));
8688 8689 8690 8691
        return FALSE;
    }

    vshPrint (ctl, "%s\n", hostname);
8692
    VIR_FREE(hostname);
8693 8694 8695 8696 8697 8698 8699

    return TRUE;
}

/*
 * "uri" command
 */
8700
static const vshCmdInfo info_uri[] = {
8701
    {"help", N_("print the hypervisor canonical URI")},
8702
    {"desc", ""},
8703 8704 8705 8706
    {NULL, NULL}
};

static int
8707
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8708 8709 8710
{
    char *uri;

8711
    if (!vshConnectionUsability(ctl, ctl->conn))
8712 8713 8714 8715
        return FALSE;

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
8716
        vshError(ctl, "%s", _("failed to get URI"));
8717 8718 8719 8720
        return FALSE;
    }

    vshPrint (ctl, "%s\n", uri);
8721
    VIR_FREE(uri);
8722 8723 8724 8725

    return TRUE;
}

E
Eric Blake 已提交
8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755
/*
 * "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}
};

static int
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

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

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
        return FALSE;
    }

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

    return TRUE;
}

8756 8757 8758
/*
 * "vncdisplay" command
 */
8759
static const vshCmdInfo info_vncdisplay[] = {
8760 8761
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
8762 8763 8764
    {NULL, NULL}
};

8765
static const vshCmdOptDef opts_vncdisplay[] = {
8766
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8767 8768 8769 8770
    {NULL, 0, 0, NULL}
};

static int
8771
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
8772 8773 8774 8775 8776 8777 8778 8779 8780
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    int ret = FALSE;
    int port = 0;
    char *doc;

8781
    if (!vshConnectionUsability(ctl, ctl->conn))
8782 8783
        return FALSE;

J
Jim Meyering 已提交
8784
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8785 8786 8787 8788 8789 8790 8791 8792 8793
        return FALSE;

    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);
8794
    VIR_FREE(doc);
8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812
    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) ||
8813
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833
        vshPrint(ctl, ":%d\n", port-5900);
    } else {
        vshPrint(ctl, "%s:%d\n", (const char *)obj->stringval, port-5900);
    }
    xmlXPathFreeObject(obj);
    obj = NULL;
    ret = TRUE;

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

/*
 * "ttyconsole" command
 */
8834
static const vshCmdInfo info_ttyconsole[] = {
8835 8836
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
8837 8838 8839
    {NULL, NULL}
};

8840
static const vshCmdOptDef opts_ttyconsole[] = {
8841
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8842 8843 8844 8845
    {NULL, 0, 0, NULL}
};

static int
8846
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
8847 8848 8849 8850 8851 8852 8853 8854
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    int ret = FALSE;
    char *doc;

8855
    if (!vshConnectionUsability(ctl, ctl->conn))
8856 8857
        return FALSE;

J
Jim Meyering 已提交
8858
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8859 8860 8861 8862 8863 8864 8865 8866 8867
        return FALSE;

    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);
8868
    VIR_FREE(doc);
8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880
    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);
8881
    ret = TRUE;
8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893

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

/*
 * "attach-device" command
8894
 */
8895
static const vshCmdInfo info_attach_device[] = {
8896 8897
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
8898 8899 8900
    {NULL, NULL}
};

8901
static const vshCmdOptDef opts_attach_device[] = {
8902 8903 8904
    {"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")},
8905 8906 8907 8908
    {NULL, 0, 0, NULL}
};

static int
8909
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
8910 8911
{
    virDomainPtr dom;
8912
    const char *from = NULL;
8913 8914
    char *buffer;
    int ret = TRUE;
J
Jim Fehlig 已提交
8915
    unsigned int flags;
8916

8917
    if (!vshConnectionUsability(ctl, ctl->conn))
8918 8919
        return FALSE;

J
Jim Meyering 已提交
8920
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8921 8922
        return FALSE;

8923
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8924 8925 8926 8927
        virDomainFree(dom);
        return FALSE;
    }

8928
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8929
        virshReportError(ctl);
8930
        virDomainFree(dom);
8931
        return FALSE;
8932
    }
8933

J
Jim Fehlig 已提交
8934 8935 8936 8937 8938 8939 8940 8941
    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);
    }
8942
    VIR_FREE(buffer);
8943 8944

    if (ret < 0) {
8945
        vshError(ctl, _("Failed to attach device from %s"), from);
8946 8947
        virDomainFree(dom);
        return FALSE;
8948
    } else {
J
Jim Meyering 已提交
8949
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
8950 8951 8952 8953 8954 8955 8956 8957 8958 8959
    }

    virDomainFree(dom);
    return TRUE;
}


/*
 * "detach-device" command
 */
8960
static const vshCmdInfo info_detach_device[] = {
8961 8962
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
8963 8964 8965
    {NULL, NULL}
};

8966
static const vshCmdOptDef opts_detach_device[] = {
8967 8968 8969
    {"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")},
8970 8971 8972 8973
    {NULL, 0, 0, NULL}
};

static int
8974
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
8975 8976
{
    virDomainPtr dom;
8977
    const char *from = NULL;
8978 8979
    char *buffer;
    int ret = TRUE;
J
Jim Fehlig 已提交
8980
    unsigned int flags;
8981

8982
    if (!vshConnectionUsability(ctl, ctl->conn))
8983 8984
        return FALSE;

J
Jim Meyering 已提交
8985
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8986 8987
        return FALSE;

8988
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8989 8990 8991 8992
        virDomainFree(dom);
        return FALSE;
    }

8993
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8994
        virshReportError(ctl);
8995
        virDomainFree(dom);
8996
        return FALSE;
8997
    }
8998

J
Jim Fehlig 已提交
8999 9000 9001 9002 9003 9004 9005 9006
    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);
    }
9007
    VIR_FREE(buffer);
9008 9009

    if (ret < 0) {
9010
        vshError(ctl, _("Failed to detach device from %s"), from);
9011 9012
        virDomainFree(dom);
        return FALSE;
9013
    } else {
J
Jim Meyering 已提交
9014
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
9015 9016 9017 9018 9019 9020
    }

    virDomainFree(dom);
    return TRUE;
}

9021

9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034
/*
 * "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")},
9035
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
9036 9037 9038 9039 9040 9041 9042
    {NULL, 0, 0, NULL}
};

static int
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
9043
    const char *from = NULL;
9044 9045 9046 9047
    char *buffer;
    int ret = TRUE;
    unsigned int flags;

9048
    if (!vshConnectionUsability(ctl, ctl->conn))
9049 9050 9051 9052 9053
        return FALSE;

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;

9054
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9055 9056 9057 9058 9059
        virDomainFree(dom);
        return FALSE;
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9060
        virshReportError(ctl);
9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071
        virDomainFree(dom);
        return FALSE;
    }

    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;
    }
9072 9073 9074 9075

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

9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091
    ret = virDomainUpdateDeviceFlags(dom, buffer, flags);
    VIR_FREE(buffer);

    if (ret < 0) {
        vshError(ctl, _("Failed to update device from %s"), from);
        virDomainFree(dom);
        return FALSE;
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
    return TRUE;
}


9092 9093 9094
/*
 * "attach-interface" command
 */
9095
static const vshCmdInfo info_attach_interface[] = {
9096 9097
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
9098 9099 9100
    {NULL, NULL}
};

9101
static const vshCmdOptDef opts_attach_interface[] = {
9102 9103 9104 9105 9106 9107
    {"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")},
9108
    {"model", VSH_OT_DATA, 0, N_("model type")},
9109
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
9110 9111 9112 9113
    {NULL, 0, 0, NULL}
};

static int
9114
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
9115 9116
{
    virDomainPtr dom = NULL;
9117 9118
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
9119
    int typ, ret = FALSE;
J
Jim Fehlig 已提交
9120
    unsigned int flags;
9121 9122
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9123

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

J
Jim Meyering 已提交
9127
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9128 9129
        goto cleanup;

9130
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9131 9132
        goto cleanup;

9133 9134 9135 9136
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
9137 9138
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
9139
        goto cleanup;
9140
    }
9141 9142

    /* check interface type */
9143
    if (STREQ(type, "network")) {
9144
        typ = 1;
9145
    } else if (STREQ(type, "bridge")) {
9146 9147
        typ = 2;
    } else {
E
Eric Blake 已提交
9148 9149
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
9150 9151 9152 9153
        goto cleanup;
    }

    /* Make XML of interface */
9154
    virBufferVSprintf(&buf, "<interface type='%s'>\n", type);
9155

9156 9157 9158 9159
    if (typ == 1)
        virBufferVSprintf(&buf, "  <source network='%s'/>\n", source);
    else if (typ == 2)
        virBufferVSprintf(&buf, "  <source bridge='%s'/>\n", source);
9160

9161 9162 9163 9164 9165 9166
    if (target != NULL)
        virBufferVSprintf(&buf, "  <target dev='%s'/>\n", target);
    if (mac != NULL)
        virBufferVSprintf(&buf, "  <mac address='%s'/>\n", mac);
    if (script != NULL)
        virBufferVSprintf(&buf, "  <script path='%s'/>\n", script);
9167 9168
    if (model != NULL)
        virBufferVSprintf(&buf, "  <model type='%s'/>\n", model);
9169

9170
    virBufferAddLit(&buf, "</interface>\n");
9171

9172 9173 9174
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
9175 9176
    }

9177
    xml = virBufferContentAndReset(&buf);
9178

J
Jim Fehlig 已提交
9179 9180 9181 9182
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9183
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
9184
    } else {
9185
        ret = virDomainAttachDevice(dom, xml);
9186
    }
9187

9188 9189
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9190
    if (ret != 0) {
L
Laine Stump 已提交
9191
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
9192 9193 9194 9195 9196
        ret = FALSE;
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
        ret = TRUE;
    }
9197 9198 9199 9200

 cleanup:
    if (dom)
        virDomainFree(dom);
9201
    virBufferFreeAndReset(&buf);
9202 9203 9204 9205 9206 9207
    return ret;
}

/*
 * "detach-interface" command
 */
9208
static const vshCmdInfo info_detach_interface[] = {
9209 9210
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
9211 9212 9213
    {NULL, NULL}
};

9214
static const vshCmdOptDef opts_detach_interface[] = {
9215 9216 9217 9218
    {"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")},
9219 9220 9221 9222
    {NULL, 0, 0, NULL}
};

static int
9223
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
9224 9225 9226 9227 9228 9229 9230
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
9231
    const char *mac =NULL, *type = NULL;
9232
    char *doc;
9233 9234
    char buf[64];
    int i = 0, diff_mac, ret = FALSE;
J
Jim Fehlig 已提交
9235
    unsigned int flags;
9236

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

J
Jim Meyering 已提交
9240
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9241 9242
        goto cleanup;

9243
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9244 9245
        goto cleanup;

9246 9247
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
9248
        goto cleanup;
9249
    }
9250 9251 9252 9253 9254 9255 9256 9257

    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);
9258
    VIR_FREE(doc);
9259
    if (!xml) {
9260
        vshError(ctl, "%s", _("Failed to get interface information"));
9261 9262 9263 9264
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9265
        vshError(ctl, "%s", _("Failed to get interface information"));
9266 9267 9268
        goto cleanup;
    }

E
Eric Blake 已提交
9269
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
9270 9271 9272
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9273
        vshError(ctl, _("No found interface whose type is %s"), type);
9274 9275 9276
        goto cleanup;
    }

9277 9278 9279 9280 9281 9282
    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;
    }

9283 9284 9285 9286 9287 9288 9289
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9290 9291 9292 9293 9294
            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);
9295 9296 9297 9298 9299 9300 9301
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9302
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
9303 9304 9305 9306 9307
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9308
        vshError(ctl, "%s", _("Failed to allocate memory"));
9309 9310 9311
        goto cleanup;
    }

9312
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
9313
        vshError(ctl, "%s", _("Failed to create XML"));
9314 9315 9316
        goto cleanup;
    }

J
Jim Fehlig 已提交
9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328
    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 已提交
9329
        vshError(ctl, "%s", _("Failed to detach interface"));
9330
        ret = FALSE;
J
Jim Fehlig 已提交
9331
    } else {
J
Jim Meyering 已提交
9332
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
9333
        ret = TRUE;
9334
    }
9335 9336 9337 9338

 cleanup:
    if (dom)
        virDomainFree(dom);
9339
    xmlXPathFreeObject(obj);
9340
    xmlXPathFreeContext(ctxt);
9341 9342 9343 9344 9345 9346 9347 9348 9349 9350
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    return ret;
}

/*
 * "attach-disk" command
 */
9351
static const vshCmdInfo info_attach_disk[] = {
9352 9353
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
9354 9355 9356
    {NULL, NULL}
};

9357
static const vshCmdOptDef opts_attach_disk[] = {
9358 9359 9360 9361 9362 9363 9364 9365
    {"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")},
9366
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
9367 9368 9369 9370
    {NULL, 0, 0, NULL}
};

static int
9371
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
9372 9373
{
    virDomainPtr dom = NULL;
9374 9375
    const char *source = NULL, *target = NULL, *driver = NULL,
                *subdriver = NULL, *type = NULL, *mode = NULL;
9376
    int isFile = 0, ret = FALSE;
J
Jim Fehlig 已提交
9377
    unsigned int flags;
9378
    const char *stype = NULL;
9379 9380
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9381

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

J
Jim Meyering 已提交
9385
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9386 9387
        goto cleanup;

9388
    if (vshCommandOptString(cmd, "source", &source) <= 0)
9389 9390
        goto cleanup;

9391
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9392 9393
        goto cleanup;

9394 9395 9396 9397 9398
    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) {
9399
        vshError(ctl, "%s", _("missing option"));
9400 9401
        goto cleanup;
    }
9402

9403 9404
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
9405
            isFile = 1;
9406 9407 9408 9409 9410
    } else if (STREQ(stype, "file")) {
        isFile = 1;
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
9411 9412 9413
    }

    if (mode) {
9414
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
9415 9416
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
9417 9418 9419 9420 9421
            goto cleanup;
        }
    }

    /* Make XML of disk */
9422 9423 9424 9425 9426 9427
    virBufferVSprintf(&buf, "<disk type='%s'",
                      (isFile) ? "file" : "block");
    if (type)
        virBufferVSprintf(&buf, " device='%s'", type);
    virBufferAddLit(&buf, ">\n");

9428 9429 9430 9431 9432
    if (driver || subdriver)
        virBufferVSprintf(&buf, "  <driver");

    if (driver)
        virBufferVSprintf(&buf, " name='%s'", driver);
9433 9434
    if (subdriver)
        virBufferVSprintf(&buf, " type='%s'", subdriver);
9435 9436 9437

    if (driver || subdriver)
        virBufferAddLit(&buf, "/>\n");
9438 9439 9440 9441 9442 9443 9444 9445 9446

    virBufferVSprintf(&buf, "  <source %s='%s'/>\n",
                      (isFile) ? "file" : "dev",
                      source);
    virBufferVSprintf(&buf, "  <target dev='%s'/>\n", target);
    if (mode)
        virBufferVSprintf(&buf, "  <%s/>\n", mode);

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

9448 9449 9450
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
9451 9452
    }

9453
    xml = virBufferContentAndReset(&buf);
9454

J
Jim Fehlig 已提交
9455 9456 9457 9458
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9459
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
9460
    } else {
9461
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
9462
    }
9463

9464 9465
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9466
    if (ret != 0) {
L
Laine Stump 已提交
9467
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
9468 9469 9470 9471 9472
        ret = FALSE;
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
        ret = TRUE;
    }
9473 9474 9475 9476

 cleanup:
    if (dom)
        virDomainFree(dom);
9477
    virBufferFreeAndReset(&buf);
9478 9479 9480 9481 9482 9483
    return ret;
}

/*
 * "detach-disk" command
 */
9484
static const vshCmdInfo info_detach_disk[] = {
9485 9486
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
9487 9488 9489
    {NULL, NULL}
};

9490
static const vshCmdOptDef opts_detach_disk[] = {
9491 9492 9493
    {"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")},
9494 9495 9496 9497
    {NULL, 0, 0, NULL}
};

static int
9498
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
9499 9500 9501 9502 9503 9504 9505
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
9506
    const char *target = NULL;
9507
    char *doc;
9508
    int i = 0, diff_tgt, ret = FALSE;
J
Jim Fehlig 已提交
9509
    unsigned int flags;
9510

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

J
Jim Meyering 已提交
9514
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9515 9516
        goto cleanup;

9517
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9518 9519 9520 9521 9522 9523 9524 9525 9526
        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);
9527
    VIR_FREE(doc);
9528
    if (!xml) {
9529
        vshError(ctl, "%s", _("Failed to get disk information"));
9530 9531 9532 9533
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9534
        vshError(ctl, "%s", _("Failed to get disk information"));
9535 9536 9537 9538 9539 9540
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9541
        vshError(ctl, "%s", _("Failed to get disk information"));
9542 9543 9544 9545 9546 9547 9548
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9549 9550 9551 9552 9553
            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);
9554 9555 9556 9557 9558 9559 9560
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9561
    vshError(ctl, _("No found disk whose target is %s"), target);
9562 9563 9564 9565 9566
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9567
        vshError(ctl, "%s", _("Failed to allocate memory"));
9568 9569 9570
        goto cleanup;
    }

9571
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
9572
        vshError(ctl, "%s", _("Failed to create XML"));
9573 9574 9575
        goto cleanup;
    }

J
Jim Fehlig 已提交
9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587
    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 已提交
9588
        vshError(ctl, "%s", _("Failed to detach disk"));
9589
        ret = FALSE;
J
Jim Fehlig 已提交
9590
    } else {
J
Jim Meyering 已提交
9591
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
9592
        ret = TRUE;
9593
    }
9594 9595

 cleanup:
9596
    xmlXPathFreeObject(obj);
9597
    xmlXPathFreeContext(ctxt);
9598 9599 9600 9601 9602 9603 9604 9605 9606
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
    return ret;
}

9607 9608 9609 9610
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
9611 9612
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
9613 9614 9615 9616
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
9617
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
9618 9619 9620 9621 9622 9623
    {NULL, 0, 0, NULL}
};

static int
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
9624
    const char *from = NULL;
9625 9626 9627 9628
    int ret = TRUE;
    char *buffer;
    int result;

9629
    if (!vshConnectionUsability(ctl, ctl->conn))
9630 9631
        return FALSE;

9632
    if (vshCommandOptString(cmd, "file", &from) <= 0)
9633 9634 9635 9636 9637 9638
        return FALSE;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
9639
    VIR_FREE(buffer);
9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
        ret = FALSE;
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
        ret = TRUE;
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
        ret = TRUE;
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
        ret = FALSE;
    }

    return ret;
}

9669 9670 9671 9672
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
9673 9674
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
9675 9676 9677 9678
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
9679
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
9680 9681 9682 9683 9684 9685
    {NULL, 0, 0, NULL}
};

static int
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
9686
    const char *from = NULL;
9687 9688 9689 9690 9691 9692
    int ret = TRUE;
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
9693
    xmlNodePtr node_list;
9694 9695 9696 9697 9698 9699
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

9700
    if (!vshConnectionUsability(ctl, ctl->conn))
9701 9702
        return FALSE;

9703
    if (vshCommandOptString(cmd, "file", &from) <= 0)
9704 9705 9706 9707 9708 9709 9710 9711 9712
        return FALSE;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;

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

L
Laine Stump 已提交
9713 9714
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
        ret = FALSE;
        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);
        ret = FALSE;
        goto cleanup;
    }

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

    if (result)
        vshPrint(ctl, "%s", result);
    else
        ret = FALSE;

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"));
    ret = FALSE;
9782
    goto cleanup;
9783 9784
}

9785 9786 9787 9788 9789 9790 9791 9792
/* 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;

9793
    ret = vshMalloc(ctl, PATH_MAX);
9794 9795 9796

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
9797 9798
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
9799
    if (fd == -1) {
9800
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
9801
                 strerror(errno));
9802
        VIR_FREE(ret);
9803 9804 9805 9806
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
9807 9808
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
9809
        VIR_FORCE_CLOSE(fd);
9810
        unlink (ret);
9811
        VIR_FREE(ret);
9812 9813
        return NULL;
    }
S
Stefan Berger 已提交
9814
    if (VIR_CLOSE(fd) < 0) {
9815 9816
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
9817
        unlink (ret);
9818
        VIR_FREE(ret);
9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833
        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 已提交
9834 9835 9836 9837
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
9838

9839
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
9840 9841 9842 9843
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
9844

9845 9846 9847 9848 9849
    /* 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 已提交
9850 9851
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
9852
     */
E
Eric Blake 已提交
9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864
    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);
9865 9866
    }

E
Eric Blake 已提交
9867 9868 9869 9870 9871 9872 9873
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
9874
    }
E
Eric Blake 已提交
9875
    ret = 0;
9876

E
Eric Blake 已提交
9877 9878 9879
cleanup:
    virCommandFree(cmd);
    return ret;
9880 9881 9882 9883 9884 9885 9886 9887
}

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

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
9888
        vshError(ctl,
9889
                 _("%s: failed to read temporary file: %s"),
9890
                 filename, strerror(errno));
9891 9892 9893 9894 9895
        return NULL;
    }
    return ret;
}

9896 9897

#ifndef WIN32
P
Paolo Bonzini 已提交
9898 9899 9900 9901
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
9902 9903
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
9904 9905 9906 9907
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
9908
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
9909 9910 9911 9912 9913 9914
    {NULL, 0, 0, NULL}
};

static int
cmdCd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
9915
    const char *dir = NULL;
9916
    char *dir_malloced = NULL;
P
Phil Petty 已提交
9917
    int ret = TRUE;
P
Paolo Bonzini 已提交
9918 9919

    if (!ctl->imode) {
9920
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
C
Chris Lalancette 已提交
9921
        return FALSE;
P
Paolo Bonzini 已提交
9922 9923
    }

9924
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
9925
        uid_t uid = geteuid();
9926
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
9927 9928 9929 9930
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
9931
    if (chdir(dir) == -1) {
9932
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
P
Phil Petty 已提交
9933
        ret = FALSE;
P
Paolo Bonzini 已提交
9934 9935
    }

9936
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
9937
    return ret;
P
Paolo Bonzini 已提交
9938 9939
}

9940 9941 9942
#endif

#ifndef WIN32
P
Paolo Bonzini 已提交
9943 9944 9945 9946
/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
9947 9948
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970
    {NULL, NULL}
};

static int
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
    size_t path_max;
    int err = TRUE;

    path_max = (size_t) PATH_MAX + 2;
    cwd = vshMalloc (ctl, path_max);
    while (cwd) {
        err = getcwd (cwd, path_max) == NULL;
        if (!err || errno != ERANGE)
            break;

        path_max *= 2;
        cwd = vshRealloc (ctl, cwd, path_max);
    }

    if (err)
9971 9972
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
P
Paolo Bonzini 已提交
9973 9974 9975
    else
        vshPrint (ctl, _("%s\n"), cwd);

9976
    VIR_FREE(cwd);
P
Paolo Bonzini 已提交
9977 9978
    return !err;
}
9979
#endif
P
Paolo Bonzini 已提交
9980

E
Eric Blake 已提交
9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054
/*
 * "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.
 */
static int
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"));
        return FALSE;
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
    return TRUE;
}

10055 10056 10057 10058
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
10059 10060
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
10061 10062 10063 10064
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
10065
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080
    {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.
 */
static int
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
    int ret = FALSE;
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
10081
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
10082

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

J
Jim Meyering 已提交
10086
    dom = vshCommandOptDomain (ctl, cmd, NULL);
10087 10088 10089 10090
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
10091
    doc = virDomainGetXMLDesc (dom, flags);
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
    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));
        ret = TRUE;
        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.
     */
10118
    doc_reread = virDomainGetXMLDesc (dom, flags);
10119 10120 10121 10122
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
10123 10124
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142
        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));

    ret = TRUE;

 cleanup:
    if (dom)
        virDomainFree (dom);

10143 10144 10145
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
10146 10147 10148

    if (tmp) {
        unlink (tmp);
10149
        VIR_FREE(tmp);
10150 10151 10152 10153 10154
    }

    return ret;
}

10155

10156 10157 10158 10159
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
10160 10161
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
10162 10163 10164 10165
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
10166
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
10167 10168 10169 10170 10171 10172 10173 10174 10175 10176
    {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[] = {
10177 10178
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
10179 10180 10181 10182
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
10183
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10184 10185 10186 10187 10188 10189
    {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 已提交
10190 10191 10192
/*
 * "quit" command
 */
10193
static const vshCmdInfo info_quit[] = {
10194
    {"help", N_("quit this interactive terminal")},
10195
    {"desc", ""},
10196
    {NULL, NULL}
K
Karel Zak 已提交
10197 10198 10199
};

static int
10200
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10201
{
K
Karel Zak 已提交
10202 10203 10204 10205
    ctl->imode = FALSE;
    return TRUE;
}

10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225
/*
 * "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}
};

static int
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
10226
    const char *from = NULL;
10227 10228 10229 10230 10231 10232 10233
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

10234
    if (!vshConnectionUsability(ctl, ctl->conn))
10235 10236 10237 10238 10239 10240
        goto cleanup;

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

10241
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
10242
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325
    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");

    ret = TRUE;

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

static int
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
    int current;
    virDomainSnapshotPtr snapshot = NULL;

10326
    if (!vshConnectionUsability(ctl, ctl->conn))
10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381
        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);
    }

    ret = TRUE;

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

static int
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
    int numsnaps;
    char **names = NULL;
10382
    int actual = 0;
10383 10384 10385 10386 10387 10388 10389 10390 10391 10392
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
    long creation;
    char timestr[100];
    struct tm time_info;

10393
    if (!vshConnectionUsability(ctl, ctl->conn))
10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404
        goto cleanup;

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

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

10405 10406
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451

    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;
            if (virXPathLong("string(/domainsnapshot/creationTime)", ctxt,
                             &creation) < 0)
                continue;
            localtime_r(&creation, &time_info);
10452
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468

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

    ret = TRUE;

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);
10469 10470
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497
    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}
};

static int
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
10498
    const char *name = NULL;
10499 10500 10501
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

10502
    if (!vshConnectionUsability(ctl, ctl->conn))
10503 10504 10505 10506 10507 10508
        goto cleanup;

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

10509
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10510 10511 10512 10513 10514 10515 10516 10517 10518 10519
        goto cleanup;

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

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

10520
    vshPrint(ctl, "%s", xml);
10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534

    ret = TRUE;

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

    return ret;
}

/*
10535
 * "snapshot-revert" command
10536
 */
10537
static const vshCmdInfo info_snapshot_revert[] = {
10538 10539 10540 10541 10542
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

10543
static const vshCmdOptDef opts_snapshot_revert[] = {
10544 10545 10546 10547 10548 10549
    {"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}
};

static int
10550
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
10551 10552 10553
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
10554
    const char *name = NULL;
10555 10556
    virDomainSnapshotPtr snapshot = NULL;

10557
    if (!vshConnectionUsability(ctl, ctl->conn))
10558 10559 10560 10561 10562 10563
        goto cleanup;

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

10564
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605
        goto cleanup;

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

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

    ret = TRUE;

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

static int
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
10606
    const char *name = NULL;
10607 10608 10609
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

10610
    if (!vshConnectionUsability(ctl, ctl->conn))
10611 10612 10613 10614 10615 10616
        goto cleanup;

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

10617
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640
        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;

    ret = TRUE;

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

    return ret;
}

10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652
/*
 * "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")},
10653
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
10654 10655 10656 10657 10658 10659 10660 10661
    {NULL, 0, 0, NULL}
};

static int
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
10662
    const char *monitor_cmd = NULL;
10663
    char *result = NULL;
10664
    unsigned int flags = 0;
10665 10666 10667 10668 10669 10670 10671 10672

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

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

10673
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
10674 10675 10676 10677
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

10678 10679 10680 10681
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695
        goto cleanup;

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

    ret = TRUE;

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

    return ret;
}

10696
static const vshCmdDef domManagementCmds[] = {
10697 10698 10699
    {"attach-device", cmdAttachDevice, opts_attach_device, info_attach_device},
    {"attach-disk", cmdAttachDisk, opts_attach_disk, info_attach_disk},
    {"attach-interface", cmdAttachInterface, opts_attach_interface, info_attach_interface},
10700
    {"autostart", cmdAutostart, opts_autostart, info_autostart},
10701
    {"blkiotune", cmdBlkiotune, opts_blkiotune, info_blkiotune},
10702
#ifndef WIN32
10703
    {"console", cmdConsole, opts_console, info_console},
10704
#endif
10705
    {"cpu-baseline", cmdCPUBaseline, opts_cpu_baseline, info_cpu_baseline},
10706
    {"cpu-compare", cmdCPUCompare, opts_cpu_compare, info_cpu_compare},
10707
    {"create", cmdCreate, opts_create, info_create},
10708
    {"define", cmdDefine, opts_define, info_define},
K
Karel Zak 已提交
10709
    {"destroy", cmdDestroy, opts_destroy, info_destroy},
10710 10711 10712
    {"detach-device", cmdDetachDevice, opts_detach_device, info_detach_device},
    {"detach-disk", cmdDetachDisk, opts_detach_disk, info_detach_disk},
    {"detach-interface", cmdDetachInterface, opts_detach_interface, info_detach_interface},
K
Karel Zak 已提交
10713
    {"domid", cmdDomid, opts_domid, info_domid},
10714
    {"domjobabort", cmdDomjobabort, opts_domjobabort, info_domjobabort},
10715
    {"domjobinfo", cmdDomjobinfo, opts_domjobinfo, info_domjobinfo},
K
Karel Zak 已提交
10716
    {"domname", cmdDomname, opts_domname, info_domname},
10717
    {"domuuid", cmdDomuuid, opts_domuuid, info_domuuid},
10718 10719
    {"domxml-from-native", cmdDomXMLFromNative, opts_domxmlfromnative, info_domxmlfromnative},
    {"domxml-to-native", cmdDomXMLToNative, opts_domxmltonative, info_domxmltonative},
10720
    {"dump", cmdDump, opts_dump, info_dump},
10721
    {"dumpxml", cmdDumpXML, opts_dumpxml, info_dumpxml},
10722
    {"edit", cmdEdit, opts_edit, info_edit},
10723 10724
    {"managedsave", cmdManagedSave, opts_managedsave, info_managedsave},
    {"managedsave-remove", cmdManagedSaveRemove, opts_managedsaveremove, info_managedsaveremove},
E
Eric Blake 已提交
10725
    {"maxvcpus", cmdMaxvcpus, opts_maxvcpus, info_maxvcpus},
10726
    {"memtune", cmdMemtune, opts_memtune, info_memtune},
10727
    {"migrate", cmdMigrate, opts_migrate, info_migrate},
10728
    {"migrate-setmaxdowntime", cmdMigrateSetMaxDowntime, opts_migrate_setmaxdowntime, info_migrate_setmaxdowntime},
10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762
    {"reboot", cmdReboot, opts_reboot, info_reboot},
    {"restore", cmdRestore, opts_restore, info_restore},
    {"resume", cmdResume, opts_resume, info_resume},
    {"save", cmdSave, opts_save, info_save},
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo},
    {"setmaxmem", cmdSetmaxmem, opts_setmaxmem, info_setmaxmem},
    {"setmem", cmdSetmem, opts_setmem, info_setmem},
    {"setvcpus", cmdSetvcpus, opts_setvcpus, info_setvcpus},
    {"shutdown", cmdShutdown, opts_shutdown, info_shutdown},
    {"start", cmdStart, opts_start, info_start},
    {"suspend", cmdSuspend, opts_suspend, info_suspend},
    {"ttyconsole", cmdTTYConsole, opts_ttyconsole, info_ttyconsole},
    {"undefine", cmdUndefine, opts_undefine, info_undefine},
    {"update-device", cmdUpdateDevice, opts_update_device, info_update_device},
    {"vcpucount", cmdVcpucount, opts_vcpucount, info_vcpucount},
    {"vcpuinfo", cmdVcpuinfo, opts_vcpuinfo, info_vcpuinfo},
    {"vcpupin", cmdVcpupin, opts_vcpupin, info_vcpupin},
    {"version", cmdVersion, NULL, info_version},
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay},
    {NULL, NULL, NULL, NULL}
};

static const vshCmdDef domMonitoringCmds[] = {
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat},
    {"domifstat", cmdDomIfstat, opts_domifstat, info_domifstat},
    {"dominfo", cmdDominfo, opts_dominfo, info_dominfo},
    {"dommemstat", cmdDomMemStat, opts_dommemstat, info_dommemstat},
    {"domstate", cmdDomstate, opts_domstate, info_domstate},
    {"list", cmdList, opts_list, info_list},
    {NULL, NULL, NULL, NULL}
};

static const vshCmdDef storagePoolCmds[] = {
10763 10764 10765 10766
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as},
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
     opts_find_storage_pool_sources, info_find_storage_pool_sources},
10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792
    {"pool-autostart", cmdPoolAutostart, opts_pool_autostart, info_pool_autostart},
    {"pool-build", cmdPoolBuild, opts_pool_build, info_pool_build},
    {"pool-create-as", cmdPoolCreateAs, opts_pool_X_as, info_pool_create_as},
    {"pool-create", cmdPoolCreate, opts_pool_create, info_pool_create},
    {"pool-define-as", cmdPoolDefineAs, opts_pool_X_as, info_pool_define_as},
    {"pool-define", cmdPoolDefine, opts_pool_define, info_pool_define},
    {"pool-delete", cmdPoolDelete, opts_pool_delete, info_pool_delete},
    {"pool-destroy", cmdPoolDestroy, opts_pool_destroy, info_pool_destroy},
    {"pool-dumpxml", cmdPoolDumpXML, opts_pool_dumpxml, info_pool_dumpxml},
    {"pool-edit", cmdPoolEdit, opts_pool_edit, info_pool_edit},
    {"pool-info", cmdPoolInfo, opts_pool_info, info_pool_info},
    {"pool-list", cmdPoolList, opts_pool_list, info_pool_list},
    {"pool-name", cmdPoolName, opts_pool_name, info_pool_name},
    {"pool-refresh", cmdPoolRefresh, opts_pool_refresh, info_pool_refresh},
    {"pool-start", cmdPoolStart, opts_pool_start, info_pool_start},
    {"pool-undefine", cmdPoolUndefine, opts_pool_undefine, info_pool_undefine},
    {"pool-uuid", cmdPoolUuid, opts_pool_uuid, info_pool_uuid},
    {NULL, NULL, NULL, NULL}
};

static const vshCmdDef storageVolCmds[] = {
    {"vol-clone", cmdVolClone, opts_vol_clone, info_vol_clone},
    {"vol-create-as", cmdVolCreateAs, opts_vol_create_as, info_vol_create_as},
    {"vol-create", cmdVolCreate, opts_vol_create, info_vol_create},
    {"vol-create-from", cmdVolCreateFrom, opts_vol_create_from, info_vol_create_from},
    {"vol-delete", cmdVolDelete, opts_vol_delete, info_vol_delete},
10793
    {"vol-download", cmdVolDownload, opts_vol_download, info_vol_download },
10794 10795 10796 10797 10798 10799 10800
    {"vol-dumpxml", cmdVolDumpXML, opts_vol_dumpxml, info_vol_dumpxml},
    {"vol-info", cmdVolInfo, opts_vol_info, info_vol_info},
    {"vol-key", cmdVolKey, opts_vol_key, info_vol_key},
    {"vol-list", cmdVolList, opts_vol_list, info_vol_list},
    {"vol-name", cmdVolName, opts_vol_name, info_vol_name},
    {"vol-path", cmdVolPath, opts_vol_path, info_vol_path},
    {"vol-pool", cmdVolPool, opts_vol_pool, info_vol_pool},
10801
    {"vol-upload", cmdVolUpload, opts_vol_upload, info_vol_upload },
10802 10803 10804
    {"vol-wipe", cmdVolWipe, opts_vol_wipe, info_vol_wipe},
    {NULL, NULL, NULL, NULL}
};
10805

10806
static const vshCmdDef networkCmds[] = {
10807
    {"net-autostart", cmdNetworkAutostart, opts_network_autostart, info_network_autostart},
10808 10809 10810 10811
    {"net-create", cmdNetworkCreate, opts_network_create, info_network_create},
    {"net-define", cmdNetworkDefine, opts_network_define, info_network_define},
    {"net-destroy", cmdNetworkDestroy, opts_network_destroy, info_network_destroy},
    {"net-dumpxml", cmdNetworkDumpXML, opts_network_dumpxml, info_network_dumpxml},
10812
    {"net-edit", cmdNetworkEdit, opts_network_edit, info_network_edit},
O
Osier Yang 已提交
10813
    {"net-info", cmdNetworkInfo, opts_network_info, info_network_info},
10814 10815 10816 10817 10818
    {"net-list", cmdNetworkList, opts_network_list, info_network_list},
    {"net-name", cmdNetworkName, opts_network_name, info_network_name},
    {"net-start", cmdNetworkStart, opts_network_start, info_network_start},
    {"net-undefine", cmdNetworkUndefine, opts_network_undefine, info_network_undefine},
    {"net-uuid", cmdNetworkUuid, opts_network_uuid, info_network_uuid},
10819 10820
    {NULL, NULL, NULL, NULL}
};
10821

10822 10823 10824
static const vshCmdDef nodedevCmds[] = {
    {"nodedev-create", cmdNodeDeviceCreate, opts_node_device_create, info_node_device_create},
    {"nodedev-destroy", cmdNodeDeviceDestroy, opts_node_device_destroy, info_node_device_destroy},
10825
    {"nodedev-dettach", cmdNodeDeviceDettach, opts_node_device_dettach, info_node_device_dettach},
10826 10827
    {"nodedev-dumpxml", cmdNodeDeviceDumpXML, opts_node_device_dumpxml, info_node_device_dumpxml},
    {"nodedev-list", cmdNodeListDevices, opts_node_list_devices, info_node_list_devices},
10828 10829
    {"nodedev-reattach", cmdNodeDeviceReAttach, opts_node_device_reattach, info_node_device_reattach},
    {"nodedev-reset", cmdNodeDeviceReset, opts_node_device_reset, info_node_device_reset},
10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844
    {NULL, NULL, NULL, NULL}
};

static const vshCmdDef ifaceCmds[] = {
    {"iface-define", cmdInterfaceDefine, opts_interface_define, info_interface_define},
    {"iface-destroy", cmdInterfaceDestroy, opts_interface_destroy, info_interface_destroy},
    {"iface-dumpxml", cmdInterfaceDumpXML, opts_interface_dumpxml, info_interface_dumpxml},
    {"iface-edit", cmdInterfaceEdit, opts_interface_edit, info_interface_edit},
    {"iface-list", cmdInterfaceList, opts_interface_list, info_interface_list},
    {"iface-mac", cmdInterfaceMAC, opts_interface_mac, info_interface_mac},
    {"iface-name", cmdInterfaceName, opts_interface_name, info_interface_name},
    {"iface-start", cmdInterfaceStart, opts_interface_start, info_interface_start},
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine, info_interface_undefine},
    {NULL, NULL, NULL, NULL}
};
10845

10846
static const vshCmdDef nwfilterCmds[] = {
10847 10848 10849
    {"nwfilter-define", cmdNWFilterDefine, opts_nwfilter_define, info_nwfilter_define},
    {"nwfilter-dumpxml", cmdNWFilterDumpXML, opts_nwfilter_dumpxml, info_nwfilter_dumpxml},
    {"nwfilter-edit", cmdNWFilterEdit, opts_nwfilter_edit, info_nwfilter_edit},
10850 10851 10852 10853
    {"nwfilter-list", cmdNWFilterList, opts_nwfilter_list, info_nwfilter_list},
    {"nwfilter-undefine", cmdNWFilterUndefine, opts_nwfilter_undefine, info_nwfilter_undefine},
    {NULL, NULL, NULL, NULL}
};
10854

10855
static const vshCmdDef secretCmds[] = {
10856 10857 10858 10859
    {"secret-define", cmdSecretDefine, opts_secret_define, info_secret_define},
    {"secret-dumpxml", cmdSecretDumpXML, opts_secret_dumpxml, info_secret_dumpxml},
    {"secret-get-value", cmdSecretGetValue, opts_secret_get_value, info_secret_get_value},
    {"secret-list", cmdSecretList, NULL, info_secret_list},
10860 10861 10862 10863
    {"secret-set-value", cmdSecretSetValue, opts_secret_set_value, info_secret_set_value},
    {"secret-undefine", cmdSecretUndefine, opts_secret_undefine, info_secret_undefine},
    {NULL, NULL, NULL, NULL}
};
10864

10865 10866 10867 10868 10869 10870 10871
static const vshCmdDef virshCmds[] = {
#ifndef WIN32
    {"cd", cmdCd, opts_cd, info_cd},
#endif
    {"echo", cmdEcho, opts_echo, info_echo},
    {"exit", cmdQuit, NULL, info_quit},
    {"help", cmdHelp, opts_help, info_help},
10872
#ifndef WIN32
P
Paolo Bonzini 已提交
10873
    {"pwd", cmdPwd, NULL, info_pwd},
10874
#endif
K
Karel Zak 已提交
10875
    {"quit", cmdQuit, NULL, info_quit},
10876 10877
    {NULL, NULL, NULL, NULL}
};
10878

10879
static const vshCmdDef snapshotCmds[] = {
10880 10881 10882 10883 10884
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create, info_snapshot_create},
    {"snapshot-current", cmdSnapshotCurrent, opts_snapshot_current, info_snapshot_current},
    {"snapshot-delete", cmdSnapshotDelete, opts_snapshot_delete, info_snapshot_delete},
    {"snapshot-dumpxml", cmdSnapshotDumpXML, opts_snapshot_dumpxml, info_snapshot_dumpxml},
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list, info_snapshot_list},
10885
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert, info_snapshot_revert},
10886 10887
    {NULL, NULL, NULL, NULL}
};
10888

10889 10890 10891 10892 10893
static const vshCmdDef hostAndHypervisorCmds[] = {
    {"capabilities", cmdCapabilities, NULL, info_capabilities},
    {"connect", cmdConnect, opts_connect, info_connect},
    {"freecell", cmdFreecell, opts_freecell, info_freecell},
    {"hostname", cmdHostname, NULL, info_hostname},
10894
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo},
10895
    {"qemu-monitor-command", cmdQemuMonitorCommand, opts_qemu_monitor_command, info_qemu_monitor_command},
E
Eric Blake 已提交
10896
    {"sysinfo", cmdSysinfo, NULL, info_sysinfo},
10897
    {"uri", cmdURI, NULL, info_uri},
10898
    {NULL, NULL, NULL, NULL}
K
Karel Zak 已提交
10899 10900
};

10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917
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 已提交
10918 10919 10920 10921
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
10922
static const char *
10923
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
10924
{
10925
    const vshCmdInfo *info;
10926

K
Karel Zak 已提交
10927
    for (info = cmd->info; info && info->name; info++) {
10928
        if (STREQ(info->name, name))
K
Karel Zak 已提交
10929 10930 10931 10932 10933
            return info->data;
    }
    return NULL;
}

10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965
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;
}

10966
static const vshCmdOptDef *
10967 10968
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
10969
{
10970 10971 10972 10973
    int i;

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

10975 10976 10977 10978 10979 10980
        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 已提交
10981
            return opt;
10982 10983 10984 10985 10986
        }
    }

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

10990
static const vshCmdOptDef *
10991 10992
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
10993
{
10994
    int i;
10995
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
10996

10997 10998 10999 11000 11001 11002 11003 11004 11005 11006
    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 已提交
11007 11008
}

11009 11010 11011
/*
 * Checks for required options
 */
11012
static int
11013 11014
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
11015
{
11016
    const vshCmdDef *def = cmd->def;
11017 11018 11019 11020 11021 11022 11023 11024 11025
    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];
11026

11027 11028 11029 11030 11031
            vshError(ctl,
                     opt->type == VSH_OT_DATA ?
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
11032 11033
        }
    }
11034
    return -1;
11035 11036
}

11037
static const vshCmdDef *
11038 11039
vshCmddefSearch(const char *cmdname)
{
11040
    const vshCmdGrp *g;
11041
    const vshCmdDef *c;
11042

11043 11044
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
11045
            if (STREQ(c->name, cmdname))
11046 11047 11048 11049
                return c;
        }
    }

K
Karel Zak 已提交
11050 11051 11052
    return NULL;
}

11053 11054 11055 11056 11057 11058
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
11059
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087
            return g;
    }

    return NULL;
}

static int
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);
        return FALSE;
    } 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")));
        }
    }

    return TRUE;
}

K
Karel Zak 已提交
11088
static int
11089
vshCmddefHelp(vshControl *ctl, const char *cmdname)
11090
{
11091
    const vshCmdDef *def = vshCmddefSearch(cmdname);
11092

K
Karel Zak 已提交
11093
    if (!def) {
11094
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
11095 11096
        return FALSE;
    } else {
E
Eric Blake 已提交
11097 11098
        const char *desc = _(vshCmddefGetInfo(def, "desc"));
        const char *help = _(vshCmddefGetInfo(def, "help"));
11099
        char buf[256];
11100 11101 11102 11103 11104 11105 11106 11107
        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);
            return FALSE;
        }
K
Karel Zak 已提交
11108

11109
        fputs(_("  NAME\n"), stdout);
11110 11111
        fprintf(stdout, "    %s - %s\n", def->name, help);

11112 11113 11114 11115 11116 11117
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
                const char *fmt;
11118 11119
                switch (opt->type) {
                case VSH_OT_BOOL:
11120
                    fmt = "[--%s]";
11121 11122
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
11123
                    /* xgettext:c-format */
11124 11125
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
11126 11127
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
11128 11129
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
11130 11131
                    break;
                case VSH_OT_DATA:
11132
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
11133 11134 11135 11136 11137 11138
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
                    fmt = _("[<string>]...");
                    break;
                default:
11139
                    assert(0);
11140
                }
11141
                fputc(' ', stdout);
E
Eric Blake 已提交
11142
                fprintf(stdout, fmt, opt->name);
11143
            }
K
Karel Zak 已提交
11144
        }
11145 11146 11147
        fputc('\n', stdout);

        if (desc[0]) {
11148
            /* Print the description only if it's not empty.  */
11149
            fputs(_("\n  DESCRIPTION\n"), stdout);
K
Karel Zak 已提交
11150 11151
            fprintf(stdout, "    %s\n", desc);
        }
11152

K
Karel Zak 已提交
11153
        if (def->opts) {
11154
            const vshCmdOptDef *opt;
11155
            fputs(_("\n  OPTIONS\n"), stdout);
11156
            for (opt = def->opts; opt->name; opt++) {
11157 11158
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
11159
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
11160 11161
                    break;
                case VSH_OT_INT:
11162 11163 11164
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
11165 11166
                    break;
                case VSH_OT_STRING:
11167
                    /* OT_STRING should never be VSH_OFLAG_REQ */
11168
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
11169 11170
                    break;
                case VSH_OT_DATA:
11171 11172
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
11173 11174 11175 11176 11177 11178 11179
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
                    continue;
                default:
                    assert(0);
                }
11180

E
Eric Blake 已提交
11181
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
11182
            }
K
Karel Zak 已提交
11183 11184 11185 11186 11187 11188 11189 11190 11191 11192
        }
        fputc('\n', stdout);
    }
    return TRUE;
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
11193 11194 11195
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
11196 11197
    vshCmdOpt *a = arg;

11198
    while (a) {
K
Karel Zak 已提交
11199
        vshCmdOpt *tmp = a;
11200

K
Karel Zak 已提交
11201 11202
        a = a->next;

11203 11204
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
11205 11206 11207 11208
    }
}

static void
11209
vshCommandFree(vshCmd *cmd)
11210
{
K
Karel Zak 已提交
11211 11212
    vshCmd *c = cmd;

11213
    while (c) {
K
Karel Zak 已提交
11214
        vshCmd *tmp = c;
11215

K
Karel Zak 已提交
11216 11217 11218 11219
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
11220
        VIR_FREE(tmp);
K
Karel Zak 已提交
11221 11222 11223 11224 11225 11226 11227
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
11228
vshCommandOpt(const vshCmd *cmd, const char *name)
11229
{
K
Karel Zak 已提交
11230
    vshCmdOpt *opt = cmd->opts;
11231 11232

    while (opt) {
11233
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
11234 11235 11236 11237 11238 11239 11240
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
11241 11242 11243 11244 11245 11246 11247 11248 11249
 * @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 已提交
11250 11251
 */
static int
11252
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
11253
{
K
Karel Zak 已提交
11254
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11255
    int ret = 0, num;
11256
    char *end_p = NULL;
11257

11258
    if ((arg != NULL) && (arg->data != NULL)) {
11259 11260 11261 11262 11263 11264
        num = strtol(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11265
    }
11266
    return ret;
K
Karel Zak 已提交
11267 11268
}

11269 11270 11271 11272 11273 11274
/*
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
11275 11276
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11277 11278
    int ret = 0;
    unsigned long num;
11279 11280 11281
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
11282 11283 11284 11285 11286 11287
        num = strtoul(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11288
    }
11289
    return ret;
11290 11291
}

K
Karel Zak 已提交
11292 11293
/*
 * Returns option as STRING
11294
 * See vshCommandOptInt()
K
Karel Zak 已提交
11295
 */
11296 11297
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
11298
{
K
Karel Zak 已提交
11299
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11300 11301 11302
    int ret = 0;

    if (arg && arg->data) {
E
Eric Blake 已提交
11303 11304 11305 11306
        if (*arg->data
            || (arg->def && (arg->def->flag & VSH_OFLAG_EMPTY_OK))) {
            *value = arg->data;
            ret = 1;
11307 11308
        } else if (arg->def && ((arg->def->flag) & VSH_OFLAG_REQ)) {
            vshError(NULL, _("Missing required option '%s'"), name);
E
Eric Blake 已提交
11309 11310 11311 11312
            ret = -1;
        } else {
            /* Treat "--option ''" as if option had not been specified. */
            ret = 0;
11313 11314
        }
    }
11315

11316
    return ret;
K
Karel Zak 已提交
11317 11318
}

11319 11320
/*
 * Returns option as long long
11321
 * See vshCommandOptInt()
11322
 */
11323 11324 11325
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
11326 11327
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11328 11329
    int ret = 0;
    long long num;
11330 11331
    char *end_p = NULL;

11332 11333 11334 11335 11336 11337 11338 11339 11340
    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;
11341 11342
}

11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363
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 已提交
11364 11365 11366 11367
/*
 * Returns TRUE/FALSE if the option exists
 */
static int
11368
vshCommandOptBool(const vshCmd *cmd, const char *name)
11369
{
K
Karel Zak 已提交
11370 11371 11372
    return vshCommandOpt(cmd, name) ? TRUE : FALSE;
}

11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393
/*
 * 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 已提交
11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411
/* 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)
11412
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
11413 11414 11415
                 cmd->def->name, optname);
    return found;
}
11416

K
Karel Zak 已提交
11417
static virDomainPtr
J
Jim Meyering 已提交
11418
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
11419
                      const char **name, int flag)
11420
{
K
Karel Zak 已提交
11421
    virDomainPtr dom = NULL;
11422
    const char *n = NULL;
K
Karel Zak 已提交
11423
    int id;
J
Jim Meyering 已提交
11424 11425 11426
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11427

11428
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11429 11430
        return NULL;

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

K
Karel Zak 已提交
11434 11435
    if (name)
        *name = n;
11436

K
Karel Zak 已提交
11437
    /* try it by ID */
11438
    if (flag & VSH_BYID) {
11439
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
11440 11441 11442 11443
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
11444
    }
K
Karel Zak 已提交
11445
    /* try it by UUID */
11446
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
11447
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
11448
                 cmd->def->name, optname);
K
Karel Zak 已提交
11449
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
11450
    }
K
Karel Zak 已提交
11451
    /* try it by NAME */
11452
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11453
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
11454
                 cmd->def->name, optname);
K
Karel Zak 已提交
11455
        dom = virDomainLookupByName(ctl->conn, n);
11456
    }
K
Karel Zak 已提交
11457

11458
    if (!dom)
11459
        vshError(ctl, _("failed to get domain '%s'"), n);
11460

K
Karel Zak 已提交
11461 11462 11463
    return dom;
}

11464
static virNetworkPtr
J
Jim Meyering 已提交
11465
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
11466
                       const char **name, int flag)
11467 11468
{
    virNetworkPtr network = NULL;
11469
    const char *n = NULL;
J
Jim Meyering 已提交
11470 11471 11472
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11473

11474
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11475 11476 11477 11478 11479 11480 11481 11482 11483
        return NULL;

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

    if (name)
        *name = n;

    /* try it by UUID */
11484
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
11485
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
11486
                 cmd->def->name, optname);
11487 11488 11489 11490
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11491
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
11492 11493 11494 11495 11496
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
11497
        vshError(ctl, _("failed to get network '%s'"), n);
11498 11499 11500 11501

    return network;
}

11502 11503 11504

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
11505
                        const char **name, int flag)
11506 11507
{
    virNWFilterPtr nwfilter = NULL;
11508
    const char *n = NULL;
11509 11510 11511 11512
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11513
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540
        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;
}

11541 11542
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
11543
                         const char **name, int flag)
11544 11545
{
    virInterfacePtr iface = NULL;
11546
    const char *n = NULL;
11547 11548 11549 11550
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11551
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11552 11553 11554 11555 11556 11557 11558 11559 11560
        return NULL;

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

    if (name)
        *name = n;

    /* try it by NAME */
11561
    if ((flag & VSH_BYNAME)) {
11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573
        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)
11574
        vshError(ctl, _("failed to get interface '%s'"), n);
11575 11576 11577 11578

    return iface;
}

11579
static virStoragePoolPtr
11580
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
11581
                    const char **name, int flag)
11582 11583
{
    virStoragePoolPtr pool = NULL;
11584
    const char *n = NULL;
11585

11586
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11587 11588 11589 11590 11591 11592 11593 11594 11595
        return NULL;

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

    if (name)
        *name = n;

    /* try it by UUID */
11596
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
11597
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
11598
                 cmd->def->name, optname);
11599 11600 11601
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
11602
    if (pool == NULL && (flag & VSH_BYNAME)) {
11603 11604 11605 11606 11607 11608
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
11609
        vshError(ctl, _("failed to get pool '%s'"), n);
11610 11611 11612 11613 11614

    return pool;
}

static virStorageVolPtr
11615
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
11616 11617
                   const char *optname,
                   const char *pooloptname,
11618
                   const char **name, int flag)
11619 11620 11621
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
11622
    const char *n = NULL, *p = NULL;
11623

11624
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11625 11626
        return NULL;

11627 11628
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
11629
        return NULL;
11630
    }
11631 11632 11633 11634 11635 11636 11637 11638 11639 11640

    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;

11641
    /* try it by name */
11642
    if (pool && (flag & VSH_BYNAME)) {
11643
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
11644 11645 11646
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
11647
    /* try it by key */
11648 11649 11650 11651 11652
    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);
    }
11653
    /* try it by path */
11654 11655 11656 11657 11658 11659 11660
    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)
11661
        vshError(ctl, _("failed to get vol '%s'"), n);
11662 11663 11664 11665 11666 11667 11668

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

11669
static virSecretPtr
11670
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
11671 11672
{
    virSecretPtr secret = NULL;
11673
    const char *n = NULL;
11674 11675 11676 11677 11678
    const char *optname = "secret";

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

11679
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11680 11681 11682 11683 11684 11685 11686 11687 11688 11689
        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)
11690
        vshError(ctl, _("failed to get secret '%s'"), n);
11691 11692 11693 11694

    return secret;
}

K
Karel Zak 已提交
11695 11696 11697 11698
/*
 * Executes command(s) and returns return code from last command
 */
static int
11699
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
11700
{
K
Karel Zak 已提交
11701
    int ret = TRUE;
11702 11703

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

11707 11708 11709
        if ((ctl->conn == NULL) || (disconnected != 0))
            vshReconnect(ctl);

11710
        if (enable_timing)
K
Karel Zak 已提交
11711
            GETTIMEOFDAY(&before);
11712

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

11715
        if (enable_timing)
K
Karel Zak 已提交
11716
            GETTIMEOFDAY(&after);
11717

J
John Levon 已提交
11718 11719 11720
        if (ret == FALSE)
            virshReportError(ctl);

11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731
        /* try to automatically catch disconnections */
        if ((ret == FALSE) &&
            ((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);

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

11735
        if (enable_timing)
11736
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
11737 11738
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
11739
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
11740 11741 11742 11743 11744 11745
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
11746
 * Command parsing
K
Karel Zak 已提交
11747 11748 11749
 * ---------------
 */

11750 11751 11752 11753 11754 11755 11756 11757 11758 11759
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 已提交
11760
    /* vshCommandStringGetArg() */
11761
    char *pos;
L
Lai Jiangshan 已提交
11762 11763 11764
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
11765 11766
} vshCommandParser;

K
Karel Zak 已提交
11767
static int
11768
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
11769
{
K
Karel Zak 已提交
11770 11771 11772
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
11773

K
Karel Zak 已提交
11774 11775 11776 11777
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
11778

11779
    while (1) {
K
Karel Zak 已提交
11780
        vshCmdOpt *last = NULL;
11781
        const vshCmdDef *cmd = NULL;
11782
        vshCommandToken tk;
L
Lai Jiangshan 已提交
11783
        bool data_only = false;
11784 11785 11786
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
11787

K
Karel Zak 已提交
11788
        first = NULL;
11789

11790
        while (1) {
11791
            const vshCmdOptDef *opt = NULL;
11792

K
Karel Zak 已提交
11793
            tkdata = NULL;
11794
            tk = parser->getNextArg(ctl, parser, &tkdata);
11795 11796

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
11797
                goto syntaxError;
H
Hu Tao 已提交
11798 11799
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
11800
                break;
H
Hu Tao 已提交
11801
            }
11802 11803

            if (cmd == NULL) {
K
Karel Zak 已提交
11804 11805
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
11806
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
11807
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
11808
                }
11809 11810 11811 11812 11813 11814 11815
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
11816
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
11817 11818 11819 11820
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
11821 11822 11823 11824 11825
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
11826 11827
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
11828
                    VIR_FREE(optstr);
K
Karel Zak 已提交
11829 11830
                    goto syntaxError;
                }
11831
                VIR_FREE(tkdata);
K
Karel Zak 已提交
11832 11833 11834

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
11835 11836 11837
                    if (optstr)
                        tkdata = optstr;
                    else
11838
                        tk = parser->getNextArg(ctl, parser, &tkdata);
11839
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
11840
                        goto syntaxError;
11841
                    if (tk != VSH_TK_ARG) {
11842
                        vshError(ctl,
11843
                                 _("expected syntax: --%s <%s>"),
11844 11845
                                 opt->name,
                                 opt->type ==
11846
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
11847 11848
                        goto syntaxError;
                    }
11849
                    opts_need_arg &= ~opts_seen;
11850 11851 11852 11853 11854 11855 11856 11857
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
11858
                }
L
Lai Jiangshan 已提交
11859 11860 11861 11862
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
11863
            } else {
L
Lai Jiangshan 已提交
11864
get_data:
11865 11866
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
11867
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
11868 11869 11870 11871 11872
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
11873
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
11874

K
Karel Zak 已提交
11875 11876 11877 11878
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
11879

K
Karel Zak 已提交
11880 11881 11882 11883 11884
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
11885

K
Karel Zak 已提交
11886
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
11887 11888
                         cmd->name,
                         opt->name,
11889 11890
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
11891 11892
            }
        }
11893

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

K
Karel Zak 已提交
11898 11899 11900 11901
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

11902
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
11903
                VIR_FREE(c);
11904
                goto syntaxError;
11905
            }
11906

K
Karel Zak 已提交
11907 11908 11909 11910 11911 11912
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
11913 11914 11915

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
11916
    }
11917

K
Karel Zak 已提交
11918 11919
    return TRUE;

11920
 syntaxError:
11921
    if (ctl->cmd) {
K
Karel Zak 已提交
11922
        vshCommandFree(ctl->cmd);
11923 11924
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
11925 11926
    if (first)
        vshCommandOptFree(first);
11927
    VIR_FREE(tkdata);
11928
    return FALSE;
K
Karel Zak 已提交
11929 11930
}

11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038
/* --------------------
 * 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;
}

static int vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
{
    vshCommandParser parser;

    if (nargs <= 0)
        return FALSE;

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

static int vshCommandStringParse(vshControl *ctl, char *cmdstr)
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
        return FALSE;

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

K
Karel Zak 已提交
12039
/* ---------------
12040
 * Misc utils
K
Karel Zak 已提交
12041 12042
 * ---------------
 */
K
Karel Zak 已提交
12043
static const char *
12044 12045
vshDomainStateToString(int state)
{
K
Karel Zak 已提交
12046
    switch (state) {
12047
    case VIR_DOMAIN_RUNNING:
12048
        return N_("running");
12049
    case VIR_DOMAIN_BLOCKED:
12050
        return N_("idle");
12051
    case VIR_DOMAIN_PAUSED:
12052
        return N_("paused");
12053
    case VIR_DOMAIN_SHUTDOWN:
12054
        return N_("in shutdown");
12055
    case VIR_DOMAIN_SHUTOFF:
12056
        return N_("shut off");
12057
    case VIR_DOMAIN_CRASHED:
12058
        return N_("crashed");
12059
    default:
12060
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
12061
    }
12062
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
12063 12064
}

12065 12066 12067 12068
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
12069
    case VIR_VCPU_OFFLINE:
12070
        return N_("offline");
12071
    case VIR_VCPU_BLOCKED:
12072
        return N_("idle");
12073
    case VIR_VCPU_RUNNING:
12074
        return N_("running");
12075
    default:
12076
        ;/*FALLTHROUGH*/
12077
    }
12078
    return N_("no state");
12079 12080
}

K
Karel Zak 已提交
12081
static int
12082
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
12083
{
12084 12085
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
12086 12087
     */
    if (!conn) {
12088
        vshError(ctl, "%s", _("no valid connection"));
K
Karel Zak 已提交
12089 12090 12091 12092 12093
        return FALSE;
    }
    return TRUE;
}

K
Karel Zak 已提交
12094
static void
12095
vshDebug(vshControl *ctl, int level, const char *format, ...)
12096
{
K
Karel Zak 已提交
12097 12098
    va_list ap;

12099 12100 12101 12102
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
12103 12104 12105 12106 12107 12108
    if (level > ctl->debug)
        return;

    va_start(ap, format);
    vfprintf(stdout, format, ap);
    va_end(ap);
K
Karel Zak 已提交
12109 12110 12111
}

static void
12112
vshPrintExtra(vshControl *ctl, const char *format, ...)
12113
{
K
Karel Zak 已提交
12114
    va_list ap;
12115
    char *str;
12116

12117
    if (ctl && ctl->quiet == TRUE)
K
Karel Zak 已提交
12118
        return;
12119

K
Karel Zak 已提交
12120
    va_start(ap, format);
12121 12122 12123 12124 12125
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
12126
    va_end(ap);
12127 12128
    fprintf(stdout, "%s", str);
    VIR_FREE(str);
K
Karel Zak 已提交
12129 12130
}

K
Karel Zak 已提交
12131

K
Karel Zak 已提交
12132
static void
12133
vshError(vshControl *ctl, const char *format, ...)
12134
{
K
Karel Zak 已提交
12135
    va_list ap;
12136
    char *str;
12137

12138 12139 12140 12141 12142
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
12143

12144
    fputs(_("error: "), stderr);
12145

K
Karel Zak 已提交
12146
    va_start(ap, format);
12147 12148 12149
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
12150 12151
    va_end(ap);

12152 12153
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
12154 12155 12156
}

/*
12157
 * Initialize connection.
K
Karel Zak 已提交
12158 12159
 */
static int
12160
vshInit(vshControl *ctl)
12161
{
K
Karel Zak 已提交
12162 12163 12164
    if (ctl->conn)
        return FALSE;

12165 12166
    vshOpenLogFile(ctl);

12167 12168
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
12169

12170 12171 12172
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

12173 12174
    if (virEventRegisterDefaultImpl() < 0)
        return FALSE;
12175

12176 12177 12178 12179
    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

12180

12181 12182 12183 12184
    /* This is not necessarily fatal.  All the individual commands check
     * vshConnectionUsability, except ones which don't need a connection
     * such as "help".
     */
12185
    if (!ctl->conn) {
12186
        virshReportError(ctl);
12187
        vshError(ctl, "%s", _("failed to connect to the hypervisor"));
12188 12189
        return FALSE;
    }
K
Karel Zak 已提交
12190 12191 12192 12193

    return TRUE;
}

12194 12195
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214
/**
 * 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:
12215
                vshError(ctl, "%s",
J
Jim Meyering 已提交
12216
                         _("failed to get the log file information"));
12217
                exit(EXIT_FAILURE);
12218 12219 12220
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
12221 12222
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
12223 12224 12225 12226
        }
    }

    /* log file open */
12227
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
12228
        vshError(ctl, "%s",
J
Jim Meyering 已提交
12229
                 _("failed to open the log file. check the log file path"));
12230
        exit(EXIT_FAILURE);
12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format, va_list ap)
{
12242
    char *msg_buf;
12243 12244 12245 12246 12247 12248 12249
    const char *lvl = "";
    struct timeval stTimeval;
    struct tm *stTm;

    if (ctl->log_fd == -1)
        return;

12250 12251
    msg_buf = vshMalloc(ctl, MSG_BUFFER);

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
    /**
     * create log format
     *
     * [YYYY.MM.DD HH:MM:SS SIGNATURE PID] LOG_LEVEL message
    */
    gettimeofday(&stTimeval, NULL);
    stTm = localtime(&stTimeval.tv_sec);
    snprintf(msg_buf, sizeof(msg_buf),
             "[%d.%02d.%02d %02d:%02d:%02d ",
             (1900 + stTm->tm_year),
             (1 + stTm->tm_mon),
             (stTm->tm_mday),
             (stTm->tm_hour),
             (stTm->tm_min),
             (stTm->tm_sec));
    snprintf(msg_buf + strlen(msg_buf), sizeof(msg_buf) - strlen(msg_buf),
             "%s] ", SIGN_NAME);
    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;
    }
    snprintf(msg_buf + strlen(msg_buf), sizeof(msg_buf) - strlen(msg_buf),
             "%s ", lvl);
    vsnprintf(msg_buf + strlen(msg_buf), sizeof(msg_buf) - strlen(msg_buf),
              msg_format, ap);

    if (msg_buf[strlen(msg_buf) - 1] != '\n')
        snprintf(msg_buf + strlen(msg_buf), sizeof(msg_buf) - strlen(msg_buf), "\n");

    /* write log */
12298
    if (safewrite(ctl->log_fd, msg_buf, strlen(msg_buf)) < 0) {
12299
        vshCloseLogFile(ctl);
12300
        vshError(ctl, "%s", _("failed to write the log file"));
12301
    }
12302 12303

    VIR_FREE(msg_buf);
12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
12315 12316 12317
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
12318 12319 12320
    }

    if (ctl->logfile) {
12321
        VIR_FREE(ctl->logfile);
12322 12323 12324 12325
        ctl->logfile = NULL;
    }
}

12326
#ifdef USE_READLINE
12327

K
Karel Zak 已提交
12328 12329 12330 12331 12332
/* -----------------
 * Readline stuff
 * -----------------
 */

12333
/*
K
Karel Zak 已提交
12334 12335
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
12336
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
12337 12338
 */
static char *
12339 12340
vshReadlineCommandGenerator(const char *text, int state)
{
12341
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
12342
    const char *name;
12343 12344
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
12345 12346

    if (!state) {
12347 12348
        grp_list_index = 0;
        cmd_list_index = 0;
12349
        len = strlen(text);
K
Karel Zak 已提交
12350 12351
    }

12352 12353
    grp = cmdGroups;

K
Karel Zak 已提交
12354
    /* Return the next name which partially matches from the
12355
     * command list.
K
Karel Zak 已提交
12356
     */
12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370
    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 已提交
12371 12372 12373 12374 12375 12376 12377
    }

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

static char *
12378 12379
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
12380
    static int list_index, len;
12381
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
12382
    const char *name;
K
Karel Zak 已提交
12383 12384 12385 12386 12387 12388 12389 12390 12391

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

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

12392
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
12393
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
12394 12395 12396

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
12397
        len = strlen(text);
12398
        VIR_FREE(cmdname);
K
Karel Zak 已提交
12399 12400 12401 12402
    }

    if (!cmd)
        return NULL;
12403

12404 12405 12406
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
12407
    while ((name = cmd->opts[list_index].name)) {
12408
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
12409
        char *res;
12410

K
Karel Zak 已提交
12411
        list_index++;
12412

K
Karel Zak 已提交
12413
        if (opt->type == VSH_OT_DATA)
K
Karel Zak 已提交
12414 12415
            /* ignore non --option */
            continue;
12416

K
Karel Zak 已提交
12417
        if (len > 2) {
12418
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
12419 12420
                continue;
        }
12421
        res = vshMalloc(NULL, strlen(name) + 3);
12422
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
12423 12424 12425 12426 12427 12428 12429 12430
        return res;
    }

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

static char **
12431 12432 12433
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
12434 12435
    char **matches = (char **) NULL;

12436
    if (start == 0)
K
Karel Zak 已提交
12437
        /* command name generator */
12438
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
12439 12440
    else
        /* commands options */
12441
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
12442 12443 12444 12445
    return matches;
}


12446 12447
static int
vshReadlineInit(vshControl *ctl)
12448
{
12449 12450
    char *userdir = NULL;

K
Karel Zak 已提交
12451 12452 12453 12454 12455
    /* 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;
12456 12457 12458

    /* Limit the total size of the history buffer */
    stifle_history(500);
12459 12460

    /* Prepare to read/write history from/to the ~/.virsh/history file */
12461
    userdir = virGetUserDirectory(getuid());
12462 12463 12464 12465 12466 12467

    if (userdir == NULL)
        return -1;

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12468
        VIR_FREE(userdir);
12469 12470 12471 12472 12473
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12474
        VIR_FREE(userdir);
12475 12476 12477
        return -1;
    }

12478
    VIR_FREE(userdir);
12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496

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

12497 12498
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
12499 12500
}

12501 12502 12503 12504 12505 12506
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

12507
#else /* !USE_READLINE */
12508

12509 12510 12511 12512 12513 12514 12515
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

12516
static void
12517
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540
{
    /* 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);
}

12541
#endif /* !USE_READLINE */
12542

K
Karel Zak 已提交
12543
/*
J
Jim Meyering 已提交
12544
 * Deinitialize virsh
K
Karel Zak 已提交
12545 12546
 */
static int
12547
vshDeinit(vshControl *ctl)
12548
{
12549
    vshReadlineDeinit(ctl);
12550
    vshCloseLogFile(ctl);
12551
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
12552
    if (ctl->conn) {
12553 12554 12555
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
12556 12557
        }
    }
D
Daniel P. Berrange 已提交
12558 12559
    virResetLastError();

K
Karel Zak 已提交
12560 12561
    return TRUE;
}
12562

K
Karel Zak 已提交
12563 12564 12565 12566
/*
 * Print usage
 */
static void
12567
vshUsage(void)
12568
{
12569
    const vshCmdGrp *grp;
12570
    const vshCmdDef *cmd;
12571

L
Lai Jiangshan 已提交
12572 12573
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
12574 12575 12576 12577 12578 12579 12580 12581
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
                      "    -d | --debug <num>      debug level [0-5]\n"
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
12582
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
12583
                      "    -V | --version=long     version and full options\n\n"
12584
                      "  commands (non interactive mode):\n\n"), progname, progname);
12585

12586 12587
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
12588

12589 12590 12591 12592 12593 12594 12595 12596 12597
        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"));
12598 12599 12600
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
12601 12602
}

12603 12604 12605 12606 12607 12608 12609 12610 12611 12612
/*
 * 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 已提交
12613 12614
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649
#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 已提交
12650
    vshPrint(ctl, "%s", _(" Networking:"));
12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676
#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 已提交
12677
    vshPrint(ctl, "%s", _(" Storage:"));
12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700
#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 已提交
12701
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
12702
#ifdef WITH_SECDRIVER_APPARMOR
12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725
    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 已提交
12726 12727 12728 12729 12730
/*
 * argv[]:  virsh [options] [command]
 *
 */
static int
12731
vshParseArgv(vshControl *ctl, int argc, char **argv)
12732
{
12733 12734
    bool help = false;
    int arg;
K
Karel Zak 已提交
12735
    struct option opt[] = {
E
Eric Blake 已提交
12736 12737 12738 12739 12740 12741 12742 12743 12744
        {"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}
12745 12746
    };

12747 12748 12749
    /* 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. */
12750
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
12751
        switch (arg) {
12752
        case 'd':
D
Daniel Veillard 已提交
12753
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
12754
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
12755 12756
                exit(EXIT_FAILURE);
            }
12757 12758
            break;
        case 'h':
12759
            help = true;
12760 12761 12762 12763 12764 12765 12766 12767 12768 12769
            break;
        case 'q':
            ctl->quiet = TRUE;
            break;
        case 't':
            ctl->timing = TRUE;
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
12770 12771 12772 12773 12774 12775
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
12776 12777 12778
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
12779 12780 12781
        case 'r':
            ctl->readonly = TRUE;
            break;
12782 12783 12784
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
12785
        default:
12786 12787
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
12788 12789 12790 12791
        }
    }

    if (help) {
12792 12793
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
12794 12795
            exit(EXIT_FAILURE);
        }
12796 12797 12798

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
12799
        exit(EXIT_SUCCESS);
12800 12801
    }

12802
    if (argc > optind) {
K
Karel Zak 已提交
12803 12804
        /* parse command */
        ctl->imode = FALSE;
12805 12806 12807
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
12808
        } else {
12809
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
12810 12811 12812 12813 12814
        }
    }
    return TRUE;
}

12815 12816 12817 12818
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
12819
    char *defaultConn;
K
Karel Zak 已提交
12820 12821
    int ret = TRUE;

12822 12823
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
12824
        /* failure to setup locale is not fatal */
12825
    }
12826
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
12827
        perror("bindtextdomain");
E
Eric Blake 已提交
12828
        return EXIT_FAILURE;
12829
    }
12830
    if (!textdomain(PACKAGE)) {
12831
        perror("textdomain");
E
Eric Blake 已提交
12832
        return EXIT_FAILURE;
12833 12834
    }

12835
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
12836 12837 12838
        progname = argv[0];
    else
        progname++;
12839

K
Karel Zak 已提交
12840
    memset(ctl, 0, sizeof(vshControl));
12841
    ctl->imode = TRUE;          /* default is interactive mode */
12842
    ctl->log_fd = -1;           /* Initialize log file descriptor */
K
Karel Zak 已提交
12843

12844
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
12845
        ctl->name = vshStrdup(ctl, defaultConn);
12846 12847
    }

D
Daniel P. Berrange 已提交
12848 12849
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
12850
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
12851
    }
12852

D
Daniel P. Berrange 已提交
12853 12854
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
12855
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
12856
    }
12857

K
Karel Zak 已提交
12858
    if (!ctl->imode) {
12859
        ret = vshCommandRun(ctl, ctl->cmd);
12860
    } else {
K
Karel Zak 已提交
12861 12862
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
12863
            vshPrint(ctl,
12864
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
12865
                     progname);
J
Jim Meyering 已提交
12866
            vshPrint(ctl, "%s",
12867
                     _("Type:  'help' for help with commands\n"
12868
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
12869
        }
12870 12871 12872 12873 12874 12875

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
12876
        do {
12877
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
12878
            ctl->cmdstr =
12879
                vshReadline(ctl, prompt);
12880 12881
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
12882
            if (*ctl->cmdstr) {
12883
#if USE_READLINE
K
Karel Zak 已提交
12884
                add_history(ctl->cmdstr);
12885
#endif
12886
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
12887 12888
                    vshCommandRun(ctl, ctl->cmd);
            }
12889
            VIR_FREE(ctl->cmdstr);
12890
        } while (ctl->imode);
K
Karel Zak 已提交
12891

12892 12893
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
12894
    }
12895

K
Karel Zak 已提交
12896 12897
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
12898
}