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

13
#include <config.h>
14

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

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

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

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

static char *progname;

64 65
#define VIRSH_MAX_XML_FILE 10*1024*1024

K
Karel Zak 已提交
66 67 68 69 70 71 72 73
#define VSH_PROMPT_RW    "virsh # "
#define VSH_PROMPT_RO    "virsh > "

#define GETTIMEOFDAY(T) gettimeofday(T, NULL)
#define DIFF_MSEC(T, U) \
        ((((int) ((T)->tv_sec - (U)->tv_sec)) * 1000000.0 + \
          ((int) ((T)->tv_usec - (U)->tv_usec))) / 1000.0)

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
/**
 * The log configuration
 */
#define MSG_BUFFER    4096
#define SIGN_NAME     "virsh"
#define DIR_MODE      (S_IWUSR | S_IRUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)  /* 0755 */
#define FILE_MODE     (S_IWUSR | S_IRUSR | S_IRGRP | S_IROTH)                                /* 0644 */
#define LOCK_MODE     (S_IWUSR | S_IRUSR)                                                    /* 0600 */
#define LVL_DEBUG     "DEBUG"
#define LVL_INFO      "INFO"
#define LVL_NOTICE    "NOTICE"
#define LVL_WARNING   "WARNING"
#define LVL_ERROR     "ERROR"

/**
 * vshErrorLevel:
 *
J
Jim Meyering 已提交
91
 * Indicates the level of a log message
92 93 94 95 96 97 98 99 100
 */
typedef enum {
    VSH_ERR_DEBUG = 0,
    VSH_ERR_INFO,
    VSH_ERR_NOTICE,
    VSH_ERR_WARNING,
    VSH_ERR_ERROR
} vshErrorLevel;

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

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

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
/*
 * Command group types
 */
#define VSH_CMD_GRP_DOM_MANAGEMENT   "Domain Management"
#define VSH_CMD_GRP_DOM_MONITORING   "Domain Monitoring"
#define VSH_CMD_GRP_STORAGE_POOL     "Storage Pool"
#define VSH_CMD_GRP_STORAGE_VOL      "Storage Volume"
#define VSH_CMD_GRP_NETWORK          "Networking"
#define VSH_CMD_GRP_NODEDEV          "Node Device"
#define VSH_CMD_GRP_IFACE            "Interface"
#define VSH_CMD_GRP_NWFILTER         "Network Filter"
#define VSH_CMD_GRP_SECRET           "Secret"
#define VSH_CMD_GRP_SNAPSHOT         "Snapshot"
#define VSH_CMD_GRP_HOST_AND_HV      "Host and Hypervisor"
#define VSH_CMD_GRP_VIRSH            "Virsh itself"

K
Karel Zak 已提交
148 149 150
/*
 * Command Option Flags
 */
E
Eric Blake 已提交
151 152 153 154 155
enum {
    VSH_OFLAG_NONE     = 0,        /* without flags */
    VSH_OFLAG_REQ      = (1 << 0), /* option required */
    VSH_OFLAG_EMPTY_OK = (1 << 1), /* empty string option allowed */
};
K
Karel Zak 已提交
156 157 158 159 160 161 162 163

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

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

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

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

/*
 * vshCmdDef - command definition
 */
191 192
typedef struct {
    const char *name;
E
Eric Blake 已提交
193
    bool (*handler) (vshControl *, const vshCmd *);    /* command handler */
194 195
    const vshCmdOptDef *opts;   /* definition of command options */
    const vshCmdInfo *info;     /* details about command */
K
Karel Zak 已提交
196 197 198 199 200 201
} vshCmdDef;

/*
 * vshCmd - parsed command
 */
typedef struct __vshCmd {
202
    const vshCmdDef *def;       /* command definition */
203 204
    vshCmdOpt *opts;            /* list of command arguments */
    struct __vshCmd *next;      /* next command */
K
Karel Zak 已提交
205 206 207 208 209 210
} __vshCmd;

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

230 231 232 233 234
typedef struct vshCmdGrp {
    const char *name;
    const char *keyword; /* help keyword */
    const vshCmdDef *commands;
} vshCmdGrp;
235

236
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
237

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

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

250
static const char *vshCmddefGetInfo(const vshCmdDef *cmd, const char *info);
251
static const vshCmdDef *vshCmddefSearch(const char *cmdname);
E
Eric Blake 已提交
252
static bool vshCmddefHelp(vshControl *ctl, const char *name);
253
static const vshCmdGrp *vshCmdGrpSearch(const char *grpname);
E
Eric Blake 已提交
254
static bool vshCmdGrpHelp(vshControl *ctl, const char *name);
K
Karel Zak 已提交
255

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

274 275 276
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
277
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
278

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

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

286
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
287
                                            const char **name, int flag);
288 289

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

294
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
295
                                                  const char **name, int flag);
296 297 298 299 300 301

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

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

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

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

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

318
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
319 320
                                           const char *optname,
                                           const char *pooloptname,
321
                                           const char **name, int flag);
322 323

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

328
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
329
                                        const char **name);
330

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

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

339
static int vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason);
K
Karel Zak 已提交
340
static const char *vshDomainStateToString(int state);
341
static const char *vshDomainStateReasonToString(int state, int reason);
342
static const char *vshDomainVcpuStateToString(int state);
E
Eric Blake 已提交
343
static bool vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
K
Karel Zak 已提交
344

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

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

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

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

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

E
Eric Blake 已提交
361 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
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
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435

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;

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

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

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

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

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

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

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

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

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

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

E
Eric Blake 已提交
602
static bool
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");
        }

E
Eric Blake 已提交
624
        return true;
625
    }
626

E
Eric Blake 已提交
627
    if (vshCmddefSearch(name)) {
628
        return vshCmddefHelp(ctl, name);
E
Eric Blake 已提交
629
    } else if (vshCmdGrpSearch(name)) {
630 631 632
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
E
Eric Blake 已提交
633
        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
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
653
static bool
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))
E
Eric Blake 已提交
661
        return false;
662

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

    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
        virDomainFree(dom);
E
Eric Blake 已提交
674
        return false;
675 676
    }

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);
E
Eric Blake 已提交
683
    return true;
684 685
}

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

E
Eric Blake 已提交
703
static bool
704
cmdConnect(vshControl *ctl, const vshCmd *cmd)
705
{
E
Eric Blake 已提交
706
    bool 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);
E
Eric Blake 已提交
713
            return false;
K
Karel Zak 已提交
714 715 716
        }
        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"));
E
Eric Blake 已提交
721
        return false;
722
    }
723
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
724

725
    ctl->useGetInfo = false;
E
Eric Blake 已提交
726
    ctl->readonly = ro;
K
Karel Zak 已提交
727

728 729 730
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

E
Eric Blake 已提交
734
    return !!ctl->conn;
K
Karel Zak 已提交
735 736
}

737 738
#ifndef WIN32

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

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

E
Eric Blake 已提交
755
static bool
756
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
757
{
E
Eric Blake 已提交
758
    bool ret = false;
759
    int state;
760

761
    if ((state = vshDomainState(ctl, dom, NULL)) < 0) {
762 763 764 765
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

766
    if (state == VIR_DOMAIN_SHUTOFF) {
767 768 769 770
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

771 772
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
    vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
773
    if (vshRunConsole(dom, name) == 0)
E
Eric Blake 已提交
774
        ret = true;
775 776

 cleanup:
777

778 779 780
    return ret;
}

E
Eric Blake 已提交
781
static bool
782 783 784
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
785
    bool ret = false;
786
    const char *name = NULL;
787

788
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
789
        return false;
790 791

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

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

799
    ret = cmdRunConsole(ctl, dom, name);
800

801
cleanup:
802 803 804 805
    virDomainFree(dom);
    return ret;
}

806 807 808
#endif /* WIN32 */


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

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

K
Karel Zak 已提交
824

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

836
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
837
        return false;
838

839
    if (active) {
840 841
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
842
            vshError(ctl, "%s", _("Failed to list active domains"));
E
Eric Blake 已提交
843
            return false;
844 845 846 847 848
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
849
                vshError(ctl, "%s", _("Failed to list active domains"));
850
                VIR_FREE(ids);
E
Eric Blake 已提交
851
                return false;
852 853
            }

854
            qsort(&ids[0], maxid, sizeof(int), idsorter);
855
        }
856 857
    }
    if (inactive) {
858 859
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
860
            vshError(ctl, "%s", _("Failed to list inactive domains"));
861
            VIR_FREE(ids);
E
Eric Blake 已提交
862
            return false;
863
        }
864 865 866 867
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
868
                vshError(ctl, "%s", _("Failed to list inactive domains"));
869 870
                VIR_FREE(ids);
                VIR_FREE(names);
E
Eric Blake 已提交
871
                return false;
872
            }
873

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

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

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

K
Karel Zak 已提交
887
        vshPrint(ctl, "%3d %-20s %s\n",
888 889
                 virDomainGetID(dom),
                 virDomainGetName(dom),
890
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
891
        virDomainFree(dom);
K
Karel Zak 已提交
892
    }
893 894 895 896
    for (i = 0; i < maxname; i++) {
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);

        /* this kind of work with domains is not atomic operation */
897
        if (!dom) {
898
            VIR_FREE(names[i]);
899
            continue;
900
        }
901

902 903 904 905
        vshPrint(ctl, "%3s %-20s %s\n",
                 "-",
                 names[i],
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
906

907
        virDomainFree(dom);
908
        VIR_FREE(names[i]);
909
    }
910 911
    VIR_FREE(ids);
    VIR_FREE(names);
E
Eric Blake 已提交
912
    return true;
K
Karel Zak 已提交
913 914 915
}

/*
K
Karel Zak 已提交
916
 * "domstate" command
K
Karel Zak 已提交
917
 */
918
static const vshCmdInfo info_domstate[] = {
919 920
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
921
    {NULL, NULL}
K
Karel Zak 已提交
922 923
};

924
static const vshCmdOptDef opts_domstate[] = {
925
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
926
    {"reason", VSH_OT_BOOL, 0, N_("also print reason for the state")},
927
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
928 929
};

E
Eric Blake 已提交
930
static bool
931
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
932
{
K
Karel Zak 已提交
933
    virDomainPtr dom;
E
Eric Blake 已提交
934
    bool ret = true;
935 936
    int showReason = vshCommandOptBool(cmd, "reason");
    int state, reason;
937

938
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
939
        return false;
940

J
Jim Meyering 已提交
941
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
942
        return false;
943

944
    if ((state = vshDomainState(ctl, dom, &reason)) < 0) {
E
Eric Blake 已提交
945
        ret = false;
946 947 948 949 950 951 952 953 954 955 956
        goto cleanup;
    }

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

958
cleanup:
959 960 961 962
    virDomainFree(dom);
    return ret;
}

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

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

E
Eric Blake 已提交
977
static bool
978
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
979 980
{
    virDomainPtr dom;
981
    const char *name = NULL, *device = NULL;
982 983
    struct _virDomainBlockStats stats;

984
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
985
        return false;
986

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

990
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
L
Laine Stump 已提交
991
        virDomainFree(dom);
E
Eric Blake 已提交
992
        return false;
L
Laine Stump 已提交
993
    }
994 995

    if (virDomainBlockStats (dom, device, &stats, sizeof stats) == -1) {
996
        vshError(ctl, _("Failed to get block stats %s %s"), name, device);
997
        virDomainFree(dom);
E
Eric Blake 已提交
998
        return false;
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
    }

    if (stats.rd_req >= 0)
        vshPrint (ctl, "%s rd_req %lld\n", device, stats.rd_req);

    if (stats.rd_bytes >= 0)
        vshPrint (ctl, "%s rd_bytes %lld\n", device, stats.rd_bytes);

    if (stats.wr_req >= 0)
        vshPrint (ctl, "%s wr_req %lld\n", device, stats.wr_req);

    if (stats.wr_bytes >= 0)
        vshPrint (ctl, "%s wr_bytes %lld\n", device, stats.wr_bytes);

    if (stats.errs >= 0)
        vshPrint (ctl, "%s errs %lld\n", device, stats.errs);

    virDomainFree(dom);
E
Eric Blake 已提交
1017
    return true;
1018 1019 1020 1021
}

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

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

E
Eric Blake 已提交
1034
static bool
1035
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1036 1037
{
    virDomainPtr dom;
1038
    const char *name = NULL, *device = NULL;
1039 1040
    struct _virDomainInterfaceStats stats;

1041
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1042
        return false;
1043

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

1047
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1048
        virDomainFree(dom);
E
Eric Blake 已提交
1049
        return false;
L
Laine Stump 已提交
1050
    }
1051 1052

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1053
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1054
        virDomainFree(dom);
E
Eric Blake 已提交
1055
        return false;
1056 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
    }

    if (stats.rx_bytes >= 0)
        vshPrint (ctl, "%s rx_bytes %lld\n", device, stats.rx_bytes);

    if (stats.rx_packets >= 0)
        vshPrint (ctl, "%s rx_packets %lld\n", device, stats.rx_packets);

    if (stats.rx_errs >= 0)
        vshPrint (ctl, "%s rx_errs %lld\n", device, stats.rx_errs);

    if (stats.rx_drop >= 0)
        vshPrint (ctl, "%s rx_drop %lld\n", device, stats.rx_drop);

    if (stats.tx_bytes >= 0)
        vshPrint (ctl, "%s tx_bytes %lld\n", device, stats.tx_bytes);

    if (stats.tx_packets >= 0)
        vshPrint (ctl, "%s tx_packets %lld\n", device, stats.tx_packets);

    if (stats.tx_errs >= 0)
        vshPrint (ctl, "%s tx_errs %lld\n", device, stats.tx_errs);

    if (stats.tx_drop >= 0)
        vshPrint (ctl, "%s tx_drop %lld\n", device, stats.tx_drop);

    virDomainFree(dom);
E
Eric Blake 已提交
1083
    return true;
1084 1085
}

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

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

E
Eric Blake 已提交
1100
static bool
1101
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1102 1103
{
    virDomainPtr dom;
1104
    const char *name;
1105 1106 1107
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1112
        return false;
1113 1114 1115 1116 1117

    nr_stats = virDomainMemoryStats (dom, stats, VIR_DOMAIN_MEMORY_STAT_NR, 0);
    if (nr_stats == -1) {
        vshError(ctl, _("Failed to get memory statistics for domain %s"), name);
        virDomainFree(dom);
E
Eric Blake 已提交
1118
        return false;
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
    }

    for (i = 0; i < nr_stats; i++) {
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_SWAP_IN)
            vshPrint (ctl, "swap_in %llu\n", stats[i].val);
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_SWAP_OUT)
            vshPrint (ctl, "swap_out %llu\n", stats[i].val);
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT)
            vshPrint (ctl, "major_fault %llu\n", stats[i].val);
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT)
            vshPrint (ctl, "minor_fault %llu\n", stats[i].val);
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_UNUSED)
            vshPrint (ctl, "unused %llu\n", stats[i].val);
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_AVAILABLE)
            vshPrint (ctl, "available %llu\n", stats[i].val);
    }

    virDomainFree(dom);
E
Eric Blake 已提交
1137
    return true;
1138 1139
}

1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
/*
 * "domblkinfo" command
 */
static const vshCmdInfo info_domblkinfo[] = {
    {"help", N_("domain block device size information")},
    {"desc", N_("Get block device size info for a domain.")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
1155
static bool
1156 1157 1158 1159
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1160
    bool ret = true;
1161
    const char *device = NULL;
1162

1163
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1164
        return false;
1165 1166

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

1169
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1170
        virDomainFree(dom);
E
Eric Blake 已提交
1171
        return false;
1172 1173 1174 1175
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1176
        return false;
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
    }

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

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

1196
static const vshCmdOptDef opts_suspend[] = {
1197
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1198
    {NULL, 0, 0, NULL}
1199 1200
};

E
Eric Blake 已提交
1201
static bool
1202
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1203
{
1204
    virDomainPtr dom;
1205
    const char *name;
E
Eric Blake 已提交
1206
    bool ret = true;
1207

1208
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1209
        return false;
1210

J
Jim Meyering 已提交
1211
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1212
        return false;
1213 1214

    if (virDomainSuspend(dom) == 0) {
1215
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1216
    } else {
1217
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1218
        ret = false;
1219
    }
1220

1221 1222 1223 1224
    virDomainFree(dom);
    return ret;
}

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

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

E
Eric Blake 已提交
1243
static bool
1244
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1245 1246
{
    virDomainPtr dom;
1247
    const char *from = NULL;
E
Eric Blake 已提交
1248
    bool ret = true;
1249
    char *buffer;
1250
#ifndef WIN32
1251
    int console = vshCommandOptBool(cmd, "console");
1252
#endif
1253
    unsigned int flags = VIR_DOMAIN_NONE;
1254

1255
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1256
        return false;
1257

1258
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1259
        return false;
1260

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

1264 1265 1266 1267
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1268
    VIR_FREE(buffer);
1269

1270
    if (dom != NULL) {
1271
        vshPrint(ctl, _("Domain %s created from %s\n"),
1272
                 virDomainGetName(dom), from);
1273
#ifndef WIN32
1274
        if (console)
1275
            cmdRunConsole(ctl, dom, NULL);
1276
#endif
1277
        virDomainFree(dom);
1278
    } else {
1279
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1280
        ret = false;
1281 1282 1283 1284
    }
    return ret;
}

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

1294
static const vshCmdOptDef opts_define[] = {
1295
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1296 1297 1298
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1299
static bool
1300
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1301 1302
{
    virDomainPtr dom;
1303
    const char *from = NULL;
E
Eric Blake 已提交
1304
    bool ret = true;
1305
    char *buffer;
1306

1307
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1308
        return false;
1309

1310
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1311
        return false;
1312

1313
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1314
        return false;
1315 1316

    dom = virDomainDefineXML(ctl->conn, buffer);
1317
    VIR_FREE(buffer);
1318

1319
    if (dom != NULL) {
1320
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1321
                 virDomainGetName(dom), from);
1322
        virDomainFree(dom);
1323
    } else {
1324
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1325
        ret = false;
1326 1327 1328 1329 1330 1331 1332
    }
    return ret;
}

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

1339
static const vshCmdOptDef opts_undefine[] = {
1340
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1341 1342 1343
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1344
static bool
1345
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1346 1347
{
    virDomainPtr dom;
E
Eric Blake 已提交
1348
    bool ret = true;
1349
    const char *name = NULL;
1350
    int id;
1351

1352
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1353
        return false;
1354

1355
    if (vshCommandOptString(cmd, "domain", &name) <= 0)
E
Eric Blake 已提交
1356
        return false;
1357 1358 1359

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

    if (virDomainUndefine(dom) == 0) {
1373
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1374
    } else {
1375
        vshError(ctl, _("Failed to undefine domain %s"), name);
E
Eric Blake 已提交
1376
        ret = false;
1377 1378
    }

1379
    virDomainFree(dom);
1380 1381 1382 1383 1384 1385 1386
    return ret;
}


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

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

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

1414
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1415
        return false;
1416

1417 1418
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
1419
        return false;
1420 1421

    if (virDomainGetID(dom) != (unsigned int)-1) {
1422
        vshError(ctl, "%s", _("Domain is already active"));
1423
        virDomainFree(dom);
E
Eric Blake 已提交
1424
        return false;
1425 1426
    }

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

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

1456
static const vshCmdOptDef opts_save[] = {
1457 1458
    {"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")},
1459
    {NULL, 0, 0, NULL}
1460 1461
};

E
Eric Blake 已提交
1462
static bool
1463
cmdSave(vshControl *ctl, const vshCmd *cmd)
1464
{
1465
    virDomainPtr dom;
1466 1467
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1468
    bool ret = true;
1469

1470
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1471
        return false;
1472

1473
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1474
        return false;
1475

J
Jim Meyering 已提交
1476
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1477
        return false;
1478 1479

    if (virDomainSave(dom, to) == 0) {
1480
        vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
1481
    } else {
1482
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
E
Eric Blake 已提交
1483
        ret = false;
1484
    }
1485

1486 1487 1488 1489
    virDomainFree(dom);
    return ret;
}

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

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

E
Eric Blake 已提交
1507
static bool
1508 1509 1510
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1511
    const char *name;
E
Eric Blake 已提交
1512
    bool ret = true;
1513

1514
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1515
        return false;
1516 1517

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1518
        return false;
1519 1520 1521 1522 1523

    if (virDomainManagedSave(dom, 0) == 0) {
        vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    } else {
        vshError(ctl, _("Failed to save domain %s state"), name);
E
Eric Blake 已提交
1524
        ret = false;
1525 1526 1527 1528 1529 1530
    }

    virDomainFree(dom);
    return ret;
}

1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544
/*
 * "managedsave-remove" command
 */
static const vshCmdInfo info_managedsaveremove[] = {
    {"help", N_("Remove managed save of a domain")},
    {"desc", N_("Remove an existing managed save state file from a domain")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
1545
static bool
1546 1547 1548
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1549
    const char *name;
E
Eric Blake 已提交
1550
    bool ret = false;
1551 1552
    int hassave;

1553
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1554
        return false;
1555 1556

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1557
        return false;
1558 1559 1560

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1561
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
        goto cleanup;
    }

    if (hassave) {
        if (virDomainManagedSaveRemove(dom, 0) < 0) {
            vshError(ctl, _("Failed to remove managed save image for domain %s"),
                     name);
            goto cleanup;
        }
        else
            vshPrint(ctl, _("Removed managedsave image for domain %s"), name);
    }
    else
        vshPrint(ctl, _("Domain %s has no manage save image; removal skipped"),
                 name);

E
Eric Blake 已提交
1578
    ret = true;
1579 1580 1581 1582 1583 1584

cleanup:
    virDomainFree(dom);
    return ret;
}

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

1594
static const vshCmdOptDef opts_schedinfo[] = {
1595 1596 1597 1598
    {"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")},
1599 1600 1601
    {"current", VSH_OT_BOOL, 0, N_("get/set current scheduler info")},
    {"config", VSH_OT_BOOL, 0, N_("get/set value to be used on next boot")},
    {"live", VSH_OT_BOOL, 0, N_("get/set value from running domain")},
1602 1603 1604
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
1605
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

E
Eric Blake 已提交
1699
static bool
1700 1701 1702 1703 1704 1705 1706 1707
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
    virSchedParameterPtr params = NULL;
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
1708
    bool ret_val = false;
1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
    unsigned int flags = 0;
    int current = vshCommandOptBool(cmd, "current");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
            return false;
        }
        flags = VIR_DOMAIN_SCHEDPARAM_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_SCHEDPARAM_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_SCHEDPARAM_LIVE;
    }
1726

1727
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1728
        return false;
1729

1730
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
1731
        return false;
1732 1733 1734

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
1735
    if (schedulertype != NULL){
1736
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
1737
             schedulertype);
1738
        VIR_FREE(schedulertype);
1739
    } else {
1740
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
1741
        goto cleanup;
1742 1743
    }

1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
    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) {
1764 1765 1766 1767 1768
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
1769 1770 1771 1772 1773 1774
            if (ret == -1)
                goto cleanup;

            ret = virDomainGetSchedulerParameters(dom, params, &nparams);
            if (ret == -1)
                goto cleanup;
1775 1776 1777 1778
        } 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.  */
1779 1780
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
1781 1782 1783 1784
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
1785 1786
        }

E
Eric Blake 已提交
1787
        ret_val = true;
1788 1789 1790
        for (i = 0; i < nparams; i++){
            switch (params[i].type) {
            case VIR_DOMAIN_SCHED_FIELD_INT:
1791
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1792 1793
                 break;
            case VIR_DOMAIN_SCHED_FIELD_UINT:
1794
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1795 1796
                 break;
            case VIR_DOMAIN_SCHED_FIELD_LLONG:
1797
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1798 1799
                 break;
            case VIR_DOMAIN_SCHED_FIELD_ULLONG:
1800
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1801 1802
                 break;
            case VIR_DOMAIN_SCHED_FIELD_DOUBLE:
1803
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1804 1805
                 break;
            case VIR_DOMAIN_SCHED_FIELD_BOOLEAN:
1806
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
1807 1808
                 break;
            default:
1809
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
1810 1811 1812
            }
        }
    }
1813

1814
 cleanup:
1815
    VIR_FREE(params);
1816
    virDomainFree(dom);
1817
    return ret_val;
1818 1819
}

1820 1821 1822
/*
 * "restore" command
 */
1823
static const vshCmdInfo info_restore[] = {
1824 1825
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
1826
    {NULL, NULL}
1827 1828
};

1829
static const vshCmdOptDef opts_restore[] = {
1830
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
1831
    {NULL, 0, 0, NULL}
1832 1833
};

E
Eric Blake 已提交
1834
static bool
1835
cmdRestore(vshControl *ctl, const vshCmd *cmd)
1836
{
1837
    const char *from = NULL;
E
Eric Blake 已提交
1838
    bool ret = true;
1839

1840
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1841
        return false;
1842

1843
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1844
        return false;
1845 1846

    if (virDomainRestore(ctl->conn, from) == 0) {
1847
        vshPrint(ctl, _("Domain restored from %s\n"), from);
1848
    } else {
1849
        vshError(ctl, _("Failed to restore domain from %s"), from);
E
Eric Blake 已提交
1850
        ret = false;
1851 1852 1853 1854
    }
    return ret;
}

D
Daniel Veillard 已提交
1855 1856 1857
/*
 * "dump" command
 */
1858
static const vshCmdInfo info_dump[] = {
1859 1860
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
1861 1862 1863
    {NULL, NULL}
};

