virsh.c 445.6 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>
E
Eric Blake 已提交
35
#include <strings.h>
K
Karel Zak 已提交
36

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

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

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

static char *progname;

65 66
#define VIRSH_MAX_XML_FILE 10*1024*1024

K
Karel Zak 已提交
67 68 69
#define VSH_PROMPT_RW    "virsh # "
#define VSH_PROMPT_RO    "virsh > "

70 71
#define VIR_FROM_THIS VIR_FROM_NONE

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

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

J
Jiri Denemark 已提交
104 105
#define VSH_DEBUG_DEFAULT VSH_ERR_ERROR

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

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

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

K
Karel Zak 已提交
153 154 155
/*
 * Command Option Flags
 */
E
Eric Blake 已提交
156 157 158 159
enum {
    VSH_OFLAG_NONE     = 0,        /* without flags */
    VSH_OFLAG_REQ      = (1 << 0), /* option required */
    VSH_OFLAG_EMPTY_OK = (1 << 1), /* empty string option allowed */
L
Lai Jiangshan 已提交
160
    VSH_OFLAG_REQ_OPT  = (1 << 2), /* --optionname required */
E
Eric Blake 已提交
161
};
K
Karel Zak 已提交
162 163 164 165 166 167

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

/*
E
Eric Blake 已提交
168 169 170 171 172
 * vshCmdInfo -- name/value pair for information about command
 *
 * Commands should have at least the following names:
 * "name" - command name
 * "desc" - description of command, or empty string
K
Karel Zak 已提交
173
 */
174
typedef struct {
E
Eric Blake 已提交
175 176
    const char *name;           /* name of information, or NULL for list end */
    const char *data;           /* non-NULL information */
K
Karel Zak 已提交
177 178 179 180 181
} vshCmdInfo;

/*
 * vshCmdOptDef - command option definition
 */
182
typedef struct {
E
Eric Blake 已提交
183
    const char *name;           /* the name of option, or NULL for list end */
184
    vshCmdOptType type;         /* option type */
E
Eric Blake 已提交
185
    unsigned int flags;         /* flags */
E
Eric Blake 已提交
186
    const char *help;           /* non-NULL help string */
K
Karel Zak 已提交
187 188 189 190
} vshCmdOptDef;

/*
 * vshCmdOpt - command options
E
Eric Blake 已提交
191 192 193
 *
 * After parsing a command, all arguments to the command have been
 * collected into a list of these objects.
K
Karel Zak 已提交
194 195
 */
typedef struct vshCmdOpt {
E
Eric Blake 已提交
196 197
    const vshCmdOptDef *def;    /* non-NULL pointer to option definition */
    char *data;                 /* allocated data, or NULL for bool option */
198
    struct vshCmdOpt *next;
K
Karel Zak 已提交
199 200
} vshCmdOpt;

201 202 203 204 205 206 207
/*
 * Command Usage Flags
 */
enum {
    VSH_CMD_FLAG_NOCONNECT = (1 << 0),  /* no prior connection needed */
};

K
Karel Zak 已提交
208 209 210
/*
 * vshCmdDef - command definition
 */
211
typedef struct {
E
Eric Blake 已提交
212
    const char *name;           /* name of command, or NULL for list end */
E
Eric Blake 已提交
213
    bool (*handler) (vshControl *, const vshCmd *);    /* command handler */
214 215
    const vshCmdOptDef *opts;   /* definition of command options */
    const vshCmdInfo *info;     /* details about command */
216
    unsigned int flags;         /* bitwise OR of VSH_CMD_FLAG */
K
Karel Zak 已提交
217 218 219 220 221 222
} vshCmdDef;

/*
 * vshCmd - parsed command
 */
typedef struct __vshCmd {
223
    const vshCmdDef *def;       /* command definition */
224 225
    vshCmdOpt *opts;            /* list of command arguments */
    struct __vshCmd *next;      /* next command */
K
Karel Zak 已提交
226 227 228 229 230 231
} __vshCmd;

/*
 * vshControl
 */
typedef struct __vshControl {
K
Karel Zak 已提交
232
    char *name;                 /* connection name */
233
    virConnectPtr conn;         /* connection to hypervisor (MAY BE NULL) */
234 235
    vshCmd *cmd;                /* the current command */
    char *cmdstr;               /* string with command */
E
Eric Blake 已提交
236 237
    bool imode;                 /* interactive mode? */
    bool quiet;                 /* quiet mode */
238
    int debug;                  /* print debug messages? */
E
Eric Blake 已提交
239 240
    bool timing;                /* print timing info? */
    bool readonly;              /* connect readonly (first time only, not
241 242
                                 * during explicit connect command)
                                 */
243 244
    char *logfile;              /* log file name */
    int log_fd;                 /* log file descriptor */
245 246
    char *historydir;           /* readline history directory name */
    char *historyfile;          /* readline history file name */
247 248
    bool useGetInfo;            /* must use virDomainGetInfo, since
                                   virDomainGetState is not supported */
K
Karel Zak 已提交
249
} __vshControl;
250

251
typedef struct vshCmdGrp {
E
Eric Blake 已提交
252
    const char *name;    /* name of group, or NULL for list end */
253 254 255
    const char *keyword; /* help keyword */
    const vshCmdDef *commands;
} vshCmdGrp;
256

257
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
258

259 260
static void vshError(vshControl *ctl, const char *format, ...)
    ATTRIBUTE_FMT_PRINTF(2, 3);
E
Eric Blake 已提交
261 262
static bool vshInit(vshControl *ctl);
static bool vshDeinit(vshControl *ctl);
263
static void vshUsage(void);
264
static void vshOpenLogFile(vshControl *ctl);
265 266
static void vshOutputLogFile(vshControl *ctl, int log_level, const char *format, va_list ap)
    ATTRIBUTE_FMT_PRINTF(3, 0);
267
static void vshCloseLogFile(vshControl *ctl);
K
Karel Zak 已提交
268

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

271
static const char *vshCmddefGetInfo(const vshCmdDef *cmd, const char *info);
272
static const vshCmdDef *vshCmddefSearch(const char *cmdname);
E
Eric Blake 已提交
273
static bool vshCmddefHelp(vshControl *ctl, const char *name);
274
static const vshCmdGrp *vshCmdGrpSearch(const char *grpname);
E
Eric Blake 已提交
275
static bool vshCmdGrpHelp(vshControl *ctl, const char *name);
K
Karel Zak 已提交
276

E
Eric Blake 已提交
277 278 279
static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
    ATTRIBUTE_RETURN_CHECK;
280 281
static int vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
282 283 284
static int vshCommandOptUInt(const vshCmd *cmd, const char *name,
                             unsigned int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
285 286 287 288 289 290 291 292 293
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;
294 295 296
static int vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                                  unsigned long long *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
E
Eric Blake 已提交
297
static bool vshCommandOptBool(const vshCmd *cmd, const char *name);
298 299
static const vshCmdOpt *vshCommandOptArgv(const vshCmd *cmd,
                                          const vshCmdOpt *opt);
K
Karel Zak 已提交
300

301 302 303
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
304
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
305

306
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
307
                                          const char **name, int flag);
K
Karel Zak 已提交
308 309

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

313
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
314
                                            const char **name, int flag);
315 316

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
317 318
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
319 320
                           VSH_BYUUID|VSH_BYNAME)

321
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
322
                                                  const char **name, int flag);
323 324 325 326 327 328

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

329
static virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
330
                                                const char **name, int flag);
331 332 333 334 335 336

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

337
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
338
                            const char *optname, const char **name, int flag);
339 340 341 342 343 344

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

345
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
346 347
                                           const char *optname,
                                           const char *pooloptname,
348
                                           const char **name, int flag);
349 350

/* default is lookup by Name and UUID */
351
#define vshCommandOptVol(_ctl, _cmd, _optname, _pooloptname, _name)   \
352 353 354
    vshCommandOptVolBy(_ctl, _cmd, _optname, _pooloptname, _name,     \
                           VSH_BYUUID|VSH_BYNAME)

355
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
356
                                        const char **name);
357

358
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
359
    ATTRIBUTE_FMT_PRINTF(2, 3);
360
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
361
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
362 363

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

366
static int vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason);
K
Karel Zak 已提交
367
static const char *vshDomainStateToString(int state);
368
static const char *vshDomainStateReasonToString(int state, int reason);
369
static const char *vshDomainControlStateToString(int state);
370
static const char *vshDomainVcpuStateToString(int state);
E
Eric Blake 已提交
371
static bool vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
K
Karel Zak 已提交
372

373 374 375 376
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

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

386
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
387 388
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
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
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463

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;

464
  /* User visible sort, so we want locale-specific case comparison.  */
465 466 467
  return strcasecmp(*sa, *sb);
}

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
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 已提交
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
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)
{
515 516 517 518 519 520 521 522
    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)
523
            goto out;
524
    }
J
John Levon 已提交
525 526

    if (last_error->code == VIR_ERR_OK) {
527
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
528 529 530
        goto out;
    }

531
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
532 533 534 535 536 537

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

538 539 540 541 542 543 544 545 546
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;
}

547 548 549 550 551
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

552 553 554 555 556
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

557 558 559 560 561 562
/*
 * 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
 */
563 564 565 566
static void vshCatchDisconnect(int sig, siginfo_t *siginfo,
                               void *context ATTRIBUTE_UNUSED) {
    if ((sig == SIGPIPE) ||
        (SA_SIGINFO && siginfo->si_signo == SIGPIPE))
567 568 569 570 571 572 573 574 575
        disconnected++;
}

/*
 * vshSetupSignals:
 *
 * Catch SIGPIPE signals which may arise when disconnection
 * from libvirtd occurs
 */
L
Laine Stump 已提交
576
static void
577 578 579 580 581 582 583 584 585 586 587 588 589
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 已提交
590
 * Reconnect after a disconnect from libvirtd
591 592
 *
 */
L
Laine Stump 已提交
593
static void
594 595 596 597 598 599
vshReconnect(vshControl *ctl)
{
    bool connected = false;

    if (ctl->conn != NULL) {
        connected = true;
600
        virConnectClose(ctl->conn);
601
    }
602 603 604 605 606 607

    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);
    if (!ctl->conn)
        vshError(ctl, "%s", _("Failed to reconnect to the hypervisor"));
608
    else if (connected)
609 610
        vshError(ctl, "%s", _("Reconnected to the hypervisor"));
    disconnected = 0;
611
    ctl->useGetInfo = false;
612
}
613

K
Karel Zak 已提交
614 615 616 617 618 619
/* ---------------
 * Commands
 * ---------------
 */

/*
620
 * "help" command
K
Karel Zak 已提交
621
 */
622
static const vshCmdInfo info_help[] = {
623
    {"help", N_("print help")},
624 625
    {"desc", N_("Prints global help, command specific help, or help for a\n"
                "    group of related commands")},
626

627
    {NULL, NULL}
K
Karel Zak 已提交
628 629
};

630
static const vshCmdOptDef opts_help[] = {
631
    {"command", VSH_OT_DATA, 0, N_("Prints global help, command specific help, or help for a group of related commands")},
632
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
633 634
};

E
Eric Blake 已提交
635
static bool
636
cmdHelp(vshControl *ctl, const vshCmd *cmd)
637
 {
638
    const char *name = NULL;
639

640
    if (vshCommandOptString(cmd, "command", &name) <= 0) {
641
        const vshCmdGrp *grp;
642
        const vshCmdDef *def;
643

644 645 646 647 648 649 650 651 652 653 654 655 656
        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 已提交
657
        return true;
658
    }
659

E
Eric Blake 已提交
660
    if (vshCmddefSearch(name)) {
661
        return vshCmddefHelp(ctl, name);
E
Eric Blake 已提交
662
    } else if (vshCmdGrpSearch(name)) {
663 664 665
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
E
Eric Blake 已提交
666
        return false;
K
Karel Zak 已提交
667 668 669
    }
}

670 671 672
/*
 * "autostart" command
 */
673
static const vshCmdInfo info_autostart[] = {
674
    {"help", N_("autostart a domain")},
675
    {"desc",
676
     N_("Configure a domain to be automatically started at boot.")},
677 678 679
    {NULL, NULL}
};

680
static const vshCmdOptDef opts_autostart[] = {
681 682
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
683 684 685
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
686
static bool
687
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
688 689
{
    virDomainPtr dom;
690
    const char *name;
691 692
    int autostart;

693
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
694
        return false;
695

J
Jim Meyering 已提交
696
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
697
        return false;
698 699 700 701

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
702
        if (autostart)
703
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
704
        else
705
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
706
        virDomainFree(dom);
E
Eric Blake 已提交
707
        return false;
708 709
    }

710
    if (autostart)
711
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
712
    else
713
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
714

715
    virDomainFree(dom);
E
Eric Blake 已提交
716
    return true;
717 718
}

K
Karel Zak 已提交
719
/*
720
 * "connect" command
K
Karel Zak 已提交
721
 */
722
static const vshCmdInfo info_connect[] = {
723
    {"help", N_("(re)connect to hypervisor")},
724
    {"desc",
725
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
726
    {NULL, NULL}
K
Karel Zak 已提交
727 728
};

729
static const vshCmdOptDef opts_connect[] = {
E
Eric Blake 已提交
730 731
    {"name",     VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("hypervisor connection URI")},
732
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
733
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
734 735
};

E
Eric Blake 已提交
736
static bool
737
cmdConnect(vshControl *ctl, const vshCmd *cmd)
738
{
E
Eric Blake 已提交
739
    bool ro = vshCommandOptBool(cmd, "readonly");
740
    const char *name = NULL;
741

K
Karel Zak 已提交
742
    if (ctl->conn) {
743 744 745
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
E
Eric Blake 已提交
746
            return false;
K
Karel Zak 已提交
747 748 749
        }
        ctl->conn = NULL;
    }
750

751
    VIR_FREE(ctl->name);
752 753
    if (vshCommandOptString(cmd, "name", &name) < 0) {
        vshError(ctl, "%s", _("Please specify valid connection URI"));
E
Eric Blake 已提交
754
        return false;
755
    }
756
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
757

758
    ctl->useGetInfo = false;
E
Eric Blake 已提交
759
    ctl->readonly = ro;
K
Karel Zak 已提交
760

761 762 763
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

E
Eric Blake 已提交
767
    return !!ctl->conn;
K
Karel Zak 已提交
768 769
}

770 771
#ifndef WIN32

772
/*
773
 * "console" command
774
 */
775
static const vshCmdInfo info_console[] = {
776
    {"help", N_("connect to the guest console")},
777
    {"desc",
778
     N_("Connect the virtual serial console for the guest")},
779 780 781
    {NULL, NULL}
};

782
static const vshCmdOptDef opts_console[] = {
783
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
784
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
785 786 787
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
788
static bool
789
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
790
{
E
Eric Blake 已提交
791
    bool ret = false;
792
    int state;
793

794
    if ((state = vshDomainState(ctl, dom, NULL)) < 0) {
795 796 797 798
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

799
    if (state == VIR_DOMAIN_SHUTOFF) {
800 801 802 803
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

804 805
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
    vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
806
    if (vshRunConsole(dom, name) == 0)
E
Eric Blake 已提交
807
        ret = true;
808 809

 cleanup:
810

811 812 813
    return ret;
}

E
Eric Blake 已提交
814
static bool
815 816 817
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
818
    bool ret = false;
819
    const char *name = NULL;
820

821
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
822
        return false;
823 824

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

827 828 829 830
    if (vshCommandOptString(cmd, "devname", &name) < 0) {
        vshError(ctl, "%s", _("Invalid devname"));
        goto cleanup;
    }
831

832
    ret = cmdRunConsole(ctl, dom, name);
833

834
cleanup:
835 836 837 838
    virDomainFree(dom);
    return ret;
}

839 840 841
#endif /* WIN32 */


K
Karel Zak 已提交
842 843 844
/*
 * "list" command
 */
845
static const vshCmdInfo info_list[] = {
846 847
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
848
    {NULL, NULL}
K
Karel Zak 已提交
849 850
};

851
static const vshCmdOptDef opts_list[] = {
852 853
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
E
Eric Blake 已提交
854 855
    {"managed-save", VSH_OT_BOOL, 0,
     N_("mark domains with managed save state")},
856 857 858
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
859

E
Eric Blake 已提交
860
static bool
861
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
862
{
863 864 865 866
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
867
    char **names = NULL;
868
    int maxname = 0;
E
Eric Blake 已提交
869 870 871
    bool managed = vshCommandOptBool(cmd, "managed-save");
    int state;

872
    inactive |= all;
K
Karel Zak 已提交
873

874
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
875
        return false;
876

877
    if (active) {
878 879
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
880
            vshError(ctl, "%s", _("Failed to list active domains"));
E
Eric Blake 已提交
881
            return false;
882 883 884 885 886
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
887
                vshError(ctl, "%s", _("Failed to list active domains"));
888
                VIR_FREE(ids);
E
Eric Blake 已提交
889
                return false;
890 891
            }

892
            qsort(&ids[0], maxid, sizeof(int), idsorter);
893
        }
894 895
    }
    if (inactive) {
896 897
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
898
            vshError(ctl, "%s", _("Failed to list inactive domains"));
899
            VIR_FREE(ids);
E
Eric Blake 已提交
900
            return false;
901
        }
902 903 904 905
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
906
                vshError(ctl, "%s", _("Failed to list inactive domains"));
907 908
                VIR_FREE(ids);
                VIR_FREE(names);
E
Eric Blake 已提交
909
                return false;
910
            }
911

912
            qsort(&names[0], maxname, sizeof(char*), namesorter);
913
        }
914
    }
915
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
916
    vshPrintExtra(ctl, "----------------------------------\n");
917 918

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

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

K
Karel Zak 已提交
925
        vshPrint(ctl, "%3d %-20s %s\n",
926 927
                 virDomainGetID(dom),
                 virDomainGetName(dom),
E
Eric Blake 已提交
928
                 _(vshDomainStateToString(vshDomainState(ctl, dom, NULL))));
929
        virDomainFree(dom);
K
Karel Zak 已提交
930
    }
931 932 933 934
    for (i = 0; i < maxname; i++) {
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);

        /* this kind of work with domains is not atomic operation */
935
        if (!dom) {
936
            VIR_FREE(names[i]);
937
            continue;
938
        }
939

E
Eric Blake 已提交
940 941 942 943 944
        state = vshDomainState(ctl, dom, NULL);
        if (managed && state == VIR_DOMAIN_SHUTOFF &&
            virDomainHasManagedSaveImage(dom, 0) > 0)
            state = -2;

945 946 947
        vshPrint(ctl, "%3s %-20s %s\n",
                 "-",
                 names[i],
E
Eric Blake 已提交
948
                 state == -2 ? _("saved") : _(vshDomainStateToString(state)));
949

950
        virDomainFree(dom);
951
        VIR_FREE(names[i]);
952
    }
953 954
    VIR_FREE(ids);
    VIR_FREE(names);
E
Eric Blake 已提交
955
    return true;
K
Karel Zak 已提交
956 957 958
}

/*
K
Karel Zak 已提交
959
 * "domstate" command
K
Karel Zak 已提交
960
 */
961
static const vshCmdInfo info_domstate[] = {
962 963
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
964
    {NULL, NULL}
K
Karel Zak 已提交
965 966
};

967
static const vshCmdOptDef opts_domstate[] = {
968
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
969
    {"reason", VSH_OT_BOOL, 0, N_("also print reason for the state")},
970
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
971 972
};

E
Eric Blake 已提交
973
static bool
974
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
975
{
K
Karel Zak 已提交
976
    virDomainPtr dom;
E
Eric Blake 已提交
977
    bool ret = true;
978 979
    int showReason = vshCommandOptBool(cmd, "reason");
    int state, reason;
980

981
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
982
        return false;
983

J
Jim Meyering 已提交
984
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
985
        return false;
986

987
    if ((state = vshDomainState(ctl, dom, &reason)) < 0) {
E
Eric Blake 已提交
988
        ret = false;
989 990 991 992 993 994 995 996 997 998 999
        goto cleanup;
    }

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

1001
cleanup:
1002 1003 1004 1005
    virDomainFree(dom);
    return ret;
}

1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
/*
 * "domcontrol" command
 */
static const vshCmdInfo info_domcontrol[] = {
    {"help", N_("domain control interface state")},
    {"desc", N_("Returns state of a control interface to the domain.")},
    {NULL, NULL}
};

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

static bool
cmdDomControl(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = true;
    virDomainControlInfo info;

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

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

    if (virDomainGetControlInfo(dom, &info, 0) < 0) {
        ret = false;
        goto cleanup;
    }

    if (info.state != VIR_DOMAIN_CONTROL_OK &&
        info.state != VIR_DOMAIN_CONTROL_ERROR) {
        vshPrint(ctl, "%s (%0.3fs)\n",
                 _(vshDomainControlStateToString(info.state)),
                 info.stateTime / 1000.0);
    } else {
        vshPrint(ctl, "%s\n",
                 _(vshDomainControlStateToString(info.state)));
    }

cleanup:
    virDomainFree(dom);
    return ret;
}

1053 1054
/* "domblkstat" command
 */
1055
static const vshCmdInfo info_domblkstat[] = {
1056 1057
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
1058 1059 1060
    {NULL,NULL}
};

1061
static const vshCmdOptDef opts_domblkstat[] = {
1062 1063
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
1064 1065 1066
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1067
static bool
1068
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
1069 1070
{
    virDomainPtr dom;
1071
    const char *name = NULL, *device = NULL;
1072 1073
    struct _virDomainBlockStats stats;

1074
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1075
        return false;
1076

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

1080
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
L
Laine Stump 已提交
1081
        virDomainFree(dom);
E
Eric Blake 已提交
1082
        return false;
L
Laine Stump 已提交
1083
    }
1084 1085

    if (virDomainBlockStats (dom, device, &stats, sizeof stats) == -1) {
1086
        vshError(ctl, _("Failed to get block stats %s %s"), name, device);
1087
        virDomainFree(dom);
E
Eric Blake 已提交
1088
        return false;
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
    }

    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 已提交
1107
    return true;
1108 1109 1110 1111
}

/* "domifstat" command
 */
1112
static const vshCmdInfo info_domifstat[] = {
1113 1114
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1115 1116 1117
    {NULL,NULL}
};

1118
static const vshCmdOptDef opts_domifstat[] = {
1119 1120
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1121 1122 1123
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1124
static bool
1125
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1126 1127
{
    virDomainPtr dom;
1128
    const char *name = NULL, *device = NULL;
1129 1130
    struct _virDomainInterfaceStats stats;

1131
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1132
        return false;
1133

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

1137
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1138
        virDomainFree(dom);
E
Eric Blake 已提交
1139
        return false;
L
Laine Stump 已提交
1140
    }
1141 1142

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1143
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1144
        virDomainFree(dom);
E
Eric Blake 已提交
1145
        return false;
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
    }

    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 已提交
1173
    return true;
1174 1175
}

1176 1177 1178
/*
 * "dommemstats" command
 */
1179
static const vshCmdInfo info_dommemstat[] = {
1180 1181
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1182 1183 1184
    {NULL,NULL}
};

1185
static const vshCmdOptDef opts_dommemstat[] = {
1186
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1187 1188 1189
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1190
static bool
1191
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1192 1193
{
    virDomainPtr dom;
1194
    const char *name;
1195 1196 1197
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1198
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1199
        return false;
1200 1201

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1202
        return false;
1203 1204 1205 1206 1207

    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 已提交
1208
        return false;
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
    }

    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);
1224 1225
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON)
            vshPrint (ctl, "actual %llu\n", stats[i].val);
1226 1227 1228
    }

    virDomainFree(dom);
E
Eric Blake 已提交
1229
    return true;
1230 1231
}

1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
/*
 * "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 已提交
1247
static bool
1248 1249 1250 1251
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1252
    bool ret = true;
1253
    const char *device = NULL;
1254

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

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

1261
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1262
        virDomainFree(dom);
E
Eric Blake 已提交
1263
        return false;
1264 1265 1266 1267
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1268
        return false;
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
    }

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

1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
/*
 * "domblklist" command
 */
static const vshCmdInfo info_domblklist[] = {
    {"help", N_("list all domain blocks")},
    {"desc", N_("Get the names of block devices for a domain.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_domblklist[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"inactive", VSH_OT_BOOL, 0,
     N_("get inactive rather than running configuration")},
    {NULL, 0, 0, NULL}
};

static bool
cmdDomblklist(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = false;
    unsigned int flags = 0;
    char *xml = NULL;
    xmlDocPtr xmldoc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    int ndisks;
    xmlNodePtr *disks = NULL;
    int i;

    if (vshCommandOptBool(cmd, "inactive"))
        flags |= VIR_DOMAIN_XML_INACTIVE;

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

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

    xml = virDomainGetXMLDesc(dom, flags);
    if (!xml)
        goto cleanup;

    xmldoc = virXMLParseStringCtxt(xml, "domain.xml", &ctxt);
    if (!xmldoc)
        goto cleanup;

    ndisks = virXPathNodeSet("./devices/disk", ctxt, &disks);
    if (ndisks < 0)
        goto cleanup;

    vshPrint(ctl, "%-10s %s\n", _("Target"), _("Source"));
    vshPrint(ctl, "------------------------------------------------\n");

    for (i = 0; i < ndisks; i++) {
        char *target;
        char *source;

        ctxt->node = disks[i];
        target = virXPathString("string(./target/@dev)", ctxt);
        if (!target) {
            vshError(ctl, "unable to query block list");
            goto cleanup;
        }
        source = virXPathString("string(./source/@file"
                                "|./source/@dev"
                                "|./source/@dir"
                                "|./source/@name)", ctxt);
        vshPrint(ctl, "%-10s %s\n", target, source ? source : "-");
        VIR_FREE(target);
        VIR_FREE(source);
    }

    ret = 0;

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

1359 1360 1361
/*
 * "suspend" command
 */
1362
static const vshCmdInfo info_suspend[] = {
1363 1364
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1365
    {NULL, NULL}
1366 1367
};

1368
static const vshCmdOptDef opts_suspend[] = {
1369
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1370
    {NULL, 0, 0, NULL}
1371 1372
};

E
Eric Blake 已提交
1373
static bool
1374
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1375
{
1376
    virDomainPtr dom;
1377
    const char *name;
E
Eric Blake 已提交
1378
    bool ret = true;
1379

1380
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1381
        return false;
1382

J
Jim Meyering 已提交
1383
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1384
        return false;
1385 1386

    if (virDomainSuspend(dom) == 0) {
1387
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1388
    } else {
1389
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1390
        ret = false;
1391
    }
1392

1393 1394 1395 1396
    virDomainFree(dom);
    return ret;
}

1397 1398 1399
/*
 * "create" command
 */
1400
static const vshCmdInfo info_create[] = {
1401 1402
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1403 1404 1405
    {NULL, NULL}
};

1406
static const vshCmdOptDef opts_create[] = {
1407
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1408
#ifndef WIN32
1409
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1410
#endif
1411
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1412
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1413 1414 1415
    {NULL, 0, 0, NULL}
};

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

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

1431
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1432
        return false;
1433

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

1437 1438
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1439 1440
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1441 1442

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1443
    VIR_FREE(buffer);
1444

1445
    if (dom != NULL) {
1446
        vshPrint(ctl, _("Domain %s created from %s\n"),
1447
                 virDomainGetName(dom), from);
1448
#ifndef WIN32
1449
        if (console)
1450
            cmdRunConsole(ctl, dom, NULL);
1451
#endif
1452
        virDomainFree(dom);
1453
    } else {
1454
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1455
        ret = false;
1456 1457 1458 1459
    }
    return ret;
}

1460 1461 1462
/*
 * "define" command
 */
1463
static const vshCmdInfo info_define[] = {
1464 1465
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1466 1467 1468
    {NULL, NULL}
};

1469
static const vshCmdOptDef opts_define[] = {
1470
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1471 1472 1473
    {NULL, 0, 0, NULL}
};

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

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

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

1488
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1489
        return false;
1490 1491

    dom = virDomainDefineXML(ctl->conn, buffer);
1492
    VIR_FREE(buffer);
1493

1494
    if (dom != NULL) {
1495
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1496
                 virDomainGetName(dom), from);
1497
        virDomainFree(dom);
1498
    } else {
1499
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1500
        ret = false;
1501 1502 1503 1504 1505 1506 1507
    }
    return ret;
}

/*
 * "undefine" command
 */
1508
static const vshCmdInfo info_undefine[] = {
1509 1510
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1511 1512 1513
    {NULL, NULL}
};

1514
static const vshCmdOptDef opts_undefine[] = {
1515
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1516
    {"managed-save", VSH_OT_BOOL, 0, N_("remove domain managed state file")},
1517 1518
    {"snapshots-metadata", VSH_OT_BOOL, 0,
     N_("remove all domain snapshot metadata, if inactive")},
1519 1520 1521
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1522
static bool
1523
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1524 1525
{
    virDomainPtr dom;
1526
    bool ret = false;
1527
    const char *name = NULL;
1528
    /* Flags to attempt.  */
E
Eric Blake 已提交
1529
    unsigned int flags = 0;
1530 1531 1532 1533
    /* User-requested actions.  */
    bool managed_save = vshCommandOptBool(cmd, "managed-save");
    bool snapshots_metadata = vshCommandOptBool(cmd, "snapshots-metadata");
    /* Positive if these items exist.  */
1534
    int has_managed_save = 0;
1535 1536 1537 1538 1539
    int has_snapshots_metadata = 0;
    int has_snapshots = 0;
    /* True if undefine will not strand data, even on older servers.  */
    bool managed_save_safe = false;
    bool snapshots_safe = false;
1540
    int rc = -1;
1541
    int running;
1542

1543
    if (managed_save) {
1544
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
1545 1546 1547 1548 1549 1550
        managed_save_safe = true;
    }
    if (snapshots_metadata) {
        flags |= VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
1551

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

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

1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
    /* Do some flag manipulation.  The goal here is to disable bits
     * from flags to reduce the likelihood of a server rejecting
     * unknown flag bits, as well as to track conditions which are
     * safe by default for the given hypervisor and server version.  */
    running = virDomainIsActive(dom);
    if (running < 0) {
        virshReportError(ctl);
        goto cleanup;
    }
    if (!running) {
        /* Undefine with snapshots only fails for inactive domains,
         * and managed save only exists on inactive domains; if
         * running, then we don't want to remove anything.  */
        has_managed_save = virDomainHasManagedSaveImage(dom, 0);
        if (has_managed_save < 0) {
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
                goto cleanup;
            }
1577 1578
            virFreeError(last_error);
            last_error = NULL;
1579
            has_managed_save = 0;
1580 1581
        }

1582 1583
        has_snapshots = virDomainSnapshotNum(dom, 0);
        if (has_snapshots < 0) {
1584 1585
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
                goto cleanup;
            }
            virFreeError(last_error);
            last_error = NULL;
            has_snapshots = 0;
        }
        if (has_snapshots) {
            has_snapshots_metadata
                = virDomainSnapshotNum(dom, VIR_DOMAIN_SNAPSHOT_LIST_METADATA);
            if (has_snapshots_metadata < 0) {
                /* The server did not know the new flag, assume that all
                   snapshots have metadata.  */
1598 1599
                virFreeError(last_error);
                last_error = NULL;
1600 1601 1602 1603 1604
                has_snapshots_metadata = has_snapshots;
            } else {
                /* The server knew the new flag, all aspects of
                 * undefineFlags are safe.  */
                managed_save_safe = snapshots_safe = true;
1605
            }
1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
        }
    }
    if (!has_managed_save) {
        flags &= ~VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
        managed_save_safe = true;
    }
    if (has_snapshots == 0) {
        snapshots_safe = true;
    }
    if (has_snapshots_metadata == 0) {
        flags &= ~VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
1619

1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
    /* Generally we want to try the new API first.  However, while
     * virDomainUndefineFlags was introduced at the same time as
     * VIR_DOMAIN_UNDEFINE_MANAGED_SAVE in 0.9.4, the
     * VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA flag was not present
     * until 0.9.5; skip to piecewise emulation if we couldn't prove
     * above that the new API is safe.  */
    if (managed_save_safe && snapshots_safe) {
        rc = virDomainUndefineFlags(dom, flags);
        if (rc == 0 || (last_error->code != VIR_ERR_NO_SUPPORT &&
                        last_error->code != VIR_ERR_INVALID_ARG))
            goto out;
        virFreeError(last_error);
        last_error = NULL;
    }
1634

1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
    /* The new API is unsupported or unsafe; fall back to doing things
     * piecewise.  */
    if (has_managed_save) {
        if (!managed_save) {
            vshError(ctl, "%s",
                     _("Refusing to undefine while domain managed save "
                       "image exists"));
            goto cleanup;
        }
        if (virDomainManagedSaveRemove(dom, 0) < 0) {
            virshReportError(ctl);
            goto cleanup;
1647 1648 1649
        }
    }

1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
    /* No way to emulate deletion of just snapshot metadata
     * without support for the newer flags.  Oh well.  */
    if (has_snapshots_metadata) {
        vshError(ctl,
                 snapshots_metadata ?
                 _("Unable to remove metadata of %d snapshots") :
                 _("Refusing to undefine while %d snapshots exist"),
                 has_snapshots_metadata);
        goto cleanup;
    }

    rc = virDomainUndefine(dom);

out:
1664
    if (rc == 0) {
1665
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1666
        ret = true;
1667
    } else {
1668
        vshError(ctl, _("Failed to undefine domain %s"), name);
1669 1670
    }

1671
cleanup:
1672
    virDomainFree(dom);
1673 1674 1675 1676 1677 1678 1679
    return ret;
}


/*
 * "start" command
 */
1680
static const vshCmdInfo info_start[] = {
1681
    {"help", N_("start a (previously defined) inactive domain")},
1682 1683 1684
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1685 1686 1687
    {NULL, NULL}
};

1688
static const vshCmdOptDef opts_start[] = {
1689
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1690
#ifndef WIN32
1691
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1692
#endif
E
Eric Blake 已提交
1693
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1694 1695
    {"autodestroy", VSH_OT_BOOL, 0,
     N_("automatically destroy the guest when virsh disconnects")},
1696 1697
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when loading")},
1698 1699
    {"force-boot", VSH_OT_BOOL, 0,
     N_("force fresh boot by discarding any managed save")},
1700 1701 1702
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1703
static bool
1704
cmdStart(vshControl *ctl, const vshCmd *cmd)
1705 1706
{
    virDomainPtr dom;
1707
    bool ret = false;
1708
#ifndef WIN32
1709
    int console = vshCommandOptBool(cmd, "console");
1710
#endif
E
Eric Blake 已提交
1711
    unsigned int flags = VIR_DOMAIN_NONE;
1712
    int rc;
1713

1714
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1715
        return false;
1716

1717 1718
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
1719
        return false;
1720 1721

    if (virDomainGetID(dom) != (unsigned int)-1) {
1722
        vshError(ctl, "%s", _("Domain is already active"));
1723
        virDomainFree(dom);
E
Eric Blake 已提交
1724
        return false;
1725 1726
    }

E
Eric Blake 已提交
1727 1728
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1729 1730
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1731 1732
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_START_BYPASS_CACHE;
1733 1734
    if (vshCommandOptBool(cmd, "force-boot"))
        flags |= VIR_DOMAIN_START_FORCE_BOOT;
E
Eric Blake 已提交
1735

1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760
    /* We can emulate force boot, even for older servers that reject it.  */
    if (flags & VIR_DOMAIN_START_FORCE_BOOT) {
        if (virDomainCreateWithFlags(dom, flags) == 0)
            goto started;
        if (last_error->code != VIR_ERR_NO_SUPPORT &&
            last_error->code != VIR_ERR_INVALID_ARG) {
            virshReportError(ctl);
            goto cleanup;
        }
        virFreeError(last_error);
        last_error = NULL;
        rc = virDomainHasManagedSaveImage(dom, 0);
        if (rc < 0) {
            /* No managed save image to remove */
            virFreeError(last_error);
            last_error = NULL;
        } else if (rc > 0) {
            if (virDomainManagedSaveRemove(dom, 0) < 0) {
                virshReportError(ctl);
                goto cleanup;
            }
        }
        flags &= ~VIR_DOMAIN_START_FORCE_BOOT;
    }

E
Eric Blake 已提交
1761 1762
    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
1763
         : virDomainCreate(dom)) < 0) {
1764
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
1765
        goto cleanup;
1766
    }
1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778

started:
    vshPrint(ctl, _("Domain %s started\n"),
             virDomainGetName(dom));
#ifndef WIN32
    if (console && !cmdRunConsole(ctl, dom, NULL))
        goto cleanup;
#endif

    ret = true;

cleanup:
1779
    virDomainFree(dom);
1780 1781 1782
    return ret;
}

1783 1784 1785
/*
 * "save" command
 */
1786
static const vshCmdInfo info_save[] = {
1787
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
1788
    {"desc", N_("Save the RAM state of a running domain.")},
1789
    {NULL, NULL}
1790 1791
};

1792
static const vshCmdOptDef opts_save[] = {
1793
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
1794 1795
    {"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")},
1796 1797
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
1798 1799
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on restore")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on restore")},
1800
    {NULL, 0, 0, NULL}
1801 1802
};

E
Eric Blake 已提交
1803
static bool
1804
cmdSave(vshControl *ctl, const vshCmd *cmd)
1805
{
1806
    virDomainPtr dom;
1807 1808
    const char *name = NULL;
    const char *to = NULL;
1809
    bool ret = false;
E
Eric Blake 已提交
1810
    unsigned int flags = 0;
1811 1812
    const char *xmlfile = NULL;
    char *xml = NULL;
1813

1814
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1815
        return false;
1816

1817
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1818
        return false;
1819

1820 1821
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
1822 1823 1824 1825
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
1826

1827 1828 1829 1830 1831
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

1835 1836 1837 1838 1839 1840
    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
        goto cleanup;

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
1841
         : virDomainSave(dom, to)) < 0) {
1842
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
1843
        goto cleanup;
1844
    }
1845

1846 1847 1848 1849
    vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
    ret = true;

cleanup:
1850
    VIR_FREE(xml);
1851 1852 1853 1854
    virDomainFree(dom);
    return ret;
}

1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875
/*
 * "save-image-dumpxml" command
 */
static const vshCmdInfo info_save_image_dumpxml[] = {
    {"help", N_("saved state domain information in XML")},
    {"desc", N_("Output the domain information for a saved state file,\n"
                "as an XML dump to stdout.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_save_image_dumpxml[] = {
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("saved state file to read")},
    {"security-info", VSH_OT_BOOL, 0, N_("include security sensitive information in XML dump")},
    {NULL, 0, 0, NULL}
};

static bool
cmdSaveImageDumpxml(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
E
Eric Blake 已提交
1876
    unsigned int flags = 0;
1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912
    char *xml = NULL;

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;

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

    if (vshCommandOptString(cmd, "file", &file) <= 0)
        return false;

    xml = virDomainSaveImageGetXMLDesc(ctl->conn, file, flags);
    if (!xml)
        goto cleanup;

    vshPrint(ctl, "%s", xml);
    ret = true;

cleanup:
    VIR_FREE(xml);
    return ret;
}

/*
 * "save-image-define" command
 */
static const vshCmdInfo info_save_image_define[] = {
    {"help", N_("redefine the XML for a domain's saved state file")},
    {"desc", N_("Replace the domain XML associated with a saved state file")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_save_image_define[] = {
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("saved state file to modify")},
    {"xml", VSH_OT_STRING, VSH_OFLAG_REQ,
     N_("filename containing updated XML for the target")},
1913 1914
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on restore")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on restore")},
1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
    {NULL, 0, 0, NULL}
};

static bool
cmdSaveImageDefine(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
    const char *xmlfile = NULL;
    char *xml = NULL;
1925 1926 1927 1928 1929 1930
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969

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

    if (vshCommandOptString(cmd, "file", &file) <= 0)
        return false;

    if (vshCommandOptString(cmd, "xml", &xmlfile) <= 0) {
        vshError(ctl, "%s", _("malformed or missing xml argument"));
        return false;
    }

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

    if (virDomainSaveImageDefineXML(ctl->conn, file, xml, 0) < 0) {
        vshError(ctl, _("Failed to update %s"), file);
        goto cleanup;
    }

    vshPrint(ctl, _("State file %s updated.\n"), file);
    ret = true;

cleanup:
    VIR_FREE(xml);
    return ret;
}

/*
 * "save-image-edit" command
 */
static const vshCmdInfo info_save_image_edit[] = {
    {"help", N_("edit XML for a domain's saved state file")},
    {"desc", N_("Edit the domain XML associated with a saved state file")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_save_image_edit[] = {
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("saved state file to edit")},
1970 1971
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on restore")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on restore")},
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982
    {NULL, 0, 0, NULL}
};

static bool
cmdSaveImageEdit(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998
    unsigned int getxml_flags = VIR_DOMAIN_XML_SECURE;
    unsigned int define_flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        define_flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        define_flags |= VIR_DOMAIN_SAVE_PAUSED;

    /* Normally, we let the API reject mutually exclusive flags.
     * However, in the edit cycle, we let the user retry if the define
     * step fails, but the define step will always fail on invalid
     * flags, so we reject it up front to avoid looping.  */
    if (define_flags == (VIR_DOMAIN_SAVE_RUNNING | VIR_DOMAIN_SAVE_PAUSED)) {
        vshError(ctl, "%s", _("--running and --saved are mutually exclusive"));
        return false;
    }
1999 2000 2001 2002 2003 2004 2005 2006

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

    if (vshCommandOptString(cmd, "file", &file) <= 0)
        return false;

    /* Get the XML configuration of the saved image.  */
2007
    doc = virDomainSaveImageGetXMLDesc(ctl->conn, file, getxml_flags);
2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
    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;

2025 2026 2027
    /* Compare original XML with edited.  Short-circuit if it did not
     * change, and we do not have any flags.  */
    if (STREQ(doc, doc_edited) && !define_flags) {
2028 2029 2030 2031 2032 2033 2034
        vshPrint(ctl, _("Saved image %s XML configuration not changed.\n"),
                 file);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
2035 2036
    if (virDomainSaveImageDefineXML(ctl->conn, file, doc_edited,
                                    define_flags) < 0) {
2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053
        vshError(ctl, _("Failed to update %s"), file);
        goto cleanup;
    }

    vshPrint(ctl, _("State file %s edited.\n"), file);
    ret = true;

cleanup:
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
    return ret;
}

2054 2055 2056 2057 2058
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
2059 2060 2061 2062
    {"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.")},
2063 2064 2065 2066
    {NULL, NULL}
};

static const vshCmdOptDef opts_managedsave[] = {
2067
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2068
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2069 2070
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on next start")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on next start")},
2071 2072 2073
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2074
static bool
2075 2076 2077
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
2078
    const char *name;
2079
    bool ret = false;
E
Eric Blake 已提交
2080
    unsigned int flags = 0;
2081

2082
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2083
        return false;
2084

2085 2086
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2087 2088 2089 2090
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2091

2092
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2093
        return false;
2094

2095
    if (virDomainManagedSave(dom, flags) < 0) {
2096
        vshError(ctl, _("Failed to save domain %s state"), name);
2097
        goto cleanup;
2098 2099
    }

2100 2101 2102 2103
    vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    ret = true;

cleanup:
2104 2105 2106 2107
    virDomainFree(dom);
    return ret;
}

2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121
/*
 * "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 已提交
2122
static bool
2123 2124 2125
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
2126
    const char *name;
E
Eric Blake 已提交
2127
    bool ret = false;
2128 2129
    int hassave;

2130
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2131
        return false;
2132 2133

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2134
        return false;
2135 2136 2137

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
2138
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154
        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 已提交
2155
    ret = true;
2156 2157 2158 2159 2160 2161

cleanup:
    virDomainFree(dom);
    return ret;
}

2162 2163 2164
/*
 * "schedinfo" command
 */
2165
static const vshCmdInfo info_schedinfo[] = {
2166 2167
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
2168 2169 2170
    {NULL, NULL}
};

2171
static const vshCmdOptDef opts_schedinfo[] = {
2172 2173 2174 2175
    {"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")},
2176 2177 2178
    {"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")},
2179 2180 2181
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
2182
static int
2183
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
2184
                   virTypedParameterPtr param)
2185
{
2186
    const char *data = NULL;
2187 2188 2189

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
2190
        param->type == VIR_TYPED_PARAM_UINT &&
2191 2192
        vshCommandOptBool(cmd, "weight")) {
        int val;
2193
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
2194
            vshError(ctl, "%s", _("Invalid value of weight"));
2195
            return -1;
2196
        } else {
2197
            param->value.ui = val;
2198
        }
2199
        return 1;
2200 2201
    }

2202 2203
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
2204
        param->type == VIR_TYPED_PARAM_UINT &&
2205 2206
        vshCommandOptBool(cmd, "cap")) {
        int val;
2207
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
2208
            vshError(ctl, "%s", _("Invalid value of cap"));
2209
            return -1;
2210
        } else {
2211
            param->value.ui = val;
2212
        }
2213
        return 1;
2214
    }
2215

2216
    if (vshCommandOptString(cmd, "set", &data) > 0) {
2217 2218 2219
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
2220
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
2221
            return -1;
2222
        }
2223 2224 2225 2226 2227 2228 2229 2230 2231
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
2232
        case VIR_TYPED_PARAM_INT:
2233
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
2234
                vshError(ctl, "%s",
2235 2236 2237 2238
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
2239
        case VIR_TYPED_PARAM_UINT:
2240
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
2241
                vshError(ctl, "%s",
2242 2243 2244 2245
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
2246
        case VIR_TYPED_PARAM_LLONG:
2247
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
2248
                vshError(ctl, "%s",
J
Jim Meyering 已提交
2249
                         _("Invalid value for parameter, expecting a long long"));
2250 2251 2252
                return -1;
            }
            break;
2253
        case VIR_TYPED_PARAM_ULLONG:
2254
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
2255
                vshError(ctl, "%s",
2256 2257 2258 2259
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
2260
        case VIR_TYPED_PARAM_DOUBLE:
2261
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
2262
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
2263 2264 2265
                return -1;
            }
            break;
2266
        case VIR_TYPED_PARAM_BOOLEAN:
2267
            param->value.b = STREQ(val, "0") ? 0 : 1;
2268
        }
2269
        return 1;
2270
    }
2271

2272 2273
    return 0;
}
2274

2275

E
Eric Blake 已提交
2276
static bool
2277 2278 2279 2280
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
2281
    virTypedParameterPtr params = NULL;
2282 2283 2284
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
2285
    bool ret_val = false;
2286 2287 2288 2289 2290 2291 2292 2293 2294 2295
    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;
        }
2296
        flags = VIR_DOMAIN_AFFECT_CURRENT;
2297 2298
    } else {
        if (config)
2299
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
2300
        if (live)
2301
            flags |= VIR_DOMAIN_AFFECT_LIVE;
2302
    }
2303

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

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

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
2312
    if (schedulertype != NULL) {
2313
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
2314
             schedulertype);
2315
        VIR_FREE(schedulertype);
2316
    } else {
2317
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
2318
        goto cleanup;
2319 2320
    }

2321
    if (nparams) {
2322
        params = vshMalloc(ctl, sizeof(*params) * nparams);
2323

2324
        memset(params, 0, sizeof(*params) * nparams);
2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335
        if (flags || current) {
            /* We cannot query both live and config at once, so settle
               on current in that case.  If we are setting, then the
               two values should match when we re-query; otherwise, we
               report the error later.  */
            ret = virDomainGetSchedulerParametersFlags(dom, params, &nparams,
                                                       ((live && config) ? 0
                                                        : flags));
        } else {
            ret = virDomainGetSchedulerParameters(dom, params, &nparams);
        }
2336 2337 2338 2339
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
2340
        for (i = 0; i < nparams; i++) {
2341 2342 2343 2344 2345 2346 2347 2348 2349 2350
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
2351 2352 2353 2354 2355
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
2356 2357 2358
            if (ret == -1)
                goto cleanup;

2359 2360 2361 2362 2363 2364 2365
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
2366 2367
            if (ret == -1)
                goto cleanup;
2368 2369 2370 2371
        } 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.  */
2372 2373
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
2374 2375 2376 2377
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
2378 2379 2380 2381 2382 2383
            /* When not doing --set, --live and --config do not mix.  */
            if (live && config) {
                vshError(ctl, "%s",
                         _("cannot query both live and config at once"));
                goto cleanup;
            }
2384 2385
        }

E
Eric Blake 已提交
2386
        ret_val = true;
2387
        for (i = 0; i < nparams; i++) {
2388
            switch (params[i].type) {
2389
            case VIR_TYPED_PARAM_INT:
2390
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
2391
                 break;
2392
            case VIR_TYPED_PARAM_UINT:
2393
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
2394
                 break;
2395
            case VIR_TYPED_PARAM_LLONG:
2396
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
2397
                 break;
2398
            case VIR_TYPED_PARAM_ULLONG:
2399
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
2400
                 break;
2401
            case VIR_TYPED_PARAM_DOUBLE:
2402
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
2403
                 break;
2404
            case VIR_TYPED_PARAM_BOOLEAN:
2405
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
2406 2407
                 break;
            default:
2408
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
2409 2410 2411
            }
        }
    }
2412

2413
 cleanup:
2414
    VIR_FREE(params);
2415
    virDomainFree(dom);
2416
    return ret_val;
2417 2418
}

2419 2420 2421
/*
 * "restore" command
 */
2422
static const vshCmdInfo info_restore[] = {
2423 2424
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
2425
    {NULL, NULL}
2426 2427
};

2428
static const vshCmdOptDef opts_restore[] = {
2429
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
2430 2431
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when restoring")},
2432 2433
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2434 2435
    {"running", VSH_OT_BOOL, 0, N_("restore domain into running state")},
    {"paused", VSH_OT_BOOL, 0, N_("restore domain into paused state")},
2436
    {NULL, 0, 0, NULL}
2437 2438
};

E
Eric Blake 已提交
2439
static bool
2440
cmdRestore(vshControl *ctl, const vshCmd *cmd)
2441
{
2442
    const char *from = NULL;
2443
    bool ret = false;
E
Eric Blake 已提交
2444
    unsigned int flags = 0;
2445 2446
    const char *xmlfile = NULL;
    char *xml = NULL;
2447

2448
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2449
        return false;
2450

2451
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2452
        return false;
2453

2454 2455
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2456 2457 2458 2459
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2460

2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

    if (((flags || xml)
         ? virDomainRestoreFlags(ctl->conn, from, xml, flags)
2472
         : virDomainRestore(ctl->conn, from)) < 0) {
2473
        vshError(ctl, _("Failed to restore domain from %s"), from);
2474
        goto cleanup;
2475
    }
2476 2477 2478 2479 2480

    vshPrint(ctl, _("Domain restored from %s\n"), from);
    ret = true;

cleanup:
2481
    VIR_FREE(xml);
2482 2483 2484
    return ret;
}

D
Daniel Veillard 已提交
2485 2486 2487
/*
 * "dump" command
 */
2488
static const vshCmdInfo info_dump[] = {
2489 2490
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
2491 2492 2493
    {NULL, NULL}
};

2494
static const vshCmdOptDef opts_dump[] = {
2495 2496
    {"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")},
2497 2498
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when saving")},
2499 2500
    {"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 已提交
2501 2502 2503
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2504
static bool
2505
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
2506 2507
{
    virDomainPtr dom;
2508 2509
    const char *name = NULL;
    const char *to = NULL;
2510
    bool ret = false;
E
Eric Blake 已提交
2511
    unsigned int flags = 0;
D
Daniel Veillard 已提交
2512

2513
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2514
        return false;
D
Daniel Veillard 已提交
2515

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

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

P
Paolo Bonzini 已提交
2522 2523
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
2524 2525
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;
2526 2527
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DUMP_BYPASS_CACHE;
2528

2529
    if (virDomainCoreDump(dom, to, flags) < 0) {
2530
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
2531
        goto cleanup;
D
Daniel Veillard 已提交
2532 2533
    }

2534 2535 2536 2537
    vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
    ret = true;

cleanup:
D
Daniel Veillard 已提交
2538 2539 2540 2541
    virDomainFree(dom);
    return ret;
}

2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688
static const vshCmdInfo info_screenshot[] = {
    {"help", N_("take a screenshot of a current domain console and store it "
                "into a file")},
    {"desc", N_("screenshot of a current domain console")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_screenshot[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"file", VSH_OT_DATA, VSH_OFLAG_NONE, N_("where to store the screenshot")},
    {"screen", VSH_OT_INT, VSH_OFLAG_NONE, N_("ID of a screen to take screenshot of")},
    {NULL, 0, 0, NULL}
};

static int vshStreamSink(virStreamPtr st ATTRIBUTE_UNUSED,
                         const char *bytes, size_t nbytes, void *opaque)
{
    int *fd = opaque;

    return safewrite(*fd, bytes, nbytes);
}

/**
 * Generate string: '<domain name>-<timestamp>[<extension>]'
 */
static char *
vshGenFileName(vshControl *ctl, virDomainPtr dom, const char *mime)
{
    char timestr[100];
    struct timeval cur_time;
    struct tm time_info;
    const char *ext = NULL;
    char *ret = NULL;

    /* We should be already connected, but doesn't
     * hurt to check */
    if (!vshConnectionUsability(ctl, ctl->conn))
        return NULL;

    if (!dom) {
        vshError(ctl, "%s", _("Invalid domain supplied"));
        return NULL;
    }

    if (STREQ(mime, "image/x-portable-pixmap"))
        ext = ".ppm";
    else if (STREQ(mime, "image/png"))
        ext = ".png";
    /* add mime type here */

    gettimeofday(&cur_time, NULL);
    localtime_r(&cur_time.tv_sec, &time_info);
    strftime(timestr, sizeof(timestr), "%Y-%m-%d-%H:%M:%S", &time_info);

    if (virAsprintf(&ret, "%s-%s%s", virDomainGetName(dom),
                    timestr, ext ? ext : "") < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        return NULL;
    }

    return ret;
}

static bool
cmdScreenshot(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name = NULL;
    char *file = NULL;
    int fd = -1;
    virStreamPtr st = NULL;
    unsigned int screen = 0;
    unsigned int flags = 0; /* currently unused */
    int ret = false;
    bool created = true;
    bool generated = false;
    char *mime = NULL;

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

    if (vshCommandOptString(cmd, "file", (const char **) &file) < 0) {
        vshError(ctl, "%s", _("file must not be empty"));
        return false;
    }

    if (vshCommandOptUInt(cmd, "screen", &screen) < 0) {
        vshError(ctl, "%s", _("invalid screen ID"));
        return false;
    }

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

    st = virStreamNew(ctl->conn, 0);

    mime = virDomainScreenshot(dom, st, screen, flags);
    if (!mime) {
        vshError(ctl, _("could not take a screenshot of %s"), name);
        goto cleanup;
    }

    if (!file) {
        if (!(file=vshGenFileName(ctl, dom, mime)))
            return false;
        generated = true;
    }

    if ((fd = open(file, O_WRONLY|O_CREAT|O_EXCL, 0666)) < 0) {
        created = false;
        if (errno != EEXIST ||
            (fd = open(file, O_WRONLY|O_TRUNC, 0666)) < 0) {
            vshError(ctl, _("cannot create file %s"), file);
            goto cleanup;
        }
    }

    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
        vshError(ctl, _("could not receive data from domain %s"), name);
        goto cleanup;
    }

    if (VIR_CLOSE(fd) < 0) {
        vshError(ctl, _("cannot close file %s"), file);
        goto cleanup;
    }

    if (virStreamFinish(st) < 0) {
        vshError(ctl, _("cannot close stream on domain %s"), name);
        goto cleanup;
    }

    vshPrint(ctl, _("Screenshot saved to %s, with type of %s"), file, mime);
    ret = true;

cleanup:
    if (!ret && created)
        unlink(file);
    if (generated)
        VIR_FREE(file);
    virDomainFree(dom);
    if (st)
        virStreamFree(st);
    VIR_FORCE_CLOSE(fd);
    return ret;
}

2689 2690 2691
/*
 * "resume" command
 */
2692
static const vshCmdInfo info_resume[] = {
2693 2694
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
2695
    {NULL, NULL}
2696 2697
};

2698
static const vshCmdOptDef opts_resume[] = {
2699
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2700
    {NULL, 0, 0, NULL}
2701 2702
};

E
Eric Blake 已提交
2703
static bool
2704
cmdResume(vshControl *ctl, const vshCmd *cmd)
2705
{
2706
    virDomainPtr dom;
E
Eric Blake 已提交
2707
    bool ret = true;
2708
    const char *name;
2709

2710
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2711
        return false;
2712

J
Jim Meyering 已提交
2713
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2714
        return false;
2715 2716

    if (virDomainResume(dom) == 0) {
2717
        vshPrint(ctl, _("Domain %s resumed\n"), name);
2718
    } else {
2719
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
2720
        ret = false;
2721
    }
2722

2723 2724 2725 2726
    virDomainFree(dom);
    return ret;
}

2727 2728 2729
/*
 * "shutdown" command
 */
2730
static const vshCmdInfo info_shutdown[] = {
2731 2732
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
2733
    {NULL, NULL}
2734 2735
};

2736
static const vshCmdOptDef opts_shutdown[] = {
2737
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2738
    {NULL, 0, 0, NULL}
2739 2740
};

E
Eric Blake 已提交
2741
static bool
2742
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
2743
{
2744
    virDomainPtr dom;
E
Eric Blake 已提交
2745
    bool ret = true;
2746
    const char *name;
2747

2748
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2749
        return false;
2750

J
Jim Meyering 已提交
2751
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2752
        return false;
2753 2754

    if (virDomainShutdown(dom) == 0) {
2755
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
2756
    } else {
2757
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
2758
        ret = false;
2759
    }
2760

2761 2762 2763 2764
    virDomainFree(dom);
    return ret;
}

2765 2766 2767
/*
 * "reboot" command
 */
2768
static const vshCmdInfo info_reboot[] = {
2769 2770
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
2771 2772 2773
    {NULL, NULL}
};

2774
static const vshCmdOptDef opts_reboot[] = {
2775
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2776 2777 2778
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2779
static bool
2780
cmdReboot(vshControl *ctl, const vshCmd *cmd)
2781 2782
{
    virDomainPtr dom;
E
Eric Blake 已提交
2783
    bool ret = true;
2784
    const char *name;
2785

2786
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2787
        return false;
2788

J
Jim Meyering 已提交
2789
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2790
        return false;
2791 2792

    if (virDomainReboot(dom, 0) == 0) {
2793
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
2794
    } else {
2795
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
2796
        ret = false;
2797 2798 2799 2800 2801 2802
    }

    virDomainFree(dom);
    return ret;
}

2803 2804 2805
/*
 * "destroy" command
 */
2806
static const vshCmdInfo info_destroy[] = {
2807 2808 2809
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
2810
    {NULL, NULL}
2811 2812
};

2813
static const vshCmdOptDef opts_destroy[] = {
2814
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2815
    {NULL, 0, 0, NULL}
2816 2817
};

E
Eric Blake 已提交
2818
static bool
2819
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2820
{
2821
    virDomainPtr dom;
E
Eric Blake 已提交
2822
    bool ret = true;
2823
    const char *name;
2824

2825
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2826
        return false;
2827

J
Jim Meyering 已提交
2828
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2829
        return false;
2830 2831

    if (virDomainDestroy(dom) == 0) {
2832
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2833
    } else {
2834
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
2835
        ret = false;
2836
    }
2837

2838
    virDomainFree(dom);
K
Karel Zak 已提交
2839 2840 2841 2842
    return ret;
}

/*
2843
 * "dominfo" command
K
Karel Zak 已提交
2844
 */
2845
static const vshCmdInfo info_dominfo[] = {
2846 2847
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2848
    {NULL, NULL}
K
Karel Zak 已提交
2849 2850
};

2851
static const vshCmdOptDef opts_dominfo[] = {
2852
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2853
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2854 2855
};

E
Eric Blake 已提交
2856
static bool
2857
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2858
{
K
Karel Zak 已提交
2859 2860
    virDomainInfo info;
    virDomainPtr dom;
2861
    virSecurityModel secmodel;
2862
    virSecurityLabelPtr seclabel;
2863
    int persistent = 0;
E
Eric Blake 已提交
2864 2865
    bool ret = true;
    int autostart;
2866
    unsigned int id;
2867
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2868
    int has_managed_save = 0;
2869

2870
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2871
        return false;
K
Karel Zak 已提交
2872

J
Jim Meyering 已提交
2873
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2874
        return false;
2875

2876 2877
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2878
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2879
    else
2880
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2881 2882
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2883
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2884
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2885 2886

    if ((str = virDomainGetOSType(dom))) {
2887
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2888
        VIR_FREE(str);
2889 2890 2891
    }

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

2895
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2896 2897

        if (info.cpuTime != 0) {
2898
            double cpuUsed = info.cpuTime;
2899

2900
            cpuUsed /= 1000000000.0;
2901

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

2905 2906
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2907
                 info.maxMem);
2908
        else
2909
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2910 2911
                 _("no limit"));

2912
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2913 2914
                 info.memory);

K
Karel Zak 已提交
2915
    } else {
E
Eric Blake 已提交
2916
        ret = false;
K
Karel Zak 已提交
2917
    }
2918

2919 2920
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
2921 2922
    vshDebug(ctl, VSH_ERR_DEBUG, "Domain persistent flag value: %d\n",
             persistent);
2923 2924 2925 2926 2927 2928
    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 */
2929
    if (!virDomainGetAutostart(dom, &autostart)) {
2930
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2931 2932 2933
                 autostart ? _("enable") : _("disable") );
    }

2934 2935 2936 2937 2938 2939 2940
    has_managed_save = virDomainHasManagedSaveImage(dom, 0);
    if (has_managed_save < 0)
        vshPrint(ctl, "%-15s %s\n", _("Managed save:"), _("unknown"));
    else
        vshPrint(ctl, "%-15s %s\n", _("Managed save:"),
                 has_managed_save ? _("yes") : _("no"));

2941 2942 2943
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2944 2945
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
2946
            return false;
2947 2948 2949
        } else {
            virFreeError(last_error);
            last_error = NULL;
2950
        }
2951 2952 2953 2954 2955 2956 2957
    } 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 */
2958
            if (VIR_ALLOC(seclabel) < 0) {
2959
                virDomainFree(dom);
E
Eric Blake 已提交
2960
                return false;
2961 2962 2963 2964 2965
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
2966
                return false;
2967
            } else {
2968
                if (seclabel->label[0] != '\0')
2969
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
2970
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
2971
            }
2972 2973

            VIR_FREE(seclabel);
2974 2975
        }
    }
2976
    virDomainFree(dom);
K
Karel Zak 已提交
2977 2978 2979
    return ret;
}

2980 2981 2982 2983
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2984 2985
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2986 2987 2988 2989
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2990
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2991 2992 2993 2994
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
2995
static bool
2996 2997 2998 2999
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
3000
    bool ret = true;
3001

3002
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3003
        return false;
3004 3005

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3006
        return false;
3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032

    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 已提交
3033
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
3034
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
3035
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
3036
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
3037
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
3038 3039 3040
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
3041
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
3042
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
3043
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
3044
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
3045
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
3046 3047 3048
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
3049
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
3050
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
3051
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
3052
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
3053
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
3054 3055
        }
    } else {
E
Eric Blake 已提交
3056
        ret = false;
3057 3058 3059 3060 3061 3062
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

3063 3064 3065 3066
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
3067 3068
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
3069 3070 3071 3072
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
3073
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3074 3075 3076
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3077
static bool
3078 3079 3080
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3081
    bool ret = true;
3082

3083
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3084
        return false;
3085 3086

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
3090
        ret = false;
3091 3092 3093 3094 3095

    virDomainFree(dom);
    return ret;
}

3096 3097 3098
/*
 * "freecell" command
 */
3099
static const vshCmdInfo info_freecell[] = {
3100 3101
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
3102 3103 3104
    {NULL, NULL}
};

3105
static const vshCmdOptDef opts_freecell[] = {
3106
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
3107
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
3108 3109 3110
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3111
static bool
3112
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
3113
{
W
Wen Congyang 已提交
3114
    bool func_ret = false;
3115
    int ret;
3116
    int cell = -1, cell_given;
3117
    unsigned long long memory;
3118 3119 3120 3121
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
3122
    int all_given;
3123 3124 3125 3126
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
3127

3128

3129
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3130
        return false;
3131

3132 3133 3134 3135
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
3136 3137 3138 3139 3140 3141 3142 3143 3144
    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) {
3145 3146 3147
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3148 3149 3150
            goto cleanup;
        }

3151
        xml = virXMLParseStringCtxt(cap_xml, "node.xml", &ctxt);
3152 3153
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3154 3155
            goto cleanup;
        }
3156 3157 3158 3159
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
3160
            vshError(ctl, "%s", _("could not get information about "
3161
                                  "NUMA topology"));
3162 3163 3164
            goto cleanup;
        }

3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185
        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;
            }
        }

3186
        memory = 0;
3187 3188 3189 3190
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
3191 3192 3193 3194
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
3195
    } else {
3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209
        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));
3210 3211
    }

E
Eric Blake 已提交
3212
    func_ret = true;
3213

3214
cleanup:
3215
    xmlXPathFreeContext(ctxt);
3216
    xmlFreeDoc(xml);
3217
    VIR_FREE(nodes);
3218 3219 3220
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
3221
    return func_ret;
3222 3223
}

E
Eric Blake 已提交
3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237
/*
 * "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 已提交
3238
static bool
E
Eric Blake 已提交
3239 3240
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
3241
    const char *type = NULL;
E
Eric Blake 已提交
3242 3243
    int vcpus;

3244 3245
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
3246
        return false;
3247
    }
E
Eric Blake 已提交
3248 3249

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3250
        return false;
E
Eric Blake 已提交
3251 3252 3253

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

E
Eric Blake 已提交
3257
    return true;
E
Eric Blake 已提交
3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271
}

/*
 * "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")},
3272
    {"active", VSH_OT_BOOL, 0, N_("get number of currently active vcpus")},
E
Eric Blake 已提交
3273
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
3274 3275 3276
    {"config", VSH_OT_BOOL, 0, N_("get value to be used on next boot")},
    {"current", VSH_OT_BOOL, 0,
     N_("get value according to current domain state")},
E
Eric Blake 已提交
3277 3278 3279
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3280
static bool
E
Eric Blake 已提交
3281 3282 3283
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3284
    bool ret = true;
E
Eric Blake 已提交
3285
    int maximum = vshCommandOptBool(cmd, "maximum");
3286
    int active = vshCommandOptBool(cmd, "active");
E
Eric Blake 已提交
3287 3288
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3289 3290
    int current = vshCommandOptBool(cmd, "current");
    bool all = maximum + active + current + config + live == 0;
E
Eric Blake 已提交
3291 3292
    int count;

3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307
    /* We want one of each pair of mutually exclusive options; that
     * is, use of flags requires exactly two options.  We reject the
     * use of more than 2 flags later on.  */
    if (maximum + active + current + config + live == 1) {
        if (maximum || active) {
            vshError(ctl,
                     _("when using --%s, one of --config, --live, or --current "
                       "must be specified"),
                     maximum ? "maximum" : "active");
        } else {
            vshError(ctl,
                     _("when using --%s, either --maximum or --active must be "
                       "specified"),
                     (current ? "current" : config ? "config" : "live"));
        }
E
Eric Blake 已提交
3308
        return false;
E
Eric Blake 已提交
3309
    }
3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322

    /* Backwards compatibility: prior to 0.9.4,
     * VIR_DOMAIN_AFFECT_CURRENT was unsupported, and --current meant
     * the opposite of --maximum.  Translate the old '--current
     * --live' into the new '--active --live', while treating the new
     * '--maximum --current' correctly rather than rejecting it as
     * '--maximum --active'.  */
    if (!maximum && !active && current) {
        current = false;
        active = true;
    }

    if (maximum && active) {
E
Eric Blake 已提交
3323
        vshError(ctl, "%s",
3324
                 _("--maximum and --active cannot both be specified"));
E
Eric Blake 已提交
3325
        return false;
E
Eric Blake 已提交
3326
    }
3327 3328 3329
    if (current + config + live > 1) {
        vshError(ctl, "%s",
                 _("--config, --live, and --current are mutually exclusive"));
E
Eric Blake 已提交
3330
        return false;
E
Eric Blake 已提交
3331 3332 3333
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3334
        return false;
E
Eric Blake 已提交
3335 3336

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

    /* In all cases, try the new API first; if it fails because we are
3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353
     * talking to an older client, generally we try a fallback API
     * before giving up.  --current requires the new API, since we
     * don't know whether the domain is running or inactive.  */
    if (current) {
        count = virDomainGetVcpusFlags(dom,
                                       maximum ? VIR_DOMAIN_VCPU_MAXIMUM : 0);
        if (count < 0) {
            virshReportError(ctl);
            ret = false;
        } else {
            vshPrint(ctl, "%d\n", count);
        }
    }

E
Eric Blake 已提交
3354 3355
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
3356
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
3357 3358 3359 3360 3361 3362 3363 3364 3365
        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;
            }
3366 3367
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
3368 3369 3370 3371 3372
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
3373
            ret = false;
E
Eric Blake 已提交
3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385
        } 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 |
3386
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
3387 3388 3389 3390 3391 3392 3393
        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 已提交
3394
            ret = false;
E
Eric Blake 已提交
3395 3396 3397 3398 3399 3400 3401 3402 3403 3404
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3405
    if (all || (active && config)) {
3406
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430
        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 已提交
3431
            ret = false;
E
Eric Blake 已提交
3432 3433 3434 3435 3436 3437 3438 3439 3440 3441
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3442
    if (all || (active && live)) {
3443
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
3444 3445 3446 3447 3448 3449 3450 3451 3452
        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 已提交
3453
            ret = false;
E
Eric Blake 已提交
3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467
        } 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;
}

3468 3469 3470
/*
 * "vcpuinfo" command
 */
3471
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
3472
    {"help", N_("detailed domain vcpu information")},
3473
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
3474 3475 3476
    {NULL, NULL}
};

3477
static const vshCmdOptDef opts_vcpuinfo[] = {
3478
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3479 3480 3481
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3482
static bool
3483
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
3484 3485 3486 3487 3488
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
3489 3490
    unsigned char *cpumaps;
    int ncpus, maxcpu;
3491
    size_t cpumaplen;
E
Eric Blake 已提交
3492
    bool ret = true;
3493
    int n, m;
3494

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

J
Jim Meyering 已提交
3498
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3499
        return false;
3500 3501 3502

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3503
        return false;
3504 3505 3506 3507
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3508
        return false;
3509 3510
    }

3511
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
3512 3513 3514
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
3515