1864
static const vshCmdOptDef opts_dump[] = {
1865 1866 1867 1868
    {"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 已提交
1869 1870 1871
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1872
static bool
1873
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
1874 1875
{
    virDomainPtr dom;
1876 1877
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1878
    bool ret = true;
1879
    int flags = 0;
D
Daniel Veillard 已提交
1880

1881
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1882
        return false;
D
Daniel Veillard 已提交
1883

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

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

P
Paolo Bonzini 已提交
1890 1891
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
1892 1893 1894 1895
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;

    if (virDomainCoreDump(dom, to, flags) == 0) {
1896
        vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
D
Daniel Veillard 已提交
1897
    } else {
1898
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
E
Eric Blake 已提交
1899
        ret = false;
D
Daniel Veillard 已提交
1900 1901 1902 1903 1904 1905
    }

    virDomainFree(dom);
    return ret;
}

1906 1907 1908
/*
 * "resume" command
 */
1909
static const vshCmdInfo info_resume[] = {
1910 1911
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
1912
    {NULL, NULL}
1913 1914
};

1915
static const vshCmdOptDef opts_resume[] = {
1916
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1917
    {NULL, 0, 0, NULL}
1918 1919
};

E
Eric Blake 已提交
1920
static bool
1921
cmdResume(vshControl *ctl, const vshCmd *cmd)
1922
{
1923
    virDomainPtr dom;
E
Eric Blake 已提交
1924
    bool ret = true;
1925
    const char *name;
1926

1927
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1928
        return false;
1929

J
Jim Meyering 已提交
1930
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1931
        return false;
1932 1933

    if (virDomainResume(dom) == 0) {
1934
        vshPrint(ctl, _("Domain %s resumed\n"), name);
1935
    } else {
1936
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
1937
        ret = false;
1938
    }
1939

1940 1941 1942 1943
    virDomainFree(dom);
    return ret;
}

1944 1945 1946
/*
 * "shutdown" command
 */
1947
static const vshCmdInfo info_shutdown[] = {
1948 1949
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
1950
    {NULL, NULL}
1951 1952
};

1953
static const vshCmdOptDef opts_shutdown[] = {
1954
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1955
    {NULL, 0, 0, NULL}
1956 1957
};

E
Eric Blake 已提交
1958
static bool
1959
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
1960
{
1961
    virDomainPtr dom;
E
Eric Blake 已提交
1962
    bool ret = true;
1963
    const char *name;
1964

1965
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1966
        return false;
1967

J
Jim Meyering 已提交
1968
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1969
        return false;
1970 1971

    if (virDomainShutdown(dom) == 0) {
1972
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
1973
    } else {
1974
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
1975
        ret = false;
1976
    }
1977

1978 1979 1980 1981
    virDomainFree(dom);
    return ret;
}

1982 1983 1984
/*
 * "reboot" command
 */
1985
static const vshCmdInfo info_reboot[] = {
1986 1987
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
1988 1989 1990
    {NULL, NULL}
};

1991
static const vshCmdOptDef opts_reboot[] = {
1992
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1993 1994 1995
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1996
static bool
1997
cmdReboot(vshControl *ctl, const vshCmd *cmd)
1998 1999
{
    virDomainPtr dom;
E
Eric Blake 已提交
2000
    bool ret = true;
2001
    const char *name;
2002

2003
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2004
        return false;
2005

J
Jim Meyering 已提交
2006
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2007
        return false;
2008 2009

    if (virDomainReboot(dom, 0) == 0) {
2010
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
2011
    } else {
2012
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
2013
        ret = false;
2014 2015 2016 2017 2018 2019
    }

    virDomainFree(dom);
    return ret;
}

2020 2021 2022
/*
 * "destroy" command
 */
2023
static const vshCmdInfo info_destroy[] = {
2024 2025
    {"help", N_("destroy a domain")},
    {"desc", N_("Destroy a given domain.")},
2026
    {NULL, NULL}
2027 2028
};

2029
static const vshCmdOptDef opts_destroy[] = {
2030
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2031
    {NULL, 0, 0, NULL}
2032 2033
};

E
Eric Blake 已提交
2034
static bool
2035
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2036
{
2037
    virDomainPtr dom;
E
Eric Blake 已提交
2038
    bool ret = true;
2039
    const char *name;
2040

2041
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2042
        return false;
2043

J
Jim Meyering 已提交
2044
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2045
        return false;
2046 2047

    if (virDomainDestroy(dom) == 0) {
2048
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2049
    } else {
2050
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
2051
        ret = false;
2052
    }
2053

2054
    virDomainFree(dom);
K
Karel Zak 已提交
2055 2056 2057 2058
    return ret;
}

/*
2059
 * "dominfo" command
K
Karel Zak 已提交
2060
 */
2061
static const vshCmdInfo info_dominfo[] = {
2062 2063
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2064
    {NULL, NULL}
K
Karel Zak 已提交
2065 2066
};

2067
static const vshCmdOptDef opts_dominfo[] = {
2068
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2069
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2070 2071
};

E
Eric Blake 已提交
2072
static bool
2073
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2074
{
K
Karel Zak 已提交
2075 2076
    virDomainInfo info;
    virDomainPtr dom;
2077
    virSecurityModel secmodel;
2078
    virSecurityLabelPtr seclabel;
2079
    int persistent = 0;
E
Eric Blake 已提交
2080 2081
    bool ret = true;
    int autostart;
2082
    unsigned int id;
2083
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2084

2085
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2086
        return false;
K
Karel Zak 已提交
2087

J
Jim Meyering 已提交
2088
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2089
        return false;
2090

2091 2092
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2093
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2094
    else
2095
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2096 2097
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2098
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2099
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2100 2101

    if ((str = virDomainGetOSType(dom))) {
2102
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2103
        VIR_FREE(str);
2104 2105 2106
    }

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

2110
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2111 2112

        if (info.cpuTime != 0) {
2113
            double cpuUsed = info.cpuTime;
2114

2115
            cpuUsed /= 1000000000.0;
2116

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

2120 2121
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2122
                 info.maxMem);
2123
        else
2124
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2125 2126
                 _("no limit"));

2127
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2128 2129
                 info.memory);

K
Karel Zak 已提交
2130
    } else {
E
Eric Blake 已提交
2131
        ret = false;
K
Karel Zak 已提交
2132
    }
2133

2134 2135 2136 2137 2138 2139 2140 2141 2142
    /* 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 */
2143
    if (!virDomainGetAutostart(dom, &autostart)) {
2144
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2145 2146 2147
                 autostart ? _("enable") : _("disable") );
    }

2148 2149 2150
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2151 2152
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
2153
            return false;
2154 2155 2156
        } else {
            virFreeError(last_error);
            last_error = NULL;
2157
        }
2158 2159 2160 2161 2162 2163 2164
    } 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 */
2165
            if (VIR_ALLOC(seclabel) < 0) {
2166
                virDomainFree(dom);
E
Eric Blake 已提交
2167
                return false;
2168 2169 2170 2171 2172
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
2173
                return false;
2174
            } else {
2175
                if (seclabel->label[0] != '\0')
2176
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
2177
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
2178
            }
2179 2180

            VIR_FREE(seclabel);
2181 2182
        }
    }
2183
    virDomainFree(dom);
K
Karel Zak 已提交
2184 2185 2186
    return ret;
}

2187 2188 2189 2190
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2191 2192
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2193 2194 2195 2196
    {NULL, NULL}
};

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


E
Eric Blake 已提交
2202
static bool
2203 2204 2205 2206
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
2207
    bool ret = true;
2208

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2213
        return false;
2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239

    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 已提交
2240
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2241
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2242
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2243
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2244
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2245 2246 2247
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2248
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2249
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2250
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2251
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2252
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2253 2254 2255
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2256
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2257
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2258
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2259
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2260
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2261 2262
        }
    } else {
E
Eric Blake 已提交
2263
        ret = false;
2264 2265 2266 2267 2268 2269
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2270 2271 2272 2273
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2274 2275
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2276 2277 2278 2279
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2280
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2281 2282 2283
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2284
static bool
2285 2286 2287
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2288
    bool ret = true;
2289

2290
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2291
        return false;
2292 2293

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
2297
        ret = false;
2298 2299 2300 2301 2302

    virDomainFree(dom);
    return ret;
}

2303 2304 2305
/*
 * "freecell" command
 */
2306
static const vshCmdInfo info_freecell[] = {
2307 2308
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2309 2310 2311
    {NULL, NULL}
};

2312
static const vshCmdOptDef opts_freecell[] = {
2313
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2314
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
2315 2316 2317
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2318
static bool
2319
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2320
{
W
Wen Congyang 已提交
2321
    bool func_ret = false;
2322
    int ret;
2323
    int cell = -1, cell_given;
2324
    unsigned long long memory;
2325 2326 2327 2328
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
2329
    int all_given;
2330 2331 2332 2333
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
2334

2335

2336
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2337
        return false;
2338

2339 2340 2341 2342
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
2343 2344 2345 2346 2347 2348 2349 2350 2351
    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) {
2352 2353 2354
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2355 2356 2357
            goto cleanup;
        }

2358 2359 2360
        xml = xmlReadDoc((const xmlChar *) cap_xml, "node.xml", NULL,
                          XML_PARSE_NOENT | XML_PARSE_NONET |
                          XML_PARSE_NOWARNING);
2361

2362 2363
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2364 2365 2366
            goto cleanup;
        }

2367 2368 2369 2370 2371
        ctxt = xmlXPathNewContext(xml);
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
2372
            vshError(ctl, "%s", _("could not get information about "
2373
                                  "NUMA topology"));
2374 2375 2376
            goto cleanup;
        }

2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397
        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;
            }
        }

2398
        memory = 0;
2399 2400 2401 2402
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
2403 2404 2405 2406
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
2407
    } else {
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421
        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));
2422 2423
    }

E
Eric Blake 已提交
2424
    func_ret = true;
2425

2426
cleanup:
2427 2428 2429
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
2430
    VIR_FREE(nodes);
2431 2432 2433
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
2434
    return func_ret;
2435 2436
}

E
Eric Blake 已提交
2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450
/*
 * "maxvcpus" command
 */
static const vshCmdInfo info_maxvcpus[] = {
    {"help", N_("connection vcpu maximum")},
    {"desc", N_("Show maximum number of virtual CPUs for guests on this connection.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_maxvcpus[] = {
    {"type", VSH_OT_STRING, 0, N_("domain type")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2451
static bool
E
Eric Blake 已提交
2452 2453
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
2454
    const char *type = NULL;
E
Eric Blake 已提交
2455 2456
    int vcpus;

2457 2458
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
2459
        return false;
2460
    }
E
Eric Blake 已提交
2461 2462

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2463
        return false;
E
Eric Blake 已提交
2464 2465 2466

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

E
Eric Blake 已提交
2470
    return true;
E
Eric Blake 已提交
2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490
}

/*
 * "vcpucount" command
 */
static const vshCmdInfo info_vcpucount[] = {
    {"help", N_("domain vcpu counts")},
    {"desc", N_("Returns the number of virtual CPUs used by the domain.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_vcpucount[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"maximum", VSH_OT_BOOL, 0, N_("get maximum cap on vcpus")},
    {"current", VSH_OT_BOOL, 0, N_("get current vcpu usage")},
    {"config", VSH_OT_BOOL, 0, N_("get value to be used on next boot")},
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2491
static bool
E
Eric Blake 已提交
2492 2493 2494
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2495
    bool ret = true;
E
Eric Blake 已提交
2496 2497 2498 2499 2500 2501 2502 2503 2504 2505
    int maximum = vshCommandOptBool(cmd, "maximum");
    int current = vshCommandOptBool(cmd, "current");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    bool all = maximum + current + config + live == 0;
    int count;

    if (maximum && current) {
        vshError(ctl, "%s",
                 _("--maximum and --current cannot both be specified"));
E
Eric Blake 已提交
2506
        return false;
E
Eric Blake 已提交
2507 2508 2509 2510
    }
    if (config && live) {
        vshError(ctl, "%s",
                 _("--config and --live cannot both be specified"));
E
Eric Blake 已提交
2511
        return false;
E
Eric Blake 已提交
2512 2513 2514 2515 2516 2517 2518 2519 2520 2521
    }
    /* We want one of each pair of mutually exclusive options; that
     * is, use of flags requires exactly two options.  */
    if (maximum + current + config + live == 1) {
        vshError(ctl,
                 _("when using --%s, either --%s or --%s must be specified"),
                 (maximum ? "maximum" : current ? "current"
                  : config ? "config" : "live"),
                 maximum + current ? "config" : "maximum",
                 maximum + current ? "live" : "current");
E
Eric Blake 已提交
2522
        return false;
E
Eric Blake 已提交
2523 2524 2525
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2526
        return false;
E
Eric Blake 已提交
2527 2528

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2529
        return false;
E
Eric Blake 已提交
2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545

    /* 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;
            }
2546 2547
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
2548 2549 2550 2551 2552
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2553
            ret = false;
E
Eric Blake 已提交
2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    if (all || (maximum && live)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
                                             VIR_DOMAIN_VCPU_LIVE));
        if (count < 0 && (last_error->code == VIR_ERR_NO_SUPPORT
                          || last_error->code == VIR_ERR_INVALID_ARG)) {
            count = virDomainGetMaxVcpus(dom);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2574
            ret = false;
E
Eric Blake 已提交
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
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    if (all || (current && config)) {
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_VCPU_CONFIG);
        if (count < 0 && (last_error->code == VIR_ERR_NO_SUPPORT
                          || last_error->code == VIR_ERR_INVALID_ARG)) {
            char *tmp, *end;
            char *xml = virDomainGetXMLDesc(dom, VIR_DOMAIN_XML_INACTIVE);
            if (xml && (tmp = strstr(xml, "<vcpu"))) {
                end = strchr(tmp, '>');
                if (end) {
                    *end = '\0';
                    tmp = strstr(tmp, "current=");
                    if (!tmp)
                        tmp = end + 1;
                    else {
                        tmp += strlen("current=");
                        tmp += *tmp == '\'' || *tmp == '"';
                    }
                }
                if (!tmp || virStrToLong_i(tmp, &tmp, 10, &count) < 0)
                    count = -1;
            }
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2611
            ret = false;
E
Eric Blake 已提交
2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    if (all || (current && live)) {
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_VCPU_LIVE);
        if (count < 0 && (last_error->code == VIR_ERR_NO_SUPPORT
                          || last_error->code == VIR_ERR_INVALID_ARG)) {
            virDomainInfo info;
            if (virDomainGetInfo(dom, &info) == 0)
                count = info.nrVirtCpu;
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2633
            ret = false;
E
Eric Blake 已提交
2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647
        } 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;
}

2648 2649 2650
/*
 * "vcpuinfo" command
 */
2651
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
2652
    {"help", N_("detailed domain vcpu information")},
2653
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
2654 2655 2656
    {NULL, NULL}
};

2657
static const vshCmdOptDef opts_vcpuinfo[] = {
2658
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2659 2660 2661
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2662
static bool
2663
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
2664 2665 2666 2667 2668 2669 2670 2671
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
    unsigned char *cpumap;
    int ncpus;
    size_t cpumaplen;
E
Eric Blake 已提交
2672
    bool ret = true;
2673

2674
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2675
        return false;
2676

J
Jim Meyering 已提交
2677
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2678
        return false;
2679 2680 2681

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2682
        return false;
2683 2684 2685 2686
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2687
        return false;
2688 2689
    }

2690
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
2691
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2692
    cpumap = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
2693

2694 2695 2696
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
                                   cpumap, cpumaplen)) >= 0) {
2697
        int n;
2698 2699 2700 2701 2702
        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 已提交
2703
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719
            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");
            }
        }
2720
    } else {
2721
        if (info.state == VIR_DOMAIN_SHUTOFF) {
2722 2723
            vshError(ctl, "%s",
                     _("Domain shut off, virtual CPUs not present."));
2724
        }
E
Eric Blake 已提交
2725
        ret = false;
2726 2727
    }

2728 2729
    VIR_FREE(cpumap);
    VIR_FREE(cpuinfo);
2730 2731 2732 2733 2734 2735 2736
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
2737
static const vshCmdInfo info_vcpupin[] = {
2738 2739
    {"help", N_("control domain vcpu affinity")},
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
2740 2741 2742
    {NULL, NULL}
};

2743
static const vshCmdOptDef opts_vcpupin[] = {
2744
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2745
    {"vcpu", VSH_OT_INT, VSH_OFLAG_REQ, N_("vcpu number")},
2746
    {"cpulist", VSH_OT_DATA, VSH_OFLAG_REQ, N_("host cpu number(s) (comma separated)")},
2747 2748 2749
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2750
static bool
2751
cmdVcpupin(vshControl *ctl, const vshCmd *cmd)
2752 2753 2754 2755 2756
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    int vcpu;
2757
    const char *cpulist = NULL;
E
Eric Blake 已提交
2758
    bool ret = true;
2759 2760
    unsigned char *cpumap;
    int cpumaplen;
2761 2762
    int i;
    enum { expect_num, expect_num_or_comma } state;
2763

2764
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2765
        return false;
2766

J
Jim Meyering 已提交
2767
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2768
        return false;
2769

2770
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) <= 0) {
2771
        vshError(ctl, "%s", _("vcpupin: Invalid or missing vCPU number."));
2772
        virDomainFree(dom);
E
Eric Blake 已提交
2773
        return false;
2774 2775
    }

2776
    if (vshCommandOptString(cmd, "cpulist", &cpulist) <= 0) {
2777
        virDomainFree(dom);
E
Eric Blake 已提交
2778
        return false;
2779
    }
2780

2781 2782
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2783
        return false;
2784 2785 2786
    }

    if (virDomainGetInfo(dom, &info) != 0) {
2787
        vshError(ctl, "%s", _("vcpupin: failed to get domain informations."));
2788
        virDomainFree(dom);
E
Eric Blake 已提交
2789
        return false;
2790 2791 2792
    }

    if (vcpu >= info.nrVirtCpu) {
2793
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
2794
        virDomainFree(dom);
E
Eric Blake 已提交
2795
        return false;
2796 2797
    }

2798 2799 2800 2801
    /* Check that the cpulist parameter is a comma-separated list of
     * numbers and give an intelligent error message if not.
     */
    if (cpulist[0] == '\0') {
2802
        vshError(ctl, "%s", _("cpulist: Invalid format. Empty string."));
2803
        virDomainFree (dom);
E
Eric Blake 已提交
2804
        return false;
2805 2806 2807 2808 2809 2810
    }

    state = expect_num;
    for (i = 0; cpulist[i]; i++) {
        switch (state) {
        case expect_num:
2811
          if (!c_isdigit (cpulist[i])) {
2812 2813 2814
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2815
                virDomainFree (dom);
E
Eric Blake 已提交
2816
                return false;
2817 2818 2819 2820 2821 2822
            }
            state = expect_num_or_comma;
            break;
        case expect_num_or_comma:
            if (cpulist[i] == ',')
                state = expect_num;
2823
            else if (!c_isdigit (cpulist[i])) {
2824 2825 2826
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit or comma at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2827
                virDomainFree (dom);
E
Eric Blake 已提交
2828
                return false;
2829 2830 2831 2832
            }
        }
    }
    if (state == expect_num) {
2833 2834 2835
        vshError(ctl, _("cpulist: %s: Invalid format. Trailing comma "
                        "at position %d."),
                 cpulist, i);
2836
        virDomainFree (dom);
E
Eric Blake 已提交
2837
        return false;
2838 2839
    }

2840
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2841
    cpumap = vshCalloc(ctl, 1, cpumaplen);
2842 2843 2844 2845 2846 2847

    do {
        unsigned int cpu = atoi(cpulist);

        if (cpu < VIR_NODEINFO_MAXCPUS(nodeinfo)) {
            VIR_USE_CPU(cpumap, cpu);
2848
        } else {
2849
            vshError(ctl, _("Physical CPU %d doesn't exist."), cpu);
2850
            VIR_FREE(cpumap);
2851
            virDomainFree(dom);
E
Eric Blake 已提交
2852
            return false;
2853
        }
2854
        cpulist = strchr(cpulist, ',');
2855 2856 2857 2858 2859
        if (cpulist)
            cpulist++;
    } while (cpulist);

    if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
E
Eric Blake 已提交
2860
        ret = false;
2861 2862
    }

2863
    VIR_FREE(cpumap);
2864 2865 2866 2867
    virDomainFree(dom);
    return ret;
}

2868 2869 2870
/*
 * "setvcpus" command
 */
2871
static const vshCmdInfo info_setvcpus[] = {
2872 2873
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
2874 2875 2876
    {NULL, NULL}
};

2877
static const vshCmdOptDef opts_setvcpus[] = {
2878
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2879
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
2880 2881 2882
    {"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")},
2883 2884 2885
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2886
static bool
2887
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
2888 2889
{
    virDomainPtr dom;
2890
    int count = 0;
E
Eric Blake 已提交
2891
    bool ret = true;
E
Eric Blake 已提交
2892 2893 2894 2895 2896 2897
    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));
2898

2899
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2900
        return false;
2901

J
Jim Meyering 已提交
2902
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2903
        return false;
2904

2905 2906 2907 2908
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
2909

E
Eric Blake 已提交
2910 2911
    if (!flags) {
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
2912
            ret = false;
E
Eric Blake 已提交
2913 2914
        }
    } else {
2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
            vshDebug(ctl, 5, "--maximum flag was given\n");

            /* If neither the --config nor --live flags were given, OR
               if just the --live flag was given, we need to error out
               warning the user that the --maximum flag can only be used
               with the --config flag */
            if (live || !config) {

                /* Warn the user about the invalid flag combination */
                vshError(ctl, _("--maximum must be used with --config only"));
E
Eric Blake 已提交
2928
                ret = false;
2929 2930 2931 2932 2933
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
2934
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
2935
            ret = false;
E
Eric Blake 已提交
2936
        }
2937 2938
    }

2939
  cleanup:
2940 2941 2942 2943
    virDomainFree(dom);
    return ret;
}

2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977
/*
 * "inject-nmi" command
 */
static const vshCmdInfo info_inject_nmi[] = {
    {"help", N_("Inject NMI to the guest")},
    {"desc", N_("Inject NMI to the guest domain.")},
    {NULL, NULL}
};

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


static bool
cmdInjectNMI(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int ret = true;

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

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

    if (virDomainInjectNMI(dom, 0) < 0)
            ret = false;

    virDomainFree(dom);
    return ret;
}

2978 2979 2980
/*
 * "setmemory" command
 */
2981
static const vshCmdInfo info_setmem[] = {
2982 2983
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
2984 2985 2986
    {NULL, NULL}
};

2987
static const vshCmdOptDef opts_setmem[] = {
2988
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2989
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
2990 2991
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
2992
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
2993 2994 2995
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2996
static bool
2997
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
2998 2999
{
    virDomainPtr dom;
3000
    virDomainInfo info;
3001
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
3002
    bool ret = true;
3003 3004
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3005
    int current = vshCommandOptBool(cmd, "current");
3006 3007
    int flags = 0;

3008 3009 3010
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3011
            return false;
3012 3013 3014 3015 3016
        }
        flags = VIR_DOMAIN_MEM_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_MEM_CONFIG;
3017 3018
        if (live)
            flags |= VIR_DOMAIN_MEM_LIVE;
3019 3020 3021
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
3022
    }
3023

3024
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3025
        return false;
3026

J
Jim Meyering 已提交
3027
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3028
        return false;
3029

3030 3031
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3032
        return false;
3033 3034
    }

3035
    if (kilobytes <= 0) {
3036
        virDomainFree(dom);
3037
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
3038
        return false;
3039 3040
    }

3041 3042
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
3043
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
3044
        return false;
3045 3046 3047 3048
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
3049
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
3050
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
3051
        return false;
3052 3053
    }

3054
    if (flags == -1) {
3055
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
3056
            ret = false;
3057 3058 3059
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
3060
            ret = false;
3061
        }
3062 3063 3064 3065 3066 3067 3068 3069 3070
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
3071
static const vshCmdInfo info_setmaxmem[] = {
3072 3073
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
3074 3075 3076
    {NULL, NULL}
};

3077
static const vshCmdOptDef opts_setmaxmem[] = {
3078
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3079
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
3080 3081 3082
    {"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")},
3083 3084 3085
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3086
static bool
3087
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
3088 3089
{
    virDomainPtr dom;
3090
    int kilobytes = 0;
E
Eric Blake 已提交
3091
    bool ret = true;
3092 3093 3094 3095 3096 3097 3098 3099
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
    int flags = VIR_DOMAIN_MEM_MAXIMUM;

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3100
            return false;
3101 3102 3103 3104 3105 3106 3107 3108 3109 3110
        }
    } else {
        if (config)
            flags |= VIR_DOMAIN_MEM_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_MEM_LIVE;
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
3111

3112
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3113
        return false;
3114

J
Jim Meyering 已提交
3115
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3116
        return false;
3117

3118 3119
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3120
        return false;
3121 3122
    }

3123
    if (kilobytes <= 0) {
3124
        virDomainFree(dom);
3125
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
3126
        return false;
3127 3128
    }

3129 3130 3131
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3132
            ret = false;
3133 3134 3135 3136
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3137
            ret = false;
3138
        }
3139 3140
    }

3141 3142 3143 3144
    virDomainFree(dom);
    return ret;
}

3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163
/*
 * "blkiotune" command
 */
static const vshCmdInfo info_blkiotune[] = {
    {"help", N_("Get or set blkio parameters")},
    {"desc", N_("Get or set the current blkio parameters for a guest" \
                " domain.\n" \
                "    To get the blkio parameters use following command: \n\n" \
                "    virsh # blkiotune <domain>")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_blkiotune[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"weight", VSH_OT_INT, VSH_OFLAG_NONE,
     N_("IO Weight in range [100, 1000]")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3164
static bool
3165 3166 3167 3168 3169 3170 3171
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
    unsigned int i = 0;
    virBlkioParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3172
    bool ret = false;
3173 3174

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3175
        return false;
3176 3177

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

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

    if (weight) {
        nparams++;
        if (weight < 0) {
            virDomainFree(dom);
            vshError(ctl, _("Invalid value of %d for I/O weight"), weight);
            goto cleanup;
        }
    }

    if (nparams == 0) {
        /* get the number of blkio parameters */
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, 0) != 0) {
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3205
            ret = true;
3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246
            goto cleanup;
        }

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

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
                case VIR_DOMAIN_BLKIO_PARAM_INT:
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_UINT:
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_LLONG:
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_ULLONG:
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_DOUBLE:
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_BOOLEAN:
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
3247
        ret = true;
3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

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

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
        if (virDomainSetBlkioParameters(dom, params, nparams, 0) != 0)
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
3266
            ret = true;
3267 3268 3269 3270 3271 3272 3273 3274
    }

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

3275 3276 3277 3278
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
3279 3280 3281
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
3282 3283 3284 3285 3286 3287 3288
                "    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")},
3289
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3290
     N_("Max memory in kilobytes")},
3291
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3292
     N_("Memory during contention in kilobytes")},
3293
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3294
     N_("Max memory plus swap in kilobytes")},
3295
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
3296
     N_("Min guaranteed memory in kilobytes")},
3297 3298 3299
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3300
static bool
3301 3302 3303
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
3304 3305
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
3306 3307 3308
    int nparams = 0;
    unsigned int i = 0;
    virMemoryParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3309
    bool ret = false;
3310 3311

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3312
        return false;
3313 3314

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

3317 3318 3319 3320 3321 3322 3323 3324 3325
    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;
    }

3326 3327 3328 3329 3330 3331 3332 3333 3334
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

3335 3336 3337
    if (min_guarantee)
        nparams++;

3338 3339
    if (nparams == 0) {
        /* get the number of memory parameters */
3340
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, 0) != 0) {
3341 3342 3343 3344 3345
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

3346 3347
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3348
            ret = true;
3349 3350 3351
            goto cleanup;
        }

3352
        /* now go get all the memory parameters */
E
Eric Blake 已提交
3353
        params = vshCalloc(ctl, nparams, sizeof(*params));
3354
        if (virDomainGetMemoryParameters(dom, params, &nparams, 0) != 0) {
3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373
            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:
3374 3375 3376 3377 3378
                    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);
3379 3380 3381 3382 3383 3384 3385 3386 3387 3388
                    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:
3389
                    vshPrint(ctl, "unimplemented memory parameter type\n");
3390 3391 3392
            }
        }

E
Eric Blake 已提交
3393
        ret = true;
3394 3395
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
3396
        params = vshCalloc(ctl, nparams, sizeof(*params));
3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419

        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;
3420
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
3421 3422
                        sizeof(temp->field));
                swap_hard_limit = 0;
3423 3424 3425 3426 3427
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
3428
            }
3429 3430 3431 3432

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
3433 3434
        }
        if (virDomainSetMemoryParameters(dom, params, nparams, 0) != 0)
3435
            vshError(ctl, "%s", _("Unable to change memory parameters"));
3436
        else
E
Eric Blake 已提交
3437
            ret = true;
3438 3439 3440
    }

  cleanup:
E
Eric Blake 已提交
3441
    VIR_FREE(params);
3442 3443 3444 3445
    virDomainFree(dom);
    return ret;
}

3446 3447 3448
/*
 * "nodeinfo" command
 */
3449
static const vshCmdInfo info_nodeinfo[] = {
3450 3451
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
3452 3453 3454
    {NULL, NULL}
};

E
Eric Blake 已提交
3455
static bool
3456
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3457 3458
{
    virNodeInfo info;
3459

3460
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3461
        return false;
3462 3463

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
3464
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
3465
        return false;
3466 3467 3468 3469 3470 3471 3472 3473 3474 3475
    }
    vshPrint(ctl, "%-20s %s\n", _("CPU model:"), info.model);
    vshPrint(ctl, "%-20s %d\n", _("CPU(s):"), info.cpus);
    vshPrint(ctl, "%-20s %d MHz\n", _("CPU frequency:"), info.mhz);
    vshPrint(ctl, "%-20s %d\n", _("CPU socket(s):"), info.sockets);
    vshPrint(ctl, "%-20s %d\n", _("Core(s) per socket:"), info.cores);
    vshPrint(ctl, "%-20s %d\n", _("Thread(s) per core:"), info.threads);
    vshPrint(ctl, "%-20s %d\n", _("NUMA cell(s):"), info.nodes);
    vshPrint(ctl, "%-20s %lu kB\n", _("Memory size:"), info.memory);

E
Eric Blake 已提交
3476
    return true;
3477 3478
}

3479 3480 3481
/*
 * "capabilities" command
 */
3482
static const vshCmdInfo info_capabilities[] = {
3483 3484
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
3485 3486 3487
    {NULL, NULL}
};

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

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

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
3497
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
3498
        return false;