3516 3517
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
3518
                                   cpumaps, cpumaplen)) >= 0) {
3519 3520 3521 3522
        for (n = 0 ; n < ncpus ; n++) {
            vshPrint(ctl, "%-15s %d\n", _("VCPU:"), n);
            vshPrint(ctl, "%-15s %d\n", _("CPU:"), cpuinfo[n].cpu);
            vshPrint(ctl, "%-15s %s\n", _("State:"),
E
Eric Blake 已提交
3523
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
3524 3525 3526 3527 3528 3529 3530 3531
            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:"));
3532 3533
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
3534 3535 3536 3537 3538 3539
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
3540
    } else {
3541
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
3542
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3543 3544 3545
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
3546
            /* fallback plan to use virDomainGetVcpuPinInfo */
3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564

            for (n = 0; n < ncpus; n++) {
                vshPrint(ctl, "%-15s %d\n", _("VCPU:"), n);
                vshPrint(ctl, "%-15s %s\n", _("CPU:"), _("N/A"));
                vshPrint(ctl, "%-15s %s\n", _("State:"), _("N/A"));
                vshPrint(ctl, "%-15s %s\n", _("CPU time"), _("N/A"));
                vshPrint(ctl, "%-15s ", _("CPU Affinity:"));
                for (m = 0; m < maxcpu; m++) {
                    vshPrint(ctl, "%c",
                             VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
                }
                vshPrint(ctl, "\n");
                if (n < (ncpus - 1)) {
                    vshPrint(ctl, "\n");
                }
            }
        } else {
            ret = false;
3565
        }
3566 3567
    }

3568
    VIR_FREE(cpumaps);
3569
    VIR_FREE(cpuinfo);
3570 3571 3572 3573 3574 3575 3576
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
3577
static const vshCmdInfo info_vcpupin[] = {
3578
    {"help", N_("control or query domain vcpu affinity")},
3579
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
3580 3581 3582
    {NULL, NULL}
};

3583
static const vshCmdOptDef opts_vcpupin[] = {
3584
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3585 3586 3587
    {"vcpu", VSH_OT_INT, 0, N_("vcpu number")},
    {"cpulist", VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("host cpu number(s) to set, or omit option to query")},
3588 3589 3590
    {"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")},
3591 3592 3593
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3594
static bool
E
Eric Blake 已提交
3595
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
3596 3597 3598 3599
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
3600
    int vcpu = -1;
3601
    const char *cpulist = NULL;
E
Eric Blake 已提交
3602
    bool ret = true;
3603 3604
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
3605
    size_t cpumaplen;
3606 3607
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
3608
    bool unuse = false;
3609
    const char *cur;
3610 3611 3612
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
3613
    bool query = false; /* Query mode if no cpulist */
E
Eric Blake 已提交
3614
    unsigned int flags = 0;
3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
            return false;
        }
        flags = VIR_DOMAIN_AFFECT_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_AFFECT_LIVE;
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
3631

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

J
Jim Meyering 已提交
3635
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3636
        return false;
3637

3638 3639
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
3640
        virDomainFree(dom);
E
Eric Blake 已提交
3641
        return false;
3642
    }
3643
    query = !cpulist;
3644

3645 3646 3647 3648
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
3649
        virDomainFree(dom);
E
Eric Blake 已提交
3650
        return false;
3651
    }
3652

3653 3654
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3655
        return false;
3656 3657 3658
    }

    if (virDomainGetInfo(dom, &info) != 0) {
3659
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
3660
        virDomainFree(dom);
E
Eric Blake 已提交
3661
        return false;
3662 3663 3664
    }

    if (vcpu >= info.nrVirtCpu) {
3665
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
3666
        virDomainFree(dom);
E
Eric Blake 已提交
3667
        return false;
3668 3669
    }

3670 3671
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
3672

3673 3674 3675 3676 3677 3678 3679 3680
    /* Query mode: show CPU affinity information then exit.*/
    if (query) {
        /* When query mode and neither "live", "config" nor "current"
         * is specified, set VIR_DOMAIN_AFFECT_CURRENT as flags */
        if (flags == -1)
            flags = VIR_DOMAIN_AFFECT_CURRENT;

        cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
E
Eric Blake 已提交
3681
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726
                                             cpumaps, cpumaplen, flags)) >= 0) {

            vshPrint(ctl, "%s %s\n", _("VCPU:"), _("CPU Affinity"));
            vshPrint(ctl, "----------------------------------\n");
            for (i = 0; i < ncpus; i++) {

               if (vcpu != -1 && i != vcpu)
                   continue;

               bit = lastbit = isInvert = false;
               lastcpu = -1;

               vshPrint(ctl, "%4d: ", i);
               for (cpu = 0; cpu < maxcpu; cpu++) {

                   bit = VIR_CPU_USABLE(cpumaps, cpumaplen, i, cpu);

                   isInvert = (bit ^ lastbit);
                   if (bit && isInvert) {
                       if (lastcpu == -1)
                           vshPrint(ctl, "%d", cpu);
                       else
                           vshPrint(ctl, ",%d", cpu);
                       lastcpu = cpu;
                   }
                   if (!bit && isInvert && lastcpu != cpu - 1)
                       vshPrint(ctl, "-%d", cpu - 1);
                   lastbit = bit;
               }
               if (bit && !isInvert) {
                  vshPrint(ctl, "-%d", maxcpu - 1);
               }
               vshPrint(ctl, "\n");
            }

        } else {
            ret = false;
        }
        VIR_FREE(cpumaps);
        goto cleanup;
    }

    /* Pin mode: pinning specified vcpu to specified physical cpus*/

    cpumap = vshCalloc(ctl, 0, cpumaplen);
3727 3728
    /* Parse cpulist */
    cur = cpulist;
3729
    if (*cur == 0) {
3730
        goto parse_error;
3731 3732 3733
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
3734
        cur = "";
3735
    }
3736 3737 3738 3739 3740 3741 3742

    while (*cur != 0) {

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

3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756
        /* parse physical CPU number */
        if (!c_isdigit(*cur))
            goto parse_error;
        cpu  = virParseNumber(&cur);
        if (cpu < 0) {
            goto parse_error;
        }
        if (cpu >= maxcpu) {
            vshError(ctl, _("Physical CPU %d doesn't exist."), cpu);
            goto parse_error;
        }
        virSkipSpaces(&cur);
3757

3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784
        if ((*cur == ',') || (*cur == 0)) {
            if (unuse) {
                VIR_UNUSE_CPU(cpumap, cpu);
            } else {
                VIR_USE_CPU(cpumap, cpu);
            }
        } else if (*cur == '-') {
            /* the char '-' denotes range */
            if (unuse) {
                goto parse_error;
            }
            cur++;
            virSkipSpaces(&cur);
            /* parse the end of range */
            lastcpu = virParseNumber(&cur);
            if (lastcpu < cpu) {
                goto parse_error;
            }
            if (lastcpu >= maxcpu) {
                vshError(ctl, _("Physical CPU %d doesn't exist."), maxcpu);
                goto parse_error;
            }
            for (i = cpu; i <= lastcpu; i++) {
                VIR_USE_CPU(cpumap, i);
            }
            virSkipSpaces(&cur);
        }
3785

3786 3787 3788 3789 3790 3791
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
3792
        } else {
3793
            goto parse_error;
3794
        }
3795
    }
3796

3797 3798 3799 3800 3801 3802 3803 3804
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
3805 3806
    }

3807
cleanup:
3808
    VIR_FREE(cpumap);
3809 3810
    virDomainFree(dom);
    return ret;
3811 3812 3813 3814 3815

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

3818 3819 3820
/*
 * "setvcpus" command
 */
3821
static const vshCmdInfo info_setvcpus[] = {
3822 3823
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
3824 3825 3826
    {NULL, NULL}
};

3827
static const vshCmdOptDef opts_setvcpus[] = {
3828
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3829
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
3830 3831 3832
    {"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")},
3833
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3834 3835 3836
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3837
static bool
3838
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
3839 3840
{
    virDomainPtr dom;
3841
    int count = 0;
E
Eric Blake 已提交
3842
    bool ret = true;
E
Eric Blake 已提交
3843 3844 3845
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3846
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
3847
    unsigned int flags = 0;
3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
            return false;
        }
        flags = VIR_DOMAIN_AFFECT_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_AFFECT_LIVE;
        /* neither option is specified */
        if (!live && !config && !maximum)
            flags = -1;
    }
3864

3865
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3866
        return false;
3867

J
Jim Meyering 已提交
3868
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3869
        return false;
3870

3871 3872 3873 3874
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
3875

3876
    if (flags == -1) {
E
Eric Blake 已提交
3877
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
3878
            ret = false;
E
Eric Blake 已提交
3879 3880
        }
    } else {
3881 3882 3883
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
3884
            vshDebug(ctl, VSH_ERR_DEBUG, "--maximum flag was given\n");
3885

3886 3887
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

3888 3889 3890 3891 3892 3893 3894 3895
            /* 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 已提交
3896
                ret = false;
3897 3898 3899 3900 3901
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
3902
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
3903
            ret = false;
E
Eric Blake 已提交
3904
        }
3905 3906
    }

3907
  cleanup:
3908 3909 3910 3911
    virDomainFree(dom);
    return ret;
}

3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945
/*
 * "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;
}

3946 3947 3948 3949 3950
/*
 * "send-key" command
 */
static const vshCmdInfo info_send_key[] = {
    {"help", N_("Send keycodes to the guest")},
3951
    {"desc", N_("Send keycodes (integers or symbolic names) to the guest")},
3952 3953 3954 3955 3956
    {NULL, NULL}
};

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3957 3958
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT,
     N_("the codeset of keycodes, default:linux")},
3959
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
3960
     N_("the time (in millseconds) how long the keys will be held")},
3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032
    {"keycode", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("the key code")},
    {NULL, 0, 0, NULL}
};

static int get_integer_keycode(const char *key_name)
{
    long val;
    char *endptr;

    val = strtol(key_name, &endptr, 0);
    if (*endptr != '\0' || val > 0xffff || val <= 0)
         return -1;

    return val;
}

static bool
cmdSendKey(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int ret = false;
    const char *codeset_option;
    int codeset;
    int holdtime;
    int count = 0;
    const vshCmdOpt *opt = NULL;
    int keycode;
    unsigned int keycodes[VIR_DOMAIN_SEND_KEY_MAX_KEYS];

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

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

    if (vshCommandOptString(cmd, "codeset", &codeset_option) <= 0)
        codeset_option = "linux";

    if (vshCommandOptInt(cmd, "holdtime", &holdtime) <= 0)
        holdtime = 0;

    codeset = virKeycodeSetTypeFromString(codeset_option);
    if ((int)codeset < 0) {
        vshError(ctl, _("unknown codeset: '%s'"), codeset_option);
        goto cleanup;
    }

    while ((opt = vshCommandOptArgv(cmd, opt))) {
        if (count == VIR_DOMAIN_SEND_KEY_MAX_KEYS) {
            vshError(ctl, _("too many keycodes"));
            goto cleanup;
        }

        if ((keycode = get_integer_keycode(opt->data)) <= 0) {
            if ((keycode = virKeycodeValueFromString(codeset, opt->data)) <= 0) {
                vshError(ctl, _("invalid keycode: '%s'"), opt->data);
                goto cleanup;
            }
        }

        keycodes[count] = keycode;
        count++;
    }

    if (!(virDomainSendKey(dom, codeset, holdtime, keycodes, count, 0) < 0))
        ret = true;

cleanup:
    virDomainFree(dom);
    return ret;
}

4033 4034 4035
/*
 * "setmemory" command
 */
4036
static const vshCmdInfo info_setmem[] = {
4037 4038
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
4039 4040 4041
    {NULL, NULL}
};

4042
static const vshCmdOptDef opts_setmem[] = {
4043
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4044
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
4045 4046
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
4047
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
4048 4049 4050
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4051
static bool
4052
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
4053 4054
{
    virDomainPtr dom;
4055
    virDomainInfo info;
4056
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
4057
    bool ret = true;
4058 4059
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
4060
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4061
    unsigned int flags = 0;
4062

4063 4064 4065
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4066
            return false;
4067
        }
4068
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4069 4070
    } else {
        if (config)
4071
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4072
        if (live)
4073
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4074 4075 4076
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
4077
    }
4078

4079
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4080
        return false;
4081

J
Jim Meyering 已提交
4082
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4083
        return false;
4084

4085 4086
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4087
        return false;
4088 4089
    }

4090
    if (kilobytes <= 0) {
4091
        virDomainFree(dom);
4092
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
4093
        return false;
4094 4095
    }

4096 4097
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
4098
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
4099
        return false;
4100 4101 4102 4103
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
4104
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
4105
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
4106
        return false;
4107 4108
    }

4109
    if (flags == -1) {
4110
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
4111
            ret = false;
4112 4113 4114
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
4115
            ret = false;
4116
        }
4117 4118 4119 4120 4121 4122 4123 4124 4125
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
4126
static const vshCmdInfo info_setmaxmem[] = {
4127 4128
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
4129 4130 4131
    {NULL, NULL}
};

4132
static const vshCmdOptDef opts_setmaxmem[] = {
4133
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4134
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
4135 4136 4137
    {"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")},
4138 4139 4140
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4141
static bool
4142
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
4143 4144
{
    virDomainPtr dom;
4145
    int kilobytes = 0;
E
Eric Blake 已提交
4146
    bool ret = true;
4147 4148 4149
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4150
    unsigned int flags = VIR_DOMAIN_MEM_MAXIMUM;
4151 4152 4153 4154

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4155
            return false;
4156 4157 4158
        }
    } else {
        if (config)
4159
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4160
        if (live)
4161
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4162 4163 4164 4165
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
4166

4167
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4168
        return false;
4169

J
Jim Meyering 已提交
4170
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4171
        return false;
4172

4173 4174
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4175
        return false;
4176 4177
    }

4178
    if (kilobytes <= 0) {
4179
        virDomainFree(dom);
4180
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
4181
        return false;
4182 4183
    }

4184 4185 4186
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4187
            ret = false;
4188 4189 4190 4191
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4192
            ret = false;
4193
        }
4194 4195
    }

4196 4197 4198 4199
    virDomainFree(dom);
    return ret;
}

4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215
/*
 * "blkiotune" command
 */
static const vshCmdInfo info_blkiotune[] = {
    {"help", N_("Get or set blkio parameters")},
    {"desc", N_("Get or set the current blkio parameters for a guest" \
                " domain.\n" \
                "    To get the blkio parameters use following command: \n\n" \
                "    virsh # blkiotune <domain>")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_blkiotune[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"weight", VSH_OT_INT, VSH_OFLAG_NONE,
     N_("IO Weight in range [100, 1000]")},
H
Hu Tao 已提交
4216 4217 4218
    {"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")},
4219 4220 4221
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4222
static bool
4223 4224 4225 4226 4227
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
4228
    int rv = 0;
4229
    unsigned int i = 0;
4230
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4231
    bool ret = false;
H
Hu Tao 已提交
4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248
    unsigned int flags = 0;
    int current = vshCommandOptBool(cmd, "current");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
            return false;
        }
        flags = VIR_DOMAIN_AFFECT_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_AFFECT_LIVE;
    }
4249 4250

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4251
        return false;
4252 4253

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

4256
    if ((rv = vshCommandOptInt(cmd, "weight", &weight)) < 0) {
4257 4258 4259 4260 4261
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

4262
    if (rv > 0) {
4263
        nparams++;
4264
        if (weight <= 0) {
4265 4266 4267 4268 4269 4270 4271
            vshError(ctl, _("Invalid value of %d for I/O weight"), weight);
            goto cleanup;
        }
    }

    if (nparams == 0) {
        /* get the number of blkio parameters */
H
Hu Tao 已提交
4272
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
4273 4274 4275 4276 4277 4278 4279
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4280
            ret = true;
4281 4282 4283 4284 4285
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
4286
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
4287 4288 4289 4290 4291 4292
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4293
                case VIR_TYPED_PARAM_INT:
4294 4295 4296
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4297
                case VIR_TYPED_PARAM_UINT:
4298 4299 4300
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4301
                case VIR_TYPED_PARAM_LLONG:
4302 4303 4304
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4305
                case VIR_TYPED_PARAM_ULLONG:
4306 4307 4308
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
4309
                case VIR_TYPED_PARAM_DOUBLE:
4310 4311 4312
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4313
                case VIR_TYPED_PARAM_BOOLEAN:
4314 4315 4316 4317 4318 4319 4320 4321
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
4322
        ret = true;
4323 4324 4325 4326 4327 4328
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4329
            temp->type = VIR_TYPED_PARAM_UINT;
4330 4331 4332 4333 4334 4335 4336 4337

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
H
Hu Tao 已提交
4338
        if (virDomainSetBlkioParameters(dom, params, nparams, flags) != 0)
4339 4340
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
4341
            ret = true;
4342 4343 4344 4345 4346 4347 4348 4349
    }

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

4350 4351 4352 4353
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
4354 4355 4356
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
4357 4358 4359 4360 4361 4362 4363
                "    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")},
4364
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4365
     N_("Max memory in kilobytes")},
4366
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4367
     N_("Memory during contention in kilobytes")},
4368
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4369
     N_("Max memory plus swap in kilobytes")},
4370
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
4371
     N_("Min guaranteed memory in kilobytes")},
4372 4373 4374
    {"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")},
4375 4376 4377
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4378
static bool
4379 4380 4381
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
4382 4383
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
4384 4385
    int nparams = 0;
    unsigned int i = 0;
4386
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4387
    bool ret = false;
4388 4389 4390 4391 4392 4393 4394 4395 4396 4397
    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;
        }
4398
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4399 4400
    } else {
        if (config)
4401
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4402
        if (live)
4403
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4404
    }
4405 4406

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4407
        return false;
4408 4409

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

4412 4413 4414 4415 4416 4417 4418 4419 4420
    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;
    }

4421 4422 4423 4424 4425 4426 4427 4428 4429
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

4430 4431 4432
    if (min_guarantee)
        nparams++;

4433 4434
    if (nparams == 0) {
        /* get the number of memory parameters */
4435
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
4436 4437 4438 4439 4440
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

4441 4442
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4443
            ret = true;
4444 4445 4446
            goto cleanup;
        }

4447
        /* now go get all the memory parameters */
E
Eric Blake 已提交
4448
        params = vshCalloc(ctl, nparams, sizeof(*params));
4449
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
4450 4451 4452 4453 4454 4455
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4456
                case VIR_TYPED_PARAM_INT:
4457 4458 4459
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4460
                case VIR_TYPED_PARAM_UINT:
4461 4462 4463
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4464
                case VIR_TYPED_PARAM_LLONG:
4465 4466 4467
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4468
                case VIR_TYPED_PARAM_ULLONG:
4469 4470 4471 4472 4473
                    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);
4474
                    break;
4475
                case VIR_TYPED_PARAM_DOUBLE:
4476 4477 4478
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4479
                case VIR_TYPED_PARAM_BOOLEAN:
4480 4481 4482 4483
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
4484
                    vshPrint(ctl, "unimplemented memory parameter type\n");
4485 4486 4487
            }
        }

E
Eric Blake 已提交
4488
        ret = true;
4489 4490
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
4491
        params = vshCalloc(ctl, nparams, sizeof(*params));
4492 4493 4494

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4495
            temp->type = VIR_TYPED_PARAM_ULLONG;
4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514

            /*
             * 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;
4515
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
4516 4517
                        sizeof(temp->field));
                swap_hard_limit = 0;
4518 4519 4520 4521 4522
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
4523
            }
4524 4525 4526 4527

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
4528
        }
4529
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
4530
            vshError(ctl, "%s", _("Unable to change memory parameters"));
4531
        else
E
Eric Blake 已提交
4532
            ret = true;
4533 4534 4535
    }

  cleanup:
E
Eric Blake 已提交
4536
    VIR_FREE(params);
4537 4538 4539 4540
    virDomainFree(dom);
    return ret;
}

4541 4542 4543
/*
 * "nodeinfo" command
 */
4544
static const vshCmdInfo info_nodeinfo[] = {
4545 4546
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
4547 4548 4549
    {NULL, NULL}
};

E
Eric Blake 已提交
4550
static bool
4551
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4552 4553
{
    virNodeInfo info;
4554

4555
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4556
        return false;
4557 4558

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
4559
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
4560
        return false;
4561 4562 4563 4564 4565 4566 4567 4568 4569 4570
    }
    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 已提交
4571
    return true;
4572 4573
}

4574 4575 4576 4577 4578
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
4579
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
4580 4581 4582 4583 4584 4585 4586 4587 4588 4589
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_cpustats[] = {
    {"cpu", VSH_OT_INT, 0, N_("prints specified cpu statistics only.")},
    {"percent", VSH_OT_BOOL, 0, N_("prints by percentage during 1 second.")},
    {NULL, 0, 0, NULL}
};

static bool
4590
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
4591 4592 4593 4594
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
4595 4596
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639
    int nparams = 0;
    bool ret = false;
    struct cpu_stats {
        unsigned long long user;
        unsigned long long sys;
        unsigned long long idle;
        unsigned long long iowait;
        unsigned long long util;
    } cpu_stats[2];
    double user_time, sys_time, idle_time, iowait_time, total_time;
    double usage;

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

    if (vshCommandOptInt(cmd, "cpu", &cpuNum) < 0) {
        vshError(ctl, "%s", _("Invalid value of cpuNum"));
        return false;
    }

    if (virNodeGetCPUStats(ctl->conn, cpuNum, NULL, &nparams, 0) != 0) {
        vshError(ctl, "%s",
                 _("Unable to get number of cpu stats"));
        return false;
    }
    if (nparams == 0) {
        /* nothing to output */
        return true;
    }

    memset(cpu_stats, 0, sizeof(cpu_stats));
    params = vshCalloc(ctl, nparams, sizeof(*params));

    i = 0;
    do {
        if (virNodeGetCPUStats(ctl->conn, cpuNum, params, &nparams, 0) != 0) {
            vshError(ctl, "%s", _("Unable to get node cpu stats"));
            goto cleanup;
        }

        for (j = 0; j < nparams; j++) {
            unsigned long long value = params[j].value;

4640
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
4641
                cpu_stats[i].sys = value;
4642
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
4643
                cpu_stats[i].user = value;
4644
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
4645
                cpu_stats[i].idle = value;
4646
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
4647
                cpu_stats[i].iowait = value;
4648
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662
                cpu_stats[i].util = value;
                flag_utilization = true;
            }
        }

        if (flag_utilization || !flag_percent)
            break;

        i++;
        sleep(1);
    } while (i < 2);

    if (!flag_percent) {
        if (!flag_utilization) {
4663
            vshPrint(ctl, "%-15s %20llu\n", _("user:"), cpu_stats[0].user);
4664
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
4665
            vshPrint(ctl, "%-15s %20llu\n", _("idle:"), cpu_stats[0].idle);
4666 4667 4668 4669 4670 4671 4672
            vshPrint(ctl, "%-15s %20llu\n", _("iowait:"), cpu_stats[0].iowait);
        }
    } else {
        if (flag_utilization) {
            usage = cpu_stats[0].util;

            vshPrint(ctl, "%-15s %5.1lf%%\n", _("usage:"), usage);
4673
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle:"), 100 - usage);
4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685
        } else {
            user_time   = cpu_stats[1].user   - cpu_stats[0].user;
            sys_time    = cpu_stats[1].sys    - cpu_stats[0].sys;
            idle_time   = cpu_stats[1].idle   - cpu_stats[0].idle;
            iowait_time = cpu_stats[1].iowait - cpu_stats[0].iowait;
            total_time  = user_time + sys_time + idle_time + iowait_time;

            usage = (user_time + sys_time) / total_time * 100;

            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("usage:"), usage);
            vshPrint(ctl, "%-15s %5.1lf%%\n",
4686
                     _("user:"), user_time / total_time * 100);
4687
            vshPrint(ctl, "%-15s %5.1lf%%\n",
4688
                     _("system:"), sys_time  / total_time * 100);
4689
            vshPrint(ctl, "%-15s %5.1lf%%\n",
4690
                     _("idle:"), idle_time     / total_time * 100);
4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721
/*
 * "nodememstats" command
 */
static const vshCmdInfo info_nodememstats[] = {
    {"help", N_("Prints memory stats of the node.")},
    {"desc", N_("Returns memory stats of the node, in kilobytes.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_memstats[] = {
    {"cell", VSH_OT_INT, 0, N_("prints specified cell statistics only.")},
    {NULL, 0, 0, NULL}
};

static bool
cmdNodeMemStats(vshControl *ctl, const vshCmd *cmd)
{
    int nparams = 0;
    unsigned int i = 0;
4722 4723
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763
    bool ret = false;

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

    if (vshCommandOptInt(cmd, "cell", &cellNum) < 0) {
        vshError(ctl, "%s", _("Invalid value of cellNum"));
        return false;
    }

    /* get the number of memory parameters */
    if (virNodeGetMemoryStats(ctl->conn, cellNum, NULL, &nparams, 0) != 0) {
        vshError(ctl, "%s",
                 _("Unable to get number of memory stats"));
        goto cleanup;
    }

    if (nparams == 0) {
        /* nothing to output */
        ret = true;
        goto cleanup;
    }

    /* now go get all the memory parameters */
    params = vshCalloc(ctl, nparams, sizeof(*params));
    if (virNodeGetMemoryStats(ctl->conn, cellNum, params, &nparams, 0) != 0) {
        vshError(ctl, "%s", _("Unable to get memory stats"));
        goto cleanup;
    }

    for (i = 0; i < nparams; i++)
        vshPrint(ctl, "%-7s: %20llu kB\n", params[i].field, params[i].value);

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

4764 4765 4766
/*
 * "capabilities" command
 */
4767
static const vshCmdInfo info_capabilities[] = {
4768 4769
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
4770 4771 4772
    {NULL, NULL}
};

E
Eric Blake 已提交
4773
static bool
4774
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4775 4776 4777
{
    char *caps;

4778
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4779
        return false;
4780 4781

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
4782
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
4783
        return false;
4784 4785
    }
    vshPrint (ctl, "%s\n", caps);
4786
    VIR_FREE(caps);
4787

E
Eric Blake 已提交
4788
    return true;
4789 4790
}

4791 4792 4793
/*
 * "dumpxml" command
 */
4794
static const vshCmdInfo info_dumpxml[] = {
4795 4796
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
4797
    {NULL, NULL}
4798 4799
};

4800
static const vshCmdOptDef opts_dumpxml[] = {
4801 4802 4803
    {"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")},
4804
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
4805
    {NULL, 0, 0, NULL}
4806 4807
};

E
Eric Blake 已提交
4808
static bool
4809
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
4810
{
4811
    virDomainPtr dom;
E
Eric Blake 已提交
4812
    bool ret = true;
4813
    char *dump;
E
Eric Blake 已提交
4814
    unsigned int flags = 0;
4815 4816
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
4817
    int update = vshCommandOptBool(cmd, "update-cpu");
4818 4819 4820 4821 4822

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
4823 4824
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
4825

4826
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4827
        return false;
4828

J
Jim Meyering 已提交
4829
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4830
        return false;
4831

4832
    dump = virDomainGetXMLDesc(dom, flags);
4833
    if (dump != NULL) {
4834
        vshPrint(ctl, "%s", dump);
4835
        VIR_FREE(dump);
4836
    } else {
E
Eric Blake 已提交
4837
        ret = false;
4838
    }
4839

4840 4841 4842 4843
    virDomainFree(dom);
    return ret;
}

4844 4845 4846 4847
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
4848 4849
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
4850 4851 4852 4853
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
4854 4855
    {"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")},
4856 4857 4858
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4859
static bool
4860 4861
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4862
    bool ret = true;
4863 4864
    const char *format = NULL;
    const char *configFile = NULL;
4865 4866
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
4867
    unsigned int flags = 0;
4868

4869
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4870
        return false;
4871

4872 4873
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
4874
        return false;
4875

4876
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
4877
        return false;
4878 4879 4880

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
4881
        vshPrint(ctl, "%s", xmlData);
4882
        VIR_FREE(xmlData);
4883
    } else {
E
Eric Blake 已提交
4884
        ret = false;
4885 4886 4887 4888 4889 4890 4891 4892 4893
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
4894 4895
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
4896 4897 4898 4899
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
4900 4901
    {"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")},
4902 4903 4904
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4905
static bool
4906 4907
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4908
    bool ret = true;
4909 4910
    const char *format = NULL;
    const char *xmlFile = NULL;
4911 4912
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
4913
    unsigned int flags = 0;
4914

4915
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4916
        return false;
4917

4918 4919
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
4920
        return false;
4921

4922
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
4923
        return false;
4924 4925 4926

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
4927
        vshPrint(ctl, "%s", configData);
4928
        VIR_FREE(configData);
4929
    } else {
E
Eric Blake 已提交
4930
        ret = false;
4931 4932 4933 4934 4935
    }

    return ret;
}

K
Karel Zak 已提交
4936
/*
K
Karel Zak 已提交
4937
 * "domname" command
K
Karel Zak 已提交
4938
 */
4939
static const vshCmdInfo info_domname[] = {
4940
    {"help", N_("convert a domain id or UUID to domain name")},
4941
    {"desc", ""},
4942
    {NULL, NULL}
K
Karel Zak 已提交
4943 4944
};

4945
static const vshCmdOptDef opts_domname[] = {
4946
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
4947
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4948 4949
};

E
Eric Blake 已提交
4950
static bool
4951
cmdDomname(vshControl *ctl, const vshCmd *cmd)
4952
{
K
Karel Zak 已提交
4953 4954
    virDomainPtr dom;

4955
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4956
        return false;
J
Jim Meyering 已提交
4957
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4958
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
4959
        return false;
4960

K
Karel Zak 已提交
4961 4962
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
4963
    return true;
K
Karel Zak 已提交
4964 4965 4966
}

/*
K
Karel Zak 已提交
4967
 * "domid" command
K
Karel Zak 已提交
4968
 */
4969
static const vshCmdInfo info_domid[] = {
4970
    {"help", N_("convert a domain name or UUID to domain id")},
4971
    {"desc", ""},
4972
    {NULL, NULL}
K
Karel Zak 已提交
4973 4974
};

4975
static const vshCmdOptDef opts_domid[] = {
4976
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
4977
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4978 4979
};

E
Eric Blake 已提交
4980
static bool
4981
cmdDomid(vshControl *ctl, const vshCmd *cmd)
4982
{
4983
    virDomainPtr dom;
4984
    unsigned int id;
K
Karel Zak 已提交
4985

4986
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4987
        return false;
J
Jim Meyering 已提交
4988
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4989
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
4990
        return false;
4991

4992 4993
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
4994
        vshPrint(ctl, "%s\n", "-");
4995
    else
4996
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
4997
    virDomainFree(dom);
E
Eric Blake 已提交
4998
    return true;
K
Karel Zak 已提交
4999
}
5000

K
Karel Zak 已提交
5001 5002 5003
/*
 * "domuuid" command
 */
5004
static const vshCmdInfo info_domuuid[] = {
5005
    {"help", N_("convert a domain name or id to domain UUID")},
5006
    {"desc", ""},
K
Karel Zak 已提交
5007 5008 5009
    {NULL, NULL}
};

5010
static const vshCmdOptDef opts_domuuid[] = {
5011
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
5012 5013 5014
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5015
static bool
5016
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
5017 5018
{
    virDomainPtr dom;
5019
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
5020

5021
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5022
        return false;
J
Jim Meyering 已提交
5023
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5024
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
5025
        return false;
5026

K
Karel Zak 已提交
5027 5028 5029
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
5030
        vshError(ctl, "%s", _("failed to get domain UUID"));
5031

5032
    virDomainFree(dom);
E
Eric Blake 已提交
5033
    return true;
K
Karel Zak 已提交
5034 5035
}

5036 5037 5038
/*
 * "migrate" command
 */
5039
static const vshCmdInfo info_migrate[] = {
5040 5041
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
5042 5043 5044
    {NULL, NULL}
};

5045
static const vshCmdOptDef opts_migrate[] = {
5046 5047 5048 5049 5050 5051 5052
    {"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")},
5053 5054
    {"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)")},
5055 5056
    {"change-protection", VSH_OT_BOOL, 0,
     N_("prevent any configuration changes to domain until migration ends)")},
W
Wen Congyang 已提交
5057
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
5058
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
5059
    {"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)")},
5060 5061
    {"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 已提交
5062
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
5063
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
5064 5065 5066
    {NULL, 0, 0, NULL}
};

5067 5068 5069 5070 5071 5072 5073 5074
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
5075
{
5076
    char ret = '1';
5077
    virDomainPtr dom = NULL;
5078 5079 5080
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
E
Eric Blake 已提交
5081
    unsigned int flags = 0;
5082 5083 5084
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
5085 5086
    const char *xmlfile = NULL;
    char *xml = NULL;
5087
    sigset_t sigmask, oldsigmask;
5088 5089 5090 5091 5092

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
    if (pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask) < 0)
        goto out_sig;
5093

5094
    if (!vshConnectionUsability (ctl, ctl->conn))
5095
        goto out;
5096

J
Jim Meyering 已提交
5097
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
5098
        goto out;
5099

5100 5101
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
5102 5103
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
5104
        goto out;
5105
    }
5106

5107 5108 5109 5110 5111
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

5112 5113
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
5114 5115
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
5116
    if (vshCommandOptBool (cmd, "tunnelled"))
5117
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
5118

C
Chris Lalancette 已提交
5119 5120 5121 5122 5123
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

5124 5125 5126
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

5127 5128 5129 5130 5131 5132
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

5133 5134
    if (vshCommandOptBool (cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;
5135 5136 5137 5138 5139 5140

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


5141 5142 5143 5144
    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. */
5145

5146
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
5147
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
5148
            goto out;
5149
        }
5150

5151
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
5152
            ret = '0';
5153 5154 5155 5156 5157 5158
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
5159
        if (!dconn) goto out;
5160

5161
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
5162 5163
        if (ddom) {
            virDomainFree(ddom);
5164
            ret = '0';
5165 5166 5167
        }
        virConnectClose (dconn);
    }
5168

5169 5170 5171
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
5172
    if (dom) virDomainFree (dom);
5173
    VIR_FREE(xml);
5174 5175 5176
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
5177
static void
5178 5179
print_job_progress(const char *label, unsigned long long remaining,
                   unsigned long long total)
W
Wen Congyang 已提交
5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198
{
    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;
        }
    }

5199 5200
    /* see comments in vshError about why we must flush */
    fflush(stdout);
5201
    fprintf(stderr, "\r%s: [%3d %%]", label, progress);
5202
    fflush(stderr);
W
Wen Congyang 已提交
5203 5204
}

E
Eric Blake 已提交
5205
static bool
5206 5207 5208 5209 5210
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
5211
    bool functionReturn = false;
5212 5213 5214 5215 5216
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
5217 5218
    virDomainJobInfo jobinfo;
    bool verbose = false;
5219
    int timeout = 0;
W
Wen Congyang 已提交
5220 5221
    struct timeval start, curr;
    bool live_flag = false;
5222
    vshCtrlData data;
5223 5224 5225 5226
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
5227 5228

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

W
Wen Congyang 已提交
5231 5232 5233
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
5234
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
5235
        live_flag = true;
5236
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253
        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;
        }
    }

5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276
    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 已提交
5277
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
5278
    while (1) {
5279
repoll:
W
Wen Congyang 已提交
5280 5281 5282 5283
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
5284
                    functionReturn = true;
W
Wen Congyang 已提交
5285 5286
                    if (verbose) {
                        /* print [100 %] */
5287
                        print_job_progress("Migration", 0, 1);
W
Wen Congyang 已提交
5288 5289
                    }
                } else
W
Wen Congyang 已提交
5290
                    functionReturn = false;
5291
            } else
W
Wen Congyang 已提交
5292
                functionReturn = false;
W
Wen Congyang 已提交
5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
5304
            functionReturn = false;
W
Wen Congyang 已提交
5305 5306 5307
            break;
        }

W
Wen Congyang 已提交
5308 5309 5310 5311
        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. */
5312 5313
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "suspend the domain when migration timeouts\n");
W
Wen Congyang 已提交
5314 5315 5316 5317
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
5318 5319 5320 5321 5322
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
5323 5324
                print_job_progress("Migration", jobinfo.dataRemaining,
                                   jobinfo.dataTotal);
5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
5336
    return functionReturn;
5337 5338
}

5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349
/*
 * "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")},
5350
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
5351 5352 5353
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5354
static bool
5355 5356 5357
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
5358
    long long downtime = 0;
E
Eric Blake 已提交
5359
    bool ret = false;
5360

5361
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5362
        return false;
5363 5364

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

5367 5368
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
5369 5370 5371 5372 5373 5374 5375
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
5376
    ret = true;
5377 5378 5379 5380 5381 5382

done:
    virDomainFree(dom);
    return ret;
}

5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426
/*
 * "migrate-setspeed" command
 */
static const vshCmdInfo info_migrate_setspeed[] = {
    {"help", N_("Set the maximum migration bandwidth")},
    {"desc", N_("Set the maximum migration bandwidth (in Mbps) for a domain "
                "which is being migrated to another host.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_migrate_setspeed[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"bandwidth", VSH_OT_INT, VSH_OFLAG_REQ, N_("migration bandwidth limit in Mbps")},
    {NULL, 0, 0, NULL}
};

static bool
cmdMigrateSetMaxSpeed(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    unsigned long bandwidth = 0;
    bool ret = false;

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

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

    if (vshCommandOptUL(cmd, "bandwidth", &bandwidth) < 0) {
        vshError(ctl, "%s", _("migrate: Invalid bandwidth"));
        goto done;
    }

    if (virDomainMigrateSetMaxSpeed(dom, bandwidth, 0) < 0)
        goto done;

    ret = true;

done:
    virDomainFree(dom);
    return ret;
}

5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465
/*
 * "migrate-getspeed" command
 */
static const vshCmdInfo info_migrate_getspeed[] = {
    {"help", N_("Get the maximum migration bandwidth")},
    {"desc", N_("Get the maximum migration bandwidth (in Mbps) for a domain.")},
    {NULL, NULL}
};

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

static bool
cmdMigrateGetMaxSpeed(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    unsigned long bandwidth;
    bool ret = false;

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

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

    if (virDomainMigrateGetMaxSpeed(dom, &bandwidth, 0) < 0)
        goto done;

    vshPrint(ctl, "%lu\n", bandwidth);

    ret = true;

done:
    virDomainFree(dom);
    return ret;
}

5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482
typedef enum {
    VSH_CMD_BLOCK_JOB_ABORT = 0,
    VSH_CMD_BLOCK_JOB_INFO = 1,
    VSH_CMD_BLOCK_JOB_SPEED = 2,
    VSH_CMD_BLOCK_JOB_PULL = 3,
} VSH_CMD_BLOCK_JOB_MODE;

static int
blockJobImpl(vshControl *ctl, const vshCmd *cmd,
              virDomainBlockJobInfoPtr info, int mode)
{
    virDomainPtr dom = NULL;
    const char *name, *path;
    unsigned long bandwidth = 0;
    int ret = -1;

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
5486
        goto cleanup;
5487 5488

    if (vshCommandOptString(cmd, "path", &path) < 0)
5489
        goto cleanup;
5490

5491 5492
    if (vshCommandOptUL(cmd, "bandwidth", &bandwidth) < 0) {
        vshError(ctl, "%s", _("bandwidth must be a number"));
5493
        goto cleanup;
5494
    }
5495 5496 5497 5498 5499 5500 5501 5502 5503 5504

    if (mode == VSH_CMD_BLOCK_JOB_ABORT)
        ret = virDomainBlockJobAbort(dom, path, 0);
    else if (mode == VSH_CMD_BLOCK_JOB_INFO)
        ret = virDomainGetBlockJobInfo(dom, path, info, 0);
    else if (mode == VSH_CMD_BLOCK_JOB_SPEED)
        ret = virDomainBlockJobSetSpeed(dom, path, bandwidth, 0);
    else if (mode == VSH_CMD_BLOCK_JOB_PULL)
        ret = virDomainBlockPull(dom, path, bandwidth, 0);

5505
cleanup:
5506 5507
    if (dom)
        virDomainFree(dom);
5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591
    return ret;
}

/*
 * "blockpull" command
 */
static const vshCmdInfo info_block_pull[] = {
    {"help", N_("Populate a disk from its backing image.")},
    {"desc", N_("Populate a disk from its backing image.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_block_pull[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified path of disk")},
    {"bandwidth", VSH_OT_DATA, VSH_OFLAG_NONE, N_("Bandwidth limit in MB/s")},
    {NULL, 0, 0, NULL}
};

static bool
cmdBlockPull(vshControl *ctl, const vshCmd *cmd)
{
    if (blockJobImpl(ctl, cmd, NULL, VSH_CMD_BLOCK_JOB_PULL) != 0)
        return false;
    return true;
}

/*
 * "blockjobinfo" command
 */
static const vshCmdInfo info_block_job[] = {
    {"help", N_("Manage active block operations.")},
    {"desc", N_("Manage active block operations.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_block_job[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified path of disk")},
    {"abort", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("Abort the active job on the speficied disk")},
    {"info", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("Get active job information for the specified disk")},
    {"bandwidth", VSH_OT_DATA, VSH_OFLAG_NONE, N_("Set the Bandwidth limit in MB/s")},
    {NULL, 0, 0, NULL}
};

static bool
cmdBlockJob(vshControl *ctl, const vshCmd *cmd)
{
    int mode;
    virDomainBlockJobInfo info;
    const char *type;
    int ret;

    if (vshCommandOptBool (cmd, "abort")) {
        mode = VSH_CMD_BLOCK_JOB_ABORT;
    } else if (vshCommandOptBool (cmd, "info")) {
        mode = VSH_CMD_BLOCK_JOB_INFO;
    } else if (vshCommandOptBool (cmd, "bandwidth")) {
        mode = VSH_CMD_BLOCK_JOB_SPEED;
    } else {
        vshError(ctl, "%s",
                 _("One of --abort, --info, or --bandwidth is required"));
        return false;
    }

    ret = blockJobImpl(ctl, cmd, &info, mode);
    if (ret < 0)
        return false;

    if (ret == 0 || mode != VSH_CMD_BLOCK_JOB_INFO)
        return true;

    if (info.type == VIR_DOMAIN_BLOCK_JOB_TYPE_PULL)
        type = "Block Pull";
    else
        type = "Unknown job";

    print_job_progress(type, info.end - info.cur, info.end);
    if (info.bandwidth != 0)
        vshPrint(ctl, "    Bandwidth limit: %lu MB/s\n", info.bandwidth);
    return true;
}


5592 5593 5594
/*
 * "net-autostart" command
 */
5595
static const vshCmdInfo info_network_autostart[] = {
5596
    {"help", N_("autostart a network")},
5597
    {"desc",
5598
     N_("Configure a network to be automatically started at boot.")},
5599 5600 5601
    {NULL, NULL}
};

5602
static const vshCmdOptDef opts_network_autostart[] = {
5603 5604
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5605 5606 5607
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5608
static bool
5609
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
5610 5611
{
    virNetworkPtr network;
5612
    const char *name;
5613 5614
    int autostart;

5615
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5616
        return false;
5617

J
Jim Meyering 已提交
5618
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5619
        return false;
5620 5621 5622 5623

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
5624
        if (autostart)
5625
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
5626
        else
5627
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
5628
        virNetworkFree(network);
E
Eric Blake 已提交
5629
        return false;
5630 5631
    }

5632
    if (autostart)
5633
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
5634
    else
5635
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
5636

L
Laine Stump 已提交
5637
    virNetworkFree(network);
E
Eric Blake 已提交
5638
    return true;
5639
}
K
Karel Zak 已提交
5640

5641 5642 5643
/*
 * "net-create" command
 */
5644
static const vshCmdInfo info_network_create[] = {
5645 5646
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
5647 5648 5649
    {NULL, NULL}
};

5650
static const vshCmdOptDef opts_network_create[] = {
5651
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5652 5653 5654
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5655
static bool
5656
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
5657 5658
{
    virNetworkPtr network;
5659
    const char *from = NULL;
E
Eric Blake 已提交
5660
    bool ret = true;
5661
    char *buffer;
5662

5663
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5664
        return false;
5665

5666
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5667
        return false;
5668

5669
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5670
        return false;
5671 5672

    network = virNetworkCreateXML(ctl->conn, buffer);
5673
    VIR_FREE(buffer);
5674

5675 5676 5677
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
5678
        virNetworkFree(network);
5679
    } else {
5680
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
5681
        ret = false;
5682 5683 5684 5685 5686 5687 5688 5689
    }
    return ret;
}


/*
 * "net-define" command
 */
5690
static const vshCmdInfo info_network_define[] = {
5691 5692
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
5693 5694 5695
    {NULL, NULL}
};

5696
static const vshCmdOptDef opts_network_define[] = {
5697
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5698 5699 5700
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5701
static bool
5702
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
5703 5704
{
    virNetworkPtr network;
5705
    const char *from = NULL;
E
Eric Blake 已提交
5706
    bool ret = true;
5707
    char *buffer;
5708

5709
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5710
        return false;
5711

5712
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5713
        return false;
5714

5715
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5716
        return false;
5717 5718

    network = virNetworkDefineXML(ctl->conn, buffer);
5719
    VIR_FREE(buffer);
5720

5721 5722 5723
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
5724
        virNetworkFree(network);
5725
    } else {
5726
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
5727
        ret = false;
5728 5729 5730 5731 5732 5733 5734 5735
    }
    return ret;
}


/*
 * "net-destroy" command
 */
5736
static const vshCmdInfo info_network_destroy[] = {
5737 5738
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
5739 5740 5741
    {NULL, NULL}
};

5742
static const vshCmdOptDef opts_network_destroy[] = {
5743
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5744 5745 5746
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5747
static bool
5748
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
5749 5750
{
    virNetworkPtr network;
E
Eric Blake 已提交
5751
    bool ret = true;
5752
    const char *name;
5753

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

J
Jim Meyering 已提交
5757
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5758
        return false;
5759 5760 5761 5762

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

5767
    virNetworkFree(network);
5768 5769 5770 5771 5772 5773 5774
    return ret;
}


/*
 * "net-dumpxml" command
 */
5775
static const vshCmdInfo info_network_dumpxml[] = {
5776 5777
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
5778 5779 5780
    {NULL, NULL}
};

5781
static const vshCmdOptDef opts_network_dumpxml[] = {
5782
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5783 5784 5785
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5786
static bool
5787
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
5788 5789
{
    virNetworkPtr network;
E
Eric Blake 已提交
5790
    bool ret = true;
5791 5792
    char *dump;

5793
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5794
        return false;
5795

J
Jim Meyering 已提交
5796
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
5797
        return false;
5798 5799 5800

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
5801
        vshPrint(ctl, "%s", dump);
5802
        VIR_FREE(dump);
5803
    } else {
E
Eric Blake 已提交
5804
        ret = false;
5805 5806 5807 5808 5809 5810
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824
/*
 * "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 已提交
5825
static bool
O
Osier Yang 已提交
5826 5827 5828 5829 5830 5831 5832 5833 5834 5835
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 已提交
5836
        return false;
O
Osier Yang 已提交
5837 5838 5839

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5840
        return false;
O
Osier Yang 已提交
5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865

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

5866
    VIR_FREE(bridge);
O
Osier Yang 已提交
5867
    virNetworkFree(network);
E
Eric Blake 已提交
5868
    return true;
O
Osier Yang 已提交
5869
}
5870

5871 5872 5873 5874
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
5875 5876
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
5877 5878 5879 5880
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
5881
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5882 5883 5884
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5885
static bool
5886 5887
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5888
    bool ret = false;
5889 5890 5891 5892 5893
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
5894
    unsigned int flags = VIR_INTERFACE_XML_INACTIVE;
5895

5896
    if (!vshConnectionUsability(ctl, ctl->conn))
5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922
        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 已提交
5923
        ret = true;
5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935
        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)) {
5936 5937
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949
        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 已提交
5950
    ret = true;
5951 5952 5953 5954 5955

cleanup:
    if (iface)
        virInterfaceFree (iface);

5956 5957 5958
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
5959 5960 5961

    if (tmp) {
        unlink (tmp);
5962
        VIR_FREE(tmp);
5963 5964 5965 5966 5967
    }

    return ret;
}

5968 5969 5970
/*
 * "net-list" command
 */
5971
static const vshCmdInfo info_network_list[] = {
5972 5973
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
5974 5975 5976
    {NULL, NULL}
};

5977
static const vshCmdOptDef opts_network_list[] = {
5978 5979
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
5980 5981 5982
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5983
static bool
5984
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5985 5986 5987 5988 5989
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
5990
    char **activeNames = NULL, **inactiveNames = NULL;
5991 5992
    inactive |= all;

5993
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5994
        return false;
5995 5996

    if (active) {
5997 5998
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
5999
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
6000
            return false;
6001
        }
6002
        if (maxactive) {
6003
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
6004

6005
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
6006
                                                    maxactive)) < 0) {
6007
                vshError(ctl, "%s", _("Failed to list active networks"));
6008
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6009
                return false;
6010
            }
6011

6012
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
6013
        }
6014 6015
    }
    if (inactive) {
6016 6017
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
6018
            vshError(ctl, "%s", _("Failed to list inactive networks"));
6019
            VIR_FREE(activeNames);
E
Eric Blake 已提交
6020
            return false;
6021
        }
6022 6023 6024
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

6025 6026 6027
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
6028
                vshError(ctl, "%s", _("Failed to list inactive networks"));
6029 6030
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6031
                return false;
6032
            }
6033

6034 6035
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
6036
    }
6037 6038
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
6039
    vshPrintExtra(ctl, "-----------------------------------------\n");
6040 6041

    for (i = 0; i < maxactive; i++) {
6042 6043
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
6044 6045
        const char *autostartStr;
        int autostart = 0;
6046 6047 6048

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6049
            VIR_FREE(activeNames[i]);
6050
            continue;
6051
        }
6052

6053 6054 6055
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6056
            autostartStr = autostart ? _("yes") : _("no");
6057 6058 6059 6060 6061

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
6062
        virNetworkFree(network);
6063
        VIR_FREE(activeNames[i]);
6064 6065 6066
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
6067 6068
        const char *autostartStr;
        int autostart = 0;
6069 6070 6071

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6072
            VIR_FREE(inactiveNames[i]);
6073
            continue;
6074
        }
6075

6076 6077 6078
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6079
            autostartStr = autostart ? _("yes") : _("no");
6080

6081
        vshPrint(ctl, "%-20s %-10s %-10s\n",
6082 6083 6084
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
6085 6086

        virNetworkFree(network);
6087
        VIR_FREE(inactiveNames[i]);
6088
    }
6089 6090
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6091
    return true;
6092 6093 6094 6095 6096 6097
}


/*
 * "net-name" command
 */
6098
static const vshCmdInfo info_network_name[] = {
6099
    {"help", N_("convert a network UUID to network name")},
6100
    {"desc", ""},
6101 6102 6103
    {NULL, NULL}
};

6104
static const vshCmdOptDef opts_network_name[] = {
6105
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
6106 6107 6108
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6109
static bool
6110
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
6111 6112 6113
{
    virNetworkPtr network;

6114
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6115
        return false;
J
Jim Meyering 已提交
6116
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
6117
                                           VSH_BYUUID)))
E
Eric Blake 已提交
6118
        return false;
6119 6120 6121

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
6122
    return true;
6123 6124 6125 6126 6127 6128
}


/*
 * "net-start" command
 */
6129
static const vshCmdInfo info_network_start[] = {
6130 6131
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
6132 6133 6134
    {NULL, NULL}
};

6135
static const vshCmdOptDef opts_network_start[] = {
6136
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
6137 6138 6139
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6140
static bool
6141
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
6142 6143
{
    virNetworkPtr network;
E
Eric Blake 已提交
6144
    bool ret = true;
6145

6146
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6147
        return false;
6148

J
Jim Meyering 已提交
6149
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
6150
         return false;
6151 6152 6153

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
6154
                 virNetworkGetName(network));
6155
    } else {
6156
        vshError(ctl, _("Failed to start network %s"),
6157
                 virNetworkGetName(network));
E
Eric Blake 已提交
6158
        ret = false;
6159
    }
L
Laine Stump 已提交
6160
    virNetworkFree(network);
6161 6162 6163 6164 6165 6166 6167
    return ret;
}


/*
 * "net-undefine" command
 */
6168
static const vshCmdInfo info_network_undefine[] = {
6169 6170
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
6171 6172 6173
    {NULL, NULL}
};

6174
static const vshCmdOptDef opts_network_undefine[] = {
6175
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6176 6177 6178
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6179
static bool
6180
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
6181 6182
{
    virNetworkPtr network;
E
Eric Blake 已提交
6183
    bool ret = true;
6184
    const char *name;
6185

6186
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6187
        return false;
6188

J
Jim Meyering 已提交
6189
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6190
        return false;
6191 6192 6193 6194

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

L
Laine Stump 已提交
6199
    virNetworkFree(network);
6200 6201 6202 6203 6204 6205 6206
    return ret;
}


/*
 * "net-uuid" command
 */
6207
static const vshCmdInfo info_network_uuid[] = {
6208
    {"help", N_("convert a network name to network UUID")},
6209
    {"desc", ""},
6210 6211 6212
    {NULL, NULL}
};

6213
static const vshCmdOptDef opts_network_uuid[] = {
6214
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
6215 6216 6217
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6218
static bool
6219
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
6220 6221 6222 6223
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

6224
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6225
        return false;
6226

J
Jim Meyering 已提交
6227
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
6228
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6229
        return false;
6230 6231 6232 6233

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

L
Laine Stump 已提交
6236
    virNetworkFree(network);
E
Eric Blake 已提交
6237
    return true;
6238 6239 6240
}


6241 6242 6243 6244 6245
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
6246 6247
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
6248 6249 6250 6251
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
6252 6253
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
6254 6255
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
6256
static bool
6257 6258 6259 6260 6261 6262 6263 6264 6265
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;

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

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
6272
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
6273
            return false;
6274 6275 6276 6277 6278 6279
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
6280
                vshError(ctl, "%s", _("Failed to list active interfaces"));
6281
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6282
                return false;
6283 6284 6285 6286 6287 6288 6289 6290
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
6291
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6292
            VIR_FREE(activeNames);
E
Eric Blake 已提交
6293
            return false;
6294 6295 6296 6297
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

6298 6299 6300
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
6301
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6302 6303
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6304
                return false;
6305 6306 6307 6308 6309
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
6310 6311
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
6312 6313 6314
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
6315 6316
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
6317 6318 6319

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6320
            VIR_FREE(activeNames[i]);
6321 6322 6323 6324 6325 6326 6327 6328
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6329
        VIR_FREE(activeNames[i]);
6330 6331
    }
    for (i = 0; i < maxinactive; i++) {
6332 6333
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
6334 6335 6336

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6337
            VIR_FREE(inactiveNames[i]);
6338 6339 6340 6341 6342 6343 6344 6345
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6346
        VIR_FREE(inactiveNames[i]);
6347
    }
6348 6349
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6350
    return true;
6351 6352 6353 6354 6355 6356 6357

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
6358
    {"help", N_("convert an interface MAC address to interface name")},
6359 6360 6361 6362 6363
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
6364
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
6365 6366 6367
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6368
static bool
6369 6370 6371 6372
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6373
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6374
        return false;
6375 6376
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
6377
        return false;
6378 6379 6380

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6381
    return true;
6382 6383 6384 6385 6386 6387
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
6388
    {"help", N_("convert an interface name to interface MAC address")},
6389 6390 6391 6392 6393
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
6394
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
6395 6396 6397
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6398
static bool
6399 6400 6401 6402
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6403
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6404
        return false;
6405 6406
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6407
        return false;
6408 6409 6410

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6411
    return true;
6412 6413 6414 6415 6416 6417
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
6418 6419
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
6420 6421 6422 6423
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
6424 6425
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
6426 6427 6428
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6429
static bool
6430 6431 6432
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6433
    bool ret = true;
6434
    char *dump;
E
Eric Blake 已提交
6435
    unsigned int flags = 0;
6436 6437 6438 6439
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
6440

6441
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6442
        return false;
6443 6444

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

6447
    dump = virInterfaceGetXMLDesc(iface, flags);
6448
    if (dump != NULL) {
6449
        vshPrint(ctl, "%s", dump);
6450
        VIR_FREE(dump);
6451
    } else {
E
Eric Blake 已提交
6452
        ret = false;
6453 6454 6455 6456 6457 6458 6459 6460 6461 6462
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
6463 6464
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
6465 6466 6467 6468
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
6469
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
6470 6471 6472
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6473
static bool
6474 6475
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
6476
    virInterfacePtr iface;
6477
    const char *from = NULL;
E
Eric Blake 已提交
6478
    bool ret = true;
6479 6480
    char *buffer;

6481
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6482
        return false;
6483

6484
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6485
        return false;
6486 6487

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

6490
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
6491
    VIR_FREE(buffer);
6492

6493
    if (iface != NULL) {
6494
        vshPrint(ctl, _("Interface %s defined from %s\n"),
6495
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
6496
        virInterfaceFree (iface);
6497
    } else {
6498
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
6499
        ret = false;
6500 6501 6502 6503 6504 6505 6506 6507
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
6508 6509
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
6510 6511 6512 6513
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
6514
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6515 6516 6517
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6518
static bool
6519 6520 6521
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6522
    bool ret = true;
6523
    const char *name;
6524

6525
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6526
        return false;
6527 6528

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6529
        return false;
6530 6531 6532 6533

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
6534
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
6535
        ret = false;
6536 6537 6538 6539 6540 6541 6542 6543 6544 6545
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
6546 6547
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
6548 6549 6550 6551
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
6552
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6553 6554 6555
    {NULL, 0, 0, NULL}
};

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

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

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6567
        return false;
6568 6569 6570 6571

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
6572
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
6573
        ret = false;
6574 6575 6576 6577 6578 6579 6580 6581 6582 6583
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
6584
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
6585
    {"desc", N_("forcefully stop a physical host interface.")},
6586 6587 6588 6589
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
6590
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6591 6592 6593
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6594
static bool
6595 6596 6597
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6598
    bool ret = true;
6599
    const char *name;
6600

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

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6605
        return false;
6606 6607 6608 6609

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
6610
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
6611
        ret = false;
6612 6613 6614 6615 6616 6617
    }

    virInterfaceFree(iface);
    return ret;
}

6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702
/*
 * "iface-begin" command
 */
static const vshCmdInfo info_interface_begin[] = {
    {"help", N_("create a snapshot of current interfaces settings, "
                "which can be later commited (iface-commit) or "
                "restored (iface-rollback)")},
    {"desc", N_("Create a restore point for interfaces settings")},
    {NULL, NULL}
};

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

static bool
cmdInterfaceBegin(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    if (!vshConnectionUsability(ctl, ctl->conn))
        return false;

    if (virInterfaceChangeBegin(ctl->conn, 0) < 0) {
        vshError(ctl, "%s", _("Failed to begin network config change transaction"));
        return false;
    }

    vshPrint(ctl, "%s", _("Network config change transaction started\n"));
    return true;
}

/*
 * "iface-commit" command
 */
static const vshCmdInfo info_interface_commit[] = {
    {"help", N_("commit changes made since iface-begin and free restore point")},
    {"desc", N_("commit changes and free restore point")},
    {NULL, NULL}
};

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

static bool
cmdInterfaceCommit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    if (!vshConnectionUsability(ctl, ctl->conn))
        return false;

    if (virInterfaceChangeCommit(ctl->conn, 0) < 0) {
        vshError(ctl, "%s", _("Failed to commit network config change transaction"));
        return false;
    }

    vshPrint(ctl, "%s", _("Network config change transaction committed\n"));
    return true;
}

/*
 * "iface-rollback" command
 */
static const vshCmdInfo info_interface_rollback[] = {
    {"help", N_("rollback to previous saved configuration created via iface-begin")},
    {"desc", N_("rollback to previous restore point")},
    {NULL, NULL}
};

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

static bool
cmdInterfaceRollback(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    if (!vshConnectionUsability(ctl, ctl->conn))
        return false;

    if (virInterfaceChangeRollback(ctl->conn, 0) < 0) {
        vshError(ctl, "%s", _("Failed to rollback network config change transaction"));
        return false;
    }

    vshPrint(ctl, "%s", _("Network config change transaction rolled back\n"));
    return true;
}
6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717

/*
 * "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 已提交
6718
static bool
6719 6720 6721
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
6722
    const char *from = NULL;
E
Eric Blake 已提交
6723
    bool ret = true;
6724 6725
    char *buffer;

6726
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6727
        return false;
6728

6729
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6730
        return false;
6731 6732

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6733
        return false;
6734 6735 6736 6737 6738 6739 6740 6741 6742 6743

    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 已提交
6744
        ret = false;
6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763
    }
    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 已提交
6764
static bool
6765 6766 6767
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6768
    bool ret = true;
6769
    const char *name;
6770

6771
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6772
        return false;
6773 6774

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
6775
        return false;
6776 6777 6778 6779 6780

    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 已提交
6781
        ret = false;
6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802
    }

    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 已提交
6803
static bool
6804 6805 6806
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6807
    bool ret = true;
6808 6809
    char *dump;

6810
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6811
        return false;
6812 6813

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
6814
        return false;
6815 6816 6817

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
6818
        vshPrint(ctl, "%s", dump);
6819 6820
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
6821
        ret = false;
6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840
    }

    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 已提交
6841
static bool
6842 6843 6844 6845 6846 6847
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

6848
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6849
        return false;
6850 6851 6852 6853

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
6854
        return false;
6855 6856 6857 6858 6859 6860 6861 6862
    }

    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 已提交
6863
        return false;
6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890
    }

    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 已提交
6891
    return true;
6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908
}


/*
 * "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 已提交
6909
static bool
6910 6911
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6912
    bool ret = false;
6913 6914 6915 6916 6917 6918
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

6919
    if (!vshConnectionUsability(ctl, ctl->conn))
6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945
        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 已提交
6946
        ret = true;
6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972
        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 已提交
6973
    ret = true;
6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991

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


6992
/**************************************************************************/
6993
/*
6994
 * "pool-autostart" command
6995
 */
6996
static const vshCmdInfo info_pool_autostart[] = {
6997
    {"help", N_("autostart a pool")},
6998
    {"desc",
6999
     N_("Configure a pool to be automatically started at boot.")},
7000
    {NULL, NULL}
7001 7002
};

7003
static const vshCmdOptDef opts_pool_autostart[] = {
7004 7005
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
7006 7007
    {NULL, 0, 0, NULL}
};
7008

E
Eric Blake 已提交
7009
static bool
7010
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
7011
{
7012
    virStoragePoolPtr pool;
7013
    const char *name;
7014
    int autostart;
7015

7016
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7017
        return false;
7018

7019
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7020
        return false;
7021

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

7024 7025
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
7026
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
7027
        else
7028
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
7029
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7030
        return false;
7031 7032
    }

7033
    if (autostart)
7034
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
7035
    else
7036
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
7037

L
Laine Stump 已提交
7038
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7039
    return true;
7040 7041
}

7042
/*
7043
 * "pool-create" command
7044
 */
7045
static const vshCmdInfo info_pool_create[] = {
7046 7047
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
7048 7049 7050
    {NULL, NULL}
};

7051
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
7052
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
7053
     N_("file containing an XML pool description")},
7054 7055 7056
    {NULL, 0, 0, NULL}
};

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

7065
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7066
        return false;
7067

7068
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7069
        return false;
7070

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

7074
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
7075
    VIR_FREE(buffer);
7076 7077 7078 7079

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7080
        virStoragePoolFree(pool);
7081
    } else {
7082
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
7083
        ret = false;
7084 7085
    }
    return ret;
7086 7087
}

7088

7089 7090 7091 7092
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
7093
    {"help", N_("create a device defined "
7094
                          "by an XML file on the node")},
7095
    {"desc", N_("Create a device on the node.  Note that this "
7096 7097 7098 7099 7100 7101 7102
                          "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,
7103
     N_("file containing an XML description of the device")},
7104 7105 7106
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7107
static bool
7108 7109 7110
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
7111
    const char *from = NULL;
E
Eric Blake 已提交
7112
    bool ret = true;
7113 7114
    char *buffer;

7115
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7116
        return false;
7117

7118
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7119
        return false;
7120

7121
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
7122
        return false;
7123 7124

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
7125
    VIR_FREE(buffer);
7126 7127 7128 7129

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
7130
        virNodeDeviceFree(dev);
7131
    } else {
7132
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
7133
        ret = false;
7134 7135 7136 7137 7138 7139 7140 7141 7142 7143
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
7144
    {"help", N_("destroy (stop) a device on the node")},
7145
    {"desc", N_("Destroy a device on the node.  Note that this "
7146
                "command destroys devices on the physical host")},
7147 7148 7149 7150 7151
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
7152
     N_("name of the device to be destroyed")},
7153 7154 7155
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7156
static bool
7157 7158 7159
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
7160
    bool ret = true;
7161
    const char *name = NULL;
7162

7163
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
7164
        return false;
7165 7166
    }

7167
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
7168
        return false;
7169 7170 7171 7172 7173 7174

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
7175
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
7176
        ret = false;
7177 7178 7179 7180 7181 7182 7183
    }

    virNodeDeviceFree(dev);
    return ret;
}


7184
/*
7185
 * XML Building helper for pool-define-as and pool-create-as
7186
 */
7187
static const vshCmdOptDef opts_pool_X_as[] = {
7188 7189 7190 7191 7192 7193 7194 7195
    {"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")},
7196
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
7197 7198 7199
    {NULL, 0, 0, NULL}
};

7200
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
7201

7202 7203
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
7204
    virBuffer buf = VIR_BUFFER_INITIALIZER;
7205

7206
    if (vshCommandOptString(cmd, "name", &name) <= 0)
7207
        goto cleanup;
7208
    if (vshCommandOptString(cmd, "type", &type) <= 0)
7209 7210
        goto cleanup;

7211 7212 7213 7214 7215
    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 ||
7216 7217
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
7218
        goto cleanup;
7219
    }
7220

7221 7222
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
7223
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
7224
        virBufferAddLit(&buf, "  <source>\n");
7225

7226
        if (srcHost)
7227
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
7228
        if (srcPath)
7229
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
7230
        if (srcDev)
7231
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
7232
        if (srcFormat)
7233
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
7234
        if (srcName)
7235
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
7236 7237

        virBufferAddLit(&buf, "  </source>\n");
7238 7239
    }
    if (target) {
7240
        virBufferAddLit(&buf, "  <target>\n");
7241
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
7242
        virBufferAddLit(&buf, "  </target>\n");
7243
    }
7244 7245 7246 7247
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7248
        return false;
7249
    }
7250 7251 7252

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
7253
    return true;
7254 7255

cleanup:
7256
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7257
    return false;
7258 7259 7260 7261 7262 7263
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
7264 7265
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
7266 7267 7268
    {NULL, NULL}
};

E
Eric Blake 已提交
7269
static bool
7270 7271 7272
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
7273 7274
    const char *name;
    char *xml;
7275
    int printXML = vshCommandOptBool(cmd, "print-xml");
7276

7277
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7278
        return false;
7279 7280

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

7283
    if (printXML) {
7284
        vshPrint(ctl, "%s", xml);
7285
        VIR_FREE(xml);
7286
    } else {
7287
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
7288
        VIR_FREE(xml);
7289

7290 7291 7292 7293
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
7294
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
7295
            return false;
7296 7297
        }
    }
E
Eric Blake 已提交
7298
    return true;
7299 7300
}

7301

7302
/*
7303
 * "pool-define" command
7304
 */
7305
static const vshCmdInfo info_pool_define[] = {
7306 7307
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
7308 7309 7310
    {NULL, NULL}
};

7311
static const vshCmdOptDef opts_pool_define[] = {
7312
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
7313 7314 7315
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7316
static bool
7317
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
7318
{
7319
    virStoragePoolPtr pool;
7320
    const char *from = NULL;
E
Eric Blake 已提交
7321
    bool ret = true;
7322
    char *buffer;
7323

7324
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7325
        return false;
7326

7327
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7328
        return false;
7329

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

7333
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
7334
    VIR_FREE(buffer);
7335 7336 7337 7338

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7339
        virStoragePoolFree(pool);
7340
    } else {
7341
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
7342
        ret = false;
7343 7344
    }
    return ret;
7345 7346
}

7347

7348 7349 7350
/*
 * "pool-define-as" command
 */
7351
static const vshCmdInfo info_pool_define_as[] = {
7352 7353
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
7354 7355 7356
    {NULL, NULL}
};

E
Eric Blake 已提交
7357
static bool
7358
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
7359 7360
{
    virStoragePoolPtr pool;
7361 7362
    const char *name;
    char *xml;
7363
    int printXML = vshCommandOptBool(cmd, "print-xml");
7364

7365
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7366
        return false;
7367

7368
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
7369
        return false;
7370

7371
    if (printXML) {
7372
        vshPrint(ctl, "%s", xml);
7373
        VIR_FREE(xml);
7374
    } else {
7375
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
7376
        VIR_FREE(xml);
7377

7378 7379 7380 7381
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
7382
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
7383
            return false;
7384 7385
        }
    }
E
Eric Blake 已提交
7386
    return true;
7387 7388 7389
}


7390
/*
7391
 * "pool-build" command
7392
 */
7393
static const vshCmdInfo info_pool_build[] = {
7394 7395
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
7396 7397 7398
    {NULL, NULL}
};

7399
static const vshCmdOptDef opts_pool_build[] = {
7400
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7401 7402
    {"no-overwrite", VSH_OT_BOOL, 0, N_("do not overwrite an existing pool of this type")},
    {"overwrite", VSH_OT_BOOL, 0, N_("overwrite any existing data")},
7403 7404 7405
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7406
static bool
7407
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
7408
{
7409
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7410
    bool ret = true;
7411
    const char *name;
7412
    unsigned int flags = 0;
7413

7414
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7415
        return false;
7416

7417
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7418
        return false;
7419

7420 7421 7422 7423 7424 7425 7426 7427 7428
    if (vshCommandOptBool (cmd, "no-overwrite")) {
        flags |= VIR_STORAGE_POOL_BUILD_NO_OVERWRITE;
    }

    if (vshCommandOptBool (cmd, "overwrite")) {
        flags |= VIR_STORAGE_POOL_BUILD_OVERWRITE;
    }

    if (virStoragePoolBuild(pool, flags) == 0) {
7429
        vshPrint(ctl, _("Pool %s built\n"), name);
7430
    } else {
7431
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
7432
        ret = false;
7433 7434
    }

7435 7436
    virStoragePoolFree(pool);

7437 7438 7439
    return ret;
}

7440
/*
7441
 * "pool-destroy" command
7442
 */
7443
static const vshCmdInfo info_pool_destroy[] = {
7444 7445 7446
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
7447 7448 7449
    {NULL, NULL}
};

7450
static const vshCmdOptDef opts_pool_destroy[] = {
7451
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7452 7453 7454
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7455
static bool
7456
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
7457
{
7458
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7459
    bool ret = true;
7460
    const char *name;
7461

7462
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7463
        return false;
7464

7465
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7466
        return false;
7467

7468 7469 7470
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
7471
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
7472
        ret = false;
7473 7474
    }

7475
    virStoragePoolFree(pool);
7476 7477 7478
    return ret;
}

7479

7480
/*
7481 7482
 * "pool-delete" command
 */
7483
static const vshCmdInfo info_pool_delete[] = {
7484 7485
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
7486 7487 7488
    {NULL, NULL}
};

7489
static const vshCmdOptDef opts_pool_delete[] = {
7490
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7491 7492 7493
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7494
static bool
7495
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
7496 7497
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7498
    bool ret = true;
7499
    const char *name;
7500

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

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7505
        return false;
7506 7507

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
7508
        vshPrint(ctl, _("Pool %s deleted\n"), name);
7509
    } else {
7510
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
7511
        ret = false;
7512 7513
    }

L
Laine Stump 已提交
7514
    virStoragePoolFree(pool);
7515 7516 7517 7518 7519 7520 7521
    return ret;
}


/*
 * "pool-refresh" command
 */
7522
static const vshCmdInfo info_pool_refresh[] = {
7523 7524
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
7525 7526 7527
    {NULL, NULL}
};