3499 3500
    }
    vshPrint (ctl, "%s\n", caps);
3501
    VIR_FREE(caps);
3502

E
Eric Blake 已提交
3503
    return true;
3504 3505
}

3506 3507 3508
/*
 * "dumpxml" command
 */
3509
static const vshCmdInfo info_dumpxml[] = {
3510 3511
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
3512
    {NULL, NULL}
3513 3514
};

3515
static const vshCmdOptDef opts_dumpxml[] = {
3516 3517 3518
    {"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")},
3519
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
3520
    {NULL, 0, 0, NULL}
3521 3522
};

E
Eric Blake 已提交
3523
static bool
3524
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
3525
{
3526
    virDomainPtr dom;
E
Eric Blake 已提交
3527
    bool ret = true;
3528
    char *dump;
3529 3530 3531
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
3532
    int update = vshCommandOptBool(cmd, "update-cpu");
3533 3534 3535 3536 3537

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
3538 3539
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
3540

3541
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3542
        return false;
3543

J
Jim Meyering 已提交
3544
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3545
        return false;
3546

3547
    dump = virDomainGetXMLDesc(dom, flags);
3548
    if (dump != NULL) {
3549
        vshPrint(ctl, "%s", dump);
3550
        VIR_FREE(dump);
3551
    } else {
E
Eric Blake 已提交
3552
        ret = false;
3553
    }
3554

3555 3556 3557 3558
    virDomainFree(dom);
    return ret;
}

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

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

E
Eric Blake 已提交
3574
static bool
3575 3576
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
3577
    bool ret = true;
3578 3579
    const char *format = NULL;
    const char *configFile = NULL;
3580 3581 3582 3583
    char *configData;
    char *xmlData;
    int flags = 0;

3584
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3585
        return false;
3586

3587 3588
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
3589
        return false;
3590

3591
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
3592
        return false;
3593 3594 3595

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
3596
        vshPrint(ctl, "%s", xmlData);
3597
        VIR_FREE(xmlData);
3598
    } else {
E
Eric Blake 已提交
3599
        ret = false;
3600 3601 3602 3603 3604 3605 3606 3607 3608
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
3609 3610
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
3611 3612 3613 3614
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
3615 3616
    {"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")},
3617 3618 3619
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3620
static bool
3621 3622
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
3623
    bool ret = true;
3624 3625
    const char *format = NULL;
    const char *xmlFile = NULL;
3626 3627 3628 3629
    char *configData;
    char *xmlData;
    int flags = 0;

3630
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3631
        return false;
3632

3633 3634
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
3635
        return false;
3636

3637
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
3638
        return false;
3639 3640 3641

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
3642
        vshPrint(ctl, "%s", configData);
3643
        VIR_FREE(configData);
3644
    } else {
E
Eric Blake 已提交
3645
        ret = false;
3646 3647 3648 3649 3650
    }

    return ret;
}

K
Karel Zak 已提交
3651
/*
K
Karel Zak 已提交
3652
 * "domname" command
K
Karel Zak 已提交
3653
 */
3654
static const vshCmdInfo info_domname[] = {
3655
    {"help", N_("convert a domain id or UUID to domain name")},
3656
    {"desc", ""},
3657
    {NULL, NULL}
K
Karel Zak 已提交
3658 3659
};

3660
static const vshCmdOptDef opts_domname[] = {
3661
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
3662
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3663 3664
};

E
Eric Blake 已提交
3665
static bool
3666
cmdDomname(vshControl *ctl, const vshCmd *cmd)
3667
{
K
Karel Zak 已提交
3668 3669
    virDomainPtr dom;

3670
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3671
        return false;
J
Jim Meyering 已提交
3672
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3673
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
3674
        return false;
3675

K
Karel Zak 已提交
3676 3677
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
3678
    return true;
K
Karel Zak 已提交
3679 3680 3681
}

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

3690
static const vshCmdOptDef opts_domid[] = {
3691
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
3692
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3693 3694
};

E
Eric Blake 已提交
3695
static bool
3696
cmdDomid(vshControl *ctl, const vshCmd *cmd)
3697
{
3698
    virDomainPtr dom;
3699
    unsigned int id;
K
Karel Zak 已提交
3700

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

3707 3708
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3709
        vshPrint(ctl, "%s\n", "-");
3710
    else
3711
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
3712
    virDomainFree(dom);
E
Eric Blake 已提交
3713
    return true;
K
Karel Zak 已提交
3714
}
3715

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

3725
static const vshCmdOptDef opts_domuuid[] = {
3726
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
3727 3728 3729
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3730
static bool
3731
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
3732 3733
{
    virDomainPtr dom;
3734
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
3735

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

K
Karel Zak 已提交
3742 3743 3744
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
3745
        vshError(ctl, "%s", _("failed to get domain UUID"));
3746

3747
    virDomainFree(dom);
E
Eric Blake 已提交
3748
    return true;
K
Karel Zak 已提交
3749 3750
}

3751 3752 3753
/*
 * "migrate" command
 */
3754
static const vshCmdInfo info_migrate[] = {
3755 3756
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
3757 3758 3759
    {NULL, NULL}
};

3760
static const vshCmdOptDef opts_migrate[] = {
3761 3762 3763 3764 3765 3766 3767
    {"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")},
3768 3769
    {"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 已提交
3770
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
3771
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3772
    {"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)")},
3773 3774
    {"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 已提交
3775
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
3776 3777 3778
    {NULL, 0, 0, NULL}
};

3779 3780 3781 3782 3783 3784 3785 3786
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
3787
{
3788
    char ret = '1';
3789
    virDomainPtr dom = NULL;
3790 3791 3792 3793
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
    int flags = 0;
3794 3795 3796
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
3797 3798
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;
3799 3800 3801 3802 3803

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

3806
    if (!vshConnectionUsability (ctl, ctl->conn))
3807
        goto out;
3808

J
Jim Meyering 已提交
3809
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
3810
        goto out;
3811

3812 3813
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
3814 3815
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
3816
        goto out;
3817
    }
3818 3819 3820

    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
3821 3822
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
3823 3824 3825
    if (vshCommandOptBool (cmd, "tunnelled"))
        flags |= VIR_MIGRATE_TUNNELLED;

C
Chris Lalancette 已提交
3826 3827 3828 3829 3830
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

3831 3832 3833
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

3834 3835 3836 3837 3838 3839
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

3840 3841 3842 3843
    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. */
3844

3845
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
3846
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
3847
            goto out;
3848
        }
3849

3850
        if (virDomainMigrateToURI (dom, desturi, flags, dname, 0) == 0)
3851
            ret = '0';
3852 3853 3854 3855 3856 3857
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
3858
        if (!dconn) goto out;
3859 3860 3861 3862

        ddom = virDomainMigrate (dom, dconn, flags, dname, migrateuri, 0);
        if (ddom) {
            virDomainFree(ddom);
3863
            ret = '0';
3864 3865 3866
        }
        virConnectClose (dconn);
    }
3867

3868
out:
3869
#if HAVE_PTHREAD_SIGMASK
3870 3871
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
3872
#endif
3873
    if (dom) virDomainFree (dom);
3874 3875 3876
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900
static void
print_job_progress(unsigned long long remaining, unsigned long long total)
{
    int progress;

    if (total == 0)
        /* migration has not been started */
        return;

    if (remaining == 0) {
        /* migration has completed */
        progress = 100;
    } else {
        /* use float to avoid overflow */
        progress = (int)(100.0 - remaining * 100.0 / total);
        if (progress >= 100) {
            /* migration has not completed, do not print [100 %] */
            progress = 99;
        }
    }

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

E
Eric Blake 已提交
3901
static bool
3902 3903 3904 3905 3906
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
3907
    bool functionReturn = false;
3908 3909 3910 3911 3912
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
3913 3914
    virDomainJobInfo jobinfo;
    bool verbose = false;
3915
    int timeout = 0;
W
Wen Congyang 已提交
3916 3917
    struct timeval start, curr;
    bool live_flag = false;
3918
    vshCtrlData data;
3919 3920 3921 3922 3923 3924
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
#endif
3925 3926

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

W
Wen Congyang 已提交
3929 3930 3931
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
3932
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
3933
        live_flag = true;
3934
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951
        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;
        }
    }

3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974
    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 已提交
3975
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
3976
    while (1) {
3977
repoll:
W
Wen Congyang 已提交
3978 3979 3980 3981
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
3982
                    functionReturn = true;
W
Wen Congyang 已提交
3983 3984 3985 3986 3987
                    if (verbose) {
                        /* print [100 %] */
                        print_job_progress(0, 1);
                    }
                } else
W
Wen Congyang 已提交
3988
                    functionReturn = false;
3989
            } else
W
Wen Congyang 已提交
3990
                functionReturn = false;
W
Wen Congyang 已提交
3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
4002
            functionReturn = false;
W
Wen Congyang 已提交
4003 4004 4005
            break;
        }

W
Wen Congyang 已提交
4006 4007 4008 4009 4010 4011 4012 4013 4014
        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 已提交
4015
        if (verbose) {
4016
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
4017
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
4018
#endif
W
Wen Congyang 已提交
4019
            ret = virDomainGetJobInfo(dom, &jobinfo);
4020
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
4021
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
4022
#endif
W
Wen Congyang 已提交
4023 4024
            if (ret == 0)
                print_job_progress(jobinfo.dataRemaining, jobinfo.dataTotal);
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
4036
    return functionReturn;
4037 4038
}

4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049
/*
 * "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")},
4050
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
4051 4052 4053
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4054
static bool
4055 4056 4057
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
4058
    long long downtime = 0;
E
Eric Blake 已提交
4059
    bool ret = false;
4060

4061
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4062
        return false;
4063 4064

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

4067 4068
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
4069 4070 4071 4072 4073 4074 4075
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
4076
    ret = true;
4077 4078 4079 4080 4081 4082

done:
    virDomainFree(dom);
    return ret;
}

4083 4084 4085
/*
 * "net-autostart" command
 */
4086
static const vshCmdInfo info_network_autostart[] = {
4087
    {"help", N_("autostart a network")},
4088
    {"desc",
4089
     N_("Configure a network to be automatically started at boot.")},
4090 4091 4092
    {NULL, NULL}
};

4093
static const vshCmdOptDef opts_network_autostart[] = {
4094 4095
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4096 4097 4098
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4099
static bool
4100
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
4101 4102
{
    virNetworkPtr network;
4103
    const char *name;
4104 4105
    int autostart;

4106
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4107
        return false;
4108

J
Jim Meyering 已提交
4109
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4110
        return false;
4111 4112 4113 4114

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
4115
        if (autostart)
4116
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
4117
        else
4118
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
4119
        virNetworkFree(network);
E
Eric Blake 已提交
4120
        return false;
4121 4122
    }

4123
    if (autostart)
4124
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
4125
    else
4126
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
4127

L
Laine Stump 已提交
4128
    virNetworkFree(network);
E
Eric Blake 已提交
4129
    return true;
4130
}
K
Karel Zak 已提交
4131

4132 4133 4134
/*
 * "net-create" command
 */
4135
static const vshCmdInfo info_network_create[] = {
4136 4137
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
4138 4139 4140
    {NULL, NULL}
};

4141
static const vshCmdOptDef opts_network_create[] = {
4142
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4143 4144 4145
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4146
static bool
4147
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
4148 4149
{
    virNetworkPtr network;
4150
    const char *from = NULL;
E
Eric Blake 已提交
4151
    bool ret = true;
4152
    char *buffer;
4153

4154
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4155
        return false;
4156

4157
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4158
        return false;
4159

4160
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4161
        return false;
4162 4163

    network = virNetworkCreateXML(ctl->conn, buffer);
4164
    VIR_FREE(buffer);
4165

4166 4167 4168
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4169
        virNetworkFree(network);
4170
    } else {
4171
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
4172
        ret = false;
4173 4174 4175 4176 4177 4178 4179 4180
    }
    return ret;
}


/*
 * "net-define" command
 */
4181
static const vshCmdInfo info_network_define[] = {
4182 4183
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
4184 4185 4186
    {NULL, NULL}
};

4187
static const vshCmdOptDef opts_network_define[] = {
4188
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4189 4190 4191
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4192
static bool
4193
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
4194 4195
{
    virNetworkPtr network;
4196
    const char *from = NULL;
E
Eric Blake 已提交
4197
    bool ret = true;
4198
    char *buffer;
4199

4200
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4201
        return false;
4202

4203
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4204
        return false;
4205

4206
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4207
        return false;
4208 4209

    network = virNetworkDefineXML(ctl->conn, buffer);
4210
    VIR_FREE(buffer);
4211

4212 4213 4214
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4215
        virNetworkFree(network);
4216
    } else {
4217
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
4218
        ret = false;
4219 4220 4221 4222 4223 4224 4225 4226
    }
    return ret;
}


/*
 * "net-destroy" command
 */
4227
static const vshCmdInfo info_network_destroy[] = {
4228 4229
    {"help", N_("destroy a network")},
    {"desc", N_("Destroy a given network.")},
4230 4231 4232
    {NULL, NULL}
};

4233
static const vshCmdOptDef opts_network_destroy[] = {
4234
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4235 4236 4237
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4238
static bool
4239
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
4240 4241
{
    virNetworkPtr network;
E
Eric Blake 已提交
4242
    bool ret = true;
4243
    const char *name;
4244

4245
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4246
        return false;
4247

J
Jim Meyering 已提交
4248
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4249
        return false;
4250 4251 4252 4253

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

4258
    virNetworkFree(network);
4259 4260 4261 4262 4263 4264 4265
    return ret;
}


/*
 * "net-dumpxml" command
 */
4266
static const vshCmdInfo info_network_dumpxml[] = {
4267 4268
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
4269 4270 4271
    {NULL, NULL}
};

4272
static const vshCmdOptDef opts_network_dumpxml[] = {
4273
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4274 4275 4276
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4277
static bool
4278
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
4279 4280
{
    virNetworkPtr network;
E
Eric Blake 已提交
4281
    bool ret = true;
4282 4283
    char *dump;

4284
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4285
        return false;
4286

J
Jim Meyering 已提交
4287
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
4288
        return false;
4289 4290 4291

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
4292
        vshPrint(ctl, "%s", dump);
4293
        VIR_FREE(dump);
4294
    } else {
E
Eric Blake 已提交
4295
        ret = false;
4296 4297 4298 4299 4300 4301
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315
/*
 * "net-info" command
 */
static const vshCmdInfo info_network_info[] = {
    {"help", N_("network information")},
    {"desc", "Returns basic information about the network"},
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_info[] = {
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4316
static bool
O
Osier Yang 已提交
4317 4318 4319 4320 4321 4322 4323 4324 4325 4326
cmdNetworkInfo(vshControl *ctl, const vshCmd *cmd)
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];
    int autostart;
    int persistent = -1;
    int active = -1;
    char *bridge = NULL;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4327
        return false;
O
Osier Yang 已提交
4328 4329 4330

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4331
        return false;
O
Osier Yang 已提交
4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357

    vshPrint(ctl, "%-15s %s\n", _("Name"), virNetworkGetName(network));

    if (virNetworkGetUUIDString(network, uuid) == 0)
        vshPrint(ctl, "%-15s %s\n", _("UUID"), uuid);

    active = virNetworkIsActive(network);
    if (active >= 0)
        vshPrint(ctl, "%-15s %s\n", _("Active:"), active? _("yes") : _("no"));

    persistent = virNetworkIsPersistent(network);
    if (persistent < 0)
        vshPrint(ctl, "%-15s %s\n", _("Persistent:"), _("unknown"));
    else
        vshPrint(ctl, "%-15s %s\n", _("Persistent:"), persistent ? _("yes") : _("no"));

    if (virNetworkGetAutostart(network, &autostart) < 0)
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
    else
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

    bridge = virNetworkGetBridgeName(network);
    if (bridge)
        vshPrint(ctl, "%-15s %s\n", _("Bridge:"), bridge);

    virNetworkFree(network);
E
Eric Blake 已提交
4358
    return true;
O
Osier Yang 已提交
4359
}
4360

4361 4362 4363 4364
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
4365 4366
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
4367 4368 4369 4370
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
4371
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4372 4373 4374
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4375
static bool
4376 4377
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4378
    bool ret = false;
4379 4380 4381 4382 4383
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
4384
    int flags = VIR_INTERFACE_XML_INACTIVE;
4385

4386
    if (!vshConnectionUsability(ctl, ctl->conn))
4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412
        goto cleanup;

    iface = vshCommandOptInterface (ctl, cmd, NULL);
    if (iface == NULL)
        goto cleanup;

    /* Get the XML configuration of the interface. */
    doc = virInterfaceGetXMLDesc (iface, flags);
    if (!doc)
        goto cleanup;

    /* Create and open the temporary file. */
    tmp = editWriteToTempFile (ctl, doc);
    if (!tmp) goto cleanup;

    /* Start the editor. */
    if (editFile (ctl, tmp) == -1) goto cleanup;

    /* Read back the edited file. */
    doc_edited = editReadBackFile (ctl, tmp);
    if (!doc_edited) goto cleanup;

    /* Compare original XML with edited.  Has it changed at all? */
    if (STREQ (doc, doc_edited)) {
        vshPrint (ctl, _("Interface %s XML configuration not changed.\n"),
                  virInterfaceGetName (iface));
E
Eric Blake 已提交
4413
        ret = true;
4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425
        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)) {
4426 4427
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439
        goto cleanup;
    }

    /* Everything checks out, so redefine the interface. */
    virInterfaceFree (iface);
    iface = virInterfaceDefineXML (ctl->conn, doc_edited, 0);
    if (!iface)
        goto cleanup;

    vshPrint (ctl, _("Interface %s XML configuration edited.\n"),
              virInterfaceGetName(iface));

E
Eric Blake 已提交
4440
    ret = true;
4441 4442 4443 4444 4445

cleanup:
    if (iface)
        virInterfaceFree (iface);

4446 4447 4448
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
4449 4450 4451

    if (tmp) {
        unlink (tmp);
4452
        VIR_FREE(tmp);
4453 4454 4455 4456 4457
    }

    return ret;
}

4458 4459 4460
/*
 * "net-list" command
 */
4461
static const vshCmdInfo info_network_list[] = {
4462 4463
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
4464 4465 4466
    {NULL, NULL}
};

4467
static const vshCmdOptDef opts_network_list[] = {
4468 4469
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
4470 4471 4472
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4473
static bool
4474
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4475 4476 4477 4478 4479
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
4480
    char **activeNames = NULL, **inactiveNames = NULL;
4481 4482
    inactive |= all;

4483
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4484
        return false;
4485 4486

    if (active) {
4487 4488
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
4489
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
4490
            return false;
4491
        }
4492
        if (maxactive) {
4493
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
4494

4495
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
4496
                                                    maxactive)) < 0) {
4497
                vshError(ctl, "%s", _("Failed to list active networks"));
4498
                VIR_FREE(activeNames);
E
Eric Blake 已提交
4499
                return false;
4500
            }
4501

4502
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
4503
        }
4504 4505
    }
    if (inactive) {
4506 4507
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
4508
            vshError(ctl, "%s", _("Failed to list inactive networks"));
4509
            VIR_FREE(activeNames);
E
Eric Blake 已提交
4510
            return false;
4511
        }
4512 4513 4514
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4515 4516 4517
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
4518
                vshError(ctl, "%s", _("Failed to list inactive networks"));
4519 4520
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4521
                return false;
4522
            }
4523

4524 4525
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
4526
    }
4527 4528
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
4529
    vshPrintExtra(ctl, "-----------------------------------------\n");
4530 4531

    for (i = 0; i < maxactive; i++) {
4532 4533
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
4534 4535
        const char *autostartStr;
        int autostart = 0;
4536 4537 4538

        /* this kind of work with networks is not atomic operation */
        if (!network) {
4539
            VIR_FREE(activeNames[i]);
4540
            continue;
4541
        }
4542

4543 4544 4545
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
4546
            autostartStr = autostart ? _("yes") : _("no");
4547 4548 4549 4550 4551

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
4552
        virNetworkFree(network);
4553
        VIR_FREE(activeNames[i]);
4554 4555 4556
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
4557 4558
        const char *autostartStr;
        int autostart = 0;
4559 4560 4561

        /* this kind of work with networks is not atomic operation */
        if (!network) {
4562
            VIR_FREE(inactiveNames[i]);
4563
            continue;
4564
        }
4565

4566 4567 4568
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
4569
            autostartStr = autostart ? _("yes") : _("no");
4570

4571
        vshPrint(ctl, "%-20s %-10s %-10s\n",
4572 4573 4574
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
4575 4576

        virNetworkFree(network);
4577
        VIR_FREE(inactiveNames[i]);
4578
    }
4579 4580
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4581
    return true;
4582 4583 4584 4585 4586 4587
}


/*
 * "net-name" command
 */
4588
static const vshCmdInfo info_network_name[] = {
4589
    {"help", N_("convert a network UUID to network name")},
4590
    {"desc", ""},
4591 4592 4593
    {NULL, NULL}
};

4594
static const vshCmdOptDef opts_network_name[] = {
4595
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
4596 4597 4598
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4599
static bool
4600
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
4601 4602 4603
{
    virNetworkPtr network;

4604
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4605
        return false;
J
Jim Meyering 已提交
4606
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4607
                                           VSH_BYUUID)))
E
Eric Blake 已提交
4608
        return false;
4609 4610 4611

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
4612
    return true;
4613 4614 4615 4616 4617 4618
}


/*
 * "net-start" command
 */
4619
static const vshCmdInfo info_network_start[] = {
4620 4621
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
4622 4623 4624
    {NULL, NULL}
};

4625
static const vshCmdOptDef opts_network_start[] = {
4626
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
4627 4628 4629
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4630
static bool
4631
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
4632 4633
{
    virNetworkPtr network;
E
Eric Blake 已提交
4634
    bool ret = true;
4635

4636
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4637
        return false;
4638

J
Jim Meyering 已提交
4639
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
4640
         return false;
4641 4642 4643

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
4644
                 virNetworkGetName(network));
4645
    } else {
4646
        vshError(ctl, _("Failed to start network %s"),
4647
                 virNetworkGetName(network));
E
Eric Blake 已提交
4648
        ret = false;
4649
    }
L
Laine Stump 已提交
4650
    virNetworkFree(network);
4651 4652 4653 4654 4655 4656 4657
    return ret;
}


/*
 * "net-undefine" command
 */
4658
static const vshCmdInfo info_network_undefine[] = {
4659 4660
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
4661 4662 4663
    {NULL, NULL}
};

4664
static const vshCmdOptDef opts_network_undefine[] = {
4665
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4666 4667 4668
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4669
static bool
4670
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
4671 4672
{
    virNetworkPtr network;
E
Eric Blake 已提交
4673
    bool ret = true;
4674
    const char *name;
4675

4676
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4677
        return false;
4678

J
Jim Meyering 已提交
4679
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4680
        return false;
4681 4682 4683 4684

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

L
Laine Stump 已提交
4689
    virNetworkFree(network);
4690 4691 4692 4693 4694 4695 4696
    return ret;
}


/*
 * "net-uuid" command
 */
4697
static const vshCmdInfo info_network_uuid[] = {
4698
    {"help", N_("convert a network name to network UUID")},
4699
    {"desc", ""},
4700 4701 4702
    {NULL, NULL}
};

4703
static const vshCmdOptDef opts_network_uuid[] = {
4704
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
4705 4706 4707
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4708
static bool
4709
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
4710 4711 4712 4713
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

4714
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4715
        return false;
4716

J
Jim Meyering 已提交
4717
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4718
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4719
        return false;
4720 4721 4722 4723

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

L
Laine Stump 已提交
4726
    virNetworkFree(network);
E
Eric Blake 已提交
4727
    return true;
4728 4729 4730
}


4731 4732 4733 4734 4735
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
4736 4737
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
4738 4739 4740 4741
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
4742 4743
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
4744 4745
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
4746
static bool
4747 4748 4749 4750 4751 4752 4753 4754 4755
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;

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

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
4762
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
4763
            return false;
4764 4765 4766 4767 4768 4769
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
4770
                vshError(ctl, "%s", _("Failed to list active interfaces"));
4771
                VIR_FREE(activeNames);
E
Eric Blake 已提交
4772
                return false;
4773 4774 4775 4776 4777 4778 4779 4780
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
4781
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4782
            VIR_FREE(activeNames);
E
Eric Blake 已提交
4783
            return false;
4784 4785 4786 4787
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4788 4789 4790
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
4791
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4792 4793
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4794
                return false;
4795 4796 4797 4798 4799
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
4800 4801
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
4802 4803 4804
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
4805 4806
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
4807 4808 4809

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4810
            VIR_FREE(activeNames[i]);
4811 4812 4813 4814 4815 4816 4817 4818
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4819
        VIR_FREE(activeNames[i]);
4820 4821
    }
    for (i = 0; i < maxinactive; i++) {
4822 4823
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
4824 4825 4826

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4827
            VIR_FREE(inactiveNames[i]);
4828 4829 4830 4831 4832 4833 4834 4835
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4836
        VIR_FREE(inactiveNames[i]);
4837
    }
4838 4839
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4840
    return true;
4841 4842 4843 4844 4845 4846 4847

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
4848
    {"help", N_("convert an interface MAC address to interface name")},
4849 4850 4851 4852 4853
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
4854
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
4855 4856 4857
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4858
static bool
4859 4860 4861 4862
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

4863
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4864
        return false;
4865 4866
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
4867
        return false;
4868 4869 4870

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
4871
    return true;
4872 4873 4874 4875 4876 4877
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
4878
    {"help", N_("convert an interface name to interface MAC address")},
4879 4880 4881 4882 4883
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
4884
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
4885 4886 4887
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4888
static bool
4889 4890 4891 4892
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

4893
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4894
        return false;
4895 4896
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4897
        return false;
4898 4899 4900

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
4901
    return true;
4902 4903 4904 4905 4906 4907
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
4908 4909
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
4910 4911 4912 4913
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
4914 4915
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
4916 4917 4918
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4919
static bool
4920 4921 4922
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
4923
    bool ret = true;
4924
    char *dump;
4925 4926 4927 4928 4929
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
4930

4931
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4932
        return false;
4933 4934

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

4937
    dump = virInterfaceGetXMLDesc(iface, flags);
4938
    if (dump != NULL) {
4939
        vshPrint(ctl, "%s", dump);
4940
        VIR_FREE(dump);
4941
    } else {
E
Eric Blake 已提交
4942
        ret = false;
4943 4944 4945 4946 4947 4948 4949 4950 4951 4952
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
4953 4954
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
4955 4956 4957 4958
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
4959
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
4960 4961 4962
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4963
static bool
4964 4965
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
4966
    virInterfacePtr iface;
4967
    const char *from = NULL;
E
Eric Blake 已提交
4968
    bool ret = true;
4969 4970
    char *buffer;

4971
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4972
        return false;
4973

4974
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4975
        return false;
4976 4977

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

4980
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
4981
    VIR_FREE(buffer);
4982

4983
    if (iface != NULL) {
4984
        vshPrint(ctl, _("Interface %s defined from %s\n"),
4985
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
4986
        virInterfaceFree (iface);
4987
    } else {
4988
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
4989
        ret = false;
4990 4991 4992 4993 4994 4995 4996 4997
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
4998 4999
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
5000 5001 5002 5003
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
5004
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5005 5006 5007
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5008
static bool
5009 5010 5011
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5012
    bool ret = true;
5013
    const char *name;
5014

5015
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5016
        return false;
5017 5018

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5019
        return false;
5020 5021 5022 5023

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
5024
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
5025
        ret = false;
5026 5027 5028 5029 5030 5031 5032 5033 5034 5035
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
5036 5037
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
5038 5039 5040 5041
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
5042
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5043 5044 5045
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5046
static bool
5047 5048 5049
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5050
    bool ret = true;
5051
    const char *name;
5052

5053
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5054
        return false;
5055 5056

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5057
        return false;
5058 5059 5060 5061

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
5062
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
5063
        ret = false;
5064 5065 5066 5067 5068 5069 5070 5071 5072 5073
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
5074 5075
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
    {"desc", N_("destroy a physical host interface.")},
5076 5077 5078 5079
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
5080
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5081 5082 5083
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5084
static bool
5085 5086 5087
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5088
    bool ret = true;
5089
    const char *name;
5090

5091
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5092
        return false;
5093 5094

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5095
        return false;
5096 5097 5098 5099

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
5100
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
5101
        ret = false;
5102 5103 5104 5105 5106 5107
    }

    virInterfaceFree(iface);
    return ret;
}

5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122

/*
 * "nwfilter-define" command
 */
static const vshCmdInfo info_nwfilter_define[] = {
    {"help", N_("define or update a network filter from an XML file")},
    {"desc", N_("Define a new network filter or update an existing one.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_nwfilter_define[] = {
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network filter description")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5123
static bool
5124 5125 5126
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
5127
    const char *from = NULL;
E
Eric Blake 已提交
5128
    bool ret = true;
5129 5130
    char *buffer;

5131
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5132
        return false;
5133

5134
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5135
        return false;
5136 5137

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5138
        return false;
5139 5140 5141 5142 5143 5144 5145 5146 5147 5148

    nwfilter = virNWFilterDefineXML(ctl->conn, buffer);
    VIR_FREE(buffer);

    if (nwfilter != NULL) {
        vshPrint(ctl, _("Network filter %s defined from %s\n"),
                 virNWFilterGetName(nwfilter), from);
        virNWFilterFree(nwfilter);
    } else {
        vshError(ctl, _("Failed to define network filter from %s"), from);
E
Eric Blake 已提交
5149
        ret = false;
5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168
    }
    return ret;
}


/*
 * "nwfilter-undefine" command
 */
static const vshCmdInfo info_nwfilter_undefine[] = {
    {"help", N_("undefine a network filter")},
    {"desc", N_("Undefine a given network filter.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_nwfilter_undefine[] = {
    {"nwfilter", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network filter name or uuid")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5169
static bool
5170 5171 5172
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5173
    bool ret = true;
5174
    const char *name;
5175

5176
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5177
        return false;
5178 5179

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
5180
        return false;
5181 5182 5183 5184 5185

    if (virNWFilterUndefine(nwfilter) == 0) {
        vshPrint(ctl, _("Network filter %s undefined\n"), name);
    } else {
        vshError(ctl, _("Failed to undefine network filter %s"), name);
E
Eric Blake 已提交
5186
        ret = false;
5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207
    }

    virNWFilterFree(nwfilter);
    return ret;
}


/*
 * "nwfilter-dumpxml" command
 */
static const vshCmdInfo info_nwfilter_dumpxml[] = {
    {"help", N_("network filter information in XML")},
    {"desc", N_("Output the network filter information as an XML dump to stdout.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_nwfilter_dumpxml[] = {
    {"nwfilter", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network filter name or uuid")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5208
static bool
5209 5210 5211
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5212
    bool ret = true;
5213 5214
    char *dump;

5215
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5216
        return false;
5217 5218

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
5219
        return false;
5220 5221 5222

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
5223
        vshPrint(ctl, "%s", dump);
5224 5225
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
5226
        ret = false;
5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245
    }

    virNWFilterFree(nwfilter);
    return ret;
}

/*
 * "nwfilter-list" command
 */
static const vshCmdInfo info_nwfilter_list[] = {
    {"help", N_("list network filters")},
    {"desc", N_("Returns list of network filters.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_nwfilter_list[] = {
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5246
static bool
5247 5248 5249 5250 5251 5252
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

5253
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5254
        return false;
5255 5256 5257 5258

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
5259
        return false;
5260 5261 5262 5263 5264 5265 5266 5267
    }

    names = vshMalloc(ctl, sizeof(char *) * numfilters);

    if ((numfilters = virConnectListNWFilters(ctl->conn, names,
                                              numfilters)) < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
        VIR_FREE(names);
E
Eric Blake 已提交
5268
        return false;
5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295
    }

    qsort(&names[0], numfilters, sizeof(char *), namesorter);

    vshPrintExtra(ctl, "%-36s  %-20s \n", _("UUID"), _("Name"));
    vshPrintExtra(ctl,
       "----------------------------------------------------------------\n");

    for (i = 0; i < numfilters; i++) {
        virNWFilterPtr nwfilter =
            virNWFilterLookupByName(ctl->conn, names[i]);

        /* this kind of work with networks is not atomic operation */
        if (!nwfilter) {
            VIR_FREE(names[i]);
            continue;
        }

        virNWFilterGetUUIDString(nwfilter, uuid);
        vshPrint(ctl, "%-36s  %-20s\n",
                 uuid,
                 virNWFilterGetName(nwfilter));
        virNWFilterFree(nwfilter);
        VIR_FREE(names[i]);
    }

    VIR_FREE(names);
E
Eric Blake 已提交
5296
    return true;
5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313
}


/*
 * "nwfilter-edit" command
 */
static const vshCmdInfo info_nwfilter_edit[] = {
    {"help", N_("edit XML configuration for a network filter")},
    {"desc", N_("Edit the XML configuration for a network filter.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_nwfilter_edit[] = {
    {"nwfilter", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network filter name or uuid")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5314
static bool
5315 5316
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5317
    bool ret = false;
5318 5319 5320 5321 5322 5323
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

5324
    if (!vshConnectionUsability(ctl, ctl->conn))
5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350
        goto cleanup;

    nwfilter = vshCommandOptNWFilter (ctl, cmd, NULL);
    if (nwfilter == NULL)
        goto cleanup;

    /* Get the XML configuration of the interface. */
    doc = virNWFilterGetXMLDesc (nwfilter, 0);
    if (!doc)
        goto cleanup;

    /* Create and open the temporary file. */
    tmp = editWriteToTempFile (ctl, doc);
    if (!tmp) goto cleanup;

    /* Start the editor. */
    if (editFile (ctl, tmp) == -1) goto cleanup;

    /* Read back the edited file. */
    doc_edited = editReadBackFile (ctl, tmp);
    if (!doc_edited) goto cleanup;

    /* Compare original XML with edited.  Has it changed at all? */
    if (STREQ (doc, doc_edited)) {
        vshPrint (ctl, _("Network filter %s XML configuration not changed.\n"),
                  virNWFilterGetName (nwfilter));
E
Eric Blake 已提交
5351
        ret = true;
5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377
        goto cleanup;
    }

    /* Now re-read the network filter XML.  Did someone else change it while
     * it was being edited?  This also catches problems such as us
     * losing a connection or the interface going away.
     */
    doc_reread = virNWFilterGetXMLDesc (nwfilter, 0);
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
        goto cleanup;
    }

    /* Everything checks out, so redefine the interface. */
    virNWFilterFree (nwfilter);
    nwfilter = virNWFilterDefineXML (ctl->conn, doc_edited);
    if (!nwfilter)
        goto cleanup;

    vshPrint (ctl, _("Network filter %s XML configuration edited.\n"),
              virNWFilterGetName(nwfilter));

E
Eric Blake 已提交
5378
    ret = true;
5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396

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


5397
/**************************************************************************/
5398
/*
5399
 * "pool-autostart" command
5400
 */
5401
static const vshCmdInfo info_pool_autostart[] = {
5402
    {"help", N_("autostart a pool")},
5403
    {"desc",
5404
     N_("Configure a pool to be automatically started at boot.")},
5405
    {NULL, NULL}
5406 5407
};

5408
static const vshCmdOptDef opts_pool_autostart[] = {
5409 5410
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5411 5412
    {NULL, 0, 0, NULL}
};
5413

E
Eric Blake 已提交
5414
static bool
5415
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
5416
{
5417
    virStoragePoolPtr pool;
5418
    const char *name;
5419
    int autostart;
5420

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

5424
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5425
        return false;
5426

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

5429 5430
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
5431
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
5432
        else
5433
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
5434
        virStoragePoolFree(pool);
E
Eric Blake 已提交
5435
        return false;
5436 5437
    }

5438
    if (autostart)
5439
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
5440
    else
5441
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
5442

L
Laine Stump 已提交
5443
    virStoragePoolFree(pool);
E
Eric Blake 已提交
5444
    return true;
5445 5446
}

5447
/*
5448
 * "pool-create" command
5449
 */
5450
static const vshCmdInfo info_pool_create[] = {
5451 5452
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
5453 5454 5455
    {NULL, NULL}
};

5456
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
5457
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
5458
     N_("file containing an XML pool description")},
5459 5460 5461
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5462
static bool
5463
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
5464
{
5465
    virStoragePoolPtr pool;
5466
    const char *from = NULL;
E
Eric Blake 已提交
5467
    bool ret = true;
5468
    char *buffer;
5469

5470
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5471
        return false;
5472

5473
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5474
        return false;
5475

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

5479
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
5480
    VIR_FREE(buffer);
5481 5482 5483 5484

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5485
        virStoragePoolFree(pool);
5486
    } else {
5487
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
5488
        ret = false;
5489 5490
    }
    return ret;
5491 5492
}

5493

5494 5495 5496 5497
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
5498
    {"help", N_("create a device defined "
5499
                          "by an XML file on the node")},
5500
    {"desc", N_("Create a device on the node.  Note that this "
5501 5502 5503 5504 5505 5506 5507
                          "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,
5508
     N_("file containing an XML description of the device")},
5509 5510 5511
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5512
static bool
5513 5514 5515
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
5516
    const char *from = NULL;
E
Eric Blake 已提交
5517
    bool ret = true;
5518 5519
    char *buffer;

5520
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5521
        return false;
5522

5523
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5524
        return false;
5525

5526
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5527
        return false;
5528 5529

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
5530
    VIR_FREE(buffer);
5531 5532 5533 5534

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
5535
        virNodeDeviceFree(dev);
5536
    } else {
5537
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
5538
        ret = false;
5539 5540 5541 5542 5543 5544 5545 5546 5547 5548
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
5549 5550
    {"help", N_("destroy a device on the node")},
    {"desc", N_("Destroy a device on the node.  Note that this "
5551 5552 5553 5554 5555 5556
                          "command destroys devices on the physical host ")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
5557
     N_("name of the device to be destroyed")},
5558 5559 5560
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5561
static bool
5562 5563 5564
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
5565
    bool ret = true;
5566
    const char *name = NULL;
5567

5568
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
5569
        return false;
5570 5571
    }

5572
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
5573
        return false;
5574 5575 5576 5577 5578 5579

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
5580
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
5581
        ret = false;
5582 5583 5584 5585 5586 5587 5588
    }

    virNodeDeviceFree(dev);
    return ret;
}


5589
/*
5590
 * XML Building helper for pool-define-as and pool-create-as
5591
 */
5592
static const vshCmdOptDef opts_pool_X_as[] = {
5593 5594 5595 5596 5597 5598 5599 5600
    {"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")},
5601
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
5602 5603 5604
    {NULL, 0, 0, NULL}
};

5605
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
5606

5607 5608
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
5609
    virBuffer buf = VIR_BUFFER_INITIALIZER;
5610

5611
    if (vshCommandOptString(cmd, "name", &name) <= 0)
5612
        goto cleanup;
5613
    if (vshCommandOptString(cmd, "type", &type) <= 0)
5614 5615
        goto cleanup;

5616 5617 5618 5619 5620
    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 ||
5621 5622
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
5623
        goto cleanup;
5624
    }
5625

5626 5627
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
5628
    if (srcHost || srcPath || srcDev) {
5629
        virBufferAddLit(&buf, "  <source>\n");
5630

5631
        if (srcHost)
5632
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
5633
        if (srcPath)
5634
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
5635
        if (srcDev)
5636
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
5637
        if (srcFormat)
5638
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
5639
        if (srcName)
5640
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
5641 5642

        virBufferAddLit(&buf, "  </source>\n");
5643 5644
    }
    if (target) {
5645
        virBufferAddLit(&buf, "  <target>\n");
5646
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
5647
        virBufferAddLit(&buf, "  </target>\n");
5648
    }
5649 5650 5651 5652
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
5653
        return false;
5654
    }
5655 5656 5657

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
5658
    return true;
5659 5660

cleanup:
5661
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
5662
    return false;
5663 5664 5665 5666 5667 5668
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
5669 5670
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
5671 5672 5673
    {NULL, NULL}
};

E
Eric Blake 已提交
5674
static bool
5675 5676 5677
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
5678 5679
    const char *name;
    char *xml;
5680
    int printXML = vshCommandOptBool(cmd, "print-xml");
5681

5682
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5683
        return false;
5684 5685

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

5688
    if (printXML) {
5689
        vshPrint(ctl, "%s", xml);
5690
        VIR_FREE(xml);
5691
    } else {
5692
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
5693
        VIR_FREE(xml);
5694

5695 5696 5697 5698
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
5699
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
5700
            return false;
5701 5702
        }
    }
E
Eric Blake 已提交
5703
    return true;
5704 5705
}

5706

5707
/*
5708
 * "pool-define" command
5709
 */
5710
static const vshCmdInfo info_pool_define[] = {
5711 5712
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
5713 5714 5715
    {NULL, NULL}
};

5716
static const vshCmdOptDef opts_pool_define[] = {
5717
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
5718 5719 5720
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5721
static bool
5722
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
5723
{
5724
    virStoragePoolPtr pool;
5725
    const char *from = NULL;
E
Eric Blake 已提交
5726
    bool ret = true;
5727
    char *buffer;
5728

5729
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5730
        return false;
5731

5732
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5733
        return false;
5734

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

5738
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
5739
    VIR_FREE(buffer);
5740 5741 5742 5743

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5744
        virStoragePoolFree(pool);
5745
    } else {
5746
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
5747
        ret = false;
5748 5749
    }
    return ret;
5750 5751
}

5752

5753 5754 5755
/*
 * "pool-define-as" command
 */
5756
static const vshCmdInfo info_pool_define_as[] = {
5757 5758
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
5759 5760 5761
    {NULL, NULL}
};

E
Eric Blake 已提交
5762
static bool
5763
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
5764 5765
{
    virStoragePoolPtr pool;
5766 5767
    const char *name;
    char *xml;
5768
    int printXML = vshCommandOptBool(cmd, "print-xml");
5769

5770
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5771
        return false;
5772

5773
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
5774
        return false;
5775

5776
    if (printXML) {
5777
        vshPrint(ctl, "%s", xml);
5778
        VIR_FREE(xml);
5779
    } else {
5780
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
5781
        VIR_FREE(xml);
5782

5783 5784 5785 5786
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
5787
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
5788
            return false;
5789 5790
        }
    }
E
Eric Blake 已提交
5791
    return true;
5792 5793 5794
}


5795
/*
5796
 * "pool-build" command
5797
 */
5798
static const vshCmdInfo info_pool_build[] = {
5799 5800
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
5801 5802 5803
    {NULL, NULL}
};

5804
static const vshCmdOptDef opts_pool_build[] = {
5805
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5806 5807 5808
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5809
static bool
5810
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
5811
{
5812
    virStoragePoolPtr pool;
E
Eric Blake 已提交
5813
    bool ret = true;
5814
    const char *name;
5815

5816
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5817
        return false;
5818

5819
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5820
        return false;
5821

5822
    if (virStoragePoolBuild(pool, 0) == 0) {
5823
        vshPrint(ctl, _("Pool %s built\n"), name);
5824
    } else {
5825
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
5826
        ret = false;
5827 5828
    }

5829 5830
    virStoragePoolFree(pool);

5831 5832 5833
    return ret;
}

5834

5835
/*
5836
 * "pool-destroy" command
5837
 */
5838
static const vshCmdInfo info_pool_destroy[] = {
5839 5840
    {"help", N_("destroy a pool")},
    {"desc", N_("Destroy a given pool.")},
5841 5842 5843
    {NULL, NULL}
};

5844
static const vshCmdOptDef opts_pool_destroy[] = {
5845
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5846 5847 5848
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5849
static bool
5850
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
5851
{
5852
    virStoragePoolPtr pool;
E
Eric Blake 已提交
5853
    bool ret = true;
5854
    const char *name;
5855

5856
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5857
        return false;
5858

5859
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5860
        return false;
5861

5862 5863 5864
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
5865
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
5866
        ret = false;
5867 5868
    }

5869
    virStoragePoolFree(pool);
5870 5871 5872
    return ret;
}

5873

5874
/*
5875 5876
 * "pool-delete" command
 */
5877
static const vshCmdInfo info_pool_delete[] = {
5878 5879
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
5880 5881 5882
    {NULL, NULL}
};

5883
static const vshCmdOptDef opts_pool_delete[] = {
5884
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5885 5886 5887
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5888
static bool
5889
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
5890 5891
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
5892
    bool ret = true;
5893
    const char *name;
5894

5895
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5896
        return false;
5897 5898

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5899
        return false;
5900 5901

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
5902
        vshPrint(ctl, _("Pool %s deleted\n"), name);
5903
    } else {
5904
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
5905
        ret = false;
5906 5907
    }

L
Laine Stump 已提交
5908
    virStoragePoolFree(pool);
5909 5910 5911 5912 5913 5914 5915
    return ret;
}


/*
 * "pool-refresh" command
 */
5916
static const vshCmdInfo info_pool_refresh[] = {
5917 5918
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
5919 5920 5921
    {NULL, NULL}
};

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

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

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

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

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
5943
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
5944
        ret = false;
5945 5946 5947 5948 5949 5950 5951 5952 5953 5954
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
5955
static const vshCmdInfo info_pool_dumpxml[] = {
5956 5957
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
5958 5959 5960
    {NULL, NULL}
};

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

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

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

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

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
5981
        vshPrint(ctl, "%s", dump);
5982
        VIR_FREE(dump);
5983
    } else {
E
Eric Blake 已提交
5984
        ret = false;
5985 5986 5987 5988 5989 5990 5991 5992 5993 5994
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
5995
static const vshCmdInfo info_pool_list[] = {
5996 5997
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
5998 5999 6000
    {NULL, NULL}
};

6001
static const vshCmdOptDef opts_pool_list[] = {
6002 6003
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
6004
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
6005 6006 6007
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6008
static bool
6009
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6010
{
6011 6012
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
6013 6014
    int i, ret;
    bool functionReturn;
6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030
    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 */
6031
    int all = vshCommandOptBool(cmd, "all");
6032 6033
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
6034 6035 6036
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

6037
    /* Check the connection to libvirtd daemon is still working */
6038
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6039
        return false;
6040

6041
    /* Retrieve the number of active storage pools */
6042
    if (active) {
6043 6044
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
6045
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
6046
            return false;
6047 6048
        }
    }
6049 6050

    /* Retrieve the number of inactive storage pools */
6051
    if (inactive) {
6052 6053
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
6054
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
6055
            return false;
6056
        }
6057
    }
6058

6059 6060
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
6061

6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073
    /* Allocate memory for arrays of storage pool names and info */
    poolNames = vshCalloc(ctl, numAllPools, sizeof(*poolNames));
    poolInfoTexts =
        vshCalloc(ctl, numAllPools, sizeof(*poolInfoTexts));

    /* Retrieve a list of active storage pool names */
    if (active) {
        if ((virConnectListStoragePools(ctl->conn,
                                        poolNames, numActivePools)) < 0) {
            vshError(ctl, "%s", _("Failed to list active pools"));
            VIR_FREE(poolInfoTexts);
            VIR_FREE(poolNames);
E
Eric Blake 已提交
6074
            return false;
6075 6076 6077
        }
    }

6078 6079 6080 6081 6082 6083 6084 6085
    /* Add the inactive storage pools to the end of the name list */
    if (inactive) {
        if ((virConnectListDefinedStoragePools(ctl->conn,
                                               &poolNames[numActivePools],
                                               numInactivePools)) < 0) {
            vshError(ctl, "%s", _("Failed to list inactive pools"));
            VIR_FREE(poolInfoTexts);
            VIR_FREE(poolNames);
E
Eric Blake 已提交
6086
            return false;
6087 6088
        }
    }
6089

6090 6091 6092 6093 6094 6095 6096 6097 6098 6099
    /* 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]);
6100
        if (!pool) {
6101
            VIR_FREE(poolNames[i]);
6102 6103 6104
            continue;
        }

6105
        /* Retrieve the autostart status of the pool */
6106
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
6107
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
6108
        else
6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126
            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;
        }
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 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239
        /* 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 */
6240 6241 6242
        virStoragePoolFree(pool);
    }

6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260
    /* 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);
6261 6262
        }

6263
        /* Cleanup and return */
E
Eric Blake 已提交
6264
        functionReturn = true;
6265 6266
        goto cleanup;
    }
6267

6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361
    /* We only get here if the --details option was selected. */

    /* Use the length of name header string if it's longest */
    stringLength = strlen(_("Name"));
    if (stringLength > nameStrLength)
        nameStrLength = stringLength;

    /* Use the length of state header string if it's longest */
    stringLength = strlen(_("State"));
    if (stringLength > stateStrLength)
        stateStrLength = stringLength;

    /* Use the length of autostart header string if it's longest */
    stringLength = strlen(_("Autostart"));
    if (stringLength > autostartStrLength)
        autostartStrLength = stringLength;

    /* Use the length of persistent header string if it's longest */
    stringLength = strlen(_("Persistent"));
    if (stringLength > persistStrLength)
        persistStrLength = stringLength;

    /* Use the length of capacity header string if it's longest */
    stringLength = strlen(_("Capacity"));
    if (stringLength > capStrLength)
        capStrLength = stringLength;

    /* Use the length of allocation header string if it's longest */
    stringLength = strlen(_("Allocation"));
    if (stringLength > allocStrLength)
        allocStrLength = stringLength;

    /* Use the length of available header string if it's longest */
    stringLength = strlen(_("Available"));
    if (stringLength > availStrLength)
        availStrLength = stringLength;

    /* Display the string lengths for debugging. */
    vshDebug(ctl, 5, "Longest name string = %lu chars\n",
             (unsigned long) nameStrLength);
    vshDebug(ctl, 5, "Longest state string = %lu chars\n",
             (unsigned long) stateStrLength);
    vshDebug(ctl, 5, "Longest autostart string = %lu chars\n",
             (unsigned long) autostartStrLength);
    vshDebug(ctl, 5, "Longest persistent string = %lu chars\n",
             (unsigned long) persistStrLength);
    vshDebug(ctl, 5, "Longest capacity string = %lu chars\n",
             (unsigned long) capStrLength);
    vshDebug(ctl, 5, "Longest allocation string = %lu chars\n",
             (unsigned long) allocStrLength);
    vshDebug(ctl, 5, "Longest available string = %lu chars\n",
             (unsigned long) availStrLength);

    /* Create the output template.  Each column is sized according to
     * the longest string.
     */
    char *outputStr;
    ret = virAsprintf(&outputStr,
              "%%-%lus  %%-%lus  %%-%lus  %%-%lus  %%%lus  %%%lus  %%%lus\n",
              (unsigned long) nameStrLength,
              (unsigned long) stateStrLength,
              (unsigned long) autostartStrLength,
              (unsigned long) persistStrLength,
              (unsigned long) capStrLength,
              (unsigned long) allocStrLength,
              (unsigned long) availStrLength);
    if (ret < 0) {
        /* An error occurred creating the string, return */
        goto asprintf_failure;
    }

    /* Display the header */
    vshPrint(ctl, outputStr, _("Name"), _("State"), _("Autostart"),
             _("Persistent"), _("Capacity"), _("Allocation"), _("Available"));
    for (i = nameStrLength + stateStrLength + autostartStrLength
                           + persistStrLength + capStrLength
                           + allocStrLength + availStrLength
                           + 12; i > 0; i--)
        vshPrintExtra(ctl, "-");
    vshPrintExtra(ctl, "\n");

    /* Display the pool info rows */
    for (i = 0; i < numAllPools; i++) {
        vshPrint(ctl, outputStr,
                 poolNames[i],
                 poolInfoTexts[i].state,
                 poolInfoTexts[i].autostart,
                 poolInfoTexts[i].persistent,
                 poolInfoTexts[i].capacity,
                 poolInfoTexts[i].allocation,
                 poolInfoTexts[i].available);
    }

    /* Cleanup and return */
E
Eric Blake 已提交
6362
    functionReturn = true;
6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376
    goto cleanup;

asprintf_failure:

    /* Display an appropriate error message then cleanup and return */
    switch (errno) {
    case ENOMEM:
        /* Couldn't allocate memory */
        vshError(ctl, "%s", _("Out of memory"));
        break;
    default:
        /* Some other error */
        vshError(ctl, _("virAsprintf failed (errno %d)"), errno);
    }
E
Eric Blake 已提交
6377
    functionReturn = false;
6378

6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390
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]);
6391
    }
6392 6393 6394 6395 6396 6397 6398

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

    /* Return the desired value */
    return functionReturn;
6399 6400
}

6401 6402 6403 6404
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
6405 6406
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6407 6408 6409 6410 6411
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6412 6413 6414
     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")},
6415
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
6416 6417 6418
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6419
static bool
6420 6421
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6422
    const char *type = NULL, *host = NULL;
6423 6424
    char *srcSpec = NULL;
    char *srcList;
6425
    const char *initiator = NULL;
6426

6427 6428
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
6429 6430
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
6431
        return false;
6432
    }
6433

6434
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6435
        return false;
6436 6437

    if (host) {
6438
        const char *port = NULL;
6439
        virBuffer buf = VIR_BUFFER_INITIALIZER;
6440 6441 6442 6443

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6444
            return false;
6445
        }
6446
        virBufferAddLit(&buf, "<source>\n");
6447
        virBufferAsprintf(&buf, "  <host name='%s'", host);
6448
        if (port)
6449
            virBufferAsprintf(&buf, " port='%s'", port);
6450
        virBufferAddLit(&buf, "/>\n");
6451 6452
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
6453
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
6454 6455
            virBufferAddLit(&buf, "  </initiator>\n");
        }
6456 6457 6458
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
6459
            return false;
6460
        }
6461
        srcSpec = virBufferContentAndReset(&buf);
6462 6463 6464
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6465
    VIR_FREE(srcSpec);
6466
    if (srcList == NULL) {
6467
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
6468
        return false;
6469 6470
    }
    vshPrint(ctl, "%s", srcList);
6471
    VIR_FREE(srcList);
6472

E
Eric Blake 已提交
6473
    return true;
6474 6475 6476 6477 6478 6479 6480
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
6481 6482
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6483 6484 6485 6486 6487
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6488
     N_("type of storage pool sources to discover")},
6489
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
6490
     N_("optional file of source xml to query for pools")},
6491 6492 6493
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6494
static bool
6495 6496
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6497
    const char *type = NULL, *srcSpecFile = NULL;
6498
    char *srcSpec = NULL, *srcList;
6499

6500
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
6501
        return false;
6502

6503 6504
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
6505
        return false;
6506
    }
6507

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

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
6512
        return false;
6513 6514

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6515
    VIR_FREE(srcSpec);
6516
    if (srcList == NULL) {
6517
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
6518
        return false;
6519 6520
    }
    vshPrint(ctl, "%s", srcList);
6521
    VIR_FREE(srcList);
6522

E
Eric Blake 已提交
6523
    return true;
6524 6525 6526
}


6527 6528 6529
/*
 * "pool-info" command
 */
6530
static const vshCmdInfo info_pool_info[] = {
6531 6532
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
6533 6534 6535
    {NULL, NULL}
};

6536
static const vshCmdOptDef opts_pool_info[] = {
6537
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6538 6539 6540
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6541
static bool
6542
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
6543 6544 6545
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
6546 6547
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
6548
    bool ret = true;
6549 6550
    char uuid[VIR_UUID_STRING_BUFLEN];

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

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6555
        return false;
6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581

    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;
6582 6583 6584 6585
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
6586 6587
        }