7528
static const vshCmdOptDef opts_pool_refresh[] = {
7529
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7530 7531 7532
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7533
static bool
7534
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
7535 7536
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7537
    bool ret = true;
7538
    const char *name;
7539

7540
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7541
        return false;
7542 7543

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7544
        return false;
7545 7546 7547 7548

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
7549
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
7550
        ret = false;
7551 7552 7553 7554 7555 7556 7557 7558 7559 7560
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
7561
static const vshCmdInfo info_pool_dumpxml[] = {
7562 7563
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
7564 7565 7566
    {NULL, NULL}
};

7567
static const vshCmdOptDef opts_pool_dumpxml[] = {
7568
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7569 7570 7571
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7572
static bool
7573
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
7574 7575
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7576
    bool ret = true;
7577 7578
    char *dump;

7579
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7580
        return false;
7581 7582

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7583
        return false;
7584 7585 7586

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
7587
        vshPrint(ctl, "%s", dump);
7588
        VIR_FREE(dump);
7589
    } else {
E
Eric Blake 已提交
7590
        ret = false;
7591 7592 7593 7594 7595 7596 7597 7598 7599 7600
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
7601
static const vshCmdInfo info_pool_list[] = {
7602 7603
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
7604 7605 7606
    {NULL, NULL}
};

7607
static const vshCmdOptDef opts_pool_list[] = {
7608 7609
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
7610
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
7611 7612 7613
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7614
static bool
7615
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7616
{
7617 7618
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
7619 7620
    int i, ret;
    bool functionReturn;
7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636
    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 */
7637
    int all = vshCommandOptBool(cmd, "all");
7638 7639
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
7640 7641 7642
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

7643
    /* Check the connection to libvirtd daemon is still working */
7644
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7645
        return false;
7646

7647
    /* Retrieve the number of active storage pools */
7648
    if (active) {
7649 7650
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
7651
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
7652
            return false;
7653 7654
        }
    }
7655 7656

    /* Retrieve the number of inactive storage pools */
7657
    if (inactive) {
7658 7659
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
7660
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
7661
            return false;
7662
        }
7663
    }
7664

7665 7666
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
7667

7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679
    /* 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 已提交
7680
            return false;
7681 7682 7683
        }
    }

7684 7685 7686 7687 7688 7689 7690 7691
    /* 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 已提交
7692
            return false;
7693 7694
        }
    }
7695

7696 7697 7698 7699 7700 7701 7702 7703 7704 7705
    /* 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]);
7706
        if (!pool) {
7707
            VIR_FREE(poolNames[i]);
7708 7709 7710
            continue;
        }

7711
        /* Retrieve the autostart status of the pool */
7712
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
7713
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
7714
        else
7715 7716 7717 7718 7719 7720
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
7721 7722
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733
            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;
        }
7734

7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846
        /* 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 */
7847 7848 7849
        virStoragePoolFree(pool);
    }

7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867
    /* 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);
7868 7869
        }

7870
        /* Cleanup and return */
E
Eric Blake 已提交
7871
        functionReturn = true;
7872 7873
        goto cleanup;
    }
7874

7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912
    /* 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. */
7913
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
7914
             (unsigned long) nameStrLength);
7915
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
7916
             (unsigned long) stateStrLength);
7917
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
7918
             (unsigned long) autostartStrLength);
7919
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
7920
             (unsigned long) persistStrLength);
7921
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
7922
             (unsigned long) capStrLength);
7923
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
7924
             (unsigned long) allocStrLength);
7925
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968
             (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 已提交
7969
    functionReturn = true;
7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983
    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 已提交
7984
    functionReturn = false;
7985

7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997
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]);
7998
    }
7999 8000 8001 8002 8003 8004 8005

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

    /* Return the desired value */
    return functionReturn;
8006 8007
}

8008 8009 8010 8011
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
8012 8013
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
8014 8015 8016 8017 8018
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
8019 8020 8021
     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")},
8022
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
8023 8024 8025
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8026
static bool
8027 8028
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
8029
    const char *type = NULL, *host = NULL;
8030 8031
    char *srcSpec = NULL;
    char *srcList;
8032
    const char *initiator = NULL;
8033

8034 8035
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
8036 8037
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
8038
        return false;
8039
    }
8040

8041
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8042
        return false;
8043 8044

    if (host) {
8045
        const char *port = NULL;
8046
        virBuffer buf = VIR_BUFFER_INITIALIZER;
8047 8048 8049 8050

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
8051
            return false;
8052
        }
8053
        virBufferAddLit(&buf, "<source>\n");
8054
        virBufferAsprintf(&buf, "  <host name='%s'", host);
8055
        if (port)
8056
            virBufferAsprintf(&buf, " port='%s'", port);
8057
        virBufferAddLit(&buf, "/>\n");
8058 8059
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
8060
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
8061 8062
            virBufferAddLit(&buf, "  </initiator>\n");
        }
8063 8064 8065
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
8066
            return false;
8067
        }
8068
        srcSpec = virBufferContentAndReset(&buf);
8069 8070 8071
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
8072
    VIR_FREE(srcSpec);
8073
    if (srcList == NULL) {
8074
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
8075
        return false;
8076 8077
    }
    vshPrint(ctl, "%s", srcList);
8078
    VIR_FREE(srcList);
8079

E
Eric Blake 已提交
8080
    return true;
8081 8082 8083 8084 8085 8086 8087
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
8088 8089
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
8090 8091 8092 8093 8094
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
8095
     N_("type of storage pool sources to discover")},
8096
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
8097
     N_("optional file of source xml to query for pools")},
8098 8099 8100
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8101
static bool
8102 8103
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
8104
    const char *type = NULL, *srcSpecFile = NULL;
8105
    char *srcSpec = NULL, *srcList;
8106

8107
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
8108
        return false;
8109

8110 8111
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
8112
        return false;
8113
    }
8114

8115
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8116
        return false;
8117 8118

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
8119
        return false;
8120 8121

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
8122
    VIR_FREE(srcSpec);
8123
    if (srcList == NULL) {
8124
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
8125
        return false;
8126 8127
    }
    vshPrint(ctl, "%s", srcList);
8128
    VIR_FREE(srcList);
8129

E
Eric Blake 已提交
8130
    return true;
8131 8132 8133
}


8134 8135 8136
/*
 * "pool-info" command
 */
8137
static const vshCmdInfo info_pool_info[] = {
8138 8139
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
8140 8141 8142
    {NULL, NULL}
};

8143
static const vshCmdOptDef opts_pool_info[] = {
8144
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8145 8146 8147
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8148
static bool
8149
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
8150 8151 8152
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
8153 8154
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
8155
    bool ret = true;
8156 8157
    char uuid[VIR_UUID_STRING_BUFLEN];

8158
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8159
        return false;
8160 8161

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8162
        return false;
8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188

    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;
8189 8190 8191 8192
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
8193 8194
        }

8195 8196
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
8197 8198
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
8199 8200 8201 8202 8203 8204 8205
        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);
8206 8207
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
8208 8209 8210 8211 8212
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224
        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 已提交
8225
        ret = false;
8226 8227 8228 8229 8230 8231 8232 8233 8234 8235
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
8236
static const vshCmdInfo info_pool_name[] = {
8237
    {"help", N_("convert a pool UUID to pool name")},
8238
    {"desc", ""},
8239 8240 8241
    {NULL, NULL}
};

8242
static const vshCmdOptDef opts_pool_name[] = {
8243
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
8244 8245 8246
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8247
static bool
8248
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
8249 8250 8251
{
    virStoragePoolPtr pool;

8252
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8253
        return false;
8254
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8255
                                           VSH_BYUUID)))
E
Eric Blake 已提交
8256
        return false;
8257 8258 8259

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8260
    return true;
8261 8262 8263 8264 8265 8266
}


/*
 * "pool-start" command
 */
8267
static const vshCmdInfo info_pool_start[] = {
8268 8269
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
8270 8271 8272
    {NULL, NULL}
};

8273
static const vshCmdOptDef opts_pool_start[] = {
8274
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
8275 8276 8277
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8278
static bool
8279
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
8280 8281
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8282
    bool ret = true;
8283

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

8287
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
8288
         return false;
8289 8290 8291 8292 8293

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
8294
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
8295
        ret = false;
8296
    }
L
Laine Stump 已提交
8297 8298

    virStoragePoolFree(pool);
8299 8300 8301 8302
    return ret;
}


8303 8304 8305
/*
 * "vol-create-as" command
 */
8306
static const vshCmdInfo info_vol_create_as[] = {
8307 8308
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
8309 8310 8311
    {NULL, NULL}
};

8312
static const vshCmdOptDef opts_vol_create_as[] = {
8313 8314 8315 8316 8317
    {"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")},
8318 8319
    {"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")},
8320 8321 8322 8323 8324 8325 8326 8327 8328 8329
    {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 已提交
8330
        /* Deliberate fallthrough cases here :-) */
8331 8332 8333
        switch (*end) {
        case 'T':
            *val *= 1024;
8334
            /* fallthrough */
8335 8336
        case 'G':
            *val *= 1024;
8337
            /* fallthrough */
8338 8339
        case 'M':
            *val *= 1024;
8340
            /* fallthrough */
8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
8354
static bool
8355
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
8356 8357 8358
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8359
    char *xml;
8360 8361
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
8362
    unsigned long long capacity, allocation = 0;
8363
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8364

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

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

8372
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8373 8374
        goto cleanup;

8375
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
8376 8377
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
8378
        vshError(ctl, _("Malformed size %s"), capacityStr);
8379

8380 8381
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
8382
        vshError(ctl, _("Malformed size %s"), allocationStr);
8383

8384 8385 8386 8387 8388 8389 8390
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

8391

8392
    virBufferAddLit(&buf, "<volume>\n");
8393 8394
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
8395
    if (allocationStr)
8396
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
8397 8398

    if (format) {
8399
        virBufferAddLit(&buf, "  <target>\n");
8400
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
8401
        virBufferAddLit(&buf, "  </target>\n");
8402
    }
8403

8404 8405 8406 8407
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
8408 8409
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
8410 8411 8412
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
8413 8414
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
8415 8416 8417 8418 8419
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
8420 8421
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
8422 8423 8424
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
8425 8426
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
8427 8428 8429 8430 8431
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
8432 8433
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
8434 8435 8436
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
8437 8438
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
8439 8440 8441 8442
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
8443
            goto cleanup;
8444 8445 8446 8447 8448
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
8449
            goto cleanup;
8450 8451 8452 8453
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
8454
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
8455
        if (snapshotStrFormat)
8456
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
8457 8458 8459 8460 8461 8462 8463 8464
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

8466 8467
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
8468
        goto cleanup;
8469 8470 8471
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
8472
    VIR_FREE(xml);
8473 8474 8475 8476 8477
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
8478
        return true;
8479
    } else {
8480
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
8481
        return false;
8482 8483 8484
    }

 cleanup:
8485
    virBufferFreeAndReset(&buf);
8486
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8487
    return false;
8488 8489 8490
}


8491 8492 8493
/*
 * "pool-undefine" command
 */
8494
static const vshCmdInfo info_pool_undefine[] = {
8495 8496
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
8497 8498 8499
    {NULL, NULL}
};

8500
static const vshCmdOptDef opts_pool_undefine[] = {
8501
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8502 8503 8504
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8505
static bool
8506
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
8507 8508
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8509
    bool ret = true;
8510
    const char *name;
8511

8512
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8513
        return false;
8514 8515

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8516
        return false;
8517 8518 8519 8520

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

L
Laine Stump 已提交
8525
    virStoragePoolFree(pool);
8526 8527 8528 8529 8530 8531 8532
    return ret;
}


/*
 * "pool-uuid" command
 */
8533
static const vshCmdInfo info_pool_uuid[] = {
8534
    {"help", N_("convert a pool name to pool UUID")},
8535
    {"desc", ""},
8536 8537 8538
    {NULL, NULL}
};

8539
static const vshCmdOptDef opts_pool_uuid[] = {
8540
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
8541 8542 8543
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8544
static bool
8545
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
8546 8547 8548 8549
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

8550
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8551
        return false;
8552 8553

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8554
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8555
        return false;
8556 8557 8558 8559

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

L
Laine Stump 已提交
8562
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8563
    return true;
8564 8565 8566 8567 8568 8569
}


/*
 * "vol-create" command
 */
8570
static const vshCmdInfo info_vol_create[] = {
8571 8572
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
8573 8574 8575
    {NULL, NULL}
};

8576
static const vshCmdOptDef opts_vol_create[] = {
8577 8578
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
8579 8580 8581
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8582
static bool
8583
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
8584 8585 8586
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8587
    const char *from = NULL;
E
Eric Blake 已提交
8588
    bool ret = true;
8589 8590
    char *buffer;

8591
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8592
        return false;
8593 8594

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

8598
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8599
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8600
        return false;
8601 8602 8603
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8604
        virshReportError(ctl);
8605
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8606
        return false;
8607 8608 8609
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
8610
    VIR_FREE(buffer);
8611 8612 8613 8614 8615 8616 8617
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
8618
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
8619
        ret = false;
8620 8621 8622 8623
    }
    return ret;
}

8624 8625 8626 8627
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
8628 8629
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
8630 8631 8632 8633
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
8634 8635 8636
    {"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 已提交
8637
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
8638 8639 8640
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8641
static bool
8642 8643 8644 8645
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
8646
    const char *from = NULL;
E
Eric Blake 已提交
8647
    bool ret = false;
8648 8649
    char *buffer = NULL;

8650
    if (!vshConnectionUsability(ctl, ctl->conn))
8651 8652 8653 8654 8655
        goto cleanup;

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

8656
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8657 8658 8659 8660 8661 8662 8663
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8664
        virshReportError(ctl);
8665 8666 8667 8668 8669 8670 8671 8672 8673
        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 {
8674
        vshError(ctl, _("Failed to create vol from %s"), from);
8675 8676 8677
        goto cleanup;
    }

E
Eric Blake 已提交
8678
    ret = true;
8679
cleanup:
8680
    VIR_FREE(buffer);
8681 8682 8683 8684
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
8685 8686
    if (newvol)
        virStorageVolFree(newvol);
8687 8688 8689 8690
    return ret;
}

static xmlChar *
8691
makeCloneXML(const char *origxml, const char *newname) {
8692

8693 8694 8695
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
8696 8697 8698
    xmlChar *newxml = NULL;
    int size;

8699
    doc = virXMLParseStringCtxt(origxml, "domain.xml", &ctxt);
8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721
    if (!doc)
        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[] = {
8722 8723
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
8724 8725 8726 8727
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
8728 8729
    {"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 已提交
8730
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8731 8732 8733
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8734
static bool
8735 8736 8737 8738
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
8739
    const char *name = NULL;
8740
    char *origxml = NULL;
8741
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
8742
    bool ret = false;
8743

8744
    if (!vshConnectionUsability(ctl, ctl->conn))
8745 8746 8747 8748 8749 8750 8751
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
8752
        vshError(ctl, "%s", _("failed to get parent pool"));
8753 8754 8755
        goto cleanup;
    }

8756
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774
        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 {
8775
        vshError(ctl, _("Failed to clone vol from %s"),
8776 8777 8778 8779
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
8780
    ret = true;
8781 8782

cleanup:
8783
    VIR_FREE(origxml);
8784 8785 8786
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
8787 8788
    if (newvol)
        virStorageVolFree(newvol);
8789 8790 8791 8792 8793
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806

/*
 * "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 已提交
8807
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821
    {"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 已提交
8822
static bool
8823 8824 8825 8826
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8827
    bool ret = false;
8828 8829 8830 8831 8832 8833 8834 8835 8836 8837
    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 已提交
8838
        return false;
8839 8840 8841 8842
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8843
        return false;
8844 8845 8846
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8847
        return false;
8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881
    }

    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 已提交
8882
    ret = true;
8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906

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 已提交
8907
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8908 8909 8910 8911 8912
    {"offset", VSH_OT_INT, 0, N_("volume offset to download from") },
    {"length", VSH_OT_INT, 0, N_("amount of data to download") },
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8913
static bool
8914 8915 8916 8917
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8918
    bool ret = false;
8919 8920 8921 8922
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
8923
    bool created = false;
8924 8925

    if (!vshConnectionUsability(ctl, ctl->conn))
8926
        return false;
8927 8928 8929

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8930
        return false;
8931 8932 8933 8934
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8935
        return false;
8936 8937 8938
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
8939
        return false;
8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951

    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;
        }
8952 8953
    } else {
        created = true;
8954 8955 8956 8957 8958 8959 8960 8961
    }

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

8962
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977
        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 已提交
8978
    ret = true;
8979 8980

cleanup:
8981
    VIR_FORCE_CLOSE(fd);
8982
    if (!ret && created)
8983 8984 8985 8986 8987 8988 8989 8990 8991
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


8992 8993 8994
/*
 * "vol-delete" command
 */
8995
static const vshCmdInfo info_vol_delete[] = {
8996 8997
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
8998 8999 9000
    {NULL, NULL}
};

9001
static const vshCmdOptDef opts_vol_delete[] = {
9002
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9003
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9004 9005 9006
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9007
static bool
9008
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
9009 9010
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9011
    bool ret = true;
9012
    const char *name;
9013

9014
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9015
        return false;
9016 9017

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9018
        return false;
9019 9020 9021
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
9022
        vshPrint(ctl, _("Vol %s deleted\n"), name);
9023
    } else {
9024
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
9025
        ret = false;
9026 9027
    }

L
Laine Stump 已提交
9028
    virStorageVolFree(vol);
9029 9030 9031 9032
    return ret;
}


D
David Allan 已提交
9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043
/*
 * "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 已提交
9044
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
9045 9046 9047
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9048
static bool
D
David Allan 已提交
9049 9050 9051
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9052
    bool ret = true;
9053
    const char *name;
D
David Allan 已提交
9054

9055
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9056
        return false;
D
David Allan 已提交
9057 9058

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9059
        return false;
D
David Allan 已提交
9060 9061 9062 9063 9064 9065
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
9066
        ret = false;
D
David Allan 已提交
9067 9068 9069 9070 9071 9072 9073
    }

    virStorageVolFree(vol);
    return ret;
}


9074 9075 9076
/*
 * "vol-info" command
 */
9077
static const vshCmdInfo info_vol_info[] = {
9078 9079
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
9080 9081 9082
    {NULL, NULL}
};

9083
static const vshCmdOptDef opts_vol_info[] = {
9084
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9085
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9086 9087 9088
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9089
static bool
9090
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
9091 9092 9093
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
9094
    bool ret = true;
9095

9096
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9097
        return false;
9098 9099

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9100
        return false;
9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116

    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 已提交
9117
        ret = false;
9118 9119 9120 9121 9122 9123 9124 9125 9126 9127
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
9128
static const vshCmdInfo info_vol_dumpxml[] = {
9129 9130
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
9131 9132 9133
    {NULL, NULL}
};

9134
static const vshCmdOptDef opts_vol_dumpxml[] = {
9135
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9136
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9137 9138 9139
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9140
static bool
9141
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
9142 9143
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9144
    bool ret = true;
9145 9146
    char *dump;

9147
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9148
        return false;
9149 9150

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9151
        return false;
9152 9153 9154

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
9155
        vshPrint(ctl, "%s", dump);
9156
        VIR_FREE(dump);
9157
    } else {
E
Eric Blake 已提交
9158
        ret = false;
9159 9160 9161 9162 9163 9164 9165 9166 9167 9168
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
9169
static const vshCmdInfo info_vol_list[] = {
9170 9171
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
9172 9173 9174
    {NULL, NULL}
};

9175
static const vshCmdOptDef opts_vol_list[] = {
9176
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9177
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
9178 9179 9180
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9181
static bool
9182
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9183
{
9184
    virStorageVolInfo volumeInfo;
9185 9186
    virStoragePoolPtr pool;
    char **activeNames = NULL;
9187 9188 9189 9190 9191
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
9192 9193
    int ret;
    bool functionReturn;
9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204
    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;
9205

9206
    /* Check the connection to libvirtd daemon is still working */
9207
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9208
        return false;
9209

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

9214 9215
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
9216

9217 9218 9219
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9220
        return false;
9221 9222
    }

9223 9224 9225 9226 9227
    /* 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) {
9228
            vshError(ctl, "%s", _("Failed to list active vols"));
9229
            VIR_FREE(activeNames);
9230
            virStoragePoolFree(pool);
E
Eric Blake 已提交
9231
            return false;
9232 9233
        }

9234 9235 9236 9237 9238
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

9241 9242 9243 9244 9245
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
9246

9247 9248 9249 9250
        /* 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"));
9251 9252
        }

9253 9254 9255 9256 9257 9258 9259 9260 9261
        /* 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 */
9262

9263
                /* Volume type */
9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276
                switch (volumeInfo.type) {
                        case VIR_STORAGE_VOL_FILE:
                            volInfoTexts[i].type = vshStrdup(ctl, _("file"));
                            break;
                        case VIR_STORAGE_VOL_BLOCK:
                            volInfoTexts[i].type = vshStrdup(ctl, _("block"));
                            break;
                        case VIR_STORAGE_VOL_DIR:
                            volInfoTexts[i].type = vshStrdup(ctl, _("dir"));
                            break;
                        default:
                            volInfoTexts[i].type = vshStrdup(ctl, _("unknown"));
                }
9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326

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

9328
        /* Cleanup memory allocation */
9329
        virStorageVolFree(vol);
9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347
    }

    /* 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 已提交
9348
        functionReturn = true;
9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379
        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 */
9380 9381 9382 9383 9384 9385 9386 9387 9388 9389
    vshDebug(ctl, VSH_ERR_DEBUG,
             "Longest name string = %zu chars\n", nameStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG,
             "Longest path string = %zu chars\n", pathStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG,
             "Longest type string = %zu chars\n", typeStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG,
             "Longest capacity string = %zu chars\n", capStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG,
             "Longest allocation string = %zu chars\n", allocStrLength);
9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423

    /* 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 已提交
9424
    functionReturn = true;
9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438
    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 已提交
9439
    functionReturn = false;
9440 9441 9442 9443 9444 9445 9446 9447 9448 9449

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);
9450
        VIR_FREE(activeNames[i]);
9451
    }
9452 9453 9454 9455

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
9456
    VIR_FREE(activeNames);
9457
    virStoragePoolFree(pool);
9458 9459 9460

    /* Return the desired value */
    return functionReturn;
9461 9462 9463 9464 9465 9466
}


/*
 * "vol-name" command
 */
9467
static const vshCmdInfo info_vol_name[] = {
9468
    {"help", N_("returns the volume name for a given volume key or path")},
9469
    {"desc", ""},
9470 9471 9472
    {NULL, NULL}
};

9473
static const vshCmdOptDef opts_vol_name[] = {
9474
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
9475 9476 9477
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9478
static bool
9479
cmdVolName(vshControl *ctl, const vshCmd *cmd)
9480 9481 9482
{
    virStorageVolPtr vol;

9483
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9484
        return false;
9485

9486
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
9487
                                   VSH_BYUUID)))
E
Eric Blake 已提交
9488
        return false;
9489 9490 9491

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9492
    return true;
9493 9494 9495
}


J
Justin Clift 已提交
9496 9497 9498 9499 9500 9501 9502 9503 9504 9505
/*
 * "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[] = {
9506
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
9507 9508 9509 9510
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9511
static bool
J
Justin Clift 已提交
9512 9513 9514 9515
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9516
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
9517 9518

    /* Check the connection to libvirtd daemon is still working */
9519
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9520
        return false;
J
Justin Clift 已提交
9521 9522

    /* Use the supplied string to locate the volume */
9523
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
9524
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
9525
        return false;
J
Justin Clift 已提交
9526 9527 9528 9529 9530 9531 9532
    }

    /* 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 已提交
9533
        return false;
J
Justin Clift 已提交
9534 9535
    }

9536 9537 9538 9539 9540 9541 9542 9543 9544
    /* 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 已提交
9545 9546 9547 9548

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9549
    return true;
J
Justin Clift 已提交
9550 9551
}

9552 9553 9554 9555

/*
 * "vol-key" command
 */
9556
static const vshCmdInfo info_vol_key[] = {
9557
    {"help", N_("returns the volume key for a given volume name or path")},
9558
    {"desc", ""},
9559 9560 9561
    {NULL, NULL}
};

9562
static const vshCmdOptDef opts_vol_key[] = {
9563
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
9564
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9565 9566 9567
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9568
static bool
9569
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
9570 9571 9572
{
    virStorageVolPtr vol;

9573
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9574
        return false;
9575

9576
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9577
        return false;
9578 9579 9580

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9581
    return true;
9582 9583 9584 9585 9586 9587 9588
}



/*
 * "vol-path" command
 */
9589
static const vshCmdInfo info_vol_path[] = {
9590
    {"help", N_("returns the volume path for a given volume name or key")},
9591
    {"desc", ""},
9592 9593 9594
    {NULL, NULL}
};

9595
static const vshCmdOptDef opts_vol_path[] = {
9596
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
9597
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9598 9599 9600
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9601
static bool
9602
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
9603 9604
{
    virStorageVolPtr vol;
9605
    const char *name = NULL;
9606
    char * StorageVolPath;
9607

9608
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9609
        return false;
9610 9611

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9612
        return false;
9613
    }
9614

9615 9616 9617 9618 9619 9620 9621
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
9622
    virStorageVolFree(vol);
E
Eric Blake 已提交
9623
    return true;
9624 9625 9626
}


9627 9628 9629 9630
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
9631 9632
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
9633 9634
    {NULL, NULL}
};
9635

9636
static const vshCmdOptDef opts_secret_define[] = {
9637
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
9638 9639
    {NULL, 0, 0, NULL}
};
9640

E
Eric Blake 已提交
9641
static bool
9642 9643
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
9644
    const char *from = NULL;
9645
    char *buffer;
9646
    virSecretPtr res;
9647
    char uuid[VIR_UUID_STRING_BUFLEN];
9648

9649
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9650
        return false;
9651

9652
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9653
        return false;
9654 9655

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
9659
    VIR_FREE(buffer);
9660 9661

    if (res == NULL) {
9662
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
9663
        return false;
9664
    }
9665
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
9666
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
9667
        virSecretFree(res);
E
Eric Blake 已提交
9668
        return false;
9669 9670 9671
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
9672
    return true;
9673 9674 9675 9676 9677 9678
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
9679 9680
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
9681 9682 9683 9684
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
9685
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9686 9687 9688
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9689
static bool
9690 9691 9692
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9693
    bool ret = false;
9694 9695
    char *xml;

9696
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9697
        return false;
9698 9699 9700

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9701
        return false;
9702 9703 9704 9705

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
9706
    vshPrint(ctl, "%s", xml);
9707
    VIR_FREE(xml);
E
Eric Blake 已提交
9708
    ret = true;
9709 9710 9711 9712 9713 9714 9715 9716 9717 9718

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
9719 9720
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
9721 9722 9723 9724
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
9725 9726
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
9727 9728 9729
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9730
static bool
9731 9732 9733 9734
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
9735
    const char *base64 = NULL;
9736
    char *value;
E
Eric Blake 已提交
9737 9738
    int res;
    bool ret = false;
9739

9740
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9741
        return false;
9742 9743 9744

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

9747
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
9748 9749 9750
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
9751
        vshError(ctl, "%s", _("Invalid base64 data"));
9752 9753 9754
        goto cleanup;
    }
    if (value == NULL) {
9755
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
9756
        return false;
9757 9758 9759 9760
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
9761
    VIR_FREE(value);
9762 9763

    if (res != 0) {
9764
        vshError(ctl, "%s", _("Failed to set secret value"));
9765 9766 9767
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
9768
    ret = true;
9769 9770 9771 9772 9773 9774 9775 9776 9777 9778

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
9779 9780
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
9781 9782 9783 9784
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
9785
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9786 9787 9788
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9789
static bool
9790 9791 9792 9793 9794 9795
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
9796
    bool ret = false;
9797

9798
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9799
        return false;
9800 9801 9802

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9803
        return false;
9804 9805 9806 9807 9808 9809 9810

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
9811
    VIR_FREE(value);
9812 9813

    if (base64 == NULL) {
9814
        vshError(ctl, "%s", _("Failed to allocate memory"));
9815 9816
        goto cleanup;
    }
9817
    vshPrint(ctl, "%s", base64);
9818
    memset(base64, 0, strlen(base64));
9819
    VIR_FREE(base64);
E
Eric Blake 已提交
9820
    ret = true;
9821 9822 9823 9824 9825 9826 9827 9828 9829 9830

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
9831 9832
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
9833 9834 9835 9836
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
9837
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9838 9839 9840
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9841
static bool
9842 9843 9844
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9845
    bool ret = false;
9846
    const char *uuid;
9847

9848
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9849
        return false;
9850 9851 9852

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
9853
        return false;
9854 9855

    if (virSecretUndefine(secret) < 0) {
9856
        vshError(ctl, _("Failed to delete secret %s"), uuid);
9857 9858 9859
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
9860
    ret = true;
9861 9862 9863 9864 9865 9866 9867 9868 9869 9870

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
9871 9872
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
9873 9874 9875
    {NULL, NULL}
};

E
Eric Blake 已提交
9876
static bool
9877 9878 9879 9880 9881
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

9882
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9883
        return false;
9884 9885 9886

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
9887
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
9888
        return false;
9889 9890 9891 9892 9893
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
9894
        vshError(ctl, "%s", _("Failed to list secrets"));
9895
        VIR_FREE(uuids);
E
Eric Blake 已提交
9896
        return false;
9897 9898 9899 9900
    }

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

9901 9902
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
9903 9904

    for (i = 0; i < maxuuids; i++) {
9905 9906 9907 9908
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
9909
            VIR_FREE(uuids[i]);
9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927
            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);
9928
        VIR_FREE(uuids[i]);
9929
    }
9930
    VIR_FREE(uuids);
E
Eric Blake 已提交
9931
    return true;
9932
}
9933 9934 9935 9936 9937


/*
 * "version" command
 */
9938
static const vshCmdInfo info_version[] = {
9939 9940
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
9941 9942 9943
    {NULL, NULL}
};

9944 9945 9946 9947
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
9948

E
Eric Blake 已提交
9949
static bool
9950
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9951 9952 9953 9954 9955 9956
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
9957
    unsigned long daemonVersion;
9958 9959 9960 9961 9962
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

9963
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9964
        return false;
9965 9966 9967

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
9968
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
9969
        return false;
9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981
    }

    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) {
9982
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
9983
        return false;
9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000
    }
    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) {
10001
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
10002
        return false;
10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015
    }
    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);
    }
10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030

    if (vshCommandOptBool(cmd, "daemon")) {
        ret = virConnectGetLibVersion(ctl->conn, &daemonVersion);
        if (ret < 0) {
            vshError(ctl, "%s", _("failed to get the daemon version"));
        } else {
            major = daemonVersion / 1000000;
            daemonVersion %= 1000000;
            minor = daemonVersion / 1000;
            rel = daemonVersion % 1000;
            vshPrint(ctl, _("Running against daemon: %d.%d.%d\n"),
                     major, minor, rel);
        }
    }

E
Eric Blake 已提交
10031
    return true;
10032 10033
}

10034 10035 10036 10037
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
10038
    {"help", N_("enumerate devices on this host")},
10039
    {"desc", ""},
10040 10041 10042 10043
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
10044 10045
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
10046 10047 10048
    {NULL, 0, 0, NULL}
};

10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070
#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] = '-';
10071 10072
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
10073 10074 10075
    }

    /* Print this device */
10076
    vshPrint(ctl, "%s", indentBuf);
10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099
    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) {
10100
        vshPrint(ctl, "%s", indentBuf);
10101
        vshPrint(ctl, " |\n");
10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123
    }

    /* 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) {
10124
        vshPrint(ctl, "%s", indentBuf);
10125 10126 10127 10128
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
10129
static bool
10130 10131
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
10132
    const char *cap = NULL;
10133
    char **devices;
10134
    int num_devices, i;
10135
    int tree = vshCommandOptBool(cmd, "tree");
10136

10137
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10138
        return false;
10139

10140
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
10141 10142 10143 10144
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
10145
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
10146
        return false;
10147
    } else if (num_devices == 0) {
E
Eric Blake 已提交
10148
        return true;
10149 10150 10151 10152 10153 10154
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
10155
        vshError(ctl, "%s", _("Failed to list node devices"));
10156
        VIR_FREE(devices);
E
Eric Blake 已提交
10157
        return false;
10158
    }
10159
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
10160 10161 10162 10163 10164 10165 10166
    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 已提交
10167
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186
            } 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++) {
10187 10188
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
10189
        }
10190
        VIR_FREE(parents);
10191 10192 10193
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
10194
            VIR_FREE(devices[i]);
10195
        }
10196
    }
10197
    VIR_FREE(devices);
E
Eric Blake 已提交
10198
    return true;
10199 10200 10201 10202 10203 10204
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
10205 10206
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
10207 10208 10209 10210 10211
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
10212
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10213 10214 10215
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10216
static bool
10217 10218
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
10219
    const char *name = NULL;
10220
    virNodeDevicePtr device;
L
Laine Stump 已提交
10221
    char *xml;
10222

10223
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10224
        return false;
10225
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10226
        return false;
10227
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10228
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10229
        return false;
10230 10231
    }

L
Laine Stump 已提交
10232 10233 10234
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
10235
        return false;
L
Laine Stump 已提交
10236 10237 10238
    }

    vshPrint(ctl, "%s\n", xml);
10239
    VIR_FREE(xml);
10240
    virNodeDeviceFree(device);
E
Eric Blake 已提交
10241
    return true;
10242 10243
}

10244 10245 10246 10247
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
10248 10249
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
10250 10251 10252 10253 10254
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
10255
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10256 10257 10258
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10259
static bool
10260 10261
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
10262
    const char *name = NULL;
10263
    virNodeDevicePtr device;
E
Eric Blake 已提交
10264
    bool ret = true;
10265

10266
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10267
        return false;
10268
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10269
        return false;
10270
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10271
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10272
        return false;
10273 10274 10275 10276 10277
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
10278
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
10279
        ret = false;
10280 10281 10282 10283 10284 10285 10286 10287 10288
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
10289 10290
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
10291 10292 10293 10294 10295
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
10296
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10297 10298 10299
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10300
static bool
10301 10302
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
10303
    const char *name = NULL;
10304
    virNodeDevicePtr device;
E
Eric Blake 已提交
10305
    bool ret = true;
10306

10307
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10308
        return false;
10309
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10310
        return false;
10311
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10312
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10313
        return false;
10314 10315 10316 10317 10318
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
10319
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
10320
        ret = false;
10321 10322 10323 10324 10325 10326 10327 10328 10329
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
10330 10331
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
10332 10333 10334 10335 10336
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
10337
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10338 10339 10340
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10341
static bool
10342 10343
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
10344
    const char *name = NULL;
10345
    virNodeDevicePtr device;
E
Eric Blake 已提交
10346
    bool ret = true;
10347

10348
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10349
        return false;
10350
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10351
        return false;
10352
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10353
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10354
        return false;
10355 10356 10357 10358 10359
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
10360
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
10361
        ret = false;
10362 10363 10364 10365 10366
    }
    virNodeDeviceFree(device);
    return ret;
}

10367
/*
E
Eric Blake 已提交
10368
 * "hostname" command
10369
 */
10370
static const vshCmdInfo info_hostname[] = {
10371
    {"help", N_("print the hypervisor hostname")},
10372
    {"desc", ""},
10373 10374 10375
    {NULL, NULL}
};

E
Eric Blake 已提交
10376
static bool
10377
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10378 10379 10380
{
    char *hostname;

10381
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10382
        return false;
10383 10384 10385

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
10386
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
10387
        return false;
10388 10389 10390
    }

    vshPrint (ctl, "%s\n", hostname);
10391
    VIR_FREE(hostname);
10392

E
Eric Blake 已提交
10393
    return true;
10394 10395 10396 10397 10398
}

/*
 * "uri" command
 */
10399
static const vshCmdInfo info_uri[] = {
10400
    {"help", N_("print the hypervisor canonical URI")},
10401
    {"desc", ""},
10402 10403 10404
    {NULL, NULL}
};

E
Eric Blake 已提交
10405
static bool
10406
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10407 10408 10409
{
    char *uri;

10410
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10411
        return false;
10412 10413 10414

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
10415
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
10416
        return false;
10417 10418 10419
    }

    vshPrint (ctl, "%s\n", uri);
10420
    VIR_FREE(uri);
10421

E
Eric Blake 已提交
10422
    return true;
10423 10424
}

E
Eric Blake 已提交
10425 10426 10427 10428 10429 10430 10431 10432 10433 10434
/*
 * "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 已提交
10435
static bool
E
Eric Blake 已提交
10436 10437 10438 10439 10440
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10441
        return false;
E
Eric Blake 已提交
10442 10443 10444 10445

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
10446
        return false;
E
Eric Blake 已提交
10447 10448 10449 10450 10451
    }

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

E
Eric Blake 已提交
10452
    return true;
E
Eric Blake 已提交
10453 10454
}

10455 10456 10457
/*
 * "vncdisplay" command
 */