6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603
        /* 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"));

6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615
        if (info.state == VIR_STORAGE_POOL_RUNNING ||
            info.state == VIR_STORAGE_POOL_DEGRADED) {
            val = prettyCapacity(info.capacity, &unit);
            vshPrint(ctl, "%-15s %2.2lf %s\n", _("Capacity:"), val, unit);

            val = prettyCapacity(info.allocation, &unit);
            vshPrint(ctl, "%-15s %2.2lf %s\n", _("Allocation:"), val, unit);

            val = prettyCapacity(info.available, &unit);
            vshPrint(ctl, "%-15s %2.2lf %s\n", _("Available:"), val, unit);
        }
    } else {
E
Eric Blake 已提交
6616
        ret = false;
6617 6618 6619 6620 6621 6622 6623 6624 6625 6626
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
6627
static const vshCmdInfo info_pool_name[] = {
6628
    {"help", N_("convert a pool UUID to pool name")},
6629
    {"desc", ""},
6630 6631 6632
    {NULL, NULL}
};

6633
static const vshCmdOptDef opts_pool_name[] = {
6634
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
6635 6636 6637
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6638
static bool
6639
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
6640 6641 6642
{
    virStoragePoolPtr pool;

6643
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6644
        return false;
6645
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6646
                                           VSH_BYUUID)))
E
Eric Blake 已提交
6647
        return false;
6648 6649 6650

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6651
    return true;
6652 6653 6654 6655 6656 6657
}


/*
 * "pool-start" command
 */
6658
static const vshCmdInfo info_pool_start[] = {
6659 6660
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
6661 6662 6663
    {NULL, NULL}
};

6664
static const vshCmdOptDef opts_pool_start[] = {
6665
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
6666 6667 6668
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6669
static bool
6670
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
6671 6672
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6673
    bool ret = true;
6674

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

6678
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
6679
         return false;
6680 6681 6682 6683 6684

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
6685
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
6686
        ret = false;
6687
    }
L
Laine Stump 已提交
6688 6689

    virStoragePoolFree(pool);
6690 6691 6692 6693
    return ret;
}


6694 6695 6696
/*
 * "vol-create-as" command
 */
6697
static const vshCmdInfo info_vol_create_as[] = {
6698 6699
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
6700 6701 6702
    {NULL, NULL}
};

6703
static const vshCmdOptDef opts_vol_create_as[] = {
6704 6705 6706 6707 6708
    {"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")},
6709 6710
    {"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")},
6711 6712 6713 6714 6715 6716 6717 6718 6719 6720
    {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 已提交
6721
        /* Deliberate fallthrough cases here :-) */
6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741
        switch (*end) {
        case 'T':
            *val *= 1024;
        case 'G':
            *val *= 1024;
        case 'M':
            *val *= 1024;
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
6742
static bool
6743
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
6744 6745 6746
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
6747
    char *xml;
6748 6749
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
6750
    unsigned long long capacity, allocation = 0;
6751
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6752

6753
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6754
        return false;
6755 6756 6757

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

6760
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6761 6762
        goto cleanup;

6763
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
6764 6765
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
6766
        vshError(ctl, _("Malformed size %s"), capacityStr);
6767

6768 6769
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
6770
        vshError(ctl, _("Malformed size %s"), allocationStr);
6771

6772 6773 6774 6775 6776 6777 6778
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

6779

6780
    virBufferAddLit(&buf, "<volume>\n");
6781 6782
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
6783
    if (allocationStr)
6784
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
6785 6786

    if (format) {
6787
        virBufferAddLit(&buf, "  <target>\n");
6788
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
6789
        virBufferAddLit(&buf, "  </target>\n");
6790
    }
6791

6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
        vshDebug(ctl, 5, "%s: Look up backing store volume '%s' as name\n",
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
                vshDebug(ctl, 5, "%s: Backing store volume found using '%s' as name\n",
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
            vshDebug(ctl, 5, "%s: Look up backing store volume '%s' as key\n",
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
                vshDebug(ctl, 5, "%s: Backing store volume found using '%s' as key\n",
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
            vshDebug(ctl, 5, "%s: Look up backing store volume '%s' as path\n",
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
                vshDebug(ctl, 5, "%s: Backing store volume found using '%s' as path\n",
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
E
Eric Blake 已提交
6825
            return false;
6826 6827 6828 6829 6830
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
6831
            return false;
6832 6833 6834 6835
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
6836
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
6837
        if (snapshotStrFormat)
6838
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
6839 6840 6841 6842 6843 6844 6845 6846
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

6848 6849
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
6850
        return false;
6851 6852 6853
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
6854
    VIR_FREE(xml);
6855 6856 6857 6858 6859
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
6860
        return true;
6861
    } else {
6862
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
6863
        return false;
6864 6865 6866
    }

 cleanup:
6867
    virBufferFreeAndReset(&buf);
6868
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6869
    return false;
6870 6871 6872
}


6873 6874 6875
/*
 * "pool-undefine" command
 */
6876
static const vshCmdInfo info_pool_undefine[] = {
6877 6878
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
6879 6880 6881
    {NULL, NULL}
};

6882
static const vshCmdOptDef opts_pool_undefine[] = {
6883
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6884 6885 6886
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6887
static bool
6888
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
6889 6890
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6891
    bool ret = true;
6892
    const char *name;
6893

6894
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6895
        return false;
6896 6897

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6898
        return false;
6899 6900 6901 6902

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

L
Laine Stump 已提交
6907
    virStoragePoolFree(pool);
6908 6909 6910 6911 6912 6913 6914
    return ret;
}


/*
 * "pool-uuid" command
 */
6915
static const vshCmdInfo info_pool_uuid[] = {
6916
    {"help", N_("convert a pool name to pool UUID")},
6917
    {"desc", ""},
6918 6919 6920
    {NULL, NULL}
};

6921
static const vshCmdOptDef opts_pool_uuid[] = {
6922
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
6923 6924 6925
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6926
static bool
6927
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
6928 6929 6930 6931
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

6932
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6933
        return false;
6934 6935

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6936
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6937
        return false;
6938 6939 6940 6941

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

L
Laine Stump 已提交
6944
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6945
    return true;
6946 6947 6948 6949 6950 6951
}


/*
 * "vol-create" command
 */
6952
static const vshCmdInfo info_vol_create[] = {
6953 6954
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
6955 6956 6957
    {NULL, NULL}
};

6958
static const vshCmdOptDef opts_vol_create[] = {
6959 6960
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
6961 6962 6963
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6964
static bool
6965
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
6966 6967 6968
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
6969
    const char *from = NULL;
E
Eric Blake 已提交
6970
    bool ret = true;
6971 6972
    char *buffer;

6973
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6974
        return false;
6975 6976

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

6980
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
6981
        virStoragePoolFree(pool);
E
Eric Blake 已提交
6982
        return false;
6983 6984 6985
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
6986
        virshReportError(ctl);
6987
        virStoragePoolFree(pool);
E
Eric Blake 已提交
6988
        return false;
6989 6990 6991
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
6992
    VIR_FREE(buffer);
6993 6994 6995 6996 6997 6998 6999
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
7000
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
7001
        ret = false;
7002 7003 7004 7005
    }
    return ret;
}

7006 7007 7008 7009
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
7010 7011
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
7012 7013 7014 7015
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
7016 7017 7018
    {"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 已提交
7019
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
7020 7021 7022
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7023
static bool
7024 7025 7026 7027
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
7028
    const char *from = NULL;
E
Eric Blake 已提交
7029
    bool ret = false;
7030 7031
    char *buffer = NULL;

7032
    if (!vshConnectionUsability(ctl, ctl->conn))
7033 7034 7035 7036 7037
        goto cleanup;

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

7038
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7039 7040 7041 7042 7043 7044 7045
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7046
        virshReportError(ctl);
7047 7048 7049 7050 7051 7052 7053 7054 7055
        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 {
7056
        vshError(ctl, _("Failed to create vol from %s"), from);
7057 7058 7059
        goto cleanup;
    }

E
Eric Blake 已提交
7060
    ret = true;
7061
cleanup:
7062
    VIR_FREE(buffer);
7063 7064 7065 7066
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
7067 7068
    if (newvol)
        virStorageVolFree(newvol);
7069 7070 7071 7072
    return ret;
}

static xmlChar *
7073
makeCloneXML(const char *origxml, const char *newname) {
7074

7075 7076 7077
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107
    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[] = {
7108 7109
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
7110 7111 7112 7113
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
7114 7115
    {"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 已提交
7116
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7117 7118 7119
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7120
static bool
7121 7122 7123 7124
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
7125
    const char *name = NULL;
7126
    char *origxml = NULL;
7127
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
7128
    bool ret = false;
7129

7130
    if (!vshConnectionUsability(ctl, ctl->conn))
7131 7132 7133 7134 7135 7136 7137
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
7138
        vshError(ctl, "%s", _("failed to get parent pool"));
7139 7140 7141
        goto cleanup;
    }

7142
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160
        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 {
7161
        vshError(ctl, _("Failed to clone vol from %s"),
7162 7163 7164 7165
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
7166
    ret = true;
7167 7168

cleanup:
7169
    VIR_FREE(origxml);
7170 7171 7172
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
7173 7174
    if (newvol)
        virStorageVolFree(newvol);
7175 7176 7177 7178 7179
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192

/*
 * "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 已提交
7193
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207
    {"offset", VSH_OT_INT, 0, N_("volume offset to upload to") },
    {"length", VSH_OT_INT, 0, N_("amount of data to upload") },
    {NULL, 0, 0, NULL}
};

static int
cmdVolUploadSource(virStreamPtr st ATTRIBUTE_UNUSED,
                   char *bytes, size_t nbytes, void *opaque)
{
    int *fd = opaque;

    return saferead(*fd, bytes, nbytes);
}

E
Eric Blake 已提交
7208
static bool
7209 7210 7211 7212
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7213
    bool ret = false;
7214 7215 7216 7217 7218 7219 7220 7221 7222 7223
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;

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

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7224
        return false;
7225 7226 7227 7228
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7229
        return false;
7230 7231 7232
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7233
        return false;
7234 7235 7236 7237 7238 7239 7240 7241 7242 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
    }

    if (vshCommandOptString(cmd, "file", &file) < 0) {
        vshError(ctl, _("file must not be empty"));
        goto cleanup;
    }

    if ((fd = open(file, O_RDONLY)) < 0) {
        vshError(ctl, _("cannot read %s"), file);
        goto cleanup;
    }

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

    if (virStreamSendAll(st, cmdVolUploadSource, &fd) < 0) {
        vshError(ctl, _("cannot send data to volume %s"), name);
        goto cleanup;
    }

    if (VIR_CLOSE(fd) < 0) {
        vshError(ctl, _("cannot close file %s"), file);
        virStreamAbort(st);
        goto cleanup;
    }

    if (virStreamFinish(st) < 0) {
        vshError(ctl, _("cannot close volume %s"), name);
        goto cleanup;
    }

E
Eric Blake 已提交
7268
    ret = true;
7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292

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 已提交
7293
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308
    {"offset", VSH_OT_INT, 0, N_("volume offset to download from") },
    {"length", VSH_OT_INT, 0, N_("amount of data to download") },
    {NULL, 0, 0, NULL}
};


static int
cmdVolDownloadSink(virStreamPtr st ATTRIBUTE_UNUSED,
                   const char *bytes, size_t nbytes, void *opaque)
{
    int *fd = opaque;

    return safewrite(*fd, bytes, nbytes);
}

E
Eric Blake 已提交
7309
static bool
7310 7311 7312 7313
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7314
    bool ret = false;
7315 7316 7317 7318
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
7319
    bool created = false;
7320 7321

    if (!vshConnectionUsability(ctl, ctl->conn))
7322
        return false;
7323 7324 7325

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7326
        return false;
7327 7328 7329 7330
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7331
        return false;
7332 7333 7334
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
7335
        return false;
7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347

    if (vshCommandOptString(cmd, "file", &file) < 0) {
        vshError(ctl, _("file must not be empty"));
        goto cleanup;
    }

    if ((fd = open(file, O_WRONLY|O_CREAT|O_EXCL, 0666)) < 0) {
        if (errno != EEXIST ||
            (fd = open(file, O_WRONLY|O_TRUNC, 0666)) < 0) {
            vshError(ctl, _("cannot create %s"), file);
            goto cleanup;
        }
7348 7349
    } else {
        created = true;
7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373
    }

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

    if (virStreamRecvAll(st, cmdVolDownloadSink, &fd) < 0) {
        vshError(ctl, _("cannot receive data from volume %s"), name);
        goto cleanup;
    }

    if (VIR_CLOSE(fd) < 0) {
        vshError(ctl, _("cannot close file %s"), file);
        virStreamAbort(st);
        goto cleanup;
    }

    if (virStreamFinish(st) < 0) {
        vshError(ctl, _("cannot close volume %s"), name);
        goto cleanup;
    }

E
Eric Blake 已提交
7374
    ret = true;
7375 7376

cleanup:
7377
    VIR_FORCE_CLOSE(fd);
7378
    if (!ret && created)
7379 7380 7381 7382 7383 7384 7385 7386 7387
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


7388 7389 7390
/*
 * "vol-delete" command
 */
7391
static const vshCmdInfo info_vol_delete[] = {
7392 7393
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
7394 7395 7396
    {NULL, NULL}
};

7397
static const vshCmdOptDef opts_vol_delete[] = {
7398
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7399
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7400 7401 7402
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7403
static bool
7404
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
7405 7406
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7407
    bool ret = true;
7408
    const char *name;
7409

7410
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7411
        return false;
7412 7413

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7414
        return false;
7415 7416 7417
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
7418
        vshPrint(ctl, _("Vol %s deleted\n"), name);
7419
    } else {
7420
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
7421
        ret = false;
7422 7423
    }

L
Laine Stump 已提交
7424
    virStorageVolFree(vol);
7425 7426 7427 7428
    return ret;
}


D
David Allan 已提交
7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439
/*
 * "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 已提交
7440
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
7441 7442 7443
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7444
static bool
D
David Allan 已提交
7445 7446 7447
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7448
    bool ret = true;
7449
    const char *name;
D
David Allan 已提交
7450

7451
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7452
        return false;
D
David Allan 已提交
7453 7454

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7455
        return false;
D
David Allan 已提交
7456 7457 7458 7459 7460 7461
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
7462
        ret = false;
D
David Allan 已提交
7463 7464 7465 7466 7467 7468 7469
    }

    virStorageVolFree(vol);
    return ret;
}


7470 7471 7472
/*
 * "vol-info" command
 */
7473
static const vshCmdInfo info_vol_info[] = {
7474 7475
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
7476 7477 7478
    {NULL, NULL}
};

7479
static const vshCmdOptDef opts_vol_info[] = {
7480
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7481
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7482 7483 7484
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7485
static bool
7486
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
7487 7488 7489
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
7490
    bool ret = true;
7491

7492
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7493
        return false;
7494 7495

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
7496
        return false;
7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512

    vshPrint(ctl, "%-15s %s\n", _("Name:"), virStorageVolGetName(vol));

    if (virStorageVolGetInfo(vol, &info) == 0) {
        double val;
        const char *unit;
        vshPrint(ctl, "%-15s %s\n", _("Type:"),
                 info.type == VIR_STORAGE_VOL_FILE ?
                 _("file") : _("block"));

        val = prettyCapacity(info.capacity, &unit);
        vshPrint(ctl, "%-15s %2.2lf %s\n", _("Capacity:"), val, unit);

        val = prettyCapacity(info.allocation, &unit);
        vshPrint(ctl, "%-15s %2.2lf %s\n", _("Allocation:"), val, unit);
    } else {
E
Eric Blake 已提交
7513
        ret = false;
7514 7515 7516 7517 7518 7519 7520 7521 7522 7523
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
7524
static const vshCmdInfo info_vol_dumpxml[] = {
7525 7526
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
7527 7528 7529
    {NULL, NULL}
};

7530
static const vshCmdOptDef opts_vol_dumpxml[] = {
7531
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7532
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7533 7534 7535
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7536
static bool
7537
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
7538 7539
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7540
    bool ret = true;
7541 7542
    char *dump;

7543
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7544
        return false;
7545 7546

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
7547
        return false;
7548 7549 7550

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
7551
        vshPrint(ctl, "%s", dump);
7552
        VIR_FREE(dump);
7553
    } else {
E
Eric Blake 已提交
7554
        ret = false;
7555 7556 7557 7558 7559 7560 7561 7562 7563 7564
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
7565
static const vshCmdInfo info_vol_list[] = {
7566 7567
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
7568 7569 7570
    {NULL, NULL}
};

7571
static const vshCmdOptDef opts_vol_list[] = {
7572
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7573
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
7574 7575 7576
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7577
static bool
7578
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7579
{
7580
    virStorageVolInfo volumeInfo;
7581 7582
    virStoragePoolPtr pool;
    char **activeNames = NULL;
7583 7584 7585 7586 7587
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
7588 7589
    int ret;
    bool functionReturn;
7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600
    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;
7601

7602
    /* Check the connection to libvirtd daemon is still working */
7603
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7604
        return false;
7605

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

7610 7611
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
7612

7613 7614 7615
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7616
        return false;
7617 7618
    }

7619 7620 7621 7622 7623
    /* 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) {
7624
            vshError(ctl, "%s", _("Failed to list active vols"));
7625
            VIR_FREE(activeNames);
7626
            virStoragePoolFree(pool);
E
Eric Blake 已提交
7627
            return false;
7628 7629
        }

7630 7631 7632 7633 7634
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

7637 7638 7639 7640 7641
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
7642

7643 7644 7645 7646
        /* 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"));
7647 7648
        }

7649 7650 7651 7652 7653 7654 7655 7656 7657
        /* 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 */
7658

7659 7660 7661 7662 7663 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
                /* 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;
        }
7714

7715
        /* Cleanup memory allocation */
7716
        virStorageVolFree(vol);
7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734
    }

    /* If the --details option wasn't selected, we output the volume
     * info using the fixed string format from previous versions to
     * maintain backward compatibility.
     */

    /* Output basic info then return if --details option not selected */
    if (!details) {
        /* The old output format */
        vshPrintExtra(ctl, "%-20s %-40s\n", _("Name"), _("Path"));
        vshPrintExtra(ctl, "-----------------------------------------\n");
        for (i = 0; i < numVolumes; i++) {
            vshPrint(ctl, "%-20s %-40s\n", activeNames[i],
                     volInfoTexts[i].path);
        }

        /* Cleanup and return */
E
Eric Blake 已提交
7735
        functionReturn = true;
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
        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 已提交
7767 7768 7769 7770 7771
    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);
7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805

    /* Create the output template */
    ret = virAsprintf(&outputStr,
                      "%%-%lus  %%-%lus  %%-%lus  %%%lus  %%%lus\n",
                      (unsigned long) nameStrLength,
                      (unsigned long) pathStrLength,
                      (unsigned long) typeStrLength,
                      (unsigned long) capStrLength,
                      (unsigned long) allocStrLength);
    if (ret < 0) {
        /* An error occurred creating the string, return */
        goto asprintf_failure;
    }

    /* Display the header */
    vshPrint(ctl, outputStr, _("Name"), _("Path"), _("Type"),
             ("Capacity"), _("Allocation"));
    for (i = nameStrLength + pathStrLength + typeStrLength
                           + capStrLength + allocStrLength
                           + 8; i > 0; i--)
        vshPrintExtra(ctl, "-");
    vshPrintExtra(ctl, "\n");

    /* Display the volume info rows */
    for (i = 0; i < numVolumes; i++) {
        vshPrint(ctl, outputStr,
                 activeNames[i],
                 volInfoTexts[i].path,
                 volInfoTexts[i].type,
                 volInfoTexts[i].capacity,
                 volInfoTexts[i].allocation);
    }

    /* Cleanup and return */
E
Eric Blake 已提交
7806
    functionReturn = true;
7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820
    goto cleanup;

asprintf_failure:

    /* Display an appropriate error message then cleanup and return */
    switch (errno) {
    case ENOMEM:
        /* Couldn't allocate memory */
        vshError(ctl, "%s", _("Out of memory"));
        break;
    default:
        /* Some other error */
        vshError(ctl, _("virAsprintf failed (errno %d)"), errno);
    }
E
Eric Blake 已提交
7821
    functionReturn = false;
7822 7823 7824 7825 7826 7827 7828 7829 7830 7831

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);
7832
        VIR_FREE(activeNames[i]);
7833
    }
7834 7835 7836 7837

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
7838
    VIR_FREE(activeNames);
7839
    virStoragePoolFree(pool);
7840 7841 7842

    /* Return the desired value */
    return functionReturn;
7843 7844 7845 7846 7847 7848
}


/*
 * "vol-name" command
 */
7849
static const vshCmdInfo info_vol_name[] = {
7850
    {"help", N_("returns the volume name for a given volume key or path")},
7851
    {"desc", ""},
7852 7853 7854
    {NULL, NULL}
};

7855
static const vshCmdOptDef opts_vol_name[] = {
7856
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
7857 7858 7859
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7860
static bool
7861
cmdVolName(vshControl *ctl, const vshCmd *cmd)
7862 7863 7864
{
    virStorageVolPtr vol;

7865
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7866
        return false;
7867 7868 7869

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
E
Eric Blake 已提交
7870
        return false;
7871 7872 7873

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
7874
    return true;
7875 7876 7877
}


J
Justin Clift 已提交
7878 7879 7880 7881 7882 7883 7884 7885 7886 7887
/*
 * "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[] = {
7888
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
7889 7890 7891 7892
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7893
static bool
J
Justin Clift 已提交
7894 7895 7896 7897
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7898
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
7899 7900

    /* Check the connection to libvirtd daemon is still working */
7901
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7902
        return false;
J
Justin Clift 已提交
7903 7904 7905 7906

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
7907
        return false;
J
Justin Clift 已提交
7908 7909 7910 7911 7912 7913 7914
    }

    /* Look up the parent storage pool for the volume */
    pool = virStoragePoolLookupByVolume(vol);
    if (pool == NULL) {
        vshError(ctl, "%s", _("failed to get parent pool"));
        virStorageVolFree(vol);
E
Eric Blake 已提交
7915
        return false;
J
Justin Clift 已提交
7916 7917
    }

7918 7919 7920 7921 7922 7923 7924 7925 7926
    /* 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 已提交
7927 7928 7929 7930

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7931
    return true;
J
Justin Clift 已提交
7932 7933
}

7934 7935 7936 7937

/*
 * "vol-key" command
 */
7938
static const vshCmdInfo info_vol_key[] = {
7939
    {"help", N_("returns the volume key for a given volume name or path")},
7940
    {"desc", ""},
7941 7942 7943
    {NULL, NULL}
};

7944
static const vshCmdOptDef opts_vol_key[] = {
7945
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
7946
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7947 7948 7949
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7950
static bool
7951
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
7952 7953 7954
{
    virStorageVolPtr vol;

7955
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7956
        return false;
7957

7958
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
7959
        return false;
7960 7961 7962

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
7963
    return true;
7964 7965 7966 7967 7968 7969 7970
}



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

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

E
Eric Blake 已提交
7983
static bool
7984
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
7985 7986
{
    virStorageVolPtr vol;
7987
    const char *name = NULL;
7988

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

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7993
        return false;
7994
    }
7995 7996 7997

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


8002 8003 8004 8005
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
8006 8007
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
8008 8009
    {NULL, NULL}
};
8010

8011
static const vshCmdOptDef opts_secret_define[] = {
8012
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
8013 8014
    {NULL, 0, 0, NULL}
};
8015

E
Eric Blake 已提交
8016
static bool
8017 8018
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
8019
    const char *from = NULL;
8020
    char *buffer;
8021
    virSecretPtr res;
8022
    char uuid[VIR_UUID_STRING_BUFLEN];
8023

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

8027
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8028
        return false;
8029 8030

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
8034
    VIR_FREE(buffer);
8035 8036

    if (res == NULL) {
8037
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
8038
        return false;
8039
    }
8040
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
8041
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
8042
        virSecretFree(res);
E
Eric Blake 已提交
8043
        return false;
8044 8045 8046
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
8047
    return true;
8048 8049 8050 8051 8052 8053
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
8054 8055
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
8056 8057 8058 8059
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
8060
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8061 8062 8063
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8064
static bool
8065 8066 8067
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8068
    bool ret = false;
8069 8070
    char *xml;

8071
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8072
        return false;
8073 8074 8075

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8076
        return false;
8077 8078 8079 8080

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
8081
    vshPrint(ctl, "%s", xml);
8082
    VIR_FREE(xml);
E
Eric Blake 已提交
8083
    ret = true;
8084 8085 8086 8087 8088 8089 8090 8091 8092 8093

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
8094 8095
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
8096 8097 8098 8099
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
8100 8101
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
8102 8103 8104
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8105
static bool
8106 8107 8108 8109
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
8110
    const char *base64 = NULL;
8111
    char *value;
E
Eric Blake 已提交
8112 8113
    int res;
    bool ret = false;
8114

8115
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8116
        return false;
8117 8118 8119

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

8122
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
8123 8124 8125
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
8126
        vshError(ctl, "%s", _("Invalid base64 data"));
8127 8128 8129
        goto cleanup;
    }
    if (value == NULL) {
8130
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
8131
        return false;
8132 8133 8134 8135
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
8136
    VIR_FREE(value);
8137 8138

    if (res != 0) {
8139
        vshError(ctl, "%s", _("Failed to set secret value"));
8140 8141 8142
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
8143
    ret = true;
8144 8145 8146 8147 8148 8149 8150 8151 8152 8153

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
8154 8155
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
8156 8157 8158 8159
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
8160
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8161 8162 8163
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8164
static bool
8165 8166 8167 8168 8169 8170
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
8171
    bool ret = false;
8172

8173
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8174
        return false;
8175 8176 8177

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8178
        return false;
8179 8180 8181 8182 8183 8184 8185

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
8186
    VIR_FREE(value);
8187 8188

    if (base64 == NULL) {
8189
        vshError(ctl, "%s", _("Failed to allocate memory"));
8190 8191
        goto cleanup;
    }
8192
    vshPrint(ctl, "%s", base64);
8193
    memset(base64, 0, strlen(base64));
8194
    VIR_FREE(base64);
E
Eric Blake 已提交
8195
    ret = true;
8196 8197 8198 8199 8200 8201 8202 8203 8204 8205

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
8206 8207
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
8208 8209 8210 8211
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
8212
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8213 8214 8215
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8216
static bool
8217 8218 8219
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8220
    bool ret = false;
8221
    const char *uuid;
8222

8223
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8224
        return false;
8225 8226 8227

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
8228
        return false;
8229 8230

    if (virSecretUndefine(secret) < 0) {
8231
        vshError(ctl, _("Failed to delete secret %s"), uuid);
8232 8233 8234
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
8235
    ret = true;
8236 8237 8238 8239 8240 8241 8242 8243 8244 8245

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
8246 8247
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
8248 8249 8250
    {NULL, NULL}
};

E
Eric Blake 已提交
8251
static bool
8252 8253 8254 8255 8256
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

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

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
8262
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
8263
        return false;
8264 8265 8266 8267 8268
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
8269
        vshError(ctl, "%s", _("Failed to list secrets"));
8270
        VIR_FREE(uuids);
E
Eric Blake 已提交
8271
        return false;
8272 8273 8274 8275
    }

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

8276 8277
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
8278 8279

    for (i = 0; i < maxuuids; i++) {
8280 8281 8282 8283
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
8284
            VIR_FREE(uuids[i]);
8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302
            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);
8303
        VIR_FREE(uuids[i]);
8304
    }
8305
    VIR_FREE(uuids);
E
Eric Blake 已提交
8306
    return true;
8307
}
8308 8309 8310 8311 8312


/*
 * "version" command
 */
8313
static const vshCmdInfo info_version[] = {
8314 8315
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
8316 8317 8318 8319
    {NULL, NULL}
};


E
Eric Blake 已提交
8320
static bool
8321
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332
{
    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;

8333
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8334
        return false;
8335 8336 8337

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
8338
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
8339
        return false;
8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351
    }

    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) {
8352
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
8353
        return false;
8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370
    }
    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) {
8371
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
8372
        return false;
8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385
    }
    if (hvVersion == 0) {
        vshPrint(ctl,
                 _("Cannot extract running %s hypervisor version\n"), hvType);
    } else {
        major = hvVersion / 1000000;
        hvVersion %= 1000000;
        minor = hvVersion / 1000;
        rel = hvVersion % 1000;

        vshPrint(ctl, _("Running hypervisor: %s %d.%d.%d\n"),
                 hvType, major, minor, rel);
    }
E
Eric Blake 已提交
8386
    return true;
8387 8388
}

8389 8390 8391 8392
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
8393
    {"help", N_("enumerate devices on this host")},
8394
    {"desc", ""},
8395 8396 8397 8398
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
8399 8400
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
8401 8402 8403
    {NULL, 0, 0, NULL}
};

8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425
#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] = '-';
8426 8427
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
8428 8429 8430
    }

    /* Print this device */
8431
    vshPrint(ctl, "%s", indentBuf);
8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454
    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) {
8455
        vshPrint(ctl, "%s", indentBuf);
8456
        vshPrint(ctl, " |\n");
8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478
    }

    /* 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) {
8479
        vshPrint(ctl, "%s", indentBuf);
8480 8481 8482 8483
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
8484
static bool
8485 8486
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
8487
    const char *cap = NULL;
8488
    char **devices;
8489
    int num_devices, i;
8490
    int tree = vshCommandOptBool(cmd, "tree");
8491

8492
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8493
        return false;
8494

8495
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
8496 8497 8498 8499
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
8500
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
8501
        return false;
8502
    } else if (num_devices == 0) {
E
Eric Blake 已提交
8503
        return true;
8504 8505 8506 8507 8508 8509
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
8510
        vshError(ctl, "%s", _("Failed to list node devices"));
8511
        VIR_FREE(devices);
E
Eric Blake 已提交
8512
        return false;
8513
    }
8514
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
8515 8516 8517 8518 8519 8520 8521
    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 已提交
8522
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541
            } 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++) {
8542 8543
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
8544
        }
8545
        VIR_FREE(parents);
8546 8547 8548
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
8549
            VIR_FREE(devices[i]);
8550
        }
8551
    }
8552
    VIR_FREE(devices);
E
Eric Blake 已提交
8553
    return true;
8554 8555 8556 8557 8558 8559
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
8560 8561
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
8562 8563 8564 8565 8566
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
8567
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8568 8569 8570
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8571
static bool
8572 8573
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
8574
    const char *name = NULL;
8575
    virNodeDevicePtr device;
L
Laine Stump 已提交
8576
    char *xml;
8577

8578
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8579
        return false;
8580
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8581
        return false;
8582
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8583
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8584
        return false;
8585 8586
    }

L
Laine Stump 已提交
8587 8588 8589
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
8590
        return false;
L
Laine Stump 已提交
8591 8592 8593
    }

    vshPrint(ctl, "%s\n", xml);
8594
    VIR_FREE(xml);
8595
    virNodeDeviceFree(device);
E
Eric Blake 已提交
8596
    return true;
8597 8598
}

8599 8600 8601 8602
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
8603 8604
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
8605 8606 8607 8608 8609
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
8610
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8611 8612 8613
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8614
static bool
8615 8616
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
8617
    const char *name = NULL;
8618
    virNodeDevicePtr device;
E
Eric Blake 已提交
8619
    bool ret = true;
8620

8621
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8622
        return false;
8623
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8624
        return false;
8625
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8626
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8627
        return false;
8628 8629 8630 8631 8632
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
8633
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
8634
        ret = false;
8635 8636 8637 8638 8639 8640 8641 8642 8643
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
8644 8645
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
8646 8647 8648 8649 8650
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
8651
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8652 8653 8654
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8655
static bool
8656 8657
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
8658
    const char *name = NULL;
8659
    virNodeDevicePtr device;
E
Eric Blake 已提交
8660
    bool ret = true;
8661

8662
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8663
        return false;
8664
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8665
        return false;
8666
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8667
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8668
        return false;
8669 8670 8671 8672 8673
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
8674
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
8675
        ret = false;
8676 8677 8678 8679 8680 8681 8682 8683 8684
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
8685 8686
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
8687 8688 8689 8690 8691
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
8692
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8693 8694 8695
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8696
static bool
8697 8698
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
8699
    const char *name = NULL;
8700
    virNodeDevicePtr device;
E
Eric Blake 已提交
8701
    bool ret = true;
8702

8703
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8704
        return false;
8705
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8706
        return false;
8707
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8708
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8709
        return false;
8710 8711 8712 8713 8714
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
8715
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
8716
        ret = false;
8717 8718 8719 8720 8721
    }
    virNodeDeviceFree(device);
    return ret;
}

8722
/*
E
Eric Blake 已提交
8723
 * "hostname" command
8724
 */
8725
static const vshCmdInfo info_hostname[] = {
8726
    {"help", N_("print the hypervisor hostname")},
8727
    {"desc", ""},
8728 8729 8730
    {NULL, NULL}
};

E
Eric Blake 已提交
8731
static bool
8732
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8733 8734 8735
{
    char *hostname;

8736
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8737
        return false;
8738 8739 8740

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
8741
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
8742
        return false;
8743 8744 8745
    }

    vshPrint (ctl, "%s\n", hostname);
8746
    VIR_FREE(hostname);
8747

E
Eric Blake 已提交
8748
    return true;
8749 8750 8751 8752 8753
}

/*
 * "uri" command
 */
8754
static const vshCmdInfo info_uri[] = {
8755
    {"help", N_("print the hypervisor canonical URI")},
8756
    {"desc", ""},
8757 8758 8759
    {NULL, NULL}
};

E
Eric Blake 已提交
8760
static bool
8761
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8762 8763 8764
{
    char *uri;

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

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
8770
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
8771
        return false;
8772 8773 8774
    }

    vshPrint (ctl, "%s\n", uri);
8775
    VIR_FREE(uri);
8776

E
Eric Blake 已提交
8777
    return true;
8778 8779
}

E
Eric Blake 已提交
8780 8781 8782 8783 8784 8785 8786 8787 8788 8789
/*
 * "sysinfo" command
 */
static const vshCmdInfo info_sysinfo[] = {
    {"help", N_("print the hypervisor sysinfo")},
    {"desc",
     N_("output an XML string for the hypervisor sysinfo, if available")},
    {NULL, NULL}
};

E
Eric Blake 已提交
8790
static bool
E
Eric Blake 已提交
8791 8792 8793 8794 8795
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

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

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
8801
        return false;
E
Eric Blake 已提交
8802 8803 8804 8805 8806
    }

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

E
Eric Blake 已提交
8807
    return true;
E
Eric Blake 已提交
8808 8809
}

8810 8811 8812
/*
 * "vncdisplay" command
 */
8813
static const vshCmdInfo info_vncdisplay[] = {
8814 8815
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
8816 8817 8818
    {NULL, NULL}
};

8819
static const vshCmdOptDef opts_vncdisplay[] = {
8820
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8821 8822 8823
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8824
static bool
8825
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
8826 8827 8828 8829 8830
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
8831
    bool ret = false;
8832 8833 8834
    int port = 0;
    char *doc;

8835
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8836
        return false;
8837

J
Jim Meyering 已提交
8838
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
8839
        return false;
8840 8841 8842 8843 8844 8845 8846 8847

    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);
8848
    VIR_FREE(doc);
8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866
    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) ||
8867
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
8868 8869 8870 8871 8872 8873
        vshPrint(ctl, ":%d\n", port-5900);
    } else {
        vshPrint(ctl, "%s:%d\n", (const char *)obj->stringval, port-5900);
    }
    xmlXPathFreeObject(obj);
    obj = NULL;
E
Eric Blake 已提交
8874
    ret = true;
8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887

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

/*
 * "ttyconsole" command
 */
8888
static const vshCmdInfo info_ttyconsole[] = {
8889 8890
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
8891 8892 8893
    {NULL, NULL}
};

8894
static const vshCmdOptDef opts_ttyconsole[] = {
8895
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8896 8897 8898
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8899
static bool
8900
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
8901 8902 8903 8904 8905
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
8906
    bool ret = false;
8907 8908
    char *doc;

8909
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8910
        return false;
8911

J
Jim Meyering 已提交
8912
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
8913
        return false;
8914 8915 8916 8917 8918 8919 8920 8921

    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);
8922
    VIR_FREE(doc);
8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        goto cleanup;

    obj = xmlXPathEval(BAD_CAST "string(/domain/devices/console/@tty)", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_STRING) ||
        (obj->stringval == NULL) || (obj->stringval[0] == 0)) {
        goto cleanup;
    }
    vshPrint(ctl, "%s\n", (const char *)obj->stringval);
E
Eric Blake 已提交
8935
    ret = true;
8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947

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

/*
 * "attach-device" command
8948
 */
8949
static const vshCmdInfo info_attach_device[] = {
8950 8951
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
8952 8953 8954
    {NULL, NULL}
};

8955
static const vshCmdOptDef opts_attach_device[] = {
8956 8957 8958
    {"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")},
8959 8960 8961
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8962
static bool
8963
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
8964 8965
{
    virDomainPtr dom;
8966
    const char *from = NULL;
8967
    char *buffer;
W
Wen Congyang 已提交
8968
    int ret;
J
Jim Fehlig 已提交
8969
    unsigned int flags;
8970

8971
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8972
        return false;
8973

J
Jim Meyering 已提交
8974
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
8975
        return false;
8976

8977
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8978
        virDomainFree(dom);
E
Eric Blake 已提交
8979
        return false;
8980 8981
    }

8982
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8983
        virshReportError(ctl);
8984
        virDomainFree(dom);
E
Eric Blake 已提交
8985
        return false;
8986
    }
8987

J
Jim Fehlig 已提交
8988 8989 8990 8991 8992 8993 8994 8995
    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);
    }
8996
    VIR_FREE(buffer);
8997 8998

    if (ret < 0) {
8999
        vshError(ctl, _("Failed to attach device from %s"), from);
9000
        virDomainFree(dom);
E
Eric Blake 已提交
9001
        return false;
9002
    } else {
J
Jim Meyering 已提交
9003
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
9004 9005 9006
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9007
    return true;
9008 9009 9010 9011 9012 9013
}


/*
 * "detach-device" command
 */
9014
static const vshCmdInfo info_detach_device[] = {
9015 9016
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
9017 9018 9019
    {NULL, NULL}
};

9020
static const vshCmdOptDef opts_detach_device[] = {
9021 9022 9023
    {"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")},
9024 9025 9026
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9027
static bool
9028
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
9029 9030
{
    virDomainPtr dom;
9031
    const char *from = NULL;
9032
    char *buffer;
W
Wen Congyang 已提交
9033
    int ret;
J
Jim Fehlig 已提交
9034
    unsigned int flags;
9035

9036
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9037
        return false;
9038

J
Jim Meyering 已提交
9039
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9040
        return false;
9041

9042
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9043
        virDomainFree(dom);
E
Eric Blake 已提交
9044
        return false;
9045 9046
    }

9047
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9048
        virshReportError(ctl);
9049
        virDomainFree(dom);
E
Eric Blake 已提交
9050
        return false;
9051
    }
9052

J
Jim Fehlig 已提交
9053 9054 9055 9056 9057 9058 9059 9060
    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);
    }
9061
    VIR_FREE(buffer);
9062 9063

    if (ret < 0) {
9064
        vshError(ctl, _("Failed to detach device from %s"), from);
9065
        virDomainFree(dom);
E
Eric Blake 已提交
9066
        return false;
9067
    } else {
J
Jim Meyering 已提交
9068
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
9069 9070 9071
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9072
    return true;
9073 9074
}

9075

9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088
/*
 * "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")},
9089
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
9090 9091 9092
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9093
static bool
9094 9095 9096
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
9097
    const char *from = NULL;
9098
    char *buffer;
W
Wen Congyang 已提交
9099
    int ret;
9100 9101
    unsigned int flags;

9102
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9103
        return false;
9104 9105

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

9108
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9109
        virDomainFree(dom);
E
Eric Blake 已提交
9110
        return false;
9111 9112 9113
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9114
        virshReportError(ctl);
9115
        virDomainFree(dom);
E
Eric Blake 已提交
9116
        return false;
9117 9118 9119 9120 9121 9122 9123 9124 9125
    }

    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;
    }
9126 9127 9128 9129

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

9130 9131 9132 9133 9134 9135
    ret = virDomainUpdateDeviceFlags(dom, buffer, flags);
    VIR_FREE(buffer);

    if (ret < 0) {
        vshError(ctl, _("Failed to update device from %s"), from);
        virDomainFree(dom);
E
Eric Blake 已提交
9136
        return false;
9137 9138 9139 9140 9141
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9142
    return true;
9143 9144 9145
}


9146 9147 9148
/*
 * "attach-interface" command
 */
9149
static const vshCmdInfo info_attach_interface[] = {
9150 9151
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
9152 9153 9154
    {NULL, NULL}
};

9155
static const vshCmdOptDef opts_attach_interface[] = {
9156 9157 9158 9159 9160 9161
    {"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")},
9162
    {"model", VSH_OT_DATA, 0, N_("model type")},
9163
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
9164 9165 9166
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9167
static bool
9168
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
9169 9170
{
    virDomainPtr dom = NULL;
9171 9172
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
9173
    int typ;
W
Wen Congyang 已提交
9174 9175
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9176
    unsigned int flags;
9177 9178
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9179

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

J
Jim Meyering 已提交
9183
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9184 9185
        goto cleanup;

9186
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9187 9188
        goto cleanup;

9189 9190 9191 9192
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
9193 9194
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
9195
        goto cleanup;
9196
    }
9197 9198

    /* check interface type */
9199
    if (STREQ(type, "network")) {
9200
        typ = 1;
9201
    } else if (STREQ(type, "bridge")) {
9202 9203
        typ = 2;
    } else {
E
Eric Blake 已提交
9204 9205
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
9206 9207 9208 9209
        goto cleanup;
    }

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

9212
    if (typ == 1)
9213
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
9214
    else if (typ == 2)
9215
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
9216

9217
    if (target != NULL)
9218
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9219
    if (mac != NULL)
9220
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
9221
    if (script != NULL)
9222
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
9223
    if (model != NULL)
9224
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
9225

9226
    virBufferAddLit(&buf, "</interface>\n");
9227

9228 9229
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
9230
        goto cleanup;
9231 9232
    }

9233
    xml = virBufferContentAndReset(&buf);
9234

J
Jim Fehlig 已提交
9235 9236 9237 9238
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9239
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
9240
    } else {
9241
        ret = virDomainAttachDevice(dom, xml);
9242
    }
9243

9244 9245
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9246
    if (ret != 0) {
L
Laine Stump 已提交
9247
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
9248 9249
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
9250
        functionReturn = true;
J
Jim Fehlig 已提交
9251
    }
9252 9253 9254 9255

 cleanup:
    if (dom)
        virDomainFree(dom);
9256
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
9257
    return functionReturn;
9258 9259 9260 9261 9262
}

/*
 * "detach-interface" command
 */
9263
static const vshCmdInfo info_detach_interface[] = {
9264 9265
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
9266 9267 9268
    {NULL, NULL}
};

9269
static const vshCmdOptDef opts_detach_interface[] = {
9270 9271 9272 9273
    {"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")},
9274 9275 9276
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9277
static bool
9278
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
9279 9280 9281 9282 9283 9284 9285
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
9286
    const char *mac =NULL, *type = NULL;
9287
    char *doc;
9288
    char buf[64];
E
Eric Blake 已提交
9289
    int i = 0, diff_mac;
W
Wen Congyang 已提交
9290 9291
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
9292
    unsigned int flags;
9293

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

J
Jim Meyering 已提交
9297
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9298 9299
        goto cleanup;

9300
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9301 9302
        goto cleanup;

9303 9304
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
9305
        goto cleanup;
9306
    }
9307 9308 9309 9310 9311 9312 9313 9314

    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);
9315
    VIR_FREE(doc);
9316
    if (!xml) {
9317
        vshError(ctl, "%s", _("Failed to get interface information"));
9318 9319 9320 9321
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9322
        vshError(ctl, "%s", _("Failed to get interface information"));
9323 9324 9325
        goto cleanup;
    }

E
Eric Blake 已提交
9326
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
9327 9328 9329
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9330
        vshError(ctl, _("No found interface whose type is %s"), type);
9331 9332 9333
        goto cleanup;
    }

9334 9335 9336 9337 9338 9339
    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;
    }

9340 9341 9342 9343 9344 9345 9346
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9347 9348 9349 9350 9351
            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);
9352 9353 9354 9355 9356 9357 9358
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9359
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
9360 9361 9362 9363 9364
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9365
        vshError(ctl, "%s", _("Failed to allocate memory"));
9366 9367 9368
        goto cleanup;
    }

9369
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
9370
        vshError(ctl, "%s", _("Failed to create XML"));
9371 9372 9373
        goto cleanup;
    }

J
Jim Fehlig 已提交
9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385
    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 已提交
9386
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
9387
    } else {
J
Jim Meyering 已提交
9388
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
9389
        functionReturn = true;
9390
    }
9391 9392 9393 9394

 cleanup:
    if (dom)
        virDomainFree(dom);
9395
    xmlXPathFreeObject(obj);
9396
    xmlXPathFreeContext(ctxt);
9397 9398 9399 9400
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
9401
    return functionReturn;
9402 9403 9404 9405 9406
}

/*
 * "attach-disk" command
 */
9407
static const vshCmdInfo info_attach_disk[] = {
9408 9409
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
9410 9411 9412
    {NULL, NULL}
};

9413
static const vshCmdOptDef opts_attach_disk[] = {
9414 9415 9416 9417 9418 9419 9420 9421
    {"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")},
9422
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
9423 9424 9425
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9426
static bool
9427
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
9428 9429
{
    virDomainPtr dom = NULL;
9430 9431
    const char *source = NULL, *target = NULL, *driver = NULL,
                *subdriver = NULL, *type = NULL, *mode = NULL;
W
Wen Congyang 已提交
9432 9433
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
9434
    unsigned int flags;
9435
    const char *stype = NULL;
9436 9437
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9438

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

J
Jim Meyering 已提交
9442
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9443 9444
        goto cleanup;

9445
    if (vshCommandOptString(cmd, "source", &source) <= 0)
9446 9447
        goto cleanup;

9448
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9449 9450
        goto cleanup;

9451 9452 9453 9454 9455
    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) {
9456
        vshError(ctl, "%s", _("missing option"));
9457 9458
        goto cleanup;
    }
9459

9460 9461
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
9462
            isFile = true;
9463
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
9464
        isFile = true;
9465 9466 9467
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
9468 9469 9470
    }

    if (mode) {
9471
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
9472 9473
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
9474 9475 9476 9477 9478
            goto cleanup;
        }
    }

    /* Make XML of disk */
9479
    virBufferAsprintf(&buf, "<disk type='%s'",
9480 9481
                      (isFile) ? "file" : "block");
    if (type)
9482
        virBufferAsprintf(&buf, " device='%s'", type);
9483 9484
    virBufferAddLit(&buf, ">\n");

9485
    if (driver || subdriver)
9486
        virBufferAsprintf(&buf, "  <driver");
9487 9488

    if (driver)
9489
        virBufferAsprintf(&buf, " name='%s'", driver);
9490
    if (subdriver)
9491
        virBufferAsprintf(&buf, " type='%s'", subdriver);
9492 9493 9494

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

9496
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
9497 9498
                      (isFile) ? "file" : "dev",
                      source);
9499
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9500
    if (mode)
9501
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
9502 9503

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

9505 9506
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
9507
        return false;
9508 9509
    }

9510
    xml = virBufferContentAndReset(&buf);
9511

J
Jim Fehlig 已提交
9512 9513 9514 9515
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9516
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
9517
    } else {
9518
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
9519
    }
9520

9521 9522
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9523
    if (ret != 0) {
L
Laine Stump 已提交
9524
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
9525 9526
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
9527
        functionReturn = true;
J
Jim Fehlig 已提交
9528
    }
9529 9530 9531 9532

 cleanup:
    if (dom)
        virDomainFree(dom);
9533
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
9534
    return functionReturn;
9535 9536 9537 9538 9539
}

/*
 * "detach-disk" command
 */
9540
static const vshCmdInfo info_detach_disk[] = {
9541 9542
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
9543 9544 9545
    {NULL, NULL}
};

9546
static const vshCmdOptDef opts_detach_disk[] = {
9547 9548 9549
    {"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")},
9550 9551 9552
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9553
static bool
9554
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
9555 9556 9557 9558 9559 9560 9561
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
9562
    const char *target = NULL;
9563
    char *doc;
E
Eric Blake 已提交
9564
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
9565 9566
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9567
    unsigned int flags;
9568

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

J
Jim Meyering 已提交
9572
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9573 9574
        goto cleanup;

9575
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9576 9577 9578 9579 9580 9581 9582 9583 9584
        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);
9585
    VIR_FREE(doc);
9586
    if (!xml) {
9587
        vshError(ctl, "%s", _("Failed to get disk information"));
9588 9589 9590 9591
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9592
        vshError(ctl, "%s", _("Failed to get disk information"));
9593 9594 9595 9596 9597 9598
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9599
        vshError(ctl, "%s", _("Failed to get disk information"));
9600 9601 9602 9603 9604 9605 9606
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9607 9608 9609 9610 9611
            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);
9612 9613 9614 9615 9616 9617 9618
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9619
    vshError(ctl, _("No found disk whose target is %s"), target);
9620 9621 9622 9623 9624
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9625
        vshError(ctl, "%s", _("Failed to allocate memory"));
9626 9627 9628
        goto cleanup;
    }

9629
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
9630
        vshError(ctl, "%s", _("Failed to create XML"));
9631 9632 9633
        goto cleanup;
    }

J
Jim Fehlig 已提交
9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645
    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 已提交
9646
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
9647
    } else {
J
Jim Meyering 已提交
9648
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
9649
        functionReturn = true;
9650
    }
9651 9652

 cleanup:
9653
    xmlXPathFreeObject(obj);
9654
    xmlXPathFreeContext(ctxt);
9655 9656 9657 9658 9659 9660
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
9661
    return functionReturn;
9662 9663
}

9664 9665 9666 9667
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
9668 9669
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
9670 9671 9672 9673
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
9674
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
9675 9676 9677
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9678
static bool
9679 9680
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
9681
    const char *from = NULL;
E
Eric Blake 已提交
9682
    bool ret = true;
9683 9684 9685
    char *buffer;
    int result;

9686
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9687
        return false;
9688

9689
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9690
        return false;
9691 9692

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
9696
    VIR_FREE(buffer);
9697 9698 9699 9700 9701

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
9702
        ret = false;
9703 9704 9705 9706 9707
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
9708
        ret = true;
9709 9710 9711 9712 9713
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
9714
        ret = true;
9715 9716 9717 9718 9719
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
9720
        ret = false;
9721 9722 9723 9724 9725
    }

    return ret;
}

9726 9727 9728 9729
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
9730 9731
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
9732 9733 9734 9735
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
9736
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
9737 9738 9739
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9740
static bool
9741 9742
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
9743
    const char *from = NULL;
E
Eric Blake 已提交
9744
    bool ret = true;
9745 9746 9747 9748 9749
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
9750
    xmlNodePtr node_list;
9751 9752 9753 9754 9755 9756
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

9757
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9758
        return false;
9759

9760
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9761
        return false;
9762 9763

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
9764
        return false;
9765 9766 9767 9768 9769

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

L
Laine Stump 已提交
9770 9771
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
9772 9773
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
9774
        ret = false;
9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810
        goto cleanup;
    }

    xmlAddChildList((xmlNodePtr) doc, node_list);

    ctxt = xmlXPathNewContext(doc);
    if (!ctxt)
        goto no_memory;

    obj = xmlXPathEval(BAD_CAST "//cpu[not(ancestor::cpu)]", ctxt);
    if ((obj == NULL) || (obj->nodesetval == NULL) ||
        (obj->nodesetval->nodeTab == NULL))
        goto cleanup;

    for (i = 0;i < obj->nodesetval->nodeNr;i++) {
        buf = xmlBufferCreate();
        if (buf == NULL)
            goto no_memory;
        sctxt = xmlSaveToBuffer(buf, NULL, 0);
        if (sctxt == NULL) {
            xmlBufferFree(buf);
            goto no_memory;
        }

        xmlSaveTree(sctxt, obj->nodesetval->nodeTab[i]);
        xmlSaveClose(sctxt);

        list = vshRealloc(ctl, list, sizeof(char *) * (count + 1));
        list[count++] = (char *) buf->content;
        buf->content = NULL;
        xmlBufferFree(buf);
        buf = NULL;
    }

    if (count == 0) {
        vshError(ctl, _("No host CPU specified in '%s'"), from);
E
Eric Blake 已提交
9811
        ret = false;
9812 9813 9814 9815 9816 9817 9818 9819
        goto cleanup;
    }

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

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
9820
        ret = false;
9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837

cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(doc);
    VIR_FREE(result);
    if ((list != NULL) && (count > 0)) {
        for (i = 0;i < count;i++)
            VIR_FREE(list[i]);
    }
    VIR_FREE(list);
    VIR_FREE(buffer);

    return ret;

no_memory:
    vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
9838
    ret = false;
9839
    goto cleanup;
9840 9841
}

9842 9843 9844 9845 9846 9847 9848 9849
/* 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;

9850
    ret = vshMalloc(ctl, PATH_MAX);
9851 9852 9853

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
9854 9855
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
9856
    if (fd == -1) {
9857
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
9858
                 strerror(errno));
9859
        VIR_FREE(ret);
9860 9861 9862 9863
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
9864 9865
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
9866
        VIR_FORCE_CLOSE(fd);
9867
        unlink (ret);
9868
        VIR_FREE(ret);
9869 9870
        return NULL;
    }
S
Stefan Berger 已提交
9871
    if (VIR_CLOSE(fd) < 0) {
9872 9873
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
9874
        unlink (ret);
9875
        VIR_FREE(ret);
9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890
        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 已提交
9891 9892 9893 9894
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
9895

9896
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
9897 9898 9899 9900
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
9901

9902 9903 9904 9905 9906
    /* 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 已提交
9907 9908
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
9909
     */
E
Eric Blake 已提交
9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921
    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);
9922 9923
    }

E
Eric Blake 已提交
9924 9925 9926 9927 9928 9929 9930
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
9931
    }
E
Eric Blake 已提交
9932
    ret = 0;
9933

E
Eric Blake 已提交
9934 9935 9936
cleanup:
    virCommandFree(cmd);
    return ret;
9937 9938 9939 9940 9941 9942 9943 9944
}

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

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
9945
        vshError(ctl,
9946
                 _("%s: failed to read temporary file: %s"),
9947
                 filename, strerror(errno));
9948 9949 9950 9951 9952
        return NULL;
    }
    return ret;
}

9953

P
Paolo Bonzini 已提交
9954 9955 9956 9957
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
9958 9959
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
9960 9961 9962 9963
    {NULL, NULL}
};

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

E
Eric Blake 已提交
9968
static bool
P
Paolo Bonzini 已提交
9969 9970
cmdCd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
9971
    const char *dir = NULL;
9972
    char *dir_malloced = NULL;
E
Eric Blake 已提交
9973
    bool ret = true;
P
Paolo Bonzini 已提交
9974 9975

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

9980
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
9981
        uid_t uid = geteuid();
9982
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
9983 9984 9985 9986
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
9987
    if (chdir(dir) == -1) {
9988
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
9989
        ret = false;
P
Paolo Bonzini 已提交
9990 9991
    }

9992
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
9993
    return ret;
P
Paolo Bonzini 已提交
9994 9995 9996 9997 9998 9999
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
10000 10001
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
10002 10003 10004
    {NULL, NULL}
};

E
Eric Blake 已提交
10005
static bool
P
Paolo Bonzini 已提交
10006 10007 10008
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
10009
    bool ret = true;
P
Paolo Bonzini 已提交
10010

10011 10012
    cwd = getcwd(NULL, 0);
    if (!cwd) {
10013 10014
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
10015 10016
        ret = false;
    } else {
P
Paolo Bonzini 已提交
10017
        vshPrint (ctl, _("%s\n"), cwd);
10018 10019
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
10020

10021
    return ret;
P
Paolo Bonzini 已提交
10022 10023
}

E
Eric Blake 已提交
10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042
/*
 * "echo" command
 */