10458
static const vshCmdInfo info_vncdisplay[] = {
10459 10460
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
10461 10462 10463
    {NULL, NULL}
};

10464
static const vshCmdOptDef opts_vncdisplay[] = {
10465
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10466 10467 10468
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10469
static bool
10470
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
10471 10472 10473 10474 10475
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10476
    bool ret = false;
10477 10478 10479
    int port = 0;
    char *doc;

10480
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10481
        return false;
10482

J
Jim Meyering 已提交
10483
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10484
        return false;
10485 10486 10487 10488 10489

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10490
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10491
    VIR_FREE(doc);
10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506
    if (!xml)
        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) ||
10507
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
10508 10509 10510 10511 10512 10513
        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 已提交
10514
    ret = true;
10515 10516 10517 10518

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10519
    xmlFreeDoc(xml);
10520 10521 10522 10523 10524 10525 10526
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
10527
static const vshCmdInfo info_ttyconsole[] = {
10528 10529
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
10530 10531 10532
    {NULL, NULL}
};

10533
static const vshCmdOptDef opts_ttyconsole[] = {
10534
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10535 10536 10537
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10538
static bool
10539
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
10540 10541 10542 10543 10544
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10545
    bool ret = false;
10546 10547
    char *doc;

10548
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10549
        return false;
10550

J
Jim Meyering 已提交
10551
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10552
        return false;
10553 10554 10555 10556 10557

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10558
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10559
    VIR_FREE(doc);
10560 10561 10562 10563 10564 10565 10566 10567 10568
    if (!xml)
        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 已提交
10569
    ret = true;
10570 10571 10572 10573

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10574
    xmlFreeDoc(xml);
10575 10576 10577 10578 10579 10580
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
10581
 */
10582
static const vshCmdInfo info_attach_device[] = {
10583 10584
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
10585 10586 10587
    {NULL, NULL}
};

10588
static const vshCmdOptDef opts_attach_device[] = {
10589 10590 10591
    {"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")},
10592 10593 10594
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10595
static bool
10596
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
10597 10598
{
    virDomainPtr dom;
10599
    const char *from = NULL;
10600
    char *buffer;
W
Wen Congyang 已提交
10601
    int ret;
J
Jim Fehlig 已提交
10602
    unsigned int flags;
10603

10604
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10605
        return false;
10606

J
Jim Meyering 已提交
10607
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10608
        return false;
10609

10610
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10611
        virDomainFree(dom);
E
Eric Blake 已提交
10612
        return false;
10613 10614
    }

10615
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10616
        virshReportError(ctl);
10617
        virDomainFree(dom);
E
Eric Blake 已提交
10618
        return false;
10619
    }
10620

J
Jim Fehlig 已提交
10621
    if (vshCommandOptBool(cmd, "persistent")) {
10622
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10623
        if (virDomainIsActive(dom) == 1)
10624
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10625 10626 10627 10628
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
10629
    VIR_FREE(buffer);
10630 10631

    if (ret < 0) {
10632
        vshError(ctl, _("Failed to attach device from %s"), from);
10633
        virDomainFree(dom);
E
Eric Blake 已提交
10634
        return false;
10635
    } else {
J
Jim Meyering 已提交
10636
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
10637 10638 10639
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10640
    return true;
10641 10642 10643 10644 10645 10646
}


/*
 * "detach-device" command
 */
10647
static const vshCmdInfo info_detach_device[] = {
10648 10649
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
10650 10651 10652
    {NULL, NULL}
};

10653
static const vshCmdOptDef opts_detach_device[] = {
10654 10655 10656
    {"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")},
10657 10658 10659
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10660
static bool
10661
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
10662 10663
{
    virDomainPtr dom;
10664
    const char *from = NULL;
10665
    char *buffer;
W
Wen Congyang 已提交
10666
    int ret;
J
Jim Fehlig 已提交
10667
    unsigned int flags;
10668

10669
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10670
        return false;
10671

J
Jim Meyering 已提交
10672
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10673
        return false;
10674

10675
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10676
        virDomainFree(dom);
E
Eric Blake 已提交
10677
        return false;
10678 10679
    }

10680
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10681
        virshReportError(ctl);
10682
        virDomainFree(dom);
E
Eric Blake 已提交
10683
        return false;
10684
    }
10685

J
Jim Fehlig 已提交
10686
    if (vshCommandOptBool(cmd, "persistent")) {
10687
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10688
        if (virDomainIsActive(dom) == 1)
10689
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10690 10691 10692 10693
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
10694
    VIR_FREE(buffer);
10695 10696

    if (ret < 0) {
10697
        vshError(ctl, _("Failed to detach device from %s"), from);
10698
        virDomainFree(dom);
E
Eric Blake 已提交
10699
        return false;
10700
    } else {
J
Jim Meyering 已提交
10701
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
10702 10703 10704
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10705
    return true;
10706 10707
}

10708

10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721
/*
 * "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")},
10722
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
10723 10724 10725
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10726
static bool
10727 10728 10729
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
10730
    const char *from = NULL;
10731
    char *buffer;
W
Wen Congyang 已提交
10732
    int ret;
10733 10734
    unsigned int flags;

10735
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10736
        return false;
10737 10738

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

10741
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10742
        virDomainFree(dom);
E
Eric Blake 已提交
10743
        return false;
10744 10745 10746
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10747
        virshReportError(ctl);
10748
        virDomainFree(dom);
E
Eric Blake 已提交
10749
        return false;
10750 10751 10752
    }

    if (vshCommandOptBool(cmd, "persistent")) {
10753
        flags = VIR_DOMAIN_AFFECT_CONFIG;
10754
        if (virDomainIsActive(dom) == 1)
10755
           flags |= VIR_DOMAIN_AFFECT_LIVE;
10756
    } else {
10757
        flags = VIR_DOMAIN_AFFECT_LIVE;
10758
    }
10759 10760 10761 10762

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

10763 10764 10765 10766 10767 10768
    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 已提交
10769
        return false;
10770 10771 10772 10773 10774
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10775
    return true;
10776 10777 10778
}


10779 10780 10781
/*
 * "attach-interface" command
 */
10782
static const vshCmdInfo info_attach_interface[] = {
10783 10784
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
10785 10786 10787
    {NULL, NULL}
};

10788
static const vshCmdOptDef opts_attach_interface[] = {
10789 10790 10791 10792 10793 10794
    {"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")},
10795
    {"model", VSH_OT_DATA, 0, N_("model type")},
10796
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
10797 10798 10799
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10800
static bool
10801
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
10802 10803
{
    virDomainPtr dom = NULL;
10804 10805
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
10806
    int typ;
W
Wen Congyang 已提交
10807 10808
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
10809
    unsigned int flags;
10810 10811
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10812

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

J
Jim Meyering 已提交
10816
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10817 10818
        goto cleanup;

10819
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10820 10821
        goto cleanup;

10822 10823 10824 10825
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
10826 10827
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
10828
        goto cleanup;
10829
    }
10830 10831

    /* check interface type */
10832
    if (STREQ(type, "network")) {
10833
        typ = 1;
10834
    } else if (STREQ(type, "bridge")) {
10835 10836
        typ = 2;
    } else {
E
Eric Blake 已提交
10837 10838
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
10839 10840 10841 10842
        goto cleanup;
    }

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

10845
    if (typ == 1)
10846
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
10847
    else if (typ == 2)
10848
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
10849

10850
    if (target != NULL)
10851
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10852
    if (mac != NULL)
10853
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
10854
    if (script != NULL)
10855
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
10856
    if (model != NULL)
10857
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
10858

10859
    virBufferAddLit(&buf, "</interface>\n");
10860

10861 10862
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
10863
        goto cleanup;
10864 10865
    }

10866
    xml = virBufferContentAndReset(&buf);
10867

J
Jim Fehlig 已提交
10868
    if (vshCommandOptBool(cmd, "persistent")) {
10869
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10870
        if (virDomainIsActive(dom) == 1)
10871
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10872
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
10873
    } else {
10874
        ret = virDomainAttachDevice(dom, xml);
10875
    }
10876

10877 10878
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10879
    if (ret != 0) {
L
Laine Stump 已提交
10880
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
10881 10882
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
10883
        functionReturn = true;
J
Jim Fehlig 已提交
10884
    }
10885 10886 10887 10888

 cleanup:
    if (dom)
        virDomainFree(dom);
10889
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10890
    return functionReturn;
10891 10892 10893 10894 10895
}

/*
 * "detach-interface" command
 */
10896
static const vshCmdInfo info_detach_interface[] = {
10897 10898
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
10899 10900 10901
    {NULL, NULL}
};

10902
static const vshCmdOptDef opts_detach_interface[] = {
10903 10904 10905 10906
    {"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")},
10907 10908 10909
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10910
static bool
10911
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
10912 10913 10914 10915 10916 10917 10918
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
10919
    const char *mac =NULL, *type = NULL;
10920
    char *doc;
10921
    char buf[64];
E
Eric Blake 已提交
10922
    int i = 0, diff_mac;
W
Wen Congyang 已提交
10923 10924
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
10925
    unsigned int flags;
10926

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

J
Jim Meyering 已提交
10930
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10931 10932
        goto cleanup;

10933
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10934 10935
        goto cleanup;

10936 10937
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
10938
        goto cleanup;
10939
    }
10940 10941 10942 10943 10944

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10945
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10946
    VIR_FREE(doc);
10947
    if (!xml) {
10948
        vshError(ctl, "%s", _("Failed to get interface information"));
10949 10950 10951
        goto cleanup;
    }

E
Eric Blake 已提交
10952
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
10953 10954 10955
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10956
        vshError(ctl, _("No found interface whose type is %s"), type);
10957 10958 10959
        goto cleanup;
    }

10960 10961 10962 10963 10964 10965
    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;
    }

10966 10967 10968 10969 10970 10971 10972
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10973 10974 10975 10976 10977
            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);
10978 10979 10980 10981 10982 10983 10984
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10985
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
10986 10987 10988 10989 10990
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10991
        vshError(ctl, "%s", _("Failed to allocate memory"));
10992 10993 10994
        goto cleanup;
    }

10995
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
10996
        vshError(ctl, "%s", _("Failed to create XML"));
10997 10998 10999
        goto cleanup;
    }

J
Jim Fehlig 已提交
11000
    if (vshCommandOptBool(cmd, "persistent")) {
11001
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11002
        if (virDomainIsActive(dom) == 1)
11003
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11004 11005 11006 11007 11008 11009 11010 11011
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11012
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
11013
    } else {
J
Jim Meyering 已提交
11014
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
11015
        functionReturn = true;
11016
    }
11017 11018 11019 11020

 cleanup:
    if (dom)
        virDomainFree(dom);
11021
    xmlXPathFreeObject(obj);
11022
    xmlXPathFreeContext(ctxt);
11023 11024
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
11025
    return functionReturn;
11026 11027 11028 11029 11030
}

/*
 * "attach-disk" command
 */
11031
static const vshCmdInfo info_attach_disk[] = {
11032 11033
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
11034 11035 11036
    {NULL, NULL}
};

11037
static const vshCmdOptDef opts_attach_disk[] = {
11038 11039 11040 11041 11042
    {"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")},
11043
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
11044 11045 11046
    {"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")},
11047
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
11048 11049 11050
    {"serial", VSH_OT_STRING, 0, N_("serial of disk device")},
    {"shareable", VSH_OT_BOOL, 0, N_("shareable between domains")},
    {"address", VSH_OT_STRING, 0, N_("address of disk device")},
11051 11052 11053
    {NULL, 0, 0, NULL}
};

11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200
enum {
    DISK_ADDR_TYPE_INVALID,
    DISK_ADDR_TYPE_PCI,
    DISK_ADDR_TYPE_SCSI,
    DISK_ADDR_TYPE_IDE,
};

struct PCIAddress {
    unsigned int domain;
    unsigned int bus;
    unsigned int slot;
    unsigned int function;
};

struct SCSIAddress {
    unsigned int controller;
    unsigned int bus;
    unsigned int unit;
};

struct IDEAddress {
    unsigned int controller;
    unsigned int bus;
    unsigned int unit;
};

struct DiskAddress {
    int type;
    union {
        struct PCIAddress pci;
        struct SCSIAddress scsi;
        struct IDEAddress ide;
    } addr;
};

static int str2PCIAddress(const char *str, struct PCIAddress *pciAddr)
{
    char *domain, *bus, *slot, *function;

    if (!pciAddr)
        return -1;
    if (!str)
        return -1;

    domain = (char *)str;

    if (virStrToLong_ui(domain, &bus, 0, &pciAddr->domain) != 0)
        return -1;

    bus++;
    if (virStrToLong_ui(bus, &slot, 0, &pciAddr->bus) != 0)
        return -1;

    slot++;
    if (virStrToLong_ui(slot, &function, 0, &pciAddr->slot) != 0)
        return -1;

    function++;
    if (virStrToLong_ui(function, NULL, 0, &pciAddr->function) != 0)
        return -1;

    return 0;
}

static int str2SCSIAddress(const char *str, struct SCSIAddress *scsiAddr)
{
    char *controller, *bus, *unit;

    if (!scsiAddr)
        return -1;
    if (!str)
        return -1;

    controller = (char *)str;

    if (virStrToLong_ui(controller, &bus, 0, &scsiAddr->controller) != 0)
        return -1;

    bus++;
    if (virStrToLong_ui(bus, &unit, 0, &scsiAddr->bus) != 0)
        return -1;

    unit++;
    if (virStrToLong_ui(unit, NULL, 0, &scsiAddr->unit) != 0)
        return -1;

    return 0;
}

static int str2IDEAddress(const char *str, struct IDEAddress *ideAddr)
{
    char *controller, *bus, *unit;

    if (!ideAddr)
        return -1;
    if (!str)
        return -1;

    controller = (char *)str;

    if (virStrToLong_ui(controller, &bus, 0, &ideAddr->controller) != 0)
        return -1;

    bus++;
    if (virStrToLong_ui(bus, &unit, 0, &ideAddr->bus) != 0)
        return -1;

    unit++;
    if (virStrToLong_ui(unit, NULL, 0, &ideAddr->unit) != 0)
        return -1;

    return 0;
}

/* pci address pci:0000.00.0x0a.0 (domain:bus:slot:function)
 * ide disk address: ide:00.00.0 (controller:bus:unit)
 * scsi disk address: scsi:00.00.0 (controller:bus:unit)
 */

static int str2DiskAddress(const char *str, struct DiskAddress *diskAddr)
{
    char *type, *addr;

    if (!diskAddr)
        return -1;
    if (!str)
        return -1;

    type = (char *)str;
    addr = strchr(type, ':');
    if (!addr)
        return -1;

    if (STREQLEN(type, "pci", addr - type)) {
        diskAddr->type = DISK_ADDR_TYPE_PCI;
        return str2PCIAddress(addr + 1, &diskAddr->addr.pci);
    } else if (STREQLEN(type, "scsi", addr - type)) {
        diskAddr->type = DISK_ADDR_TYPE_SCSI;
        return str2SCSIAddress(addr + 1, &diskAddr->addr.scsi);
    } else if (STREQLEN(type, "ide", addr - type)) {
        diskAddr->type = DISK_ADDR_TYPE_IDE;
        return str2IDEAddress(addr + 1, &diskAddr->addr.ide);
    }

    return -1;
}

E
Eric Blake 已提交
11201
static bool
11202
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
11203 11204
{
    virDomainPtr dom = NULL;
11205
    const char *source = NULL, *target = NULL, *driver = NULL,
11206 11207 11208
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
11209 11210
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
11211
    unsigned int flags;
11212
    const char *stype = NULL;
11213 11214
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
11215

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

J
Jim Meyering 已提交
11219
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11220 11221
        goto cleanup;

11222
    if (vshCommandOptString(cmd, "source", &source) <= 0)
11223 11224
        goto cleanup;

11225
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11226 11227
        goto cleanup;

11228 11229 11230 11231
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
11232 11233 11234
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
11235
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
11236
        vshError(ctl, "%s", _("missing option"));
11237 11238
        goto cleanup;
    }
11239

11240 11241
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
11242
            isFile = true;
11243
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
11244
        isFile = true;
11245 11246 11247
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
11248 11249 11250
    }

    if (mode) {
11251
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
11252 11253
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
11254 11255 11256 11257 11258
            goto cleanup;
        }
    }

    /* Make XML of disk */
11259
    virBufferAsprintf(&buf, "<disk type='%s'",
11260 11261
                      (isFile) ? "file" : "block");
    if (type)
11262
        virBufferAsprintf(&buf, " device='%s'", type);
11263 11264
    virBufferAddLit(&buf, ">\n");

11265
    if (driver || subdriver)
11266
        virBufferAsprintf(&buf, "  <driver");
11267 11268

    if (driver)
11269
        virBufferAsprintf(&buf, " name='%s'", driver);
11270
    if (subdriver)
11271
        virBufferAsprintf(&buf, " type='%s'", subdriver);
11272 11273
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
11274

11275
    if (driver || subdriver || cache)
11276
        virBufferAddLit(&buf, "/>\n");
11277

11278
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
11279 11280
                      (isFile) ? "file" : "dev",
                      source);
11281
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11282
    if (mode)
11283
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
11284

11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332
    if (serial)
        virBufferAsprintf(&buf, "  <serial>%s</serial>\n", serial);

    if (vshCommandOptBool(cmd, "shareable"))
        virBufferAsprintf(&buf, "  <shareable/>\n");

    if (straddr) {
        if (str2DiskAddress(straddr, &diskAddr) != 0) {
            vshError(ctl, _("Invalid address."));
            goto cleanup;
        }

        if (STRPREFIX((const char *)target, "vd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_PCI) {
                virBufferAsprintf(&buf,
                                  "  <address type='pci' domain='0x%04x'"
                                  " bus ='0x%02x' slot='0x%02x' function='0x%0x' />\n",
                                  diskAddr.addr.pci.domain, diskAddr.addr.pci.bus,
                                  diskAddr.addr.pci.slot, diskAddr.addr.pci.function);
            } else {
                vshError(ctl, "%s", _("expecting a pci:0000.00.00.00 address."));
                goto cleanup;
            }
        } else if (STRPREFIX((const char *)target, "sd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_SCSI) {
                virBufferAsprintf(&buf,
                                  "  <address type='drive' controller='%d'"
                                  " bus='%d' unit='%d' />\n",
                                  diskAddr.addr.scsi.controller, diskAddr.addr.scsi.bus,
                                  diskAddr.addr.scsi.unit);
            } else {
                vshError(ctl, "%s", _("expecting a scsi:00.00.00 address."));
                goto cleanup;
            }
        } else if (STRPREFIX((const char *)target, "hd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_IDE) {
                virBufferAsprintf(&buf,
                                  "  <address type='drive' controller='%d'"
                                  " bus='%d' unit='%d' />\n",
                                  diskAddr.addr.ide.controller, diskAddr.addr.ide.bus,
                                  diskAddr.addr.ide.unit);
            } else {
                vshError(ctl, "%s", _("expecting an ide:00.00.00 address."));
                goto cleanup;
            }
        }
    }

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

11335 11336
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
11337
        return false;
11338 11339
    }

11340
    xml = virBufferContentAndReset(&buf);
11341

J
Jim Fehlig 已提交
11342
    if (vshCommandOptBool(cmd, "persistent")) {
11343
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11344
        if (virDomainIsActive(dom) == 1)
11345
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11346
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
11347
    } else {
11348
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
11349
    }
11350

11351 11352
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11353
    if (ret != 0) {
L
Laine Stump 已提交
11354
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
11355 11356
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
11357
        functionReturn = true;
J
Jim Fehlig 已提交
11358
    }
11359 11360 11361 11362

 cleanup:
    if (dom)
        virDomainFree(dom);
11363
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11364
    return functionReturn;
11365 11366 11367 11368 11369
}

/*
 * "detach-disk" command
 */
11370
static const vshCmdInfo info_detach_disk[] = {
11371 11372
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
11373 11374 11375
    {NULL, NULL}
};

11376
static const vshCmdOptDef opts_detach_disk[] = {
11377 11378 11379
    {"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")},
11380 11381 11382
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11383
static bool
11384
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
11385 11386 11387 11388 11389 11390 11391
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
11392
    const char *target = NULL;
11393
    char *doc;
E
Eric Blake 已提交
11394
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
11395 11396
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11397
    unsigned int flags;
11398

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

J
Jim Meyering 已提交
11402
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11403 11404
        goto cleanup;

11405
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11406 11407 11408 11409 11410 11411
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11412
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
11413
    VIR_FREE(doc);
11414
    if (!xml) {
11415
        vshError(ctl, "%s", _("Failed to get disk information"));
11416 11417 11418 11419 11420 11421
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11422
        vshError(ctl, "%s", _("Failed to get disk information"));
11423 11424 11425 11426 11427 11428 11429
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11430 11431 11432 11433 11434
            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);
11435 11436 11437 11438 11439 11440 11441
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11442
    vshError(ctl, _("No found disk whose target is %s"), target);
11443 11444 11445 11446 11447
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11448
        vshError(ctl, "%s", _("Failed to allocate memory"));
11449 11450 11451
        goto cleanup;
    }

11452
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
11453
        vshError(ctl, "%s", _("Failed to create XML"));
11454 11455 11456
        goto cleanup;
    }

J
Jim Fehlig 已提交
11457
    if (vshCommandOptBool(cmd, "persistent")) {
11458
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11459
        if (virDomainIsActive(dom) == 1)
11460
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11461 11462 11463 11464 11465 11466 11467 11468
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11469
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
11470
    } else {
J
Jim Meyering 已提交
11471
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
11472
        functionReturn = true;
11473
    }
11474 11475

 cleanup:
11476
    xmlXPathFreeObject(obj);
11477
    xmlXPathFreeContext(ctxt);
11478 11479
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
11480 11481
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
11482
    return functionReturn;
11483 11484
}

11485 11486 11487 11488
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
11489 11490
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
11491 11492 11493 11494
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
11495
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
11496 11497 11498
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11499
static bool
11500 11501
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
11502
    const char *from = NULL;
E
Eric Blake 已提交
11503
    bool ret = true;
11504 11505 11506
    char *buffer;
    int result;

11507
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11508
        return false;
11509

11510
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11511
        return false;
11512 11513

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
11517
    VIR_FREE(buffer);
11518 11519 11520 11521 11522

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
11523
        ret = false;
11524 11525 11526 11527 11528
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
11529
        ret = true;
11530 11531 11532 11533 11534
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
11535
        ret = true;
11536 11537 11538 11539 11540
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
11541
        ret = false;
11542 11543 11544 11545 11546
    }

    return ret;
}

11547 11548 11549 11550
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
11551 11552
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
11553 11554 11555 11556
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
11557
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
11558 11559 11560
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11561
static bool
11562 11563
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
11564
    const char *from = NULL;
E
Eric Blake 已提交
11565
    bool ret = true;
11566 11567 11568 11569 11570
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
11571
    xmlNodePtr node_list;
11572 11573 11574 11575 11576 11577
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

11578
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11579
        return false;
11580

11581
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11582
        return false;
11583 11584

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
11585
        return false;
11586 11587 11588 11589 11590

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

L
Laine Stump 已提交
11591 11592
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
11593 11594
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
11595
        ret = false;
11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631
        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 已提交
11632
        ret = false;
11633 11634 11635 11636 11637 11638 11639 11640
        goto cleanup;
    }

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

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
11641
        ret = false;
11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658

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 已提交
11659
    ret = false;
11660
    goto cleanup;
11661 11662
}

11663 11664 11665 11666 11667 11668 11669 11670
/* 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;

11671
    ret = vshMalloc(ctl, PATH_MAX);
11672 11673 11674

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
11675 11676
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
11677
    if (fd == -1) {
11678
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
11679
                 strerror(errno));
11680
        VIR_FREE(ret);
11681 11682 11683 11684
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
11685 11686
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
11687
        VIR_FORCE_CLOSE(fd);
11688
        unlink (ret);
11689
        VIR_FREE(ret);
11690 11691
        return NULL;
    }
S
Stefan Berger 已提交
11692
    if (VIR_CLOSE(fd) < 0) {
11693 11694
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
11695
        unlink (ret);
11696
        VIR_FREE(ret);
11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711
        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 已提交
11712 11713 11714 11715
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
11716

11717
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
11718 11719 11720 11721
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
11722

11723 11724 11725 11726 11727
    /* 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 已提交
11728 11729
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
11730
     */
E
Eric Blake 已提交
11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742
    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);
11743 11744
    }

E
Eric Blake 已提交
11745 11746 11747 11748 11749 11750 11751
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
11752
    }
E
Eric Blake 已提交
11753
    ret = 0;
11754

E
Eric Blake 已提交
11755 11756 11757
cleanup:
    virCommandFree(cmd);
    return ret;
11758 11759 11760 11761 11762 11763 11764 11765
}

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

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
11766
        vshError(ctl,
11767
                 _("%s: failed to read temporary file: %s"),
11768
                 filename, strerror(errno));
11769 11770 11771 11772 11773
        return NULL;
    }
    return ret;
}

11774

P
Paolo Bonzini 已提交
11775 11776 11777 11778
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
11779 11780
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
11781 11782 11783 11784
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11789
static bool
11790
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
11791
{
11792
    const char *dir = NULL;
11793
    char *dir_malloced = NULL;
E
Eric Blake 已提交
11794
    bool ret = true;
P
Paolo Bonzini 已提交
11795 11796

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

11801
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
11802
        uid_t uid = geteuid();
11803
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
11804 11805 11806 11807
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
11808
    if (chdir(dir) == -1) {
11809
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
11810
        ret = false;
P
Paolo Bonzini 已提交
11811 11812
    }

11813
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
11814
    return ret;
P
Paolo Bonzini 已提交
11815 11816 11817 11818 11819 11820
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
11821 11822
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
11823 11824 11825
    {NULL, NULL}
};

E
Eric Blake 已提交
11826
static bool
P
Paolo Bonzini 已提交
11827 11828 11829
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
11830
    bool ret = true;
P
Paolo Bonzini 已提交
11831

11832 11833
    cwd = getcwd(NULL, 0);
    if (!cwd) {
11834 11835
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
11836 11837
        ret = false;
    } else {
P
Paolo Bonzini 已提交
11838
        vshPrint (ctl, _("%s\n"), cwd);
11839 11840
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
11841

11842
    return ret;
P
Paolo Bonzini 已提交
11843 11844
}

E
Eric Blake 已提交
11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856
/*
 * "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")},
11857
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
11858 11859 11860 11861 11862 11863
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
11864
static bool
E
Eric Blake 已提交
11865 11866 11867 11868 11869
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
11870
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
11871 11872 11873 11874 11875 11876 11877 11878
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

11879
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
11880 11881 11882
        bool close_quote = false;
        char *q;

11883
        arg = opt->data;
E
Eric Blake 已提交
11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911
        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 已提交
11912
        return false;
E
Eric Blake 已提交
11913 11914 11915 11916 11917
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
11918
    return true;
E
Eric Blake 已提交
11919 11920
}

11921 11922 11923 11924
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
11925 11926
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
11927 11928 11929 11930
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
11931
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11932 11933 11934 11935 11936 11937
    {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 已提交
11938
static bool
11939 11940
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
11941
    bool ret = false;
11942 11943 11944 11945 11946
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
11947
    unsigned int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
11948

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

J
Jim Meyering 已提交
11952
    dom = vshCommandOptDomain (ctl, cmd, NULL);
11953 11954 11955 11956
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
11957
    doc = virDomainGetXMLDesc (dom, flags);
11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975
    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 已提交
11976
        ret = true;
11977 11978 11979 11980 11981 11982 11983
        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.
     */
11984
    doc_reread = virDomainGetXMLDesc (dom, flags);
11985 11986 11987 11988
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
11989 11990
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002
        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 已提交
12003
    ret = true;
12004 12005 12006 12007 12008

 cleanup:
    if (dom)
        virDomainFree (dom);

12009 12010 12011
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
12012 12013 12014

    if (tmp) {
        unlink (tmp);
12015
        VIR_FREE(tmp);
12016 12017 12018 12019 12020
    }

    return ret;
}

12021

12022 12023 12024 12025
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
12026 12027
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
12028 12029 12030 12031
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
12032
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
12033 12034 12035 12036 12037 12038 12039 12040 12041 12042
    {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[] = {
12043 12044
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
12045 12046 12047 12048
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
12049
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
12050 12051 12052 12053 12054 12055
    {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 已提交
12056 12057 12058
/*
 * "quit" command
 */
12059
static const vshCmdInfo info_quit[] = {
12060
    {"help", N_("quit this interactive terminal")},
12061
    {"desc", ""},
12062
    {NULL, NULL}
K
Karel Zak 已提交
12063 12064
};

E
Eric Blake 已提交
12065
static bool
12066
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
12067
{
E
Eric Blake 已提交
12068 12069
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
12070 12071
}

12072 12073 12074 12075 12076 12077 12078
/* Helper for snapshot-create and snapshot-create-as */
static bool
vshSnapshotCreate(vshControl *ctl, virDomainPtr dom, const char *buffer,
                  unsigned int flags, const char *from)
{
    bool ret = false;
    virDomainSnapshotPtr snapshot;
12079
    bool halt = false;
12080 12081 12082 12083 12084 12085
    char *doc = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *name = NULL;

    snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109

    /* Emulate --halt on older servers.  */
    if (!snapshot && last_error->code == VIR_ERR_INVALID_ARG &&
        (flags & VIR_DOMAIN_SNAPSHOT_CREATE_HALT)) {
        int persistent;

        virFreeError(last_error);
        last_error = NULL;
        persistent = virDomainIsPersistent(dom);
        if (persistent < 0) {
            virshReportError(ctl);
            goto cleanup;
        }
        if (!persistent) {
            vshError(ctl, "%s",
                     _("cannot halt after snapshot of transient domain"));
            goto cleanup;
        }
        if (virDomainIsActive(dom) == 1)
            halt = true;
        flags &= ~VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
        snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
    }

12110 12111 12112
    if (snapshot == NULL)
        goto cleanup;

12113 12114 12115 12116 12117
    if (halt && virDomainDestroy(dom) < 0) {
        virshReportError(ctl);
        goto cleanup;
    }

12118 12119 12120 12121
    if (flags & VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA)
        doc = vshStrdup(ctl, buffer);
    else
        doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152
    if (!doc)
        goto cleanup;

    xml = virXMLParseStringCtxt(doc, "domainsnapshot.xml", &ctxt);
    if (!xml)
        goto cleanup;

    name = virXPathString("string(/domainsnapshot/name)", ctxt);
    if (!name) {
        vshError(ctl, "%s",
                 _("Could not find 'name' element in domain snapshot XML"));
        goto cleanup;
    }

    if (from)
        vshPrint(ctl, _("Domain snapshot %s created from '%s'"), name, from);
    else
        vshPrint(ctl, _("Domain snapshot %s created"), name);

    ret = true;

cleanup:
    VIR_FREE(name);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    return ret;
}

12153 12154 12155 12156
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
12157 12158
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
12159 12160 12161 12162 12163 12164
    {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")},
12165 12166 12167
    {"redefine", VSH_OT_BOOL, 0, N_("redefine metadata for existing snapshot")},
    {"current", VSH_OT_BOOL, 0, N_("with redefine, set current snapshot")},
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
12168
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
12169 12170 12171
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12172
static bool
12173 12174 12175
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12176
    bool ret = false;
12177
    const char *from = NULL;
12178
    char *buffer = NULL;
12179 12180 12181 12182 12183 12184 12185 12186
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "redefine"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE;
    if (vshCommandOptBool(cmd, "current"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT;
    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
12187 12188
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
12189

12190
    if (!vshConnectionUsability(ctl, ctl->conn))
12191 12192 12193 12194 12195 12196
        goto cleanup;

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

12197
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
12198
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213
    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;
    }

12214
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, from);
12215 12216 12217 12218 12219 12220 12221 12222 12223

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

    return ret;
}

12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236
/*
 * "snapshot-create-as" command
 */
static const vshCmdInfo info_snapshot_create_as[] = {
    {"help", N_("Create a snapshot from a set of args")},
    {"desc", N_("Create a snapshot (disk and RAM) from arguments")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_create_as[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"name", VSH_OT_DATA, 0, N_("name of snapshot")},
    {"description", VSH_OT_DATA, 0, N_("description of snapshot")},
E
Eric Blake 已提交
12237
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
12238
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
12239
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    char *buffer = NULL;
    const char *name = NULL;
    const char *desc = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
12252 12253 12254 12255
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
12256 12257
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273

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

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

    if (vshCommandOptString(cmd, "name", &name) < 0 ||
        vshCommandOptString(cmd, "description", &desc) < 0) {
        vshError(ctl, _("argument must not be empty"));
        goto cleanup;
    }

    virBufferAddLit(&buf, "<domainsnapshot>\n");
    if (name)
12274
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
12275
    if (desc)
12276
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
12277 12278 12279 12280 12281 12282 12283 12284
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
12285
    if (vshCommandOptBool(cmd, "print-xml")) {
12286 12287 12288 12289 12290
        if (vshCommandOptBool(cmd, "halt")) {
            vshError(ctl, "%s",
                     _("--print-xml and --halt are mutually exclusive"));
            goto cleanup;
        }
E
Eric Blake 已提交
12291 12292 12293 12294 12295
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

12296
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, NULL);
12297 12298 12299 12300 12301 12302 12303 12304 12305

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

    return ret;
}

12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406
/*
 * "snapshot-edit" command
 */
static const vshCmdInfo info_snapshot_edit[] = {
    {"help", N_("edit XML for a snapshot")},
    {"desc", N_("Edit the domain snapshot XML for a named snapshot")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_edit[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("also set edited snapshot as current")},
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotEdit(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    const char *name;
    bool ret = false;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    unsigned int getxml_flags = VIR_DOMAIN_XML_SECURE;
    unsigned int define_flags = VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE;

    if (vshCommandOptBool(cmd, "current"))
        define_flags |= VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT;

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

    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
        goto cleanup;

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

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

    /* Get the XML configuration of the snapshot.  */
    doc = virDomainSnapshotGetXMLDesc(snapshot, getxml_flags);
    if (!doc)
        goto cleanup;
    virDomainSnapshotFree(snapshot);
    snapshot = NULL;

    /* 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.  Short-circuit if it did not
     * change, and we do not have any flags.  */
    if (STREQ(doc, doc_edited) &&
        !(define_flags & VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT)) {
        vshPrint(ctl, _("Snapshot %s XML configuration not changed.\n"),
                 name);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
    snapshot = virDomainSnapshotCreateXML(dom, doc_edited, define_flags);
    if (!snapshot) {
        vshError(ctl, _("Failed to update %s"), name);
        goto cleanup;
    }

    vshPrint(ctl, _("Snapshot %s edited.\n"), name);
    ret = true;

cleanup:
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);
    return ret;
}

12407 12408 12409 12410
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
12411 12412
    {"help", N_("Get or set the current snapshot")},
    {"desc", N_("Get or set the current snapshot")},
12413 12414 12415 12416 12417
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12418
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
12419 12420
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
12421 12422
    {"snapshotname", VSH_OT_DATA, 0,
     N_("name of existing snapshot to make current")},
12423 12424 12425
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12426
static bool
12427 12428 12429
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12430
    bool ret = false;
12431 12432
    int current;
    virDomainSnapshotPtr snapshot = NULL;
12433
    char *xml = NULL;
12434
    const char *snapshotname = NULL;
12435 12436 12437 12438
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;
12439

12440
    if (!vshConnectionUsability(ctl, ctl->conn))
12441 12442 12443 12444 12445 12446
        goto cleanup;

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

12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475
    if (vshCommandOptString(cmd, "snapshotname", &snapshotname) < 0) {
        vshError(ctl, _("invalid snapshotname argument '%s'"), snapshotname);
        goto cleanup;
    }
    if (snapshotname) {
        virDomainSnapshotPtr snapshot2 = NULL;
        flags = (VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE |
                 VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT);

        if (vshCommandOptBool(cmd, "name")) {
            vshError(ctl, "%s",
                     _("--name and snapshotname are mutually exclusive"));
            goto cleanup;
        }
        snapshot = virDomainSnapshotLookupByName(dom, snapshotname, 0);
        if (snapshot == NULL)
            goto cleanup;
        xml = virDomainSnapshotGetXMLDesc(snapshot, VIR_DOMAIN_XML_SECURE);
        if (!xml)
            goto cleanup;
        snapshot2 = virDomainSnapshotCreateXML(dom, xml, flags);
        if (snapshot2 == NULL)
            goto cleanup;
        virDomainSnapshotFree(snapshot2);
        vshPrint(ctl, _("Snapshot %s set as current"), snapshotname);
        ret = true;
        goto cleanup;
    }

12476 12477 12478 12479
    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
12480
        char *name = NULL;
12481 12482 12483 12484

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

12485
        xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
12486 12487 12488
        if (!xml)
            goto cleanup;

12489 12490 12491 12492
        if (vshCommandOptBool(cmd, "name")) {
            xmlDocPtr xmldoc = NULL;
            xmlXPathContextPtr ctxt = NULL;

12493
            xmldoc = virXMLParseStringCtxt(xml, "domainsnapshot.xml", &ctxt);
12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505
            if (!xmldoc)
                goto cleanup;

            name = virXPathString("string(/domainsnapshot/name)", ctxt);
            xmlXPathFreeContext(ctxt);
            xmlFreeDoc(xmldoc);
            if (!name)
                goto cleanup;
        }

        vshPrint(ctl, "%s", name ? name : xml);
        VIR_FREE(name);
12506 12507
    }

E
Eric Blake 已提交
12508
    ret = true;
12509 12510

cleanup:
12511
    VIR_FREE(xml);
12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530
    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")},
12531
    {"parent", VSH_OT_BOOL, 0, N_("add a column showing parent snapshot")},
12532 12533 12534
    {"roots", VSH_OT_BOOL, 0, N_("list only snapshots without parents")},
    {"metadata", VSH_OT_BOOL, 0,
     N_("list only snapshots that have metadata that would prevent undefine")},
12535 12536 12537
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12538
static bool
12539 12540 12541
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12542
    bool ret = false;
12543
    unsigned int flags = 0;
12544 12545
    int parent_filter = 0; /* -1 for roots filtering, 0 for no parent
                              information needed, 1 for parent column */
12546 12547
    int numsnaps;
    char **names = NULL;
12548
    int actual = 0;
12549 12550 12551 12552 12553 12554
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
12555
    char *parent = NULL;
12556 12557
    long long creation_longlong;
    time_t creation_time_t;
12558 12559 12560
    char timestr[100];
    struct tm time_info;

12561
    if (vshCommandOptBool(cmd, "parent")) {
12562 12563 12564 12565 12566
        if (vshCommandOptBool(cmd, "roots")) {
            vshError(ctl, "%s",
                     _("--parent and --roots are mutually exlusive"));
            return false;
        }
12567
        parent_filter = 1;
12568 12569 12570 12571 12572 12573
    } else if (vshCommandOptBool(cmd, "roots")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
    }

    if (vshCommandOptBool(cmd, "metadata")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_METADATA;
12574 12575
    }

12576
    if (!vshConnectionUsability(ctl, ctl->conn))
12577 12578 12579 12580 12581 12582
        goto cleanup;

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

12583
    numsnaps = virDomainSnapshotNum(dom, flags);
12584

12585 12586 12587 12588 12589 12590 12591 12592 12593 12594
    /* Fall back to simulation if --roots was unsupported.  */
    if (numsnaps < 0 && last_error->code == VIR_ERR_INVALID_ARG &&
        (flags & VIR_DOMAIN_SNAPSHOT_LIST_ROOTS)) {
        virFreeError(last_error);
        last_error = NULL;
        parent_filter = -1;
        flags &= ~VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
        numsnaps = virDomainSnapshotNum(dom, flags);
    }

12595 12596 12597
    if (numsnaps < 0)
        goto cleanup;

12598 12599 12600 12601 12602 12603 12604 12605
    if (parent_filter > 0)
        vshPrintExtra(ctl, " %-20s %-25s %-15s %s",
                      _("Name"), _("Creation Time"), _("State"), _("Parent"));
    else
        vshPrintExtra(ctl, " %-20s %-25s %s",
                      _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "\n\
------------------------------------------------------------\n");
12606 12607 12608 12609 12610

    if (numsnaps) {
        if (VIR_ALLOC_N(names, numsnaps) < 0)
            goto cleanup;

12611
        actual = virDomainSnapshotListNames(dom, names, numsnaps, flags);
12612 12613 12614 12615 12616 12617 12618
        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 */
12619
            VIR_FREE(parent);
12620 12621 12622 12623
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
12624
            xmlFreeDoc(xml);
12625 12626 12627 12628 12629 12630 12631 12632 12633 12634
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

12635
            xml = virXMLParseStringCtxt(doc, "domainsnapshot.xml", &ctxt);
12636 12637 12638
            if (!xml)
                continue;

12639 12640 12641
            if (parent_filter) {
                parent = virXPathString("string(/domainsnapshot/parent/name)",
                                        ctxt);
12642 12643
                if (!parent && parent_filter < 0)
                    continue;
12644 12645
            }

12646 12647 12648
            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
12649 12650
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
12651
                continue;
12652 12653 12654 12655 12656 12657
            creation_time_t = creation_longlong;
            if (creation_time_t != creation_longlong) {
                vshError(ctl, "%s", _("time_t overflow"));
                continue;
            }
            localtime_r(&creation_time_t, &time_info);
12658 12659
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z",
                     &time_info);
12660

12661 12662 12663 12664 12665
            if (parent)
                vshPrint(ctl, " %-20s %-25s %-15s %s\n",
                         names[i], timestr, state, parent);
            else
                vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
12666 12667 12668
        }
    }

E
Eric Blake 已提交
12669
    ret = true;
12670 12671 12672

cleanup:
    /* this frees up memory from the last iteration of the loop */
12673
    VIR_FREE(parent);
12674 12675 12676 12677
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    xmlXPathFreeContext(ctxt);
12678
    xmlFreeDoc(xml);
12679
    VIR_FREE(doc);
12680 12681
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700
    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")},
12701 12702
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
12703 12704 12705
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12706
static bool
12707 12708 12709
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12710
    bool ret = false;
12711
    const char *name = NULL;
12712 12713
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
12714 12715 12716 12717
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;
12718

12719
    if (!vshConnectionUsability(ctl, ctl->conn))
12720 12721 12722 12723 12724 12725
        goto cleanup;

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

12726
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12727 12728 12729 12730 12731 12732
        goto cleanup;

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

12733
    xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
12734 12735 12736
    if (!xml)
        goto cleanup;

12737
    vshPrint(ctl, "%s", xml);
12738

E
Eric Blake 已提交
12739
    ret = true;
12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750

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

    return ret;
}

E
Eric Blake 已提交
12751 12752 12753 12754
/*
 * "snapshot-parent" command
 */
static const vshCmdInfo info_snapshot_parent[] = {
E
Eric Blake 已提交
12755
    {"help", N_("Get the name of the parent of a snapshot")},
E
Eric Blake 已提交
12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795
    {"desc", N_("Extract the snapshot's parent, if any")},
    {NULL, NULL}
};

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

static bool
cmdSnapshotParent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    const char *name = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
    char *parent = NULL;
    xmlDocPtr xmldoc = NULL;
    xmlXPathContextPtr ctxt = NULL;

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

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

    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
        goto cleanup;

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

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

12796
    xmldoc = virXMLParseStringCtxt(xml, "domainsnapshot.xml", &ctxt);
E
Eric Blake 已提交
12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810
    if (!xmldoc)
        goto cleanup;

    parent = virXPathString("string(/domainsnapshot/parent/name)", ctxt);
    if (!parent)
        goto cleanup;

    vshPrint(ctl, "%s", parent);

    ret = true;

cleanup:
    VIR_FREE(parent);
    xmlXPathFreeContext(ctxt);
12811
    xmlFreeDoc(xmldoc);
E
Eric Blake 已提交
12812 12813 12814 12815 12816 12817 12818 12819 12820
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12821
/*
12822
 * "snapshot-revert" command
12823
 */
12824
static const vshCmdInfo info_snapshot_revert[] = {
12825 12826 12827 12828 12829
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

12830
static const vshCmdOptDef opts_snapshot_revert[] = {
12831 12832
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
12833 12834
    {"running", VSH_OT_BOOL, 0, N_("after reverting, change state to running")},
    {"paused", VSH_OT_BOOL, 0, N_("after reverting, change state to paused")},
12835 12836 12837
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12838
static bool
12839
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
12840 12841
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12842
    bool ret = false;
12843
    const char *name = NULL;
12844
    virDomainSnapshotPtr snapshot = NULL;
12845 12846 12847 12848 12849 12850
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED;
12851

12852
    if (!vshConnectionUsability(ctl, ctl->conn))
12853 12854 12855 12856 12857 12858
        goto cleanup;

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

12859
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12860 12861 12862 12863 12864 12865
        goto cleanup;

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

12866
    if (virDomainRevertToSnapshot(snapshot, flags) < 0)
12867 12868
        goto cleanup;

E
Eric Blake 已提交
12869
    ret = true;
12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892

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")},
12893 12894 12895
    {"children-only", VSH_OT_BOOL, 0, N_("delete children but not snapshot")},
    {"metadata", VSH_OT_BOOL, 0,
     N_("delete only libvirt metadata, leaving snapshot contents behind")},
12896 12897 12898
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12899
static bool
12900 12901 12902
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12903
    bool ret = false;
12904
    const char *name = NULL;
12905 12906 12907
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

12908
    if (!vshConnectionUsability(ctl, ctl->conn))
12909 12910 12911 12912 12913 12914
        goto cleanup;

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

12915
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12916 12917 12918 12919
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;
12920 12921 12922 12923
    if (vshCommandOptBool(cmd, "children-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY;
    if (vshCommandOptBool(cmd, "metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY;
12924 12925 12926 12927 12928

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

12929 12930 12931
    /* XXX If we wanted, we could emulate DELETE_CHILDREN_ONLY even on
     * older servers that reject the flag, by manually computing the
     * list of descendants.  But that's a lot of code to maintain.  */
12932
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
12933 12934 12935 12936
        if (flags & VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY)
            vshPrint(ctl, _("Domain snapshot %s children deleted\n"), name);
        else
            vshPrint(ctl, _("Domain snapshot %s deleted\n"), name);
12937 12938
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
12939
        goto cleanup;
12940
    }
12941

E
Eric Blake 已提交
12942
    ret = true;
12943 12944 12945 12946 12947 12948 12949 12950 12951 12952

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

    return ret;
}

12953 12954 12955 12956
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
12957 12958
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
12959 12960 12961 12962 12963
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12964
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
12965
    {"cmd", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("command")},
12966 12967 12968
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12969
static bool
12970 12971 12972
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12973
    bool ret = false;
12974
    char *monitor_cmd = NULL;
12975
    char *result = NULL;
12976
    unsigned int flags = 0;
12977 12978 12979
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
12980 12981 12982 12983 12984 12985 12986 12987

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

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

12988 12989 12990 12991 12992 12993 12994 12995
    while ((opt = vshCommandOptArgv(cmd, opt))) {
        if (pad)
            virBufferAddChar(&buf, ' ');
        pad = true;
        virBufferAdd(&buf, opt->data, -1);
    }
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to collect command"));
12996 12997
        goto cleanup;
    }
12998
    monitor_cmd = virBufferContentAndReset(&buf);
12999

13000 13001 13002 13003
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
13004 13005 13006 13007
        goto cleanup;

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

E
Eric Blake 已提交
13008
    ret = true;
13009 13010 13011

cleanup:
    VIR_FREE(result);
13012
    VIR_FREE(monitor_cmd);
13013 13014 13015 13016 13017 13018
    if (dom)
        virDomainFree(dom);

    return ret;
}

13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064
/*
 * "qemu-attach" command
 */
static const vshCmdInfo info_qemu_attach[] = {
    {"help", N_("QEMU Attach")},
    {"desc", N_("QEMU Attach")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_attach[] = {
    {"pid", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pid")},
    {NULL, 0, 0, NULL}
};

static bool
cmdQemuAttach(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    unsigned int flags = 0;
    unsigned int pid;

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

    if (vshCommandOptUInt(cmd, "pid", &pid) <= 0) {
        vshError(ctl, "%s", _("missing pid value"));
        goto cleanup;
    }

    if (!(dom = virDomainQemuAttach(ctl->conn, pid, flags)))
        goto cleanup;

    if (dom != NULL) {
        vshPrint(ctl, _("Domain %s attached to pid %u\n"),
                 virDomainGetName(dom), pid);
        virDomainFree(dom);
        ret = true;
    } else {
        vshError(ctl, _("Failed to attach to pid %u"), pid);
    }

cleanup:
    return ret;
}

13065
static const vshCmdDef domManagementCmds[] = {
13066 13067 13068 13069 13070 13071 13072 13073
    {"attach-device", cmdAttachDevice, opts_attach_device,
     info_attach_device, 0},
    {"attach-disk", cmdAttachDisk, opts_attach_disk,
     info_attach_disk, 0},
    {"attach-interface", cmdAttachInterface, opts_attach_interface,
     info_attach_interface, 0},
    {"autostart", cmdAutostart, opts_autostart, info_autostart, 0},
    {"blkiotune", cmdBlkiotune, opts_blkiotune, info_blkiotune, 0},
13074 13075
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
13076
#ifndef WIN32
13077
    {"console", cmdConsole, opts_console, info_console, 0},
13078
#endif
13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101
    {"cpu-baseline", cmdCPUBaseline, opts_cpu_baseline, info_cpu_baseline, 0},
    {"cpu-compare", cmdCPUCompare, opts_cpu_compare, info_cpu_compare, 0},
    {"create", cmdCreate, opts_create, info_create, 0},
    {"define", cmdDefine, opts_define, info_define, 0},
    {"destroy", cmdDestroy, opts_destroy, info_destroy, 0},
    {"detach-device", cmdDetachDevice, opts_detach_device,
     info_detach_device, 0},
    {"detach-disk", cmdDetachDisk, opts_detach_disk, info_detach_disk, 0},
    {"detach-interface", cmdDetachInterface, opts_detach_interface,
     info_detach_interface, 0},
    {"domid", cmdDomid, opts_domid, info_domid, 0},
    {"domjobabort", cmdDomjobabort, opts_domjobabort, info_domjobabort, 0},
    {"domjobinfo", cmdDomjobinfo, opts_domjobinfo, info_domjobinfo, 0},
    {"domname", cmdDomname, opts_domname, info_domname, 0},
    {"domuuid", cmdDomuuid, opts_domuuid, info_domuuid, 0},
    {"domxml-from-native", cmdDomXMLFromNative, opts_domxmlfromnative,
     info_domxmlfromnative, 0},
    {"domxml-to-native", cmdDomXMLToNative, opts_domxmltonative,
     info_domxmltonative, 0},
    {"dump", cmdDump, opts_dump, info_dump, 0},
    {"dumpxml", cmdDumpXML, opts_dumpxml, info_dumpxml, 0},
    {"edit", cmdEdit, opts_edit, info_edit, 0},
    {"inject-nmi", cmdInjectNMI, opts_inject_nmi, info_inject_nmi, 0},
13102
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
13103 13104 13105 13106 13107 13108 13109 13110
    {"managedsave", cmdManagedSave, opts_managedsave, info_managedsave, 0},
    {"managedsave-remove", cmdManagedSaveRemove, opts_managedsaveremove,
     info_managedsaveremove, 0},
    {"maxvcpus", cmdMaxvcpus, opts_maxvcpus, info_maxvcpus, 0},
    {"memtune", cmdMemtune, opts_memtune, info_memtune, 0},
    {"migrate", cmdMigrate, opts_migrate, info_migrate, 0},
    {"migrate-setmaxdowntime", cmdMigrateSetMaxDowntime,
     opts_migrate_setmaxdowntime, info_migrate_setmaxdowntime, 0},
13111 13112
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
13113 13114
    {"migrate-getspeed", cmdMigrateGetMaxSpeed,
     opts_migrate_getspeed, info_migrate_getspeed, 0},
13115 13116 13117 13118
    {"reboot", cmdReboot, opts_reboot, info_reboot, 0},
    {"restore", cmdRestore, opts_restore, info_restore, 0},
    {"resume", cmdResume, opts_resume, info_resume, 0},
    {"save", cmdSave, opts_save, info_save, 0},
13119 13120 13121 13122 13123 13124
    {"save-image-define", cmdSaveImageDefine, opts_save_image_define,
     info_save_image_define, 0},
    {"save-image-dumpxml", cmdSaveImageDumpxml, opts_save_image_dumpxml,
     info_save_image_dumpxml, 0},
    {"save-image-edit", cmdSaveImageEdit, opts_save_image_edit,
     info_save_image_edit, 0},
13125
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
13126
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138
    {"setmaxmem", cmdSetmaxmem, opts_setmaxmem, info_setmaxmem, 0},
    {"setmem", cmdSetmem, opts_setmem, info_setmem, 0},
    {"setvcpus", cmdSetvcpus, opts_setvcpus, info_setvcpus, 0},
    {"shutdown", cmdShutdown, opts_shutdown, info_shutdown, 0},
    {"start", cmdStart, opts_start, info_start, 0},
    {"suspend", cmdSuspend, opts_suspend, info_suspend, 0},
    {"ttyconsole", cmdTTYConsole, opts_ttyconsole, info_ttyconsole, 0},
    {"undefine", cmdUndefine, opts_undefine, info_undefine, 0},
    {"update-device", cmdUpdateDevice, opts_update_device,
     info_update_device, 0},
    {"vcpucount", cmdVcpucount, opts_vcpucount, info_vcpucount, 0},
    {"vcpuinfo", cmdVcpuinfo, opts_vcpuinfo, info_vcpuinfo, 0},
E
Eric Blake 已提交
13139
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
13140
    {"version", cmdVersion, opts_version, info_version, 0},
13141 13142
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
13143 13144 13145
};

static const vshCmdDef domMonitoringCmds[] = {
13146
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
13147
    {"domblklist", cmdDomblklist, opts_domblklist, info_domblklist, 0},
13148
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
13149
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
13150 13151 13152 13153 13154 13155
    {"domifstat", cmdDomIfstat, opts_domifstat, info_domifstat, 0},
    {"dominfo", cmdDominfo, opts_dominfo, info_dominfo, 0},
    {"dommemstat", cmdDomMemStat, opts_dommemstat, info_dommemstat, 0},
    {"domstate", cmdDomstate, opts_domstate, info_domstate, 0},
    {"list", cmdList, opts_list, info_list, 0},
    {NULL, NULL, NULL, NULL, 0}
13156 13157 13158
};

static const vshCmdDef storagePoolCmds[] = {
13159
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
13160
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
13161
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182
     opts_find_storage_pool_sources, info_find_storage_pool_sources, 0},
    {"pool-autostart", cmdPoolAutostart, opts_pool_autostart,
     info_pool_autostart, 0},
    {"pool-build", cmdPoolBuild, opts_pool_build, info_pool_build, 0},
    {"pool-create-as", cmdPoolCreateAs, opts_pool_X_as, info_pool_create_as, 0},
    {"pool-create", cmdPoolCreate, opts_pool_create, info_pool_create, 0},
    {"pool-define-as", cmdPoolDefineAs, opts_pool_X_as, info_pool_define_as, 0},
    {"pool-define", cmdPoolDefine, opts_pool_define, info_pool_define, 0},
    {"pool-delete", cmdPoolDelete, opts_pool_delete, info_pool_delete, 0},
    {"pool-destroy", cmdPoolDestroy, opts_pool_destroy, info_pool_destroy, 0},
    {"pool-dumpxml", cmdPoolDumpXML, opts_pool_dumpxml, info_pool_dumpxml, 0},
    {"pool-edit", cmdPoolEdit, opts_pool_edit, info_pool_edit, 0},
    {"pool-info", cmdPoolInfo, opts_pool_info, info_pool_info, 0},
    {"pool-list", cmdPoolList, opts_pool_list, info_pool_list, 0},
    {"pool-name", cmdPoolName, opts_pool_name, info_pool_name, 0},
    {"pool-refresh", cmdPoolRefresh, opts_pool_refresh, info_pool_refresh, 0},
    {"pool-start", cmdPoolStart, opts_pool_start, info_pool_start, 0},
    {"pool-undefine", cmdPoolUndefine, opts_pool_undefine,
     info_pool_undefine, 0},
    {"pool-uuid", cmdPoolUuid, opts_pool_uuid, info_pool_uuid, 0},
    {NULL, NULL, NULL, NULL, 0}
13183 13184 13185
};

static const vshCmdDef storageVolCmds[] = {
13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203
    {"vol-clone", cmdVolClone, opts_vol_clone, info_vol_clone, 0},
    {"vol-create-as", cmdVolCreateAs, opts_vol_create_as,
     info_vol_create_as, 0},
    {"vol-create", cmdVolCreate, opts_vol_create, info_vol_create, 0},
    {"vol-create-from", cmdVolCreateFrom, opts_vol_create_from,
     info_vol_create_from, 0},
    {"vol-delete", cmdVolDelete, opts_vol_delete, info_vol_delete, 0},
    {"vol-download", cmdVolDownload, opts_vol_download, info_vol_download, 0},
    {"vol-dumpxml", cmdVolDumpXML, opts_vol_dumpxml, info_vol_dumpxml, 0},
    {"vol-info", cmdVolInfo, opts_vol_info, info_vol_info, 0},
    {"vol-key", cmdVolKey, opts_vol_key, info_vol_key, 0},
    {"vol-list", cmdVolList, opts_vol_list, info_vol_list, 0},
    {"vol-name", cmdVolName, opts_vol_name, info_vol_name, 0},
    {"vol-path", cmdVolPath, opts_vol_path, info_vol_path, 0},
    {"vol-pool", cmdVolPool, opts_vol_pool, info_vol_pool, 0},
    {"vol-upload", cmdVolUpload, opts_vol_upload, info_vol_upload, 0},
    {"vol-wipe", cmdVolWipe, opts_vol_wipe, info_vol_wipe, 0},
    {NULL, NULL, NULL, NULL, 0}
13204
};
13205

13206
static const vshCmdDef networkCmds[] = {
13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225
    {"net-autostart", cmdNetworkAutostart, opts_network_autostart,
     info_network_autostart, 0},
    {"net-create", cmdNetworkCreate, opts_network_create,
     info_network_create, 0},
    {"net-define", cmdNetworkDefine, opts_network_define,
     info_network_define, 0},
    {"net-destroy", cmdNetworkDestroy, opts_network_destroy,
     info_network_destroy, 0},
    {"net-dumpxml", cmdNetworkDumpXML, opts_network_dumpxml,
     info_network_dumpxml, 0},
    {"net-edit", cmdNetworkEdit, opts_network_edit, info_network_edit, 0},
    {"net-info", cmdNetworkInfo, opts_network_info, info_network_info, 0},
    {"net-list", cmdNetworkList, opts_network_list, info_network_list, 0},
    {"net-name", cmdNetworkName, opts_network_name, info_network_name, 0},
    {"net-start", cmdNetworkStart, opts_network_start, info_network_start, 0},
    {"net-undefine", cmdNetworkUndefine, opts_network_undefine,
     info_network_undefine, 0},
    {"net-uuid", cmdNetworkUuid, opts_network_uuid, info_network_uuid, 0},
    {NULL, NULL, NULL, NULL, 0}
13226
};
13227

13228
static const vshCmdDef nodedevCmds[] = {
13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243
    {"nodedev-create", cmdNodeDeviceCreate, opts_node_device_create,
     info_node_device_create, 0},
    {"nodedev-destroy", cmdNodeDeviceDestroy, opts_node_device_destroy,
     info_node_device_destroy, 0},
    {"nodedev-dettach", cmdNodeDeviceDettach, opts_node_device_dettach,
     info_node_device_dettach, 0},
    {"nodedev-dumpxml", cmdNodeDeviceDumpXML, opts_node_device_dumpxml,
     info_node_device_dumpxml, 0},
    {"nodedev-list", cmdNodeListDevices, opts_node_list_devices,
     info_node_list_devices, 0},
    {"nodedev-reattach", cmdNodeDeviceReAttach, opts_node_device_reattach,
     info_node_device_reattach, 0},
    {"nodedev-reset", cmdNodeDeviceReset, opts_node_device_reset,
     info_node_device_reset, 0},
    {NULL, NULL, NULL, NULL, 0}
13244 13245 13246
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
13247 13248 13249 13250
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264
    {"iface-define", cmdInterfaceDefine, opts_interface_define,
     info_interface_define, 0},
    {"iface-destroy", cmdInterfaceDestroy, opts_interface_destroy,
     info_interface_destroy, 0},
    {"iface-dumpxml", cmdInterfaceDumpXML, opts_interface_dumpxml,
     info_interface_dumpxml, 0},
    {"iface-edit", cmdInterfaceEdit, opts_interface_edit,
     info_interface_edit, 0},
    {"iface-list", cmdInterfaceList, opts_interface_list,
     info_interface_list, 0},
    {"iface-mac", cmdInterfaceMAC, opts_interface_mac,
     info_interface_mac, 0},
    {"iface-name", cmdInterfaceName, opts_interface_name,
     info_interface_name, 0},
E
Eric Blake 已提交
13265 13266
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
13267 13268 13269 13270 13271
    {"iface-start", cmdInterfaceStart, opts_interface_start,
     info_interface_start, 0},
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine,
     info_interface_undefine, 0},
    {NULL, NULL, NULL, NULL, 0}
13272
};
13273

13274
static const vshCmdDef nwfilterCmds[] = {
13275 13276 13277 13278 13279 13280 13281 13282 13283 13284 13285
    {"nwfilter-define", cmdNWFilterDefine, opts_nwfilter_define,
     info_nwfilter_define, 0},
    {"nwfilter-dumpxml", cmdNWFilterDumpXML, opts_nwfilter_dumpxml,
     info_nwfilter_dumpxml, 0},
    {"nwfilter-edit", cmdNWFilterEdit, opts_nwfilter_edit,
     info_nwfilter_edit, 0},
    {"nwfilter-list", cmdNWFilterList, opts_nwfilter_list,
     info_nwfilter_list, 0},
    {"nwfilter-undefine", cmdNWFilterUndefine, opts_nwfilter_undefine,
     info_nwfilter_undefine, 0},
    {NULL, NULL, NULL, NULL, 0}
13286
};
13287

13288
static const vshCmdDef secretCmds[] = {
13289 13290 13291 13292 13293 13294 13295 13296 13297 13298 13299 13300
    {"secret-define", cmdSecretDefine, opts_secret_define,
     info_secret_define, 0},
    {"secret-dumpxml", cmdSecretDumpXML, opts_secret_dumpxml,
     info_secret_dumpxml, 0},
    {"secret-get-value", cmdSecretGetValue, opts_secret_get_value,
     info_secret_get_value, 0},
    {"secret-list", cmdSecretList, NULL, info_secret_list, 0},
    {"secret-set-value", cmdSecretSetValue, opts_secret_set_value,
     info_secret_set_value, 0},
    {"secret-undefine", cmdSecretUndefine, opts_secret_undefine,
     info_secret_undefine, 0},
    {NULL, NULL, NULL, NULL, 0}
13301
};
13302

13303
static const vshCmdDef virshCmds[] = {
13304 13305 13306 13307 13308 13309 13310
    {"cd", cmdCd, opts_cd, info_cd, VSH_CMD_FLAG_NOCONNECT},
    {"echo", cmdEcho, opts_echo, info_echo, VSH_CMD_FLAG_NOCONNECT},
    {"exit", cmdQuit, NULL, info_quit, VSH_CMD_FLAG_NOCONNECT},
    {"help", cmdHelp, opts_help, info_help, VSH_CMD_FLAG_NOCONNECT},
    {"pwd", cmdPwd, NULL, info_pwd, VSH_CMD_FLAG_NOCONNECT},
    {"quit", cmdQuit, NULL, info_quit, VSH_CMD_FLAG_NOCONNECT},
    {NULL, NULL, NULL, NULL, 0}
13311
};
13312

13313
static const vshCmdDef snapshotCmds[] = {
13314 13315
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
13316 13317
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
13318 13319 13320 13321 13322 13323
    {"snapshot-current", cmdSnapshotCurrent, opts_snapshot_current,
     info_snapshot_current, 0},
    {"snapshot-delete", cmdSnapshotDelete, opts_snapshot_delete,
     info_snapshot_delete, 0},
    {"snapshot-dumpxml", cmdSnapshotDumpXML, opts_snapshot_dumpxml,
     info_snapshot_dumpxml, 0},
13324 13325
    {"snapshot-edit", cmdSnapshotEdit, opts_snapshot_edit,
     info_snapshot_edit, 0},
13326 13327
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
E
Eric Blake 已提交
13328 13329
    {"snapshot-parent", cmdSnapshotParent, opts_snapshot_parent,
     info_snapshot_parent, 0},
13330 13331 13332
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
13333
};
13334

13335
static const vshCmdDef hostAndHypervisorCmds[] = {
13336 13337 13338 13339 13340
    {"capabilities", cmdCapabilities, NULL, info_capabilities, 0},
    {"connect", cmdConnect, opts_connect, info_connect,
     VSH_CMD_FLAG_NOCONNECT},
    {"freecell", cmdFreecell, opts_freecell, info_freecell, 0},
    {"hostname", cmdHostname, NULL, info_hostname, 0},
13341
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
13342
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
13343
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
13344
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
13345 13346 13347 13348 13349
    {"qemu-monitor-command", cmdQemuMonitorCommand, opts_qemu_monitor_command,
     info_qemu_monitor_command, 0},
    {"sysinfo", cmdSysinfo, NULL, info_sysinfo, 0},
    {"uri", cmdURI, NULL, info_uri, 0},
    {NULL, NULL, NULL, NULL, 0}
K
Karel Zak 已提交
13350 13351
};

13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368
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 已提交
13369 13370 13371 13372
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
13373
static const char *
13374
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
13375
{
13376
    const vshCmdInfo *info;
13377

K
Karel Zak 已提交
13378
    for (info = cmd->info; info && info->name; info++) {
13379
        if (STREQ(info->name, name))
K
Karel Zak 已提交
13380 13381 13382 13383 13384
            return info->data;
    }
    return NULL;
}

13385
static int
E
Eric Blake 已提交
13386
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
13387 13388 13389 13390 13391
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
13392 13393 13394
    *opts_need_arg = 0;
    *opts_required = 0;

13395 13396 13397 13398 13399 13400 13401 13402 13403
    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) {
E
Eric Blake 已提交
13404
            if (opt->flags & VSH_OFLAG_REQ)
13405 13406 13407
                return -1; /* bool options can't be mandatory */
            continue;
        }
E
Eric Blake 已提交
13408 13409
        if (opt->flags & VSH_OFLAG_REQ_OPT) {
            if (opt->flags & VSH_OFLAG_REQ)
L
Lai Jiangshan 已提交
13410 13411 13412 13413
                *opts_required |= 1 << i;
            continue;
        }

13414
        *opts_need_arg |= 1 << i;
E
Eric Blake 已提交
13415
        if (opt->flags & VSH_OFLAG_REQ) {
13416 13417 13418 13419 13420 13421 13422 13423 13424 13425
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
    }
    return 0;
}

13426
static const vshCmdOptDef *
13427 13428
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
13429
{
13430 13431 13432 13433
    int i;

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

13435 13436 13437 13438 13439
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
13440 13441 13442 13443 13444
            if (opt->type == VSH_OT_ARGV) {
                vshError(ctl, _("variable argument <%s> "
                         "should not be used with --<%s>"), name, name);
                return NULL;
            }
13445
            *opts_seen |= 1 << i;
K
Karel Zak 已提交
13446
            return opt;
13447 13448 13449 13450 13451
        }
    }

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

13455
static const vshCmdOptDef *
13456 13457
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
13458
{
13459
    int i;
13460
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
13461

13462 13463 13464 13465
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
13466
    i = ffs(*opts_need_arg) - 1;
13467 13468 13469 13470 13471
    opt = &cmd->opts[i];
    if (opt->type != VSH_OT_ARGV)
        *opts_need_arg &= ~(1 << i);
    *opts_seen |= 1 << i;
    return opt;
K
Karel Zak 已提交
13472 13473
}

13474 13475 13476
/*
 * Checks for required options
 */
13477
static int
13478 13479
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
13480
{
13481
    const vshCmdDef *def = cmd->def;
13482 13483 13484 13485 13486 13487 13488 13489 13490
    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];
13491

13492
            vshError(ctl,
13493
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
13494 13495 13496
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
13497 13498
        }
    }
13499
    return -1;
13500 13501
}

13502
static const vshCmdDef *
13503 13504
vshCmddefSearch(const char *cmdname)
{
13505
    const vshCmdGrp *g;
13506
    const vshCmdDef *c;
13507

13508 13509
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
13510
            if (STREQ(c->name, cmdname))
13511 13512 13513 13514
                return c;
        }
    }

K
Karel Zak 已提交
13515 13516 13517
    return NULL;
}

13518 13519 13520 13521 13522 13523
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
13524
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
13525 13526 13527 13528 13529 13530
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
13531
static bool
13532 13533 13534 13535 13536 13537 13538
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 已提交
13539
        return false;
13540 13541 13542 13543 13544 13545 13546 13547 13548 13549
    } 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 已提交
13550
    return true;
13551 13552
}

E
Eric Blake 已提交
13553
static bool
13554
vshCmddefHelp(vshControl *ctl, const char *cmdname)
13555
{
13556
    const vshCmdDef *def = vshCmddefSearch(cmdname);
13557

K
Karel Zak 已提交
13558
    if (!def) {
13559
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
13560
        return false;
13561
    } else {
E
Eric Blake 已提交
13562 13563
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
13564
        const char *help = _(vshCmddefGetInfo(def, "help"));
13565
        char buf[256];
13566 13567 13568 13569 13570 13571
        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 已提交
13572
            return false;
13573
        }
K
Karel Zak 已提交
13574

13575
        fputs(_("  NAME\n"), stdout);
13576 13577
        fprintf(stdout, "    %s - %s\n", def->name, help);

13578 13579 13580 13581 13582
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
13583
                const char *fmt = "%s";
13584 13585
                switch (opt->type) {
                case VSH_OT_BOOL:
13586
                    fmt = "[--%s]";
13587 13588
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
13589
                    /* xgettext:c-format */
E
Eric Blake 已提交
13590
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>"
13591
                           : _("[--%s <number>]"));
13592 13593
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
13594 13595
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
13596 13597
                    break;
                case VSH_OT_DATA:
E
Eric Blake 已提交
13598
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
13599 13600 13601
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
E
Eric Blake 已提交
13602
                    fmt = (opt->flags & VSH_OFLAG_REQ) ? _("<%s>...")
13603
                           : _("[<%s>]...");
13604 13605
                    break;
                default:
13606
                    assert(0);
13607
                }
13608
                fputc(' ', stdout);
E
Eric Blake 已提交
13609
                fprintf(stdout, fmt, opt->name);
13610
            }
K
Karel Zak 已提交
13611
        }
13612 13613 13614
        fputc('\n', stdout);

        if (desc[0]) {
13615
            /* Print the description only if it's not empty.  */
13616
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
13617
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
13618
        }
13619

K
Karel Zak 已提交
13620
        if (def->opts) {
13621
            const vshCmdOptDef *opt;
13622
            fputs(_("\n  OPTIONS\n"), stdout);
13623
            for (opt = def->opts; opt->name; opt++) {
13624 13625
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
13626
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
13627 13628
                    break;
                case VSH_OT_INT:
13629
                    snprintf(buf, sizeof(buf),
E
Eric Blake 已提交
13630
                             (opt->flags & VSH_OFLAG_REQ) ? _("[--%s] <number>")
13631
                             : _("--%s <number>"), opt->name);
13632 13633
                    break;
                case VSH_OT_STRING:
13634
                    /* OT_STRING should never be VSH_OFLAG_REQ */
13635
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
13636 13637
                    break;
                case VSH_OT_DATA:
13638 13639
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
13640 13641 13642
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
13643 13644
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
13645 13646 13647
                default:
                    assert(0);
                }
13648

E
Eric Blake 已提交
13649
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
13650
            }