static const vshCmdInfo info_echo[] = {
    {"help", N_("echo arguments")},
    {"desc", N_("Echo back arguments, possibly with quoting.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_echo[] = {
    {"shell", VSH_OT_BOOL, 0, N_("escape for shell use")},
    {"xml", VSH_OT_BOOL, 0, N_("escape for XML use")},
    {"", VSH_OT_ARGV, 0, N_("arguments to echo")},
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
10043
static bool
E
Eric Blake 已提交
10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

    while ((arg = vshCommandOptArgv(cmd, count)) != NULL) {
        bool close_quote = false;
        char *q;

        if (count)
            virBufferAddChar(&buf, ' ');
        /* Add outer '' only if arg included shell metacharacters.  */
        if (shell &&
            (strpbrk(arg, "\r\t\n !\"#$&'()*;<>?[\\]^`{|}~") || !*arg)) {
            virBufferAddChar(&buf, '\'');
            close_quote = true;
        }
        if (xml) {
            virBufferEscapeString(&buf, "%s", arg);
        } else {
            if (shell && (q = strchr(arg, '\''))) {
                do {
                    virBufferAdd(&buf, arg, q - arg);
                    virBufferAddLit(&buf, "'\\''");
                    arg = q + 1;
                    q = strchr(arg, '\'');
                } while (q);
            }
            virBufferAdd(&buf, arg, strlen(arg));
        }
        if (close_quote)
            virBufferAddChar(&buf, '\'');
        count++;
    }

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
10089
        return false;
E
Eric Blake 已提交
10090 10091 10092 10093 10094
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
10095
    return true;
E
Eric Blake 已提交
10096 10097
}

10098 10099 10100 10101
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
10102 10103
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
10104 10105 10106 10107
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
10108
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10109 10110 10111 10112 10113 10114
    {NULL, 0, 0, NULL}
};

/* This function also acts as a template to generate cmdNetworkEdit
 * and cmdPoolEdit functions (below) using a sed script in the Makefile.
 */
E
Eric Blake 已提交
10115
static bool
10116 10117
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
10118
    bool ret = false;
10119 10120 10121 10122 10123
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
10124
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
10125

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

J
Jim Meyering 已提交
10129
    dom = vshCommandOptDomain (ctl, cmd, NULL);
10130 10131 10132 10133
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
10134
    doc = virDomainGetXMLDesc (dom, flags);
10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152
    if (!doc)
        goto cleanup;

    /* Create and open the temporary file. */
    tmp = editWriteToTempFile (ctl, doc);
    if (!tmp) goto cleanup;

    /* Start the editor. */
    if (editFile (ctl, tmp) == -1) goto cleanup;

    /* Read back the edited file. */
    doc_edited = editReadBackFile (ctl, tmp);
    if (!doc_edited) goto cleanup;

    /* Compare original XML with edited.  Has it changed at all? */
    if (STREQ (doc, doc_edited)) {
        vshPrint (ctl, _("Domain %s XML configuration not changed.\n"),
                  virDomainGetName (dom));
E
Eric Blake 已提交
10153
        ret = true;
10154 10155 10156 10157 10158 10159 10160
        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.
     */
10161
    doc_reread = virDomainGetXMLDesc (dom, flags);
10162 10163 10164 10165
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
10166 10167
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179
        goto cleanup;
    }

    /* Everything checks out, so redefine the domain. */
    virDomainFree (dom);
    dom = virDomainDefineXML (ctl->conn, doc_edited);
    if (!dom)
        goto cleanup;

    vshPrint (ctl, _("Domain %s XML configuration edited.\n"),
              virDomainGetName(dom));

E
Eric Blake 已提交
10180
    ret = true;
10181 10182 10183 10184 10185

 cleanup:
    if (dom)
        virDomainFree (dom);

10186 10187 10188
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
10189 10190 10191

    if (tmp) {
        unlink (tmp);
10192
        VIR_FREE(tmp);
10193 10194 10195 10196 10197
    }

    return ret;
}

10198

10199 10200 10201 10202
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
10203 10204
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
10205 10206 10207 10208
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
10209
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
10210 10211 10212 10213 10214 10215 10216 10217 10218 10219
    {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[] = {
10220 10221
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
10222 10223 10224 10225
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
10226
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10227 10228 10229 10230 10231 10232
    {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 已提交
10233 10234 10235
/*
 * "quit" command
 */
10236
static const vshCmdInfo info_quit[] = {
10237
    {"help", N_("quit this interactive terminal")},
10238
    {"desc", ""},
10239
    {NULL, NULL}
K
Karel Zak 已提交
10240 10241
};

E
Eric Blake 已提交
10242
static bool
10243
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10244
{
E
Eric Blake 已提交
10245 10246
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
10247 10248
}

10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
    {"help", N_("Create a snapshot")},
    {"desc", N_("Snapshot create")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
10264
static bool
10265 10266 10267
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10268
    bool ret = false;
10269
    const char *from = NULL;
10270 10271 10272 10273 10274 10275 10276
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

10277
    if (!vshConnectionUsability(ctl, ctl->conn))
10278 10279 10280 10281 10282 10283
        goto cleanup;

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

10284
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
10285
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
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 10326 10327 10328 10329
    else {
        if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
            /* we have to report the error here because during cleanup
             * we'll run through virDomainFree(), which loses the
             * last error
             */
            virshReportError(ctl);
            goto cleanup;
        }
    }
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

    snapshot = virDomainSnapshotCreateXML(dom, buffer, 0);
    if (snapshot == NULL)
        goto cleanup;

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

    xml = xmlReadDoc((const xmlChar *) doc, "domainsnapshot.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        goto cleanup;

    name = virXPathString("string(/domainsnapshot/name)", ctxt);
    if (!name) {
        vshError(ctl, "%s",
                 _("Could not find 'name' element in domain snapshot XML"));
        goto cleanup;
    }

    vshPrint(ctl, _("Domain snapshot %s created"), name);
    if (from)
        vshPrint(ctl, _(" from '%s'"), from);
    vshPrint(ctl, "\n");

E
Eric Blake 已提交
10330
    ret = true;
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

cleanup:
    VIR_FREE(name);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
    {"help", N_("Get the current snapshot")},
    {"desc", N_("Get the current snapshot")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
10361
static bool
10362 10363 10364
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10365
    bool ret = false;
10366 10367 10368
    int current;
    virDomainSnapshotPtr snapshot = NULL;

10369
    if (!vshConnectionUsability(ctl, ctl->conn))
10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392
        goto cleanup;

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

    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
        char *xml;

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

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

        vshPrint(ctl, "%s", xml);
        VIR_FREE(xml);
    }

E
Eric Blake 已提交
10393
    ret = true;
10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417

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

    return ret;
}

/*
 * "snapshot-list" command
 */
static const vshCmdInfo info_snapshot_list[] = {
    {"help", N_("List snapshots for a domain")},
    {"desc", N_("Snapshot List")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
10418
static bool
10419 10420 10421
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10422
    bool ret = false;
10423 10424
    int numsnaps;
    char **names = NULL;
10425
    int actual = 0;
10426 10427 10428 10429 10430 10431 10432 10433 10434 10435
    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;

10436
    if (!vshConnectionUsability(ctl, ctl->conn))
10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447
        goto cleanup;

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

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

10448 10449
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494

    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);
10495
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
10496 10497 10498 10499 10500

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

E
Eric Blake 已提交
10501
    ret = true;
10502 10503 10504 10505 10506 10507 10508 10509 10510 10511

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);
10512 10513
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535
    VIR_FREE(names);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-dumpxml" command
 */
static const vshCmdInfo info_snapshot_dumpxml[] = {
    {"help", N_("Dump XML for a domain snapshot")},
    {"desc", N_("Snapshot Dump XML")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
10536
static bool
10537 10538 10539
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10540
    bool ret = false;
10541
    const char *name = NULL;
10542 10543 10544
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

10545
    if (!vshConnectionUsability(ctl, ctl->conn))
10546 10547 10548 10549 10550 10551
        goto cleanup;

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

10552
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10553 10554 10555 10556 10557 10558 10559 10560 10561 10562
        goto cleanup;

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

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

10563
    vshPrint(ctl, "%s", xml);
10564

E
Eric Blake 已提交
10565
    ret = true;
10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577

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

    return ret;
}

/*
10578
 * "snapshot-revert" command
10579
 */
10580
static const vshCmdInfo info_snapshot_revert[] = {
10581 10582 10583 10584 10585
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

10586
static const vshCmdOptDef opts_snapshot_revert[] = {
10587 10588 10589 10590 10591
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10592
static bool
10593
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
10594 10595
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10596
    bool ret = false;
10597
    const char *name = NULL;
10598 10599
    virDomainSnapshotPtr snapshot = NULL;

10600
    if (!vshConnectionUsability(ctl, ctl->conn))
10601 10602 10603 10604 10605 10606
        goto cleanup;

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

10607
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10608 10609 10610 10611 10612 10613 10614 10615 10616
        goto cleanup;

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

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

E
Eric Blake 已提交
10617
    ret = true;
10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643

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

    return ret;
}

/*
 * "snapshot-delete" command
 */
static const vshCmdInfo info_snapshot_delete[] = {
    {"help", N_("Delete a domain snapshot")},
    {"desc", N_("Snapshot Delete")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_delete[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {"children", VSH_OT_BOOL, 0, N_("delete snapshot and all children")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10644
static bool
10645 10646 10647
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10648
    bool ret = false;
10649
    const char *name = NULL;
10650 10651 10652
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

10653
    if (!vshConnectionUsability(ctl, ctl->conn))
10654 10655 10656 10657 10658 10659
        goto cleanup;

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

10660
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;

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

    if (virDomainSnapshotDelete(snapshot, flags) < 0)
        goto cleanup;

E
Eric Blake 已提交
10673
    ret = true;
10674 10675 10676 10677 10678 10679 10680 10681 10682 10683

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

    return ret;
}

10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695
/*
 * "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")},
10696
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
10697 10698 10699
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10700
static bool
10701 10702 10703
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10704
    bool ret = false;
10705
    const char *monitor_cmd = NULL;
10706
    char *result = NULL;
10707
    unsigned int flags = 0;
10708 10709 10710 10711 10712 10713 10714 10715

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

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

10716
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
10717 10718 10719 10720
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

10721 10722 10723 10724
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
10725 10726 10727 10728
        goto cleanup;

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

E
Eric Blake 已提交
10729
    ret = true;
10730 10731 10732 10733 10734 10735 10736 10737 10738

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

    return ret;
}

10739
static const vshCmdDef domManagementCmds[] = {
10740 10741 10742
    {"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},
10743
    {"autostart", cmdAutostart, opts_autostart, info_autostart},
10744
    {"blkiotune", cmdBlkiotune, opts_blkiotune, info_blkiotune},
10745
#ifndef WIN32
10746
    {"console", cmdConsole, opts_console, info_console},
10747
#endif
10748
    {"cpu-baseline", cmdCPUBaseline, opts_cpu_baseline, info_cpu_baseline},
10749
    {"cpu-compare", cmdCPUCompare, opts_cpu_compare, info_cpu_compare},
10750
    {"create", cmdCreate, opts_create, info_create},
10751
    {"define", cmdDefine, opts_define, info_define},
K
Karel Zak 已提交
10752
    {"destroy", cmdDestroy, opts_destroy, info_destroy},
10753 10754 10755
    {"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 已提交
10756
    {"domid", cmdDomid, opts_domid, info_domid},
10757
    {"domjobabort", cmdDomjobabort, opts_domjobabort, info_domjobabort},
10758
    {"domjobinfo", cmdDomjobinfo, opts_domjobinfo, info_domjobinfo},
K
Karel Zak 已提交
10759
    {"domname", cmdDomname, opts_domname, info_domname},
10760
    {"domuuid", cmdDomuuid, opts_domuuid, info_domuuid},
10761 10762
    {"domxml-from-native", cmdDomXMLFromNative, opts_domxmlfromnative, info_domxmlfromnative},
    {"domxml-to-native", cmdDomXMLToNative, opts_domxmltonative, info_domxmltonative},
10763
    {"dump", cmdDump, opts_dump, info_dump},
10764
    {"dumpxml", cmdDumpXML, opts_dumpxml, info_dumpxml},
10765
    {"edit", cmdEdit, opts_edit, info_edit},
10766 10767
    {"managedsave", cmdManagedSave, opts_managedsave, info_managedsave},
    {"managedsave-remove", cmdManagedSaveRemove, opts_managedsaveremove, info_managedsaveremove},
E
Eric Blake 已提交
10768
    {"maxvcpus", cmdMaxvcpus, opts_maxvcpus, info_maxvcpus},
10769
    {"memtune", cmdMemtune, opts_memtune, info_memtune},
10770
    {"migrate", cmdMigrate, opts_migrate, info_migrate},
10771
    {"migrate-setmaxdowntime", cmdMigrateSetMaxDowntime, opts_migrate_setmaxdowntime, info_migrate_setmaxdowntime},
10772 10773 10774 10775 10776 10777 10778 10779
    {"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},
10780
    {"inject-nmi", cmdInjectNMI, opts_inject_nmi, info_inject_nmi},
10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806
    {"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[] = {
10807 10808 10809 10810
    {"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},
10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836
    {"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},
10837
    {"vol-download", cmdVolDownload, opts_vol_download, info_vol_download },
10838 10839 10840 10841 10842 10843 10844
    {"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},
10845
    {"vol-upload", cmdVolUpload, opts_vol_upload, info_vol_upload },
10846 10847 10848
    {"vol-wipe", cmdVolWipe, opts_vol_wipe, info_vol_wipe},
    {NULL, NULL, NULL, NULL}
};
10849

10850
static const vshCmdDef networkCmds[] = {
10851
    {"net-autostart", cmdNetworkAutostart, opts_network_autostart, info_network_autostart},
10852 10853 10854 10855
    {"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},
10856
    {"net-edit", cmdNetworkEdit, opts_network_edit, info_network_edit},
O
Osier Yang 已提交
10857
    {"net-info", cmdNetworkInfo, opts_network_info, info_network_info},
10858 10859 10860 10861 10862
    {"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},
10863 10864
    {NULL, NULL, NULL, NULL}
};
10865

10866 10867 10868
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},
10869
    {"nodedev-dettach", cmdNodeDeviceDettach, opts_node_device_dettach, info_node_device_dettach},
10870 10871
    {"nodedev-dumpxml", cmdNodeDeviceDumpXML, opts_node_device_dumpxml, info_node_device_dumpxml},
    {"nodedev-list", cmdNodeListDevices, opts_node_list_devices, info_node_list_devices},
10872 10873
    {"nodedev-reattach", cmdNodeDeviceReAttach, opts_node_device_reattach, info_node_device_reattach},
    {"nodedev-reset", cmdNodeDeviceReset, opts_node_device_reset, info_node_device_reset},
10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888
    {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}
};
10889

10890
static const vshCmdDef nwfilterCmds[] = {
10891 10892 10893
    {"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},
10894 10895 10896 10897
    {"nwfilter-list", cmdNWFilterList, opts_nwfilter_list, info_nwfilter_list},
    {"nwfilter-undefine", cmdNWFilterUndefine, opts_nwfilter_undefine, info_nwfilter_undefine},
    {NULL, NULL, NULL, NULL}
};
10898

10899
static const vshCmdDef secretCmds[] = {
10900 10901 10902 10903
    {"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},
10904 10905 10906 10907
    {"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}
};
10908

10909 10910 10911 10912 10913
static const vshCmdDef virshCmds[] = {
    {"cd", cmdCd, opts_cd, info_cd},
    {"echo", cmdEcho, opts_echo, info_echo},
    {"exit", cmdQuit, NULL, info_quit},
    {"help", cmdHelp, opts_help, info_help},
P
Paolo Bonzini 已提交
10914
    {"pwd", cmdPwd, NULL, info_pwd},
K
Karel Zak 已提交
10915
    {"quit", cmdQuit, NULL, info_quit},
10916 10917
    {NULL, NULL, NULL, NULL}
};
10918

10919
static const vshCmdDef snapshotCmds[] = {
10920 10921 10922 10923 10924
    {"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},
10925
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert, info_snapshot_revert},
10926 10927
    {NULL, NULL, NULL, NULL}
};
10928

10929 10930 10931 10932 10933
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},
10934
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo},
10935
    {"qemu-monitor-command", cmdQemuMonitorCommand, opts_qemu_monitor_command, info_qemu_monitor_command},
E
Eric Blake 已提交
10936
    {"sysinfo", cmdSysinfo, NULL, info_sysinfo},
10937
    {"uri", cmdURI, NULL, info_uri},
10938
    {NULL, NULL, NULL, NULL}
K
Karel Zak 已提交
10939 10940
};

10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957
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 已提交
10958 10959 10960 10961
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
10962
static const char *
10963
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
10964
{
10965
    const vshCmdInfo *info;
10966

K
Karel Zak 已提交
10967
    for (info = cmd->info; info && info->name; info++) {
10968
        if (STREQ(info->name, name))
K
Karel Zak 已提交
10969 10970 10971 10972 10973
            return info->data;
    }
    return NULL;
}

10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005
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;
}

11006
static const vshCmdOptDef *
11007 11008
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
11009
{
11010 11011 11012 11013
    int i;

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

11015 11016 11017 11018 11019 11020
        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 已提交
11021
            return opt;
11022 11023 11024 11025 11026
        }
    }

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

11030
static const vshCmdOptDef *
11031 11032
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
11033
{
11034
    int i;
11035
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
11036

11037 11038 11039 11040 11041 11042 11043 11044 11045 11046
    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 已提交
11047 11048
}

11049 11050 11051
/*
 * Checks for required options
 */
11052
static int
11053 11054
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
11055
{
11056
    const vshCmdDef *def = cmd->def;
11057 11058 11059 11060 11061 11062 11063 11064 11065
    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];
11066

11067 11068 11069 11070 11071
            vshError(ctl,
                     opt->type == VSH_OT_DATA ?
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
11072 11073
        }
    }
11074
    return -1;
11075 11076
}

11077
static const vshCmdDef *
11078 11079
vshCmddefSearch(const char *cmdname)
{
11080
    const vshCmdGrp *g;
11081
    const vshCmdDef *c;
11082

11083 11084
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
11085
            if (STREQ(c->name, cmdname))
11086 11087 11088 11089
                return c;
        }
    }

K
Karel Zak 已提交
11090 11091 11092
    return NULL;
}

11093 11094 11095 11096 11097 11098
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
11099
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
11100 11101 11102 11103 11104 11105
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
11106
static bool
11107 11108 11109 11110 11111 11112 11113
vshCmdGrpHelp(vshControl *ctl, const char *grpname)
{
    const vshCmdGrp *grp = vshCmdGrpSearch(grpname);
    const vshCmdDef *cmd = NULL;

    if (!grp) {
        vshError(ctl, _("command group '%s' doesn't exist"), grpname);
E
Eric Blake 已提交
11114
        return false;
11115 11116 11117 11118 11119 11120 11121 11122 11123 11124
    } else {
        vshPrint(ctl, _(" %s (help keyword '%s'):\n"), grp->name,
                 grp->keyword);

        for (cmd = grp->commands; cmd->name; cmd++) {
            vshPrint(ctl, "    %-30s %s\n", cmd->name,
                     _(vshCmddefGetInfo(cmd, "help")));
        }
    }

E
Eric Blake 已提交
11125
    return true;
11126 11127
}

E
Eric Blake 已提交
11128
static bool
11129
vshCmddefHelp(vshControl *ctl, const char *cmdname)
11130
{
11131
    const vshCmdDef *def = vshCmddefSearch(cmdname);
11132

K
Karel Zak 已提交
11133
    if (!def) {
11134
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
11135
        return false;
11136
    } else {
E
Eric Blake 已提交
11137 11138
        const char *desc = _(vshCmddefGetInfo(def, "desc"));
        const char *help = _(vshCmddefGetInfo(def, "help"));
11139
        char buf[256];
11140 11141 11142 11143 11144 11145
        uint32_t opts_need_arg;
        uint32_t opts_required;

        if (vshCmddefOptParse(def, &opts_need_arg, &opts_required)) {
            vshError(ctl, _("internal error: bad options in command: '%s'"),
                     def->name);
E
Eric Blake 已提交
11146
            return false;
11147
        }
K
Karel Zak 已提交
11148

11149
        fputs(_("  NAME\n"), stdout);
11150 11151
        fprintf(stdout, "    %s - %s\n", def->name, help);

11152 11153 11154 11155 11156
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
11157
                const char *fmt = "%s";
11158 11159
                switch (opt->type) {
                case VSH_OT_BOOL:
11160
                    fmt = "[--%s]";
11161 11162
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
11163
                    /* xgettext:c-format */
11164 11165
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
11166 11167
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
11168 11169
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
11170 11171
                    break;
                case VSH_OT_DATA:
11172
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
11173 11174 11175 11176 11177 11178
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
                    fmt = _("[<string>]...");
                    break;
                default:
11179
                    assert(0);
11180
                }
11181
                fputc(' ', stdout);
E
Eric Blake 已提交
11182
                fprintf(stdout, fmt, opt->name);
11183
            }
K
Karel Zak 已提交
11184
        }
11185 11186 11187
        fputc('\n', stdout);

        if (desc[0]) {
11188
            /* Print the description only if it's not empty.  */
11189
            fputs(_("\n  DESCRIPTION\n"), stdout);
K
Karel Zak 已提交
11190 11191
            fprintf(stdout, "    %s\n", desc);
        }
11192

K
Karel Zak 已提交
11193
        if (def->opts) {
11194
            const vshCmdOptDef *opt;
11195
            fputs(_("\n  OPTIONS\n"), stdout);
11196
            for (opt = def->opts; opt->name; opt++) {
11197 11198
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
11199
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
11200 11201
                    break;
                case VSH_OT_INT:
11202 11203 11204
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
11205 11206
                    break;
                case VSH_OT_STRING:
11207
                    /* OT_STRING should never be VSH_OFLAG_REQ */
11208
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
11209 11210
                    break;
                case VSH_OT_DATA:
11211 11212
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
11213 11214 11215 11216 11217 11218 11219
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
                    continue;
                default:
                    assert(0);
                }
11220

E
Eric Blake 已提交
11221
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
11222
            }
K
Karel Zak 已提交
11223 11224 11225
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
11226
    return true;
K
Karel Zak 已提交
11227 11228 11229 11230 11231 11232
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
11233 11234 11235
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
11236 11237
    vshCmdOpt *a = arg;

11238
    while (a) {
K
Karel Zak 已提交
11239
        vshCmdOpt *tmp = a;
11240

K
Karel Zak 已提交
11241 11242
        a = a->next;

11243 11244
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
11245 11246 11247 11248
    }
}

static void
11249
vshCommandFree(vshCmd *cmd)
11250
{
K
Karel Zak 已提交
11251 11252
    vshCmd *c = cmd;

11253
    while (c) {
K
Karel Zak 已提交
11254
        vshCmd *tmp = c;
11255

K
Karel Zak 已提交
11256 11257 11258 11259
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
11260
        VIR_FREE(tmp);
K
Karel Zak 已提交
11261 11262 11263 11264 11265 11266 11267
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
11268
vshCommandOpt(const vshCmd *cmd, const char *name)
11269
{
K
Karel Zak 已提交
11270
    vshCmdOpt *opt = cmd->opts;
11271 11272

    while (opt) {
11273
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
11274 11275 11276 11277 11278 11279 11280
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
11281 11282 11283 11284 11285 11286 11287 11288 11289
 * @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 已提交
11290 11291
 */
static int
11292
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
11293
{
K
Karel Zak 已提交
11294
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11295
    int ret = 0, num;
11296
    char *end_p = NULL;
11297

11298
    if ((arg != NULL) && (arg->data != NULL)) {
11299 11300 11301 11302 11303 11304
        num = strtol(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11305
    }
11306
    return ret;
K
Karel Zak 已提交
11307 11308
}

11309 11310 11311 11312 11313 11314
/*
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
11315 11316
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11317 11318
    int ret = 0;
    unsigned long num;
11319 11320 11321
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
11322 11323 11324 11325 11326 11327
        num = strtoul(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11328
    }
11329
    return ret;
11330 11331
}

K
Karel Zak 已提交
11332 11333
/*
 * Returns option as STRING
11334
 * See vshCommandOptInt()
K
Karel Zak 已提交
11335
 */
11336 11337
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
11338
{
K
Karel Zak 已提交
11339
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11340 11341 11342
    int ret = 0;

    if (arg && arg->data) {
E
Eric Blake 已提交
11343 11344 11345 11346
        if (*arg->data
            || (arg->def && (arg->def->flag & VSH_OFLAG_EMPTY_OK))) {
            *value = arg->data;
            ret = 1;
11347 11348
        } else if (arg->def && ((arg->def->flag) & VSH_OFLAG_REQ)) {
            vshError(NULL, _("Missing required option '%s'"), name);
E
Eric Blake 已提交
11349 11350 11351 11352
            ret = -1;
        } else {
            /* Treat "--option ''" as if option had not been specified. */
            ret = 0;
11353 11354
        }
    }
11355

11356
    return ret;
K
Karel Zak 已提交
11357 11358
}

11359 11360
/*
 * Returns option as long long
11361
 * See vshCommandOptInt()
11362
 */
11363 11364 11365
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
11366 11367
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11368 11369
    int ret = 0;
    long long num;
11370 11371
    char *end_p = NULL;

11372 11373 11374 11375 11376 11377 11378 11379 11380
    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;
11381 11382
}

11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403
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 已提交
11404
/*
E
Eric Blake 已提交
11405
 * Returns true/false if the option exists
K
Karel Zak 已提交
11406
 */
E
Eric Blake 已提交
11407
static bool
11408
vshCommandOptBool(const vshCmd *cmd, const char *name)
11409
{
E
Eric Blake 已提交
11410
    return vshCommandOpt(cmd, name) != NULL;
K
Karel Zak 已提交
11411 11412
}

11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433
/*
 * 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 已提交
11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451
/* 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)
11452
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
11453 11454 11455
                 cmd->def->name, optname);
    return found;
}
11456

K
Karel Zak 已提交
11457
static virDomainPtr
J
Jim Meyering 已提交
11458
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
11459
                      const char **name, int flag)
11460
{
K
Karel Zak 已提交
11461
    virDomainPtr dom = NULL;
11462
    const char *n = NULL;
K
Karel Zak 已提交
11463
    int id;
J
Jim Meyering 已提交
11464 11465 11466
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11467

11468
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11469 11470
        return NULL;

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

K
Karel Zak 已提交
11474 11475
    if (name)
        *name = n;
11476

K
Karel Zak 已提交
11477
    /* try it by ID */
11478
    if (flag & VSH_BYID) {
11479
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
11480 11481 11482 11483
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
11484
    }
K
Karel Zak 已提交
11485
    /* try it by UUID */
11486
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
11487
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
11488
                 cmd->def->name, optname);
K
Karel Zak 已提交
11489
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
11490
    }
K
Karel Zak 已提交
11491
    /* try it by NAME */
11492
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11493
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
11494
                 cmd->def->name, optname);
K
Karel Zak 已提交
11495
        dom = virDomainLookupByName(ctl->conn, n);
11496
    }
K
Karel Zak 已提交
11497

11498
    if (!dom)
11499
        vshError(ctl, _("failed to get domain '%s'"), n);
11500

K
Karel Zak 已提交
11501 11502 11503
    return dom;
}

11504
static virNetworkPtr
J
Jim Meyering 已提交
11505
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
11506
                       const char **name, int flag)
11507 11508
{
    virNetworkPtr network = NULL;
11509
    const char *n = NULL;
J
Jim Meyering 已提交
11510 11511 11512
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11513

11514
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11515 11516 11517 11518 11519 11520 11521 11522 11523
        return NULL;

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

    if (name)
        *name = n;

    /* try it by UUID */
11524
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
11525
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
11526
                 cmd->def->name, optname);
11527 11528 11529 11530
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11531
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
11532 11533 11534 11535 11536
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
11537
        vshError(ctl, _("failed to get network '%s'"), n);
11538 11539 11540 11541

    return network;
}

11542 11543 11544

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
11545
                        const char **name, int flag)
11546 11547
{
    virNWFilterPtr nwfilter = NULL;
11548
    const char *n = NULL;
11549 11550 11551 11552
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11553
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580
        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;
}

11581 11582
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
11583
                         const char **name, int flag)