K
Karel Zak 已提交
13651 13652 13653
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
13654
    return true;
K
Karel Zak 已提交
13655 13656 13657 13658 13659 13660
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
13661 13662 13663
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
13664 13665
    vshCmdOpt *a = arg;

13666
    while (a) {
K
Karel Zak 已提交
13667
        vshCmdOpt *tmp = a;
13668

K
Karel Zak 已提交
13669 13670
        a = a->next;

13671 13672
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
13673 13674 13675 13676
    }
}

static void
13677
vshCommandFree(vshCmd *cmd)
13678
{
K
Karel Zak 已提交
13679 13680
    vshCmd *c = cmd;

13681
    while (c) {
K
Karel Zak 已提交
13682
        vshCmd *tmp = c;
13683

K
Karel Zak 已提交
13684 13685 13686 13687
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
13688
        VIR_FREE(tmp);
K
Karel Zak 已提交
13689 13690 13691
    }
}

E
Eric Blake 已提交
13692 13693 13694 13695 13696 13697 13698 13699 13700 13701 13702
/**
 * vshCommandOpt:
 * @cmd: parsed command line to search
 * @name: option name to search for
 * @opt: result of the search
 *
 * Look up an option passed to CMD by NAME.  Returns 1 with *OPT set
 * to the option if found, 0 with *OPT set to NULL if the name is
 * valid and the option is not required, -1 with *OPT set to NULL if
 * the option is required but not present, and -2 if NAME is not valid
 * (-2 indicates a programming error).  No error messages are issued.
K
Karel Zak 已提交
13703
 */
E
Eric Blake 已提交
13704 13705
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
13706
{
E
Eric Blake 已提交
13707 13708
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
13709

E
Eric Blake 已提交
13710 13711 13712 13713 13714 13715 13716
    /* See if option is present on command line.  */
    while (candidate) {
        if (STREQ(candidate->def->name, name)) {
            *opt = candidate;
            return 1;
        }
        candidate = candidate->next;
K
Karel Zak 已提交
13717
    }
E
Eric Blake 已提交
13718 13719 13720 13721 13722 13723 13724

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
E
Eric Blake 已提交
13725
            return (valid->flags & VSH_OFLAG_REQ) == 0 ? 0 : -1;
E
Eric Blake 已提交
13726 13727 13728 13729
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
13730 13731
}

E
Eric Blake 已提交
13732 13733
/**
 * vshCommandOptInt:
13734 13735 13736 13737 13738 13739 13740
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Convert option to int
 * Return value:
 * >0 if option found and valid (@value updated)
E
Eric Blake 已提交
13741
 * 0 if option not found and not required (@value untouched)
13742
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
13743 13744
 */
static int
13745
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
13746
{
E
Eric Blake 已提交
13747 13748 13749
    vshCmdOpt *arg;
    int ret;
    int num;
13750
    char *end_p = NULL;
13751

E
Eric Blake 已提交
13752 13753 13754 13755 13756 13757 13758
    ret = vshCommandOpt(cmd, name, &arg);
    if (ret <= 0)
        return ret;
    if (!arg->data) {
        /* only possible on bool, but if name is bool, this is a
         * programming bug */
        return -2;
13759
    }
E
Eric Blake 已提交
13760 13761 13762 13763 13764 13765 13766

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
13767 13768
}

13769

E
Eric Blake 已提交
13770 13771 13772 13773 13774 13775
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
13776 13777 13778 13779 13780 13781
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
13782 13783 13784
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
13785 13786
    char *end_p = NULL;

E
Eric Blake 已提交
13787 13788 13789 13790 13791 13792 13793
    ret = vshCommandOpt(cmd, name, &arg);
    if (ret <= 0)
        return ret;
    if (!arg->data) {
        /* only possible on bool, but if name is bool, this is a
         * programming bug */
        return -2;
13794
    }
E
Eric Blake 已提交
13795 13796 13797 13798 13799 13800 13801

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13802 13803 13804
}


13805
/*
E
Eric Blake 已提交
13806 13807 13808 13809 13810
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
13811 13812 13813 13814 13815
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
13816
{
E
Eric Blake 已提交
13817 13818
    vshCmdOpt *arg;
    int ret;
13819
    unsigned long num;
13820 13821
    char *end_p = NULL;

E
Eric Blake 已提交
13822 13823 13824 13825 13826 13827 13828
    ret = vshCommandOpt(cmd, name, &arg);
    if (ret <= 0)
        return ret;
    if (!arg->data) {
        /* only possible on bool, but if name is bool, this is a
         * programming bug */
        return -2;
13829
    }
E
Eric Blake 已提交
13830 13831 13832 13833 13834 13835 13836

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13837 13838
}

E
Eric Blake 已提交
13839 13840 13841 13842 13843 13844
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
13845
 * Returns option as STRING
E
Eric Blake 已提交
13846 13847 13848 13849
 * Return value:
 * >0 if option found and valid (@value updated)
 * 0 if option not found and not required (@value untouched)
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
13850
 */
13851 13852
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
13853
{
E
Eric Blake 已提交
13854 13855 13856 13857 13858 13859 13860 13861 13862 13863
    vshCmdOpt *arg;
    int ret;

    ret = vshCommandOpt(cmd, name, &arg);
    if (ret <= 0)
        return ret;
    if (!arg->data) {
        /* only possible on bool, but if name is bool, this is a
         * programming bug */
        return -2;
13864
    }
13865

E
Eric Blake 已提交
13866
    if (!*arg->data && !(arg->def->flags & VSH_OFLAG_EMPTY_OK)) {
E
Eric Blake 已提交
13867 13868 13869 13870
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
13871 13872
}

E
Eric Blake 已提交
13873 13874 13875 13876 13877 13878
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
13879
 * Returns option as long long
13880
 * See vshCommandOptInt()
13881
 */
13882 13883 13884
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
13885
{
E
Eric Blake 已提交
13886 13887
    vshCmdOpt *arg;
    int ret;
13888
    long long num;
13889 13890
    char *end_p = NULL;

E
Eric Blake 已提交
13891 13892 13893 13894 13895 13896 13897
    ret = vshCommandOpt(cmd, name, &arg);
    if (ret <= 0)
        return ret;
    if (!arg->data) {
        /* only possible on bool, but if name is bool, this is a
         * programming bug */
        return -2;
13898
    }
E
Eric Blake 已提交
13899 13900 13901 13902 13903 13904 13905

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13906 13907
}

E
Eric Blake 已提交
13908 13909 13910 13911 13912 13913 13914 13915 13916
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
13917 13918 13919 13920
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
13921 13922
    vshCmdOpt *arg;
    int ret;
13923 13924 13925
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
13926 13927 13928 13929 13930 13931 13932
    ret = vshCommandOpt(cmd, name, &arg);
    if (ret <= 0)
        return ret;
    if (!arg->data) {
        /* only possible on bool, but if name is bool, this is a
         * programming bug */
        return -2;
13933
    }
E
Eric Blake 已提交
13934 13935 13936 13937 13938 13939 13940

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13941 13942 13943
}


E
Eric Blake 已提交
13944 13945 13946 13947 13948 13949 13950 13951 13952
/**
 * vshCommandOptBool:
 * @cmd command reference
 * @name option name
 *
 * Returns true/false if the option exists.  Note that this does NOT
 * validate whether the option is actually boolean, or even whether
 * name is legal; so that this can be used to probe whether a data
 * option is present without actually using that data.
K
Karel Zak 已提交
13953
 */
E
Eric Blake 已提交
13954
static bool
13955
vshCommandOptBool(const vshCmd *cmd, const char *name)
13956
{
E
Eric Blake 已提交
13957 13958 13959
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
13960 13961
}

E
Eric Blake 已提交
13962 13963 13964 13965 13966
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
13967 13968
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
13969
 *
13970
 * Requires that a VSH_OT_ARGV option be last in the
13971 13972
 * list of supported options in CMD->def->opts.
 */
13973 13974
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
13975
{
13976
    opt = opt ? opt->next : cmd->opts;
13977 13978

    while (opt) {
E
Eric Blake 已提交
13979
        if (opt->def->type == VSH_OT_ARGV) {
13980
            return opt;
13981 13982 13983 13984 13985 13986
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004
/* 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)
14005
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
14006 14007 14008
                 cmd->def->name, optname);
    return found;
}
14009

K
Karel Zak 已提交
14010
static virDomainPtr
J
Jim Meyering 已提交
14011
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
14012
                      const char **name, int flag)
14013
{
K
Karel Zak 已提交
14014
    virDomainPtr dom = NULL;
14015
    const char *n = NULL;
K
Karel Zak 已提交
14016
    int id;
J
Jim Meyering 已提交
14017 14018 14019
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
14020

14021
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14022 14023
        return NULL;

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

K
Karel Zak 已提交
14027 14028
    if (name)
        *name = n;
14029

K
Karel Zak 已提交
14030
    /* try it by ID */
14031
    if (flag & VSH_BYID) {
14032
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
14033 14034
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
14035 14036 14037
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
14038
    }
K
Karel Zak 已提交
14039
    /* try it by UUID */
14040
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
14041
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
14042
                 cmd->def->name, optname);
K
Karel Zak 已提交
14043
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
14044
    }
K
Karel Zak 已提交
14045
    /* try it by NAME */
14046
    if (dom==NULL && (flag & VSH_BYNAME)) {
14047
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
14048
                 cmd->def->name, optname);
K
Karel Zak 已提交
14049
        dom = virDomainLookupByName(ctl->conn, n);
14050
    }
K
Karel Zak 已提交
14051

14052
    if (!dom)
14053
        vshError(ctl, _("failed to get domain '%s'"), n);
14054

K
Karel Zak 已提交
14055 14056 14057
    return dom;
}

14058
static virNetworkPtr
J
Jim Meyering 已提交
14059
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
14060
                       const char **name, int flag)
14061 14062
{
    virNetworkPtr network = NULL;
14063
    const char *n = NULL;
J
Jim Meyering 已提交
14064 14065 14066
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
14067

14068
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14069 14070
        return NULL;

14071
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14072 14073 14074 14075 14076 14077
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
14078
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14079
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
14080
                 cmd->def->name, optname);
14081 14082 14083 14084
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
14085
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
14086 14087 14088 14089 14090
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
14091
        vshError(ctl, _("failed to get network '%s'"), n);
14092 14093 14094 14095

    return network;
}

14096 14097 14098

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
14099
                        const char **name, int flag)
14100 14101
{
    virNWFilterPtr nwfilter = NULL;
14102
    const char *n = NULL;
14103 14104 14105 14106
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14107
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14108 14109
        return NULL;

14110
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14111 14112 14113 14114 14115 14116 14117
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14118
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
14119 14120 14121 14122 14123
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
14124
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
14125 14126 14127 14128 14129 14130 14131 14132 14133 14134
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

14135 14136
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
14137
                         const char **name, int flag)
14138 14139
{
    virInterfacePtr iface = NULL;
14140
    const char *n = NULL;
14141 14142 14143 14144
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14145
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14146 14147
        return NULL;

14148
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14149 14150 14151 14152 14153 14154
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
14155
    if ((flag & VSH_BYNAME)) {
14156
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
14157 14158 14159 14160 14161
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
14162
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
14163 14164 14165 14166 14167
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
14168
        vshError(ctl, _("failed to get interface '%s'"), n);
14169 14170 14171 14172

    return iface;
}

14173
static virStoragePoolPtr
14174
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
14175
                    const char **name, int flag)
14176 14177
{
    virStoragePoolPtr pool = NULL;
14178
    const char *n = NULL;
14179

14180
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14181 14182
        return NULL;

14183
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14184 14185 14186 14187 14188 14189
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
14190
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14191
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
14192
                 cmd->def->name, optname);
14193 14194 14195
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
14196
    if (pool == NULL && (flag & VSH_BYNAME)) {
14197
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
14198 14199 14200 14201 14202
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
14203
        vshError(ctl, _("failed to get pool '%s'"), n);
14204 14205 14206 14207 14208

    return pool;
}

static virStorageVolPtr
14209
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
14210 14211
                   const char *optname,
                   const char *pooloptname,
14212
                   const char **name, int flag)
14213 14214 14215
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
14216
    const char *n = NULL, *p = NULL;
14217

14218
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14219 14220
        return NULL;

14221
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
14222
        vshError(ctl, "%s", _("missing option"));
14223
        return NULL;
14224
    }
14225 14226 14227 14228

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

14229
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
14230 14231 14232 14233 14234
             cmd->def->name, optname, n);

    if (name)
        *name = n;

14235
    /* try it by name */
14236
    if (pool && (flag & VSH_BYNAME)) {
14237
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
14238 14239 14240
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
14241
    /* try it by key */
14242
    if (vol == NULL && (flag & VSH_BYUUID)) {
14243
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
14244 14245 14246
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
14247
    /* try it by path */
14248
    if (vol == NULL && (flag & VSH_BYUUID)) {
14249
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
14250 14251 14252 14253 14254
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
14255
        vshError(ctl, _("failed to get vol '%s'"), n);
14256 14257 14258 14259 14260 14261 14262

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

14263
static virSecretPtr
14264
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
14265 14266
{
    virSecretPtr secret = NULL;
14267
    const char *n = NULL;
14268 14269 14270 14271 14272
    const char *optname = "secret";

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

14273
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14274 14275
        return NULL;

14276 14277
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
14278 14279 14280 14281 14282 14283 14284

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
14285
        vshError(ctl, _("failed to get secret '%s'"), n);
14286 14287 14288 14289

    return secret;
}

K
Karel Zak 已提交
14290 14291 14292
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
14293
static bool
14294
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
14295
{
E
Eric Blake 已提交
14296
    bool ret = true;
14297 14298

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

14302 14303
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
14304 14305
            vshReconnect(ctl);

14306
        if (enable_timing)
K
Karel Zak 已提交
14307
            GETTIMEOFDAY(&before);
14308

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

14311
        if (enable_timing)
K
Karel Zak 已提交
14312
            GETTIMEOFDAY(&after);
14313

14314
        if (!ret)
J
John Levon 已提交
14315 14316
            virshReportError(ctl);

14317
        /* try to automatically catch disconnections */
14318
        if (!ret &&
14319 14320 14321 14322 14323 14324 14325 14326 14327
            ((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);

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

14331
        if (enable_timing)
14332
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
14333 14334
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
14335
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
14336 14337 14338 14339 14340 14341
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
14342
 * Command parsing
K
Karel Zak 已提交
14343 14344 14345
 * ---------------
 */

14346 14347 14348 14349 14350 14351 14352 14353 14354 14355
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 已提交
14356
    /* vshCommandStringGetArg() */
14357
    char *pos;
L
Lai Jiangshan 已提交
14358 14359 14360
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
14361 14362
} vshCommandParser;

E
Eric Blake 已提交
14363
static bool
14364
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
14365
{
K
Karel Zak 已提交
14366 14367 14368
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
14369

K
Karel Zak 已提交
14370 14371 14372 14373
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
14374

14375
    while (1) {
K
Karel Zak 已提交
14376
        vshCmdOpt *last = NULL;
14377
        const vshCmdDef *cmd = NULL;
14378
        vshCommandToken tk;
L
Lai Jiangshan 已提交
14379
        bool data_only = false;
14380 14381 14382
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
14383

K
Karel Zak 已提交
14384
        first = NULL;
14385

14386
        while (1) {
14387
            const vshCmdOptDef *opt = NULL;
14388

K
Karel Zak 已提交
14389
            tkdata = NULL;
14390
            tk = parser->getNextArg(ctl, parser, &tkdata);
14391 14392

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14393
                goto syntaxError;
H
Hu Tao 已提交
14394 14395
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
14396
                break;
H
Hu Tao 已提交
14397
            }
14398 14399

            if (cmd == NULL) {
K
Karel Zak 已提交
14400 14401
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
14402
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
14403
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
14404
                }
14405 14406 14407 14408 14409 14410 14411
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
14412
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
14413 14414 14415 14416
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
14417 14418 14419 14420 14421
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
14422 14423
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
14424
                    VIR_FREE(optstr);
K
Karel Zak 已提交
14425 14426
                    goto syntaxError;
                }
14427
                VIR_FREE(tkdata);
K
Karel Zak 已提交
14428 14429 14430

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
14431 14432 14433
                    if (optstr)
                        tkdata = optstr;
                    else
14434
                        tk = parser->getNextArg(ctl, parser, &tkdata);
14435
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14436
                        goto syntaxError;
14437
                    if (tk != VSH_TK_ARG) {
14438
                        vshError(ctl,
14439
                                 _("expected syntax: --%s <%s>"),
14440 14441
                                 opt->name,
                                 opt->type ==
14442
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
14443 14444
                        goto syntaxError;
                    }
14445
                    opts_need_arg &= ~opts_seen;
14446 14447 14448 14449 14450 14451 14452 14453
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
14454
                }
L
Lai Jiangshan 已提交
14455 14456 14457 14458
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
14459
            } else {
L
Lai Jiangshan 已提交
14460
get_data:
14461 14462
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
14463
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
14464 14465 14466 14467 14468
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
14469
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
14470

K
Karel Zak 已提交
14471 14472 14473 14474
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
14475

K
Karel Zak 已提交
14476 14477 14478 14479 14480
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
14481

14482
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
14483 14484
                         cmd->name,
                         opt->name,
14485 14486
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
14487 14488
            }
        }
14489

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

K
Karel Zak 已提交
14494 14495 14496 14497
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

14498
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
14499
                VIR_FREE(c);
14500
                goto syntaxError;
14501
            }
14502

K
Karel Zak 已提交
14503 14504 14505 14506 14507 14508
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
14509 14510 14511

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
14512
    }
14513

E
Eric Blake 已提交
14514
    return true;
K
Karel Zak 已提交
14515

14516
 syntaxError:
14517
    if (ctl->cmd) {
K
Karel Zak 已提交
14518
        vshCommandFree(ctl->cmd);
14519 14520
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
14521 14522
    if (first)
        vshCommandOptFree(first);
14523
    VIR_FREE(tkdata);
E
Eric Blake 已提交
14524
    return false;
K
Karel Zak 已提交
14525 14526
}

14527 14528 14529 14530 14531 14532 14533 14534 14535 14536 14537 14538 14539 14540 14541 14542 14543 14544
/* --------------------
 * 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 已提交
14545 14546
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
14547 14548 14549 14550
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
14551
        return false;
14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600 14601 14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623

    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 已提交
14624 14625
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
14626 14627 14628 14629
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
14630
        return false;
14631 14632 14633 14634 14635 14636

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

K
Karel Zak 已提交
14637
/* ---------------
14638
 * Misc utils
K
Karel Zak 已提交
14639 14640
 * ---------------
 */
14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652 14653 14654 14655 14656 14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668
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 已提交
14669
static const char *
14670 14671
vshDomainStateToString(int state)
{
14672 14673
    /* Can't use virDomainStateTypeToString, because we want to mark
     * strings for translation.  */
14674
    switch ((virDomainState) state) {
14675
    case VIR_DOMAIN_RUNNING:
14676
        return N_("running");
14677
    case VIR_DOMAIN_BLOCKED:
14678
        return N_("idle");
14679
    case VIR_DOMAIN_PAUSED:
14680
        return N_("paused");
14681
    case VIR_DOMAIN_SHUTDOWN:
14682
        return N_("in shutdown");
14683
    case VIR_DOMAIN_SHUTOFF:
14684
        return N_("shut off");
14685
    case VIR_DOMAIN_CRASHED:
14686
        return N_("crashed");
14687
    case VIR_DOMAIN_NOSTATE:
14688
    default:
14689
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
14690
    }
14691
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
14692 14693
}

14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740 14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765 14766 14767 14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782 14783 14784 14785 14786 14787 14788 14789
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;
14790 14791 14792

    default:
        ;
14793 14794 14795 14796 14797
    }

    return N_("unknown");
}

14798 14799 14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814
static const char *
vshDomainControlStateToString(int state)
{
    switch ((virDomainControlState) state) {
    case VIR_DOMAIN_CONTROL_OK:
        return N_("ok");
    case VIR_DOMAIN_CONTROL_JOB:
        return N_("background job");
    case VIR_DOMAIN_CONTROL_OCCUPIED:
        return N_("occupied");
    case VIR_DOMAIN_CONTROL_ERROR:
        return N_("error");
    }

    return N_("unknown");
}

14815 14816 14817 14818
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
14819
    case VIR_VCPU_OFFLINE:
14820
        return N_("offline");
14821
    case VIR_VCPU_BLOCKED:
14822
        return N_("idle");
14823
    case VIR_VCPU_RUNNING:
14824
        return N_("running");
14825
    default:
14826
        ;/*FALLTHROUGH*/
14827
    }
14828
    return N_("no state");
14829 14830
}

E
Eric Blake 已提交
14831
static bool
14832
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
14833
{
14834 14835
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
14836 14837
     */
    if (!conn) {
14838
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
14839
        return false;
K
Karel Zak 已提交
14840
    }
E
Eric Blake 已提交
14841
    return true;
K
Karel Zak 已提交
14842 14843
}

K
Karel Zak 已提交
14844
static void
14845
vshDebug(vshControl *ctl, int level, const char *format, ...)
14846
{
K
Karel Zak 已提交
14847
    va_list ap;
14848
    char *str;
K
Karel Zak 已提交
14849

14850 14851 14852 14853 14854 14855 14856
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

14857
    va_start(ap, format);
14858
    vshOutputLogFile(ctl, level, format, ap);
14859 14860
    va_end(ap);

K
Karel Zak 已提交
14861
    va_start(ap, format);
14862 14863 14864 14865 14866
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
14867
    va_end(ap);
14868 14869
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
14870 14871 14872
}

static void
14873
vshPrintExtra(vshControl *ctl, const char *format, ...)
14874
{
K
Karel Zak 已提交
14875
    va_list ap;
14876
    char *str;
14877

14878
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
14879
        return;
14880

K
Karel Zak 已提交
14881
    va_start(ap, format);
14882 14883 14884 14885 14886
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
14887
    va_end(ap);
14888
    fputs(str, stdout);
14889
    VIR_FREE(str);
K
Karel Zak 已提交
14890 14891
}

K
Karel Zak 已提交
14892

K
Karel Zak 已提交
14893
static void
14894
vshError(vshControl *ctl, const char *format, ...)
14895
{
K
Karel Zak 已提交
14896
    va_list ap;
14897
    char *str;
14898

14899 14900 14901 14902 14903
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
14904

14905 14906 14907 14908
    /* Most output is to stdout, but if someone ran virsh 2>&1, then
     * printing to stderr will not interleave correctly with stdout
     * unless we flush between every transition between streams.  */
    fflush(stdout);
14909
    fputs(_("error: "), stderr);
14910

K
Karel Zak 已提交
14911
    va_start(ap, format);
14912 14913 14914
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
14915 14916
    va_end(ap);

14917
    fprintf(stderr, "%s\n", NULLSTR(str));
14918
    fflush(stderr);
14919
    VIR_FREE(str);
K
Karel Zak 已提交
14920 14921
}

14922

K
Karel Zak 已提交
14923
/*
14924
 * Initialize connection.
K
Karel Zak 已提交
14925
 */
E
Eric Blake 已提交
14926
static bool
14927
vshInit(vshControl *ctl)
14928
{
14929 14930
    char *debugEnv;

K
Karel Zak 已提交
14931
    if (ctl->conn)
E
Eric Blake 已提交
14932
        return false;
K
Karel Zak 已提交
14933

J
Jiri Denemark 已提交
14934
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
14935 14936 14937
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
14938 14939 14940
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
14941 14942
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
14943 14944
            } else {
                ctl->debug = debug;
14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

14957 14958
    vshOpenLogFile(ctl);

14959 14960
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
14961

14962 14963 14964
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

14965
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
14966
        return false;
14967

14968 14969 14970 14971
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
14972

14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983
        /* Connecting to a named connection must succeed, but we delay
         * connecting to the default connection until we need it
         * (since the first command might be 'connect' which allows a
         * non-default connection, or might be 'help' which needs no
         * connection).
         */
        if (!ctl->conn) {
            virshReportError(ctl);
            vshError(ctl, "%s", _("failed to connect to the hypervisor"));
            return false;
        }
14984
    }
K
Karel Zak 已提交
14985

E
Eric Blake 已提交
14986
    return true;
K
Karel Zak 已提交
14987 14988
}

14989 14990
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

14991 14992 14993 14994 14995 14996 14997 14998 14999 15000 15001 15002 15003 15004 15005 15006 15007 15008 15009
/**
 * 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:
15010
                vshError(ctl, "%s",
J
Jim Meyering 已提交
15011
                         _("failed to get the log file information"));
15012
                exit(EXIT_FAILURE);
15013 15014 15015
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
15016 15017
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
15018 15019 15020 15021
        }
    }

    /* log file open */
15022
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
15023
        vshError(ctl, "%s",
J
Jim Meyering 已提交
15024
                 _("failed to open the log file. check the log file path"));
15025
        exit(EXIT_FAILURE);
15026 15027 15028 15029 15030 15031 15032 15033 15034
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
15035 15036
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
15037
{
15038 15039 15040
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
15041 15042 15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053 15054
    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);
15055
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
15056 15057 15058 15059 15060 15061
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
15062 15063
                      SIGN_NAME,
                      (int) getpid());
15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083
    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;
    }
15084 15085 15086
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
15087

15088 15089
    if (virBufferError(&buf))
        goto error;
15090

15091 15092 15093 15094 15095
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
15096
    }
15097

15098 15099 15100 15101 15102 15103 15104 15105 15106 15107 15108
    /* 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);
15109 15110 15111 15112 15113 15114 15115 15116 15117 15118 15119
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
15120 15121 15122
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
15123 15124 15125
    }

    if (ctl->logfile) {
15126
        VIR_FREE(ctl->logfile);
15127 15128 15129 15130
        ctl->logfile = NULL;
    }
}

15131
#ifdef USE_READLINE
15132

K
Karel Zak 已提交
15133 15134 15135 15136 15137
/* -----------------
 * Readline stuff
 * -----------------
 */

15138
/*
K
Karel Zak 已提交
15139 15140
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
15141
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
15142 15143
 */
static char *
15144 15145
vshReadlineCommandGenerator(const char *text, int state)
{
15146
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
15147
    const char *name;
15148 15149
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
15150 15151

    if (!state) {
15152 15153
        grp_list_index = 0;
        cmd_list_index = 0;
15154
        len = strlen(text);
K
Karel Zak 已提交
15155 15156
    }

15157 15158
    grp = cmdGroups;

K
Karel Zak 已提交
15159
    /* Return the next name which partially matches from the
15160
     * command list.
K
Karel Zak 已提交
15161
     */
15162 15163 15164 15165 15166 15167 15168 15169 15170 15171 15172 15173 15174 15175
    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 已提交
15176 15177 15178 15179 15180 15181 15182
    }

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

static char *
15183 15184
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
15185
    static int list_index, len;
15186
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
15187
    const char *name;
K
Karel Zak 已提交
15188 15189 15190 15191 15192 15193 15194 15195 15196

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

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

15197
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
15198
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
15199 15200 15201

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
15202
        len = strlen(text);
15203
        VIR_FREE(cmdname);
K
Karel Zak 已提交
15204 15205 15206 15207
    }

    if (!cmd)
        return NULL;
15208

15209 15210 15211
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
15212
    while ((name = cmd->opts[list_index].name)) {
15213
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
15214
        char *res;
15215

K
Karel Zak 已提交
15216
        list_index++;
15217

15218
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
15219 15220
            /* ignore non --option */
            continue;
15221

K
Karel Zak 已提交
15222
        if (len > 2) {
15223
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
15224 15225
                continue;
        }
15226
        res = vshMalloc(NULL, strlen(name) + 3);
15227
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
15228 15229 15230 15231 15232 15233 15234 15235
        return res;
    }

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

static char **
15236 15237 15238
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
15239 15240
    char **matches = (char **) NULL;

15241
    if (start == 0)
K
Karel Zak 已提交
15242
        /* command name generator */
15243
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
15244 15245
    else
        /* commands options */
15246
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
15247 15248 15249 15250
    return matches;
}


15251 15252
static int
vshReadlineInit(vshControl *ctl)
15253
{
15254 15255
    char *userdir = NULL;

K
Karel Zak 已提交
15256 15257 15258 15259 15260
    /* 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;
15261 15262 15263

    /* Limit the total size of the history buffer */
    stifle_history(500);
15264 15265

    /* Prepare to read/write history from/to the ~/.virsh/history file */
15266
    userdir = virGetUserDirectory(getuid());
15267

15268 15269
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
15270
        return -1;
15271
    }
15272 15273 15274

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15275
        VIR_FREE(userdir);
15276 15277 15278 15279 15280
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15281
        VIR_FREE(userdir);
15282 15283 15284
        return -1;
    }

15285
    VIR_FREE(userdir);
15286 15287 15288 15289 15290 15291 15292 15293 15294 15295 15296 15297 15298 15299 15300 15301 15302 15303

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

15304 15305
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
15306 15307
}

15308 15309 15310 15311 15312 15313
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

15314
#else /* !USE_READLINE */
15315

15316 15317 15318 15319 15320 15321 15322
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

15323
static void
15324
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
15325 15326 15327 15328 15329 15330 15331 15332 15333 15334 15335 15336 15337 15338 15339 15340 15341 15342 15343 15344 15345 15346 15347
{
    /* 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);
}

15348
#endif /* !USE_READLINE */
15349

K
Karel Zak 已提交
15350
/*
J
Jim Meyering 已提交
15351
 * Deinitialize virsh
K
Karel Zak 已提交
15352
 */
E
Eric Blake 已提交
15353
static bool
15354
vshDeinit(vshControl *ctl)
15355
{
15356
    vshReadlineDeinit(ctl);
15357
    vshCloseLogFile(ctl);
15358
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
15359
    if (ctl->conn) {
15360 15361 15362
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
15363 15364
        }
    }
D
Daniel P. Berrange 已提交
15365 15366
    virResetLastError();

E
Eric Blake 已提交
15367
    return true;
K
Karel Zak 已提交
15368
}
15369

K
Karel Zak 已提交
15370 15371 15372 15373
/*
 * Print usage
 */
static void
15374
vshUsage(void)
15375
{
15376
    const vshCmdGrp *grp;
15377
    const vshCmdDef *cmd;
15378

L
Lai Jiangshan 已提交
15379 15380
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
15381 15382 15383
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
15384
                      "    -d | --debug <num>      debug level [0-4]\n"
15385 15386 15387 15388
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
15389
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
15390
                      "    -V | --version=long     version and full options\n\n"
15391
                      "  commands (non interactive mode):\n\n"), progname, progname);
15392

15393 15394
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
15395

15396 15397 15398 15399 15400 15401 15402 15403 15404
        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"));
15405 15406 15407
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
15408 15409
}

15410 15411 15412 15413 15414 15415 15416 15417 15418 15419
/*
 * 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 已提交
15420 15421
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
15422 15423 15424 15425 15426 15427 15428 15429 15430 15431 15432 15433 15434 15435 15436 15437 15438 15439 15440 15441 15442 15443 15444 15445 15446 15447 15448 15449 15450 15451 15452 15453 15454 15455 15456
#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 已提交
15457
    vshPrint(ctl, "%s", _(" Networking:"));
15458 15459 15460 15461 15462 15463 15464 15465 15466 15467 15468 15469 15470 15471 15472 15473 15474 15475 15476 15477 15478 15479 15480 15481 15482 15483
#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 已提交
15484
    vshPrint(ctl, "%s", _(" Storage:"));
15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499 15500 15501 15502 15503 15504 15505 15506 15507
#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 已提交
15508
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
15509
#ifdef WITH_SECDRIVER_APPARMOR
15510 15511 15512 15513 15514 15515 15516 15517 15518 15519 15520 15521 15522 15523 15524 15525 15526 15527 15528 15529 15530 15531 15532
    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 已提交
15533 15534 15535 15536
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
15537
static bool
15538
vshParseArgv(vshControl *ctl, int argc, char **argv)
15539
{
15540 15541
    bool help = false;
    int arg;
K
Karel Zak 已提交
15542
    struct option opt[] = {
E
Eric Blake 已提交
15543 15544 15545 15546 15547 15548 15549 15550 15551
        {"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}
15552 15553
    };

15554 15555 15556
    /* 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. */
15557
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
15558
        switch (arg) {
15559
        case 'd':
D
Daniel Veillard 已提交
15560
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
15561
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
15562 15563
                exit(EXIT_FAILURE);
            }
15564 15565
            break;
        case 'h':
15566
            help = true;
15567 15568
            break;
        case 'q':
E
Eric Blake 已提交
15569
            ctl->quiet = true;
15570 15571
            break;
        case 't':
E
Eric Blake 已提交
15572
            ctl->timing = true;
15573 15574 15575 15576
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
15577 15578 15579 15580 15581 15582
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
15583 15584 15585
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
15586
        case 'r':
E
Eric Blake 已提交
15587
            ctl->readonly = true;
15588
            break;
15589 15590 15591
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
15592
        default:
15593 15594
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
15595 15596 15597 15598
        }
    }

    if (help) {
15599 15600
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
15601 15602
            exit(EXIT_FAILURE);
        }
15603 15604 15605

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
15606
        exit(EXIT_SUCCESS);
15607 15608
    }

15609
    if (argc > optind) {
K
Karel Zak 已提交
15610
        /* parse command */
E
Eric Blake 已提交
15611
        ctl->imode = false;
15612
        if (argc - optind == 1) {
15613
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
15614
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
15615
        } else {
15616
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
15617 15618
        }
    }
E
Eric Blake 已提交
15619
    return true;
K
Karel Zak 已提交
15620 15621
}

15622 15623 15624 15625
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
15626
    char *defaultConn;
E
Eric Blake 已提交
15627
    bool ret = true;
K
Karel Zak 已提交
15628

15629 15630 15631
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
15632
    ctl->debug = VSH_DEBUG_DEFAULT;
15633

15634 15635
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
15636
        /* failure to setup locale is not fatal */
15637
    }
15638
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
15639
        perror("bindtextdomain");
E
Eric Blake 已提交
15640
        return EXIT_FAILURE;
15641
    }
15642
    if (!textdomain(PACKAGE)) {
15643
        perror("textdomain");
E
Eric Blake 已提交
15644
        return EXIT_FAILURE;
15645 15646
    }

15647 15648 15649 15650 15651
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

15652
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
15653 15654 15655
        progname = argv[0];
    else
        progname++;
15656

15657
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
15658
        ctl->name = vshStrdup(ctl, defaultConn);
15659 15660
    }

D
Daniel P. Berrange 已提交
15661 15662
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
15663
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
15664
    }
15665

D
Daniel P. Berrange 已提交
15666 15667
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
15668
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
15669
    }
15670

K
Karel Zak 已提交
15671
    if (!ctl->imode) {
15672
        ret = vshCommandRun(ctl, ctl->cmd);
15673
    } else {
K
Karel Zak 已提交
15674 15675
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
15676
            vshPrint(ctl,
15677
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
15678
                     progname);
J
Jim Meyering 已提交
15679
            vshPrint(ctl, "%s",
15680
                     _("Type:  'help' for help with commands\n"
15681
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
15682
        }
15683 15684 15685 15686 15687 15688

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
15689
        do {
15690
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
15691
            ctl->cmdstr =
15692
                vshReadline(ctl, prompt);
15693 15694
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
15695
            if (*ctl->cmdstr) {
15696
#if USE_READLINE
K
Karel Zak 已提交
15697
                add_history(ctl->cmdstr);
15698
#endif
15699
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
15700 15701
                    vshCommandRun(ctl, ctl->cmd);
            }
15702
            VIR_FREE(ctl->cmdstr);
15703
        } while (ctl->imode);
K
Karel Zak 已提交
15704

15705 15706
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
15707
    }
15708

K
Karel Zak 已提交
15709 15710
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
15711
}