11584 11585
{
    virInterfacePtr iface = NULL;
11586
    const char *n = NULL;
11587 11588 11589 11590
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11591
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11592 11593 11594 11595 11596 11597 11598 11599 11600
        return NULL;

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

    if (name)
        *name = n;

    /* try it by NAME */
11601
    if ((flag & VSH_BYNAME)) {
11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613
        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)
11614
        vshError(ctl, _("failed to get interface '%s'"), n);
11615 11616 11617 11618

    return iface;
}

11619
static virStoragePoolPtr
11620
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
11621
                    const char **name, int flag)
11622 11623
{
    virStoragePoolPtr pool = NULL;
11624
    const char *n = NULL;
11625

11626
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11627 11628 11629 11630 11631 11632 11633 11634 11635
        return NULL;

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

    if (name)
        *name = n;

    /* try it by UUID */
11636
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
11637
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
11638
                 cmd->def->name, optname);
11639 11640 11641
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
11642
    if (pool == NULL && (flag & VSH_BYNAME)) {
11643 11644 11645 11646 11647 11648
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
11649
        vshError(ctl, _("failed to get pool '%s'"), n);
11650 11651 11652 11653 11654

    return pool;
}

static virStorageVolPtr
11655
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
11656 11657
                   const char *optname,
                   const char *pooloptname,
11658
                   const char **name, int flag)
11659 11660 11661
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
11662
    const char *n = NULL, *p = NULL;
11663

11664
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11665 11666
        return NULL;

11667 11668
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
11669
        return NULL;
11670
    }
11671 11672 11673 11674 11675 11676 11677 11678 11679 11680

    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;

11681
    /* try it by name */
11682
    if (pool && (flag & VSH_BYNAME)) {
11683
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
11684 11685 11686
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
11687
    /* try it by key */
11688 11689 11690 11691 11692
    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);
    }
11693
    /* try it by path */
11694 11695 11696 11697 11698 11699 11700
    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)
11701
        vshError(ctl, _("failed to get vol '%s'"), n);
11702 11703 11704 11705 11706 11707 11708

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

11709
static virSecretPtr
11710
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
11711 11712
{
    virSecretPtr secret = NULL;
11713
    const char *n = NULL;
11714 11715 11716 11717 11718
    const char *optname = "secret";

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

11719
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11720 11721 11722 11723 11724 11725 11726 11727 11728 11729
        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)
11730
        vshError(ctl, _("failed to get secret '%s'"), n);
11731 11732 11733 11734

    return secret;
}

K
Karel Zak 已提交
11735 11736 11737
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
11738
static bool
11739
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
11740
{
E
Eric Blake 已提交
11741
    bool ret = true;
11742 11743

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

11747 11748 11749
        if ((ctl->conn == NULL) || (disconnected != 0))
            vshReconnect(ctl);

11750
        if (enable_timing)
K
Karel Zak 已提交
11751
            GETTIMEOFDAY(&before);
11752

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

11755
        if (enable_timing)
K
Karel Zak 已提交
11756
            GETTIMEOFDAY(&after);
11757

11758
        if (!ret)
J
John Levon 已提交
11759 11760
            virshReportError(ctl);

11761
        /* try to automatically catch disconnections */
11762
        if (!ret &&
11763 11764 11765 11766 11767 11768 11769 11770 11771
            ((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);

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

11775
        if (enable_timing)
11776
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
11777 11778
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
11779
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
11780 11781 11782 11783 11784 11785
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
11786
 * Command parsing
K
Karel Zak 已提交
11787 11788 11789
 * ---------------
 */

11790 11791 11792 11793 11794 11795 11796 11797 11798 11799
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 已提交
11800
    /* vshCommandStringGetArg() */
11801
    char *pos;
L
Lai Jiangshan 已提交
11802 11803 11804
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
11805 11806
} vshCommandParser;

E
Eric Blake 已提交
11807
static bool
11808
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
11809
{
K
Karel Zak 已提交
11810 11811 11812
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
11813

K
Karel Zak 已提交
11814 11815 11816 11817
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
11818

11819
    while (1) {
K
Karel Zak 已提交
11820
        vshCmdOpt *last = NULL;
11821
        const vshCmdDef *cmd = NULL;
11822
        vshCommandToken tk;
L
Lai Jiangshan 已提交
11823
        bool data_only = false;
11824 11825 11826
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
11827

K
Karel Zak 已提交
11828
        first = NULL;
11829

11830
        while (1) {
11831
            const vshCmdOptDef *opt = NULL;
11832

K
Karel Zak 已提交
11833
            tkdata = NULL;
11834
            tk = parser->getNextArg(ctl, parser, &tkdata);
11835 11836

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
11837
                goto syntaxError;
H
Hu Tao 已提交
11838 11839
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
11840
                break;
H
Hu Tao 已提交
11841
            }
11842 11843

            if (cmd == NULL) {
K
Karel Zak 已提交
11844 11845
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
11846
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
11847
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
11848
                }
11849 11850 11851 11852 11853 11854 11855
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
11856
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
11857 11858 11859 11860
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
11861 11862 11863 11864 11865
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
11866 11867
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
11868
                    VIR_FREE(optstr);
K
Karel Zak 已提交
11869 11870
                    goto syntaxError;
                }
11871
                VIR_FREE(tkdata);
K
Karel Zak 已提交
11872 11873 11874

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
11875 11876 11877
                    if (optstr)
                        tkdata = optstr;
                    else
11878
                        tk = parser->getNextArg(ctl, parser, &tkdata);
11879
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
11880
                        goto syntaxError;
11881
                    if (tk != VSH_TK_ARG) {
11882
                        vshError(ctl,
11883
                                 _("expected syntax: --%s <%s>"),
11884 11885
                                 opt->name,
                                 opt->type ==
11886
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
11887 11888
                        goto syntaxError;
                    }
11889
                    opts_need_arg &= ~opts_seen;
11890 11891 11892 11893 11894 11895 11896 11897
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
11898
                }
L
Lai Jiangshan 已提交
11899 11900 11901 11902
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
11903
            } else {
L
Lai Jiangshan 已提交
11904
get_data:
11905 11906
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
11907
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
11908 11909 11910 11911 11912
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
11913
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
11914

K
Karel Zak 已提交
11915 11916 11917 11918
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
11919

K
Karel Zak 已提交
11920 11921 11922 11923 11924
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
11925

K
Karel Zak 已提交
11926
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
11927 11928
                         cmd->name,
                         opt->name,
11929 11930
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
11931 11932
            }
        }
11933

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

K
Karel Zak 已提交
11938 11939 11940 11941
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

11942
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
11943
                VIR_FREE(c);
11944
                goto syntaxError;
11945
            }
11946

K
Karel Zak 已提交
11947 11948 11949 11950 11951 11952
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
11953 11954 11955

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
11956
    }
11957

E
Eric Blake 已提交
11958
    return true;
K
Karel Zak 已提交
11959

11960
 syntaxError:
11961
    if (ctl->cmd) {
K
Karel Zak 已提交
11962
        vshCommandFree(ctl->cmd);
11963 11964
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
11965 11966
    if (first)
        vshCommandOptFree(first);
11967
    VIR_FREE(tkdata);
E
Eric Blake 已提交
11968
    return false;
K
Karel Zak 已提交
11969 11970
}

11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988
/* --------------------
 * Command argv parsing
 * --------------------
 */

static vshCommandToken ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
vshCommandArgvGetArg(vshControl *ctl, vshCommandParser *parser, char **res)
{
    if (parser->arg_pos == parser->arg_end) {
        *res = NULL;
        return VSH_TK_END;
    }

    *res = vshStrdup(ctl, *parser->arg_pos);
    parser->arg_pos++;
    return VSH_TK_ARG;
}

E
Eric Blake 已提交
11989 11990
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
11991 11992 11993 11994
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
11995
        return false;
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 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067

    parser.arg_pos = argv;
    parser.arg_end = argv + nargs;
    parser.getNextArg = vshCommandArgvGetArg;
    return vshCommandParse(ctl, &parser);
}

/* ----------------------
 * Command string parsing
 * ----------------------
 */

static vshCommandToken ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
vshCommandStringGetArg(vshControl *ctl, vshCommandParser *parser, char **res)
{
    bool single_quote = false;
    bool double_quote = false;
    int sz = 0;
    char *p = parser->pos;
    char *q = vshStrdup(ctl, p);

    *res = q;

    while (*p && (*p == ' ' || *p == '\t'))
        p++;

    if (*p == '\0')
        return VSH_TK_END;
    if (*p == ';') {
        parser->pos = ++p;             /* = \0 or begin of next command */
        return VSH_TK_SUBCMD_END;
    }

    while (*p) {
        /* end of token is blank space or ';' */
        if (!double_quote && !single_quote &&
            (*p == ' ' || *p == '\t' || *p == ';'))
            break;

        if (!double_quote && *p == '\'') { /* single quote */
            single_quote = !single_quote;
            p++;
            continue;
        } else if (!single_quote && *p == '\\') { /* escape */
            /*
             * The same as the bash, a \ in "" is an escaper,
             * but a \ in '' is not an escaper.
             */
            p++;
            if (*p == '\0') {
                vshError(ctl, "%s", _("dangling \\"));
                return VSH_TK_ERROR;
            }
        } else if (!single_quote && *p == '"') { /* double quote */
            double_quote = !double_quote;
            p++;
            continue;
        }

        *q++ = *p++;
        sz++;
    }
    if (double_quote) {
        vshError(ctl, "%s", _("missing \""));
        return VSH_TK_ERROR;
    }

    *q = '\0';
    parser->pos = p;
    return VSH_TK_ARG;
}

E
Eric Blake 已提交
12068 12069
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
12070 12071 12072 12073
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
12074
        return false;
12075 12076 12077 12078 12079 12080

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

K
Karel Zak 已提交
12081
/* ---------------
12082
 * Misc utils
K
Karel Zak 已提交
12083 12084
 * ---------------
 */
12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112
static int
vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason)
{
    virDomainInfo info;

    if (reason)
        *reason = -1;

    if (!ctl->useGetInfo) {
        int state;
        if (virDomainGetState(dom, &state, reason, 0) < 0) {
            virErrorPtr err = virGetLastError();
            if (err && err->code == VIR_ERR_NO_SUPPORT)
                ctl->useGetInfo = true;
            else
                return -1;
        } else {
            return state;
        }
    }

    /* fall back to virDomainGetInfo if virDomainGetState is not supported */
    if (virDomainGetInfo(dom, &info) < 0)
        return -1;
    else
        return info.state;
}

K
Karel Zak 已提交
12113
static const char *
12114 12115
vshDomainStateToString(int state)
{
12116
    switch ((virDomainState) state) {
12117
    case VIR_DOMAIN_RUNNING:
12118
        return N_("running");
12119
    case VIR_DOMAIN_BLOCKED:
12120
        return N_("idle");
12121
    case VIR_DOMAIN_PAUSED:
12122
        return N_("paused");
12123
    case VIR_DOMAIN_SHUTDOWN:
12124
        return N_("in shutdown");
12125
    case VIR_DOMAIN_SHUTOFF:
12126
        return N_("shut off");
12127
    case VIR_DOMAIN_CRASHED:
12128
        return N_("crashed");
12129
    case VIR_DOMAIN_NOSTATE:
12130
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
12131
    }
12132
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
12133 12134
}

12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235
static const char *
vshDomainStateReasonToString(int state, int reason)
{
    switch ((virDomainState) state) {
    case VIR_DOMAIN_NOSTATE:
        switch ((virDomainNostateReason) reason) {
        case VIR_DOMAIN_NOSTATE_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_RUNNING:
        switch ((virDomainRunningReason) reason) {
        case VIR_DOMAIN_RUNNING_BOOTED:
            return N_("booted");
        case VIR_DOMAIN_RUNNING_MIGRATED:
            return N_("migrated");
        case VIR_DOMAIN_RUNNING_RESTORED:
            return N_("restored");
        case VIR_DOMAIN_RUNNING_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_RUNNING_UNPAUSED:
            return N_("unpaused");
        case VIR_DOMAIN_RUNNING_MIGRATION_CANCELED:
            return N_("migration canceled");
        case VIR_DOMAIN_RUNNING_SAVE_CANCELED:
            return N_("save canceled");
        case VIR_DOMAIN_RUNNING_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_BLOCKED:
        switch ((virDomainBlockedReason) reason) {
        case VIR_DOMAIN_BLOCKED_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_PAUSED:
        switch ((virDomainPausedReason) reason) {
        case VIR_DOMAIN_PAUSED_USER:
            return N_("user");
        case VIR_DOMAIN_PAUSED_MIGRATION:
            return N_("migrating");
        case VIR_DOMAIN_PAUSED_SAVE:
            return N_("saving");
        case VIR_DOMAIN_PAUSED_DUMP:
            return N_("dumping");
        case VIR_DOMAIN_PAUSED_IOERROR:
            return N_("I/O error");
        case VIR_DOMAIN_PAUSED_WATCHDOG:
            return N_("watchdog");
        case VIR_DOMAIN_PAUSED_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_PAUSED_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_SHUTDOWN:
        switch ((virDomainShutdownReason) reason) {
        case VIR_DOMAIN_SHUTDOWN_USER:
            return N_("user");
        case VIR_DOMAIN_SHUTDOWN_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_SHUTOFF:
        switch ((virDomainShutoffReason) reason) {
        case VIR_DOMAIN_SHUTOFF_SHUTDOWN:
            return N_("shutdown");
        case VIR_DOMAIN_SHUTOFF_DESTROYED:
            return N_("destroyed");
        case VIR_DOMAIN_SHUTOFF_CRASHED:
            return N_("crashed");
        case VIR_DOMAIN_SHUTOFF_MIGRATED:
            return N_("migrated");
        case VIR_DOMAIN_SHUTOFF_SAVED:
            return N_("saved");
        case VIR_DOMAIN_SHUTOFF_FAILED:
            return N_("failed");
        case VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_SHUTOFF_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_CRASHED:
        switch ((virDomainCrashedReason) reason) {
        case VIR_DOMAIN_CRASHED_UNKNOWN:
            ;
        }
        break;
    }

    return N_("unknown");
}

12236 12237 12238 12239
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
12240
    case VIR_VCPU_OFFLINE:
12241
        return N_("offline");
12242
    case VIR_VCPU_BLOCKED:
12243
        return N_("idle");
12244
    case VIR_VCPU_RUNNING:
12245
        return N_("running");
12246
    default:
12247
        ;/*FALLTHROUGH*/
12248
    }
12249
    return N_("no state");
12250 12251
}

E
Eric Blake 已提交
12252
static bool
12253
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
12254
{
12255 12256
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
12257 12258
     */
    if (!conn) {
12259
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
12260
        return false;
K
Karel Zak 已提交
12261
    }
E
Eric Blake 已提交
12262
    return true;
K
Karel Zak 已提交
12263 12264
}

K
Karel Zak 已提交
12265
static void
12266
vshDebug(vshControl *ctl, int level, const char *format, ...)
12267
{
K
Karel Zak 已提交
12268
    va_list ap;
12269
    char *str;
K
Karel Zak 已提交
12270

12271 12272 12273 12274
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
12275 12276 12277 12278
    if (level > ctl->debug)
        return;

    va_start(ap, format);
12279 12280 12281 12282 12283
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
12284
    va_end(ap);
12285 12286
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
12287 12288 12289
}

static void
12290
vshPrintExtra(vshControl *ctl, const char *format, ...)
12291
{
K
Karel Zak 已提交
12292
    va_list ap;
12293
    char *str;
12294

12295
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
12296
        return;
12297

K
Karel Zak 已提交
12298
    va_start(ap, format);
12299 12300 12301 12302 12303
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
12304
    va_end(ap);
12305
    fputs(str, stdout);
12306
    VIR_FREE(str);
K
Karel Zak 已提交
12307 12308
}

K
Karel Zak 已提交
12309

K
Karel Zak 已提交
12310
static void
12311
vshError(vshControl *ctl, const char *format, ...)
12312
{
K
Karel Zak 已提交
12313
    va_list ap;
12314
    char *str;
12315

12316 12317 12318 12319 12320
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
12321

12322
    fputs(_("error: "), stderr);
12323

K
Karel Zak 已提交
12324
    va_start(ap, format);
12325 12326 12327
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
12328 12329
    va_end(ap);

12330 12331
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
12332 12333
}

12334

K
Karel Zak 已提交
12335
/*
12336
 * Initialize connection.
K
Karel Zak 已提交
12337
 */
E
Eric Blake 已提交
12338
static bool
12339
vshInit(vshControl *ctl)
12340
{
K
Karel Zak 已提交
12341
    if (ctl->conn)
E
Eric Blake 已提交
12342
        return false;
K
Karel Zak 已提交
12343

12344 12345
    vshOpenLogFile(ctl);

12346 12347
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
12348

12349 12350 12351
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

12352
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
12353
        return false;
12354

12355 12356 12357 12358
    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

12359

12360 12361 12362 12363
    /* This is not necessarily fatal.  All the individual commands check
     * vshConnectionUsability, except ones which don't need a connection
     * such as "help".
     */
12364
    if (!ctl->conn) {
12365
        virshReportError(ctl);
12366
        vshError(ctl, "%s", _("failed to connect to the hypervisor"));
E
Eric Blake 已提交
12367
        return false;
12368
    }
K
Karel Zak 已提交
12369

E
Eric Blake 已提交
12370
    return true;
K
Karel Zak 已提交
12371 12372
}

12373 12374
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393
/**
 * 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:
12394
                vshError(ctl, "%s",
J
Jim Meyering 已提交
12395
                         _("failed to get the log file information"));
12396
                exit(EXIT_FAILURE);
12397 12398 12399
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
12400 12401
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
12402 12403 12404 12405
        }
    }

    /* log file open */
12406
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
12407
        vshError(ctl, "%s",
J
Jim Meyering 已提交
12408
                 _("failed to open the log file. check the log file path"));
12409
        exit(EXIT_FAILURE);
12410 12411 12412 12413 12414 12415 12416 12417 12418
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
12419 12420
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
12421
{
12422 12423 12424
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438
    const char *lvl = "";
    struct timeval stTimeval;
    struct tm *stTm;

    if (ctl->log_fd == -1)
        return;

    /**
     * create log format
     *
     * [YYYY.MM.DD HH:MM:SS SIGNATURE PID] LOG_LEVEL message
    */
    gettimeofday(&stTimeval, NULL);
    stTm = localtime(&stTimeval.tv_sec);
12439 12440 12441 12442 12443 12444 12445 12446
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s] ",
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
                      SIGN_NAME);
12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466
    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;
    }
12467 12468 12469
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
12470

12471 12472
    if (virBufferError(&buf))
        goto error;
12473

12474 12475 12476 12477 12478
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
12479
    }
12480

12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491
    /* write log */
    if (safewrite(ctl->log_fd, str, len) < 0)
        goto error;

    return;

error:
    vshCloseLogFile(ctl);
    vshError(ctl, "%s", _("failed to write the log file"));
    virBufferFreeAndReset(&buf);
    VIR_FREE(str);
12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
12503 12504 12505
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
12506 12507 12508
    }

    if (ctl->logfile) {
12509
        VIR_FREE(ctl->logfile);
12510 12511 12512 12513
        ctl->logfile = NULL;
    }
}

12514
#ifdef USE_READLINE
12515

K
Karel Zak 已提交
12516 12517 12518 12519 12520
/* -----------------
 * Readline stuff
 * -----------------
 */

12521
/*
K
Karel Zak 已提交
12522 12523
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
12524
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
12525 12526
 */
static char *
12527 12528
vshReadlineCommandGenerator(const char *text, int state)
{
12529
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
12530
    const char *name;
12531 12532
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
12533 12534

    if (!state) {
12535 12536
        grp_list_index = 0;
        cmd_list_index = 0;
12537
        len = strlen(text);
K
Karel Zak 已提交
12538 12539
    }

12540 12541
    grp = cmdGroups;

K
Karel Zak 已提交
12542
    /* Return the next name which partially matches from the
12543
     * command list.
K
Karel Zak 已提交
12544
     */
12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558
    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 已提交
12559 12560 12561 12562 12563 12564 12565
    }

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

static char *
12566 12567
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
12568
    static int list_index, len;
12569
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
12570
    const char *name;
K
Karel Zak 已提交
12571 12572 12573 12574 12575 12576 12577 12578 12579

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

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

12580
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
12581
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
12582 12583 12584

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
12585
        len = strlen(text);
12586
        VIR_FREE(cmdname);
K
Karel Zak 已提交
12587 12588 12589 12590
    }

    if (!cmd)
        return NULL;
12591

12592 12593 12594
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
12595
    while ((name = cmd->opts[list_index].name)) {
12596
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
12597
        char *res;
12598

K
Karel Zak 已提交
12599
        list_index++;
12600

K
Karel Zak 已提交
12601
        if (opt->type == VSH_OT_DATA)
K
Karel Zak 已提交
12602 12603
            /* ignore non --option */
            continue;
12604

K
Karel Zak 已提交
12605
        if (len > 2) {
12606
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
12607 12608
                continue;
        }
12609
        res = vshMalloc(NULL, strlen(name) + 3);
12610
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
12611 12612 12613 12614 12615 12616 12617 12618
        return res;
    }

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

static char **
12619 12620 12621
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
12622 12623
    char **matches = (char **) NULL;

12624
    if (start == 0)
K
Karel Zak 已提交
12625
        /* command name generator */
12626
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
12627 12628
    else
        /* commands options */
12629
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
12630 12631 12632 12633
    return matches;
}


12634 12635
static int
vshReadlineInit(vshControl *ctl)
12636
{
12637 12638
    char *userdir = NULL;

K
Karel Zak 已提交
12639 12640 12641 12642 12643
    /* 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;
12644 12645 12646

    /* Limit the total size of the history buffer */
    stifle_history(500);
12647 12648

    /* Prepare to read/write history from/to the ~/.virsh/history file */
12649
    userdir = virGetUserDirectory(getuid());
12650

12651 12652
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
12653
        return -1;
12654
    }
12655 12656 12657

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12658
        VIR_FREE(userdir);
12659 12660 12661 12662 12663
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12664
        VIR_FREE(userdir);
12665 12666 12667
        return -1;
    }

12668
    VIR_FREE(userdir);
12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686

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

12687 12688
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
12689 12690
}

12691 12692 12693 12694 12695 12696
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

12697
#else /* !USE_READLINE */
12698

12699 12700 12701 12702 12703 12704 12705
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

12706
static void
12707
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730
{
    /* 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);
}

12731
#endif /* !USE_READLINE */
12732

K
Karel Zak 已提交
12733
/*
J
Jim Meyering 已提交
12734
 * Deinitialize virsh
K
Karel Zak 已提交
12735
 */
E
Eric Blake 已提交
12736
static bool
12737
vshDeinit(vshControl *ctl)
12738
{
12739
    vshReadlineDeinit(ctl);
12740
    vshCloseLogFile(ctl);
12741
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
12742
    if (ctl->conn) {
12743 12744 12745
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
12746 12747
        }
    }
D
Daniel P. Berrange 已提交
12748 12749
    virResetLastError();

E
Eric Blake 已提交
12750
    return true;
K
Karel Zak 已提交
12751
}
12752

K
Karel Zak 已提交
12753 12754 12755 12756
/*
 * Print usage
 */
static void
12757
vshUsage(void)
12758
{
12759
    const vshCmdGrp *grp;
12760
    const vshCmdDef *cmd;
12761

L
Lai Jiangshan 已提交
12762 12763
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
12764 12765 12766 12767 12768 12769 12770 12771
                      "  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"
12772
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
12773
                      "    -V | --version=long     version and full options\n\n"
12774
                      "  commands (non interactive mode):\n\n"), progname, progname);
12775

12776 12777
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
12778

12779 12780 12781 12782 12783 12784 12785 12786 12787
        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"));
12788 12789 12790
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
12791 12792
}

12793 12794 12795 12796 12797 12798 12799 12800 12801 12802
/*
 * 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 已提交
12803 12804
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839
#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 已提交
12840
    vshPrint(ctl, "%s", _(" Networking:"));
12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866
#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 已提交
12867
    vshPrint(ctl, "%s", _(" Storage:"));
12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890
#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 已提交
12891
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
12892
#ifdef WITH_SECDRIVER_APPARMOR
12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915
    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 已提交
12916 12917 12918 12919
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
12920
static bool
12921
vshParseArgv(vshControl *ctl, int argc, char **argv)
12922
{
12923 12924
    bool help = false;
    int arg;
K
Karel Zak 已提交
12925
    struct option opt[] = {
E
Eric Blake 已提交
12926 12927 12928 12929 12930 12931 12932 12933 12934
        {"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}
12935 12936
    };

12937 12938 12939
    /* 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. */
12940
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
12941
        switch (arg) {
12942
        case 'd':
D
Daniel Veillard 已提交
12943
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
12944
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
12945 12946
                exit(EXIT_FAILURE);
            }
12947 12948
            break;
        case 'h':
12949
            help = true;
12950 12951
            break;
        case 'q':
E
Eric Blake 已提交
12952
            ctl->quiet = true;
12953 12954
            break;
        case 't':
E
Eric Blake 已提交
12955
            ctl->timing = true;
12956 12957 12958 12959
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
12960 12961 12962 12963 12964 12965
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
12966 12967 12968
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
12969
        case 'r':
E
Eric Blake 已提交
12970
            ctl->readonly = true;
12971
            break;
12972 12973 12974
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
12975
        default:
12976 12977
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
12978 12979 12980 12981
        }
    }

    if (help) {
12982 12983
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
12984 12985
            exit(EXIT_FAILURE);
        }
12986 12987 12988

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
12989
        exit(EXIT_SUCCESS);
12990 12991
    }

12992
    if (argc > optind) {
K
Karel Zak 已提交
12993
        /* parse command */
E
Eric Blake 已提交
12994
        ctl->imode = false;
12995 12996 12997
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
12998
        } else {
12999
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
13000 13001
        }
    }
E
Eric Blake 已提交
13002
    return true;
K
Karel Zak 已提交
13003 13004
}

13005 13006 13007 13008
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
13009
    char *defaultConn;
E
Eric Blake 已提交
13010
    bool ret = true;
K
Karel Zak 已提交
13011

13012 13013 13014 13015
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */

13016 13017
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
13018
        /* failure to setup locale is not fatal */
13019
    }
13020
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
13021
        perror("bindtextdomain");
E
Eric Blake 已提交
13022
        return EXIT_FAILURE;
13023
    }
13024
    if (!textdomain(PACKAGE)) {
13025
        perror("textdomain");
E
Eric Blake 已提交
13026
        return EXIT_FAILURE;
13027 13028
    }

13029 13030 13031 13032 13033
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

13034
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
13035 13036 13037
        progname = argv[0];
    else
        progname++;
13038

13039
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
13040
        ctl->name = vshStrdup(ctl, defaultConn);
13041 13042
    }

D
Daniel P. Berrange 已提交
13043 13044
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
13045
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
13046
    }
13047

D
Daniel P. Berrange 已提交
13048 13049
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
13050
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
13051
    }
13052

K
Karel Zak 已提交
13053
    if (!ctl->imode) {
13054
        ret = vshCommandRun(ctl, ctl->cmd);
13055
    } else {
K
Karel Zak 已提交
13056 13057
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
13058
            vshPrint(ctl,
13059
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
13060
                     progname);
J
Jim Meyering 已提交
13061
            vshPrint(ctl, "%s",
13062
                     _("Type:  'help' for help with commands\n"
13063
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
13064
        }
13065 13066 13067 13068 13069 13070

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
13071
        do {
13072
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
13073
            ctl->cmdstr =
13074
                vshReadline(ctl, prompt);
13075 13076
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
13077
            if (*ctl->cmdstr) {
13078
#if USE_READLINE
K
Karel Zak 已提交
13079
                add_history(ctl->cmdstr);
13080
#endif
13081
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
13082 13083
                    vshCommandRun(ctl, ctl->cmd);
            }
13084
            VIR_FREE(ctl->cmdstr);
13085
        } while (ctl->imode);
K
Karel Zak 已提交
13086

13087 13088
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
13089
    }
13090

K
Karel Zak 已提交
13091 13092
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
13093
}