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

13
#include <config.h>
14

15
#include <stdio.h>
K
Karel Zak 已提交
16 17 18
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
19
#include <unistd.h>
20
#include <errno.h>
K
Karel Zak 已提交
21
#include <getopt.h>
22
#include <sys/types.h>
K
Karel Zak 已提交
23
#include <sys/time.h>
E
Eric Blake 已提交
24
#include <sys/wait.h>
J
Jim Meyering 已提交
25
#include "c-ctype.h"
26
#include <fcntl.h>
27
#include <locale.h>
28
#include <time.h>
29
#include <limits.h>
30
#include <assert.h>
31
#include <sys/stat.h>
32
#include <inttypes.h>
33
#include <signal.h>
34
#include <poll.h>
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
    struct _virDomainBlockStats stats;
1073 1074 1075
    virTypedParameterPtr params = NULL;
    int rc, nparams = 0;
    bool ret = false;
1076

1077
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1078
        return false;
1079

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

1083 1084
    if (vshCommandOptString (cmd, "device", &device) <= 0)
        goto cleanup;
1085

1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
    rc = virDomainBlockStatsFlags(dom, device, NULL, &nparams, 0);

    /* It might fail when virDomainBlockStatsFlags is not
     * supported on older libvirt, fallback to use virDomainBlockStats
     * then.
     */
    if (rc < 0) {
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virshReportError(ctl);
            goto cleanup;
        } else {
            virFreeError(last_error);
            last_error = NULL;

            if (virDomainBlockStats (dom, device, &stats,
                                     sizeof stats) == -1) {
                vshError(ctl, _("Failed to get block stats %s %s"),
                         name, device);
                goto cleanup;
            }

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

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

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

1119 1120 1121 1122 1123 1124
            if (stats.errs >= 0)
                vshPrint (ctl, "%s errs %lld\n", device, stats.errs);
        }
    } else {
        params = vshMalloc(ctl, sizeof(*params) * nparams);
        memset(params, 0, sizeof(*params) * nparams);
1125

1126 1127 1128 1129
        if (virDomainBlockStatsFlags (dom, device, params, &nparams, 0) < 0) {
            vshError(ctl, _("Failed to get block stats %s %s"), name, device);
            goto cleanup;
        }
1130

1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
        int i;
        /* XXX: The output sequence will be different. */
        for (i = 0; i < nparams; i++) {
            switch(params[i].type) {
            case VIR_TYPED_PARAM_INT:
                vshPrint (ctl, "%s %s %d\n", device,
                          params[i].field, params[i].value.i);
                break;
            case VIR_TYPED_PARAM_UINT:
                vshPrint (ctl, "%s %s %u\n", device,
                          params[i].field, params[i].value.ui);
                break;
            case VIR_TYPED_PARAM_LLONG:
                vshPrint (ctl, "%s %s %lld\n", device,
                          params[i].field, params[i].value.l);
                break;
            case VIR_TYPED_PARAM_ULLONG:
                vshPrint (ctl, "%s %s %llu\n", device,
                          params[i].field, params[i].value.ul);
                break;
            case VIR_TYPED_PARAM_DOUBLE:
                vshPrint (ctl, "%s %s %f\n", device,
                          params[i].field, params[i].value.d);
                break;
            case VIR_TYPED_PARAM_BOOLEAN:
                vshPrint (ctl, "%s %s %s\n", device,
                          params[i].field, params[i].value.b ? _("yes") : _("no"));
                break;
            default:
                vshError(ctl, _("unimplemented block statistics parameter type"));
            }
1162

1163 1164 1165 1166 1167 1168 1169
        }
    }

    ret = true;

cleanup:
    VIR_FREE(params);
1170
    virDomainFree(dom);
1171
    return ret;
1172 1173 1174 1175
}

/* "domifstat" command
 */
1176
static const vshCmdInfo info_domifstat[] = {
1177 1178
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1179 1180 1181
    {NULL,NULL}
};

1182
static const vshCmdOptDef opts_domifstat[] = {
1183 1184
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1185 1186 1187
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1188
static bool
1189
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1190 1191
{
    virDomainPtr dom;
1192
    const char *name = NULL, *device = NULL;
1193 1194
    struct _virDomainInterfaceStats stats;

1195
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1196
        return false;
1197

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

1201
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1202
        virDomainFree(dom);
E
Eric Blake 已提交
1203
        return false;
L
Laine Stump 已提交
1204
    }
1205 1206

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1207
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1208
        virDomainFree(dom);
E
Eric Blake 已提交
1209
        return false;
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
    }

    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 已提交
1237
    return true;
1238 1239
}

1240 1241 1242
/*
 * "dommemstats" command
 */
1243
static const vshCmdInfo info_dommemstat[] = {
1244 1245
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1246 1247 1248
    {NULL,NULL}
};

1249
static const vshCmdOptDef opts_dommemstat[] = {
1250
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1251 1252 1253
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1254
static bool
1255
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1256 1257
{
    virDomainPtr dom;
1258
    const char *name;
1259 1260 1261
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1262
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1263
        return false;
1264 1265

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1266
        return false;
1267 1268 1269 1270 1271

    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 已提交
1272
        return false;
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
    }

    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);
1288 1289
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON)
            vshPrint (ctl, "actual %llu\n", stats[i].val);
1290 1291 1292
    }

    virDomainFree(dom);
E
Eric Blake 已提交
1293
    return true;
1294 1295
}

1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
/*
 * "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 已提交
1311
static bool
1312 1313 1314 1315
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1316
    bool ret = true;
1317
    const char *device = NULL;
1318

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

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

1325
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1326
        virDomainFree(dom);
E
Eric Blake 已提交
1327
        return false;
1328 1329 1330 1331
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1332
        return false;
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
    }

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

1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
/*
 * "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;
}

1423 1424 1425
/*
 * "suspend" command
 */
1426
static const vshCmdInfo info_suspend[] = {
1427 1428
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1429
    {NULL, NULL}
1430 1431
};

1432
static const vshCmdOptDef opts_suspend[] = {
1433
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1434
    {NULL, 0, 0, NULL}
1435 1436
};

E
Eric Blake 已提交
1437
static bool
1438
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1439
{
1440
    virDomainPtr dom;
1441
    const char *name;
E
Eric Blake 已提交
1442
    bool ret = true;
1443

1444
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1445
        return false;
1446

J
Jim Meyering 已提交
1447
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1448
        return false;
1449 1450

    if (virDomainSuspend(dom) == 0) {
1451
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1452
    } else {
1453
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1454
        ret = false;
1455
    }
1456

1457 1458 1459 1460
    virDomainFree(dom);
    return ret;
}

1461 1462 1463
/*
 * "create" command
 */
1464
static const vshCmdInfo info_create[] = {
1465 1466
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1467 1468 1469
    {NULL, NULL}
};

1470
static const vshCmdOptDef opts_create[] = {
1471
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1472
#ifndef WIN32
1473
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1474
#endif
1475
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1476
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1477 1478 1479
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1480
static bool
1481
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1482 1483
{
    virDomainPtr dom;
1484
    const char *from = NULL;
E
Eric Blake 已提交
1485
    bool ret = true;
1486
    char *buffer;
1487
#ifndef WIN32
1488
    int console = vshCommandOptBool(cmd, "console");
1489
#endif
1490
    unsigned int flags = VIR_DOMAIN_NONE;
1491

1492
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1493
        return false;
1494

1495
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1496
        return false;
1497

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

1501 1502
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1503 1504
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1505 1506

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1507
    VIR_FREE(buffer);
1508

1509
    if (dom != NULL) {
1510
        vshPrint(ctl, _("Domain %s created from %s\n"),
1511
                 virDomainGetName(dom), from);
1512
#ifndef WIN32
1513
        if (console)
1514
            cmdRunConsole(ctl, dom, NULL);
1515
#endif
1516
        virDomainFree(dom);
1517
    } else {
1518
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1519
        ret = false;
1520 1521 1522 1523
    }
    return ret;
}

1524 1525 1526
/*
 * "define" command
 */
1527
static const vshCmdInfo info_define[] = {
1528 1529
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1530 1531 1532
    {NULL, NULL}
};

1533
static const vshCmdOptDef opts_define[] = {
1534
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1535 1536 1537
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1538
static bool
1539
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1540 1541
{
    virDomainPtr dom;
1542
    const char *from = NULL;
E
Eric Blake 已提交
1543
    bool ret = true;
1544
    char *buffer;
1545

1546
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1547
        return false;
1548

1549
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1550
        return false;
1551

1552
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1553
        return false;
1554 1555

    dom = virDomainDefineXML(ctl->conn, buffer);
1556
    VIR_FREE(buffer);
1557

1558
    if (dom != NULL) {
1559
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1560
                 virDomainGetName(dom), from);
1561
        virDomainFree(dom);
1562
    } else {
1563
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1564
        ret = false;
1565 1566 1567 1568 1569 1570 1571
    }
    return ret;
}

/*
 * "undefine" command
 */
1572
static const vshCmdInfo info_undefine[] = {
1573 1574
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1575 1576 1577
    {NULL, NULL}
};

1578
static const vshCmdOptDef opts_undefine[] = {
1579
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1580
    {"managed-save", VSH_OT_BOOL, 0, N_("remove domain managed state file")},
1581 1582
    {"snapshots-metadata", VSH_OT_BOOL, 0,
     N_("remove all domain snapshot metadata, if inactive")},
1583 1584 1585
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1586
static bool
1587
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1588 1589
{
    virDomainPtr dom;
1590
    bool ret = false;
1591
    const char *name = NULL;
1592
    /* Flags to attempt.  */
E
Eric Blake 已提交
1593
    unsigned int flags = 0;
1594 1595 1596 1597
    /* User-requested actions.  */
    bool managed_save = vshCommandOptBool(cmd, "managed-save");
    bool snapshots_metadata = vshCommandOptBool(cmd, "snapshots-metadata");
    /* Positive if these items exist.  */
1598
    int has_managed_save = 0;
1599 1600 1601 1602 1603
    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;
1604
    int rc = -1;
1605
    int running;
1606

1607
    if (managed_save) {
1608
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
1609 1610 1611 1612 1613 1614
        managed_save_safe = true;
    }
    if (snapshots_metadata) {
        flags |= VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
1615

1616
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1617
        return false;
1618

1619
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1620
        return false;
1621

1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640
    /* 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;
            }
1641 1642
            virFreeError(last_error);
            last_error = NULL;
1643
            has_managed_save = 0;
1644 1645
        }

1646 1647
        has_snapshots = virDomainSnapshotNum(dom, 0);
        if (has_snapshots < 0) {
1648 1649
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661
                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.  */
1662 1663
                virFreeError(last_error);
                last_error = NULL;
1664 1665 1666 1667 1668
                has_snapshots_metadata = has_snapshots;
            } else {
                /* The server knew the new flag, all aspects of
                 * undefineFlags are safe.  */
                managed_save_safe = snapshots_safe = true;
1669
            }
1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682
        }
    }
    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;
    }
1683

1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
    /* 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;
    }
1698

1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
    /* 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;
1711 1712 1713
        }
    }

1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727
    /* 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:
1728
    if (rc == 0) {
1729
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1730
        ret = true;
1731
    } else {
1732
        vshError(ctl, _("Failed to undefine domain %s"), name);
1733 1734
    }

1735
cleanup:
1736
    virDomainFree(dom);
1737 1738 1739 1740 1741 1742 1743
    return ret;
}


/*
 * "start" command
 */
1744
static const vshCmdInfo info_start[] = {
1745
    {"help", N_("start a (previously defined) inactive domain")},
1746 1747 1748
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1749 1750 1751
    {NULL, NULL}
};

1752
static const vshCmdOptDef opts_start[] = {
1753
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1754
#ifndef WIN32
1755
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1756
#endif
E
Eric Blake 已提交
1757
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1758 1759
    {"autodestroy", VSH_OT_BOOL, 0,
     N_("automatically destroy the guest when virsh disconnects")},
1760 1761
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when loading")},
1762 1763
    {"force-boot", VSH_OT_BOOL, 0,
     N_("force fresh boot by discarding any managed save")},
1764 1765 1766
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1767
static bool
1768
cmdStart(vshControl *ctl, const vshCmd *cmd)
1769 1770
{
    virDomainPtr dom;
1771
    bool ret = false;
1772
#ifndef WIN32
1773
    int console = vshCommandOptBool(cmd, "console");
1774
#endif
E
Eric Blake 已提交
1775
    unsigned int flags = VIR_DOMAIN_NONE;
1776
    int rc;
1777

1778
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1779
        return false;
1780

1781 1782
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
1783
        return false;
1784 1785

    if (virDomainGetID(dom) != (unsigned int)-1) {
1786
        vshError(ctl, "%s", _("Domain is already active"));
1787
        virDomainFree(dom);
E
Eric Blake 已提交
1788
        return false;
1789 1790
    }

E
Eric Blake 已提交
1791 1792
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1793 1794
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1795 1796
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_START_BYPASS_CACHE;
1797 1798
    if (vshCommandOptBool(cmd, "force-boot"))
        flags |= VIR_DOMAIN_START_FORCE_BOOT;
E
Eric Blake 已提交
1799

1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
    /* 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 已提交
1825 1826
    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
1827
         : virDomainCreate(dom)) < 0) {
1828
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
1829
        goto cleanup;
1830
    }
1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842

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

    ret = true;

cleanup:
1843
    virDomainFree(dom);
1844 1845 1846
    return ret;
}

1847 1848 1849
/*
 * "save" command
 */
1850
static const vshCmdInfo info_save[] = {
1851
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
1852
    {"desc", N_("Save the RAM state of a running domain.")},
1853
    {NULL, NULL}
1854 1855
};

1856
static const vshCmdOptDef opts_save[] = {
1857
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
1858 1859
    {"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")},
1860 1861
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
1862 1863
    {"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")},
1864
    {NULL, 0, 0, NULL}
1865 1866
};

E
Eric Blake 已提交
1867
static bool
1868
cmdSave(vshControl *ctl, const vshCmd *cmd)
1869
{
1870
    virDomainPtr dom;
1871 1872
    const char *name = NULL;
    const char *to = NULL;
1873
    bool ret = false;
E
Eric Blake 已提交
1874
    unsigned int flags = 0;
1875 1876
    const char *xmlfile = NULL;
    char *xml = NULL;
1877

1878
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1879
        return false;
1880

1881
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1882
        return false;
1883

1884 1885
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
1886 1887 1888 1889
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
1890

1891 1892 1893 1894 1895
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

1899 1900 1901 1902 1903 1904
    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
        goto cleanup;

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
1905
         : virDomainSave(dom, to)) < 0) {
1906
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
1907
        goto cleanup;
1908
    }
1909

1910 1911 1912 1913
    vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
    ret = true;

cleanup:
1914
    VIR_FREE(xml);
1915 1916 1917 1918
    virDomainFree(dom);
    return ret;
}

1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
/*
 * "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 已提交
1940
    unsigned int flags = 0;
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 1970 1971 1972 1973 1974 1975 1976
    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")},
1977 1978
    {"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")},
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988
    {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;
1989 1990 1991 1992 1993 1994
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033

    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")},
2034 2035
    {"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")},
2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046
    {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;
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062
    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;
    }
2063 2064 2065 2066 2067 2068 2069 2070

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

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

    /* Get the XML configuration of the saved image.  */
2071
    doc = virDomainSaveImageGetXMLDesc(ctl->conn, file, getxml_flags);
2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088
    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;

2089 2090 2091
    /* 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) {
2092 2093 2094 2095 2096 2097 2098
        vshPrint(ctl, _("Saved image %s XML configuration not changed.\n"),
                 file);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
2099 2100
    if (virDomainSaveImageDefineXML(ctl->conn, file, doc_edited,
                                    define_flags) < 0) {
2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117
        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;
}

2118 2119 2120 2121 2122
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
2123 2124 2125 2126
    {"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.")},
2127 2128 2129 2130
    {NULL, NULL}
};

static const vshCmdOptDef opts_managedsave[] = {
2131
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2132
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2133 2134
    {"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")},
2135 2136 2137
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2138
static bool
2139 2140 2141
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
2142
    const char *name;
2143
    bool ret = false;
E
Eric Blake 已提交
2144
    unsigned int flags = 0;
2145

2146
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2147
        return false;
2148

2149 2150
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2151 2152 2153 2154
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2155

2156
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2157
        return false;
2158

2159
    if (virDomainManagedSave(dom, flags) < 0) {
2160
        vshError(ctl, _("Failed to save domain %s state"), name);
2161
        goto cleanup;
2162 2163
    }

2164 2165 2166 2167
    vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    ret = true;

cleanup:
2168 2169 2170 2171
    virDomainFree(dom);
    return ret;
}

2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185
/*
 * "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 已提交
2186
static bool
2187 2188 2189
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
2190
    const char *name;
E
Eric Blake 已提交
2191
    bool ret = false;
2192 2193
    int hassave;

2194
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2195
        return false;
2196 2197

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2198
        return false;
2199 2200 2201

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
2202
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218
        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 已提交
2219
    ret = true;
2220 2221 2222 2223 2224 2225

cleanup:
    virDomainFree(dom);
    return ret;
}

2226 2227 2228
/*
 * "schedinfo" command
 */
2229
static const vshCmdInfo info_schedinfo[] = {
2230 2231
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
2232 2233 2234
    {NULL, NULL}
};

2235
static const vshCmdOptDef opts_schedinfo[] = {
2236 2237 2238 2239
    {"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")},
2240 2241 2242
    {"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")},
2243 2244 2245
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
2246
static int
2247
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
2248
                   virTypedParameterPtr param)
2249
{
2250
    const char *data = NULL;
2251 2252 2253

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
2254
        param->type == VIR_TYPED_PARAM_UINT &&
2255 2256
        vshCommandOptBool(cmd, "weight")) {
        int val;
2257
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
2258
            vshError(ctl, "%s", _("Invalid value of weight"));
2259
            return -1;
2260
        } else {
2261
            param->value.ui = val;
2262
        }
2263
        return 1;
2264 2265
    }

2266 2267
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
2268
        param->type == VIR_TYPED_PARAM_UINT &&
2269 2270
        vshCommandOptBool(cmd, "cap")) {
        int val;
2271
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
2272
            vshError(ctl, "%s", _("Invalid value of cap"));
2273
            return -1;
2274
        } else {
2275
            param->value.ui = val;
2276
        }
2277
        return 1;
2278
    }
2279

2280
    if (vshCommandOptString(cmd, "set", &data) > 0) {
2281 2282 2283
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
2284
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
2285
            return -1;
2286
        }
2287 2288 2289 2290 2291 2292 2293 2294 2295
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
2296
        case VIR_TYPED_PARAM_INT:
2297
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
2298
                vshError(ctl, "%s",
2299 2300 2301 2302
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
2303
        case VIR_TYPED_PARAM_UINT:
2304
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
2305
                vshError(ctl, "%s",
2306 2307 2308 2309
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
2310
        case VIR_TYPED_PARAM_LLONG:
2311
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
2312
                vshError(ctl, "%s",
J
Jim Meyering 已提交
2313
                         _("Invalid value for parameter, expecting a long long"));
2314 2315 2316
                return -1;
            }
            break;
2317
        case VIR_TYPED_PARAM_ULLONG:
2318
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
2319
                vshError(ctl, "%s",
2320 2321 2322 2323
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
2324
        case VIR_TYPED_PARAM_DOUBLE:
2325
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
2326
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
2327 2328 2329
                return -1;
            }
            break;
2330
        case VIR_TYPED_PARAM_BOOLEAN:
2331
            param->value.b = STREQ(val, "0") ? 0 : 1;
2332
        }
2333
        return 1;
2334
    }
2335

2336 2337
    return 0;
}
2338

2339

E
Eric Blake 已提交
2340
static bool
2341 2342 2343 2344
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
2345
    virTypedParameterPtr params = NULL;
2346 2347 2348
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
2349
    bool ret_val = false;
2350 2351 2352 2353 2354 2355 2356 2357 2358 2359
    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;
        }
2360
        flags = VIR_DOMAIN_AFFECT_CURRENT;
2361 2362
    } else {
        if (config)
2363
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
2364
        if (live)
2365
            flags |= VIR_DOMAIN_AFFECT_LIVE;
2366
    }
2367

2368
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2369
        return false;
2370

2371
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2372
        return false;
2373 2374 2375

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
2376
    if (schedulertype != NULL) {
2377
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
2378
             schedulertype);
2379
        VIR_FREE(schedulertype);
2380
    } else {
2381
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
2382
        goto cleanup;
2383 2384
    }

2385
    if (nparams) {
2386
        params = vshMalloc(ctl, sizeof(*params) * nparams);
2387

2388
        memset(params, 0, sizeof(*params) * nparams);
2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399
        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);
        }
2400 2401 2402 2403
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
2404
        for (i = 0; i < nparams; i++) {
2405 2406 2407 2408 2409 2410 2411 2412 2413 2414
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
2415 2416 2417 2418 2419
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
2420 2421 2422
            if (ret == -1)
                goto cleanup;

2423 2424 2425 2426 2427 2428 2429
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
2430 2431
            if (ret == -1)
                goto cleanup;
2432 2433 2434 2435
        } 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.  */
2436 2437
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
2438 2439 2440 2441
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
2442 2443 2444 2445 2446 2447
            /* 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;
            }
2448 2449
        }

E
Eric Blake 已提交
2450
        ret_val = true;
2451
        for (i = 0; i < nparams; i++) {
2452
            switch (params[i].type) {
2453
            case VIR_TYPED_PARAM_INT:
2454
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
2455
                 break;
2456
            case VIR_TYPED_PARAM_UINT:
2457
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
2458
                 break;
2459
            case VIR_TYPED_PARAM_LLONG:
2460
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
2461
                 break;
2462
            case VIR_TYPED_PARAM_ULLONG:
2463
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
2464
                 break;
2465
            case VIR_TYPED_PARAM_DOUBLE:
2466
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
2467
                 break;
2468
            case VIR_TYPED_PARAM_BOOLEAN:
2469
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
2470 2471
                 break;
            default:
2472
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
2473 2474 2475
            }
        }
    }
2476

2477
 cleanup:
2478
    VIR_FREE(params);
2479
    virDomainFree(dom);
2480
    return ret_val;
2481 2482
}

2483 2484 2485
/*
 * "restore" command
 */
2486
static const vshCmdInfo info_restore[] = {
2487 2488
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
2489
    {NULL, NULL}
2490 2491
};

2492
static const vshCmdOptDef opts_restore[] = {
2493
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
2494 2495
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when restoring")},
2496 2497
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2498 2499
    {"running", VSH_OT_BOOL, 0, N_("restore domain into running state")},
    {"paused", VSH_OT_BOOL, 0, N_("restore domain into paused state")},
2500
    {NULL, 0, 0, NULL}
2501 2502
};

E
Eric Blake 已提交
2503
static bool
2504
cmdRestore(vshControl *ctl, const vshCmd *cmd)
2505
{
2506
    const char *from = NULL;
2507
    bool ret = false;
E
Eric Blake 已提交
2508
    unsigned int flags = 0;
2509 2510
    const char *xmlfile = NULL;
    char *xml = NULL;
2511

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

2515
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2516
        return false;
2517

2518 2519
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2520 2521 2522 2523
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2524

2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535
    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)
2536
         : virDomainRestore(ctl->conn, from)) < 0) {
2537
        vshError(ctl, _("Failed to restore domain from %s"), from);
2538
        goto cleanup;
2539
    }
2540 2541 2542 2543 2544

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

cleanup:
2545
    VIR_FREE(xml);
2546 2547 2548
    return ret;
}

D
Daniel Veillard 已提交
2549 2550 2551
/*
 * "dump" command
 */
2552
static const vshCmdInfo info_dump[] = {
2553 2554
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
2555 2556 2557
    {NULL, NULL}
};

2558
static const vshCmdOptDef opts_dump[] = {
2559 2560
    {"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")},
2561 2562
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when saving")},
2563 2564
    {"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 已提交
2565 2566 2567
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2568
static bool
2569
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
2570 2571
{
    virDomainPtr dom;
2572 2573
    const char *name = NULL;
    const char *to = NULL;
2574
    bool ret = false;
E
Eric Blake 已提交
2575
    unsigned int flags = 0;
D
Daniel Veillard 已提交
2576

2577
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2578
        return false;
D
Daniel Veillard 已提交
2579

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

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

P
Paolo Bonzini 已提交
2586 2587
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
2588 2589
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;
2590 2591
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DUMP_BYPASS_CACHE;
2592

2593
    if (virDomainCoreDump(dom, to, flags) < 0) {
2594
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
2595
        goto cleanup;
D
Daniel Veillard 已提交
2596 2597
    }

2598 2599 2600 2601
    vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
    ret = true;

cleanup:
D
Daniel Veillard 已提交
2602 2603 2604 2605
    virDomainFree(dom);
    return ret;
}

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 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752
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;
}

2753 2754 2755
/*
 * "resume" command
 */
2756
static const vshCmdInfo info_resume[] = {
2757 2758
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
2759
    {NULL, NULL}
2760 2761
};

2762
static const vshCmdOptDef opts_resume[] = {
2763
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2764
    {NULL, 0, 0, NULL}
2765 2766
};

E
Eric Blake 已提交
2767
static bool
2768
cmdResume(vshControl *ctl, const vshCmd *cmd)
2769
{
2770
    virDomainPtr dom;
E
Eric Blake 已提交
2771
    bool ret = true;
2772
    const char *name;
2773

2774
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2775
        return false;
2776

J
Jim Meyering 已提交
2777
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2778
        return false;
2779 2780

    if (virDomainResume(dom) == 0) {
2781
        vshPrint(ctl, _("Domain %s resumed\n"), name);
2782
    } else {
2783
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
2784
        ret = false;
2785
    }
2786

2787 2788 2789 2790
    virDomainFree(dom);
    return ret;
}

2791 2792 2793
/*
 * "shutdown" command
 */
2794
static const vshCmdInfo info_shutdown[] = {
2795 2796
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
2797
    {NULL, NULL}
2798 2799
};

2800
static const vshCmdOptDef opts_shutdown[] = {
2801
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2802
    {NULL, 0, 0, NULL}
2803 2804
};

E
Eric Blake 已提交
2805
static bool
2806
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
2807
{
2808
    virDomainPtr dom;
E
Eric Blake 已提交
2809
    bool ret = true;
2810
    const char *name;
2811

2812
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2813
        return false;
2814

J
Jim Meyering 已提交
2815
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2816
        return false;
2817 2818

    if (virDomainShutdown(dom) == 0) {
2819
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
2820
    } else {
2821
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
2822
        ret = false;
2823
    }
2824

2825 2826 2827 2828
    virDomainFree(dom);
    return ret;
}

2829 2830 2831
/*
 * "reboot" command
 */
2832
static const vshCmdInfo info_reboot[] = {
2833 2834
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
2835 2836 2837
    {NULL, NULL}
};

2838
static const vshCmdOptDef opts_reboot[] = {
2839
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2840 2841 2842
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2843
static bool
2844
cmdReboot(vshControl *ctl, const vshCmd *cmd)
2845 2846
{
    virDomainPtr dom;
E
Eric Blake 已提交
2847
    bool ret = true;
2848
    const char *name;
2849

2850
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2851
        return false;
2852

J
Jim Meyering 已提交
2853
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2854
        return false;
2855 2856

    if (virDomainReboot(dom, 0) == 0) {
2857
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
2858
    } else {
2859
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
2860
        ret = false;
2861 2862 2863 2864 2865 2866
    }

    virDomainFree(dom);
    return ret;
}

2867 2868 2869
/*
 * "destroy" command
 */
2870
static const vshCmdInfo info_destroy[] = {
2871 2872 2873
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
2874
    {NULL, NULL}
2875 2876
};

2877
static const vshCmdOptDef opts_destroy[] = {
2878
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2879
    {NULL, 0, 0, NULL}
2880 2881
};

E
Eric Blake 已提交
2882
static bool
2883
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2884
{
2885
    virDomainPtr dom;
E
Eric Blake 已提交
2886
    bool ret = true;
2887
    const char *name;
2888

2889
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2890
        return false;
2891

J
Jim Meyering 已提交
2892
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2893
        return false;
2894 2895

    if (virDomainDestroy(dom) == 0) {
2896
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2897
    } else {
2898
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
2899
        ret = false;
2900
    }
2901

2902
    virDomainFree(dom);
K
Karel Zak 已提交
2903 2904 2905 2906
    return ret;
}

/*
2907
 * "dominfo" command
K
Karel Zak 已提交
2908
 */
2909
static const vshCmdInfo info_dominfo[] = {
2910 2911
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2912
    {NULL, NULL}
K
Karel Zak 已提交
2913 2914
};

2915
static const vshCmdOptDef opts_dominfo[] = {
2916
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2917
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2918 2919
};

E
Eric Blake 已提交
2920
static bool
2921
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2922
{
K
Karel Zak 已提交
2923 2924
    virDomainInfo info;
    virDomainPtr dom;
2925
    virSecurityModel secmodel;
2926
    virSecurityLabelPtr seclabel;
2927
    int persistent = 0;
E
Eric Blake 已提交
2928 2929
    bool ret = true;
    int autostart;
2930
    unsigned int id;
2931
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2932
    int has_managed_save = 0;
2933

2934
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2935
        return false;
K
Karel Zak 已提交
2936

J
Jim Meyering 已提交
2937
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2938
        return false;
2939

2940 2941
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2942
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2943
    else
2944
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2945 2946
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2947
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2948
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2949 2950

    if ((str = virDomainGetOSType(dom))) {
2951
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2952
        VIR_FREE(str);
2953 2954 2955
    }

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

2959
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2960 2961

        if (info.cpuTime != 0) {
2962
            double cpuUsed = info.cpuTime;
2963

2964
            cpuUsed /= 1000000000.0;
2965

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

2969 2970
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2971
                 info.maxMem);
2972
        else
2973
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2974 2975
                 _("no limit"));

2976
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2977 2978
                 info.memory);

K
Karel Zak 已提交
2979
    } else {
E
Eric Blake 已提交
2980
        ret = false;
K
Karel Zak 已提交
2981
    }
2982

2983 2984
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
2985 2986
    vshDebug(ctl, VSH_ERR_DEBUG, "Domain persistent flag value: %d\n",
             persistent);
2987 2988 2989 2990 2991 2992
    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 */
2993
    if (!virDomainGetAutostart(dom, &autostart)) {
2994
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2995 2996 2997
                 autostart ? _("enable") : _("disable") );
    }

2998 2999 3000 3001 3002 3003 3004
    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"));

3005 3006 3007
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
3008 3009
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
3010
            return false;
3011 3012 3013
        } else {
            virFreeError(last_error);
            last_error = NULL;
3014
        }
3015 3016 3017 3018 3019 3020 3021
    } 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 */
3022
            if (VIR_ALLOC(seclabel) < 0) {
3023
                virDomainFree(dom);
E
Eric Blake 已提交
3024
                return false;
3025 3026 3027 3028 3029
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
3030
                return false;
3031
            } else {
3032
                if (seclabel->label[0] != '\0')
3033
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
3034
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
3035
            }
3036 3037

            VIR_FREE(seclabel);
3038 3039
        }
    }
3040
    virDomainFree(dom);
K
Karel Zak 已提交
3041 3042 3043
    return ret;
}

3044 3045 3046 3047
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
3048 3049
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
3050 3051 3052 3053
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
3054
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3055 3056 3057 3058
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
3059
static bool
3060 3061 3062 3063
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
3064
    bool ret = true;
3065

3066
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3067
        return false;
3068 3069

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3070
        return false;
3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096

    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 已提交
3097
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
3098
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
3099
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
3100
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
3101
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
3102 3103 3104
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
3105
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
3106
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
3107
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
3108
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
3109
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
3110 3111 3112
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
3113
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
3114
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
3115
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
3116
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
3117
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
3118 3119
        }
    } else {
E
Eric Blake 已提交
3120
        ret = false;
3121 3122 3123 3124 3125 3126
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

3127 3128 3129 3130
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
3131 3132
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
3133 3134 3135 3136
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
3137
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3138 3139 3140
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3141
static bool
3142 3143 3144
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3145
    bool ret = true;
3146

3147
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3148
        return false;
3149 3150

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
3154
        ret = false;
3155 3156 3157 3158 3159

    virDomainFree(dom);
    return ret;
}

3160 3161 3162
/*
 * "freecell" command
 */
3163
static const vshCmdInfo info_freecell[] = {
3164 3165
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
3166 3167 3168
    {NULL, NULL}
};

3169
static const vshCmdOptDef opts_freecell[] = {
3170
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
3171
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
3172 3173 3174
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3175
static bool
3176
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
3177
{
W
Wen Congyang 已提交
3178
    bool func_ret = false;
3179
    int ret;
3180
    int cell = -1, cell_given;
3181
    unsigned long long memory;
3182 3183 3184 3185
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
3186
    int all_given;
3187 3188 3189 3190
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
3191

3192

3193
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3194
        return false;
3195

3196 3197 3198 3199
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
3200 3201 3202 3203 3204 3205 3206 3207 3208
    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) {
3209 3210 3211
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3212 3213 3214
            goto cleanup;
        }

3215
        xml = virXMLParseStringCtxt(cap_xml, "node.xml", &ctxt);
3216 3217
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3218 3219
            goto cleanup;
        }
3220 3221 3222 3223
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
3224
            vshError(ctl, "%s", _("could not get information about "
3225
                                  "NUMA topology"));
3226 3227 3228
            goto cleanup;
        }

3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249
        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;
            }
        }

3250
        memory = 0;
3251 3252 3253 3254
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
3255 3256 3257 3258
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
3259
    } else {
3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273
        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));
3274 3275
    }

E
Eric Blake 已提交
3276
    func_ret = true;
3277

3278
cleanup:
3279
    xmlXPathFreeContext(ctxt);
3280
    xmlFreeDoc(xml);
3281
    VIR_FREE(nodes);
3282 3283 3284
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
3285
    return func_ret;
3286 3287
}

E
Eric Blake 已提交
3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301
/*
 * "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 已提交
3302
static bool
E
Eric Blake 已提交
3303 3304
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
3305
    const char *type = NULL;
E
Eric Blake 已提交
3306 3307
    int vcpus;

3308 3309
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
3310
        return false;
3311
    }
E
Eric Blake 已提交
3312 3313

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

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

E
Eric Blake 已提交
3321
    return true;
E
Eric Blake 已提交
3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335
}

/*
 * "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")},
3336
    {"active", VSH_OT_BOOL, 0, N_("get number of currently active vcpus")},
E
Eric Blake 已提交
3337
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
3338 3339 3340
    {"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 已提交
3341 3342 3343
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3344
static bool
E
Eric Blake 已提交
3345 3346 3347
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3348
    bool ret = true;
E
Eric Blake 已提交
3349
    int maximum = vshCommandOptBool(cmd, "maximum");
3350
    int active = vshCommandOptBool(cmd, "active");
E
Eric Blake 已提交
3351 3352
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3353 3354
    int current = vshCommandOptBool(cmd, "current");
    bool all = maximum + active + current + config + live == 0;
E
Eric Blake 已提交
3355 3356
    int count;

3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371
    /* 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 已提交
3372
        return false;
E
Eric Blake 已提交
3373
    }
3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386

    /* 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 已提交
3387
        vshError(ctl, "%s",
3388
                 _("--maximum and --active cannot both be specified"));
E
Eric Blake 已提交
3389
        return false;
E
Eric Blake 已提交
3390
    }
3391 3392 3393
    if (current + config + live > 1) {
        vshError(ctl, "%s",
                 _("--config, --live, and --current are mutually exclusive"));
E
Eric Blake 已提交
3394
        return false;
E
Eric Blake 已提交
3395 3396 3397
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3398
        return false;
E
Eric Blake 已提交
3399 3400

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

    /* In all cases, try the new API first; if it fails because we are
3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417
     * 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 已提交
3418 3419
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
3420
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
3421 3422 3423 3424 3425 3426 3427 3428 3429
        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;
            }
3430 3431
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
3432 3433 3434 3435 3436
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
3437
            ret = false;
E
Eric Blake 已提交
3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449
        } 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 |
3450
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
3451 3452 3453 3454 3455 3456 3457
        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 已提交
3458
            ret = false;
E
Eric Blake 已提交
3459 3460 3461 3462 3463 3464 3465 3466 3467 3468
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3469
    if (all || (active && config)) {
3470
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494
        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 已提交
3495
            ret = false;
E
Eric Blake 已提交
3496 3497 3498 3499 3500 3501 3502 3503 3504 3505
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3506
    if (all || (active && live)) {
3507
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
3508 3509 3510 3511 3512 3513 3514 3515 3516
        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 已提交
3517
            ret = false;
E
Eric Blake 已提交
3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531
        } 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;
}

3532 3533 3534
/*
 * "vcpuinfo" command
 */
3535
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
3536
    {"help", N_("detailed domain vcpu information")},
3537
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
3538 3539 3540
    {NULL, NULL}
};

3541
static const vshCmdOptDef opts_vcpuinfo[] = {
3542
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3543 3544 3545
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3546
static bool
3547
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
3548 3549 3550 3551 3552
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
3553 3554
    unsigned char *cpumaps;
    int ncpus, maxcpu;
3555
    size_t cpumaplen;
E
Eric Blake 已提交
3556
    bool ret = true;
3557
    int n, m;
3558

3559
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3560
        return false;
3561

J
Jim Meyering 已提交
3562
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3563
        return false;
3564 3565 3566

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3567
        return false;
3568 3569 3570 3571
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3572
        return false;
3573 3574
    }

3575
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
3576 3577 3578
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
3579

3580 3581
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
3582
                                   cpumaps, cpumaplen)) >= 0) {
3583 3584 3585 3586
        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 已提交
3587
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
3588 3589 3590 3591 3592 3593 3594 3595
            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:"));
3596 3597
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
3598 3599 3600 3601 3602 3603
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
3604
    } else {
3605
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
3606
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3607 3608 3609
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
3610
            /* fallback plan to use virDomainGetVcpuPinInfo */
3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628

            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;
3629
        }
3630 3631
    }

3632
    VIR_FREE(cpumaps);
3633
    VIR_FREE(cpuinfo);
3634 3635 3636 3637 3638 3639 3640
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
3641
static const vshCmdInfo info_vcpupin[] = {
3642
    {"help", N_("control or query domain vcpu affinity")},
3643
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
3644 3645 3646
    {NULL, NULL}
};

3647
static const vshCmdOptDef opts_vcpupin[] = {
3648
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3649 3650 3651
    {"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")},
3652 3653 3654
    {"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")},
3655 3656 3657
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3658
static bool
E
Eric Blake 已提交
3659
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
3660 3661 3662 3663
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
3664
    int vcpu = -1;
3665
    const char *cpulist = NULL;
E
Eric Blake 已提交
3666
    bool ret = true;
3667 3668
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
3669
    size_t cpumaplen;
3670 3671
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
3672
    bool unuse = false;
3673
    const char *cur;
3674 3675 3676
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
3677
    bool query = false; /* Query mode if no cpulist */
E
Eric Blake 已提交
3678
    unsigned int flags = 0;
3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694

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

3696
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3697
        return false;
3698

J
Jim Meyering 已提交
3699
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3700
        return false;
3701

3702 3703
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
3704
        virDomainFree(dom);
E
Eric Blake 已提交
3705
        return false;
3706
    }
3707
    query = !cpulist;
3708

3709 3710 3711 3712
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
3713
        virDomainFree(dom);
E
Eric Blake 已提交
3714
        return false;
3715
    }
3716

3717 3718
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3719
        return false;
3720 3721 3722
    }

    if (virDomainGetInfo(dom, &info) != 0) {
3723
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
3724
        virDomainFree(dom);
E
Eric Blake 已提交
3725
        return false;
3726 3727 3728
    }

    if (vcpu >= info.nrVirtCpu) {
3729
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
3730
        virDomainFree(dom);
E
Eric Blake 已提交
3731
        return false;
3732 3733
    }

3734 3735
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
3736

3737 3738 3739 3740 3741 3742 3743 3744
    /* 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 已提交
3745
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 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 3785 3786 3787 3788 3789 3790
                                             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);
3791 3792
    /* Parse cpulist */
    cur = cpulist;
3793
    if (*cur == 0) {
3794
        goto parse_error;
3795 3796 3797
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
3798
        cur = "";
3799
    }
3800 3801 3802 3803 3804 3805 3806

    while (*cur != 0) {

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

3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820
        /* 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);
3821

3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848
        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);
        }
3849

3850 3851 3852 3853 3854 3855
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
3856
        } else {
3857
            goto parse_error;
3858
        }
3859
    }
3860

3861 3862 3863 3864 3865 3866 3867 3868
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
3869 3870
    }

3871
cleanup:
3872
    VIR_FREE(cpumap);
3873 3874
    virDomainFree(dom);
    return ret;
3875 3876 3877 3878 3879

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

3882 3883 3884
/*
 * "setvcpus" command
 */
3885
static const vshCmdInfo info_setvcpus[] = {
3886 3887
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
3888 3889 3890
    {NULL, NULL}
};

3891
static const vshCmdOptDef opts_setvcpus[] = {
3892
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3893
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
3894 3895 3896
    {"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")},
3897
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3898 3899 3900
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3901
static bool
3902
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
3903 3904
{
    virDomainPtr dom;
3905
    int count = 0;
E
Eric Blake 已提交
3906
    bool ret = true;
E
Eric Blake 已提交
3907 3908 3909
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3910
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
3911
    unsigned int flags = 0;
3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927

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

3929
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3930
        return false;
3931

J
Jim Meyering 已提交
3932
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3933
        return false;
3934

3935 3936 3937 3938
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
3939

3940
    if (flags == -1) {
E
Eric Blake 已提交
3941
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
3942
            ret = false;
E
Eric Blake 已提交
3943 3944
        }
    } else {
3945 3946 3947
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
3948
            vshDebug(ctl, VSH_ERR_DEBUG, "--maximum flag was given\n");
3949

3950 3951
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

3952 3953 3954 3955 3956 3957 3958 3959
            /* 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 已提交
3960
                ret = false;
3961 3962 3963 3964 3965
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
3966
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
3967
            ret = false;
E
Eric Blake 已提交
3968
        }
3969 3970
    }

3971
  cleanup:
3972 3973 3974 3975
    virDomainFree(dom);
    return ret;
}

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

4010 4011 4012 4013 4014
/*
 * "send-key" command
 */
static const vshCmdInfo info_send_key[] = {
    {"help", N_("Send keycodes to the guest")},
4015
    {"desc", N_("Send keycodes (integers or symbolic names) to the guest")},
4016 4017 4018 4019 4020
    {NULL, NULL}
};

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4021 4022
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT,
     N_("the codeset of keycodes, default:linux")},
4023
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
4024
     N_("the time (in millseconds) how long the keys will be held")},
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096
    {"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;
}

4097 4098 4099
/*
 * "setmemory" command
 */
4100
static const vshCmdInfo info_setmem[] = {
4101 4102
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
4103 4104 4105
    {NULL, NULL}
};

4106
static const vshCmdOptDef opts_setmem[] = {
4107
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4108
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
4109 4110
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
4111
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
4112 4113 4114
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4115
static bool
4116
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
4117 4118
{
    virDomainPtr dom;
4119
    virDomainInfo info;
4120
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
4121
    bool ret = true;
4122 4123
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
4124
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4125
    unsigned int flags = 0;
4126

4127 4128 4129
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4130
            return false;
4131
        }
4132
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4133 4134
    } else {
        if (config)
4135
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4136
        if (live)
4137
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4138 4139 4140
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
4141
    }
4142

4143
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4144
        return false;
4145

J
Jim Meyering 已提交
4146
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4147
        return false;
4148

4149 4150
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4151
        return false;
4152 4153
    }

4154
    if (kilobytes <= 0) {
4155
        virDomainFree(dom);
4156
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
4157
        return false;
4158 4159
    }

4160 4161
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
4162
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
4163
        return false;
4164 4165 4166 4167
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
4168
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
4169
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
4170
        return false;
4171 4172
    }

4173
    if (flags == -1) {
4174
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
4175
            ret = false;
4176 4177 4178
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
4179
            ret = false;
4180
        }
4181 4182 4183 4184 4185 4186 4187 4188 4189
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
4190
static const vshCmdInfo info_setmaxmem[] = {
4191 4192
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
4193 4194 4195
    {NULL, NULL}
};

4196
static const vshCmdOptDef opts_setmaxmem[] = {
4197
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4198
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
4199 4200 4201
    {"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")},
4202 4203 4204
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4205
static bool
4206
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
4207 4208
{
    virDomainPtr dom;
4209
    int kilobytes = 0;
E
Eric Blake 已提交
4210
    bool ret = true;
4211 4212 4213
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4214
    unsigned int flags = VIR_DOMAIN_MEM_MAXIMUM;
4215 4216 4217 4218

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4219
            return false;
4220 4221 4222
        }
    } else {
        if (config)
4223
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4224
        if (live)
4225
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4226 4227 4228 4229
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
4230

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

J
Jim Meyering 已提交
4234
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4235
        return false;
4236

4237 4238
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4239
        return false;
4240 4241
    }

4242
    if (kilobytes <= 0) {
4243
        virDomainFree(dom);
4244
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
4245
        return false;
4246 4247
    }

4248 4249 4250
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4251
            ret = false;
4252 4253 4254 4255
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4256
            ret = false;
4257
        }
4258 4259
    }

4260 4261 4262 4263
    virDomainFree(dom);
    return ret;
}

4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279
/*
 * "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 已提交
4280 4281 4282
    {"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")},
4283 4284 4285
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4286
static bool
4287 4288 4289 4290 4291
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
4292
    int rv = 0;
4293
    unsigned int i = 0;
4294
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4295
    bool ret = false;
H
Hu Tao 已提交
4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312
    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;
    }
4313 4314

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

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

4320
    if ((rv = vshCommandOptInt(cmd, "weight", &weight)) < 0) {
4321 4322 4323 4324 4325
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

4326
    if (rv > 0) {
4327
        nparams++;
4328
        if (weight <= 0) {
4329 4330 4331 4332 4333 4334 4335
            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 已提交
4336
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
4337 4338 4339 4340 4341 4342 4343
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4344
            ret = true;
4345 4346 4347 4348 4349
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
4350
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
4351 4352 4353 4354 4355 4356
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4357
                case VIR_TYPED_PARAM_INT:
4358 4359 4360
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4361
                case VIR_TYPED_PARAM_UINT:
4362 4363 4364
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4365
                case VIR_TYPED_PARAM_LLONG:
4366 4367 4368
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4369
                case VIR_TYPED_PARAM_ULLONG:
4370 4371 4372
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
4373
                case VIR_TYPED_PARAM_DOUBLE:
4374 4375 4376
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4377
                case VIR_TYPED_PARAM_BOOLEAN:
4378 4379 4380 4381 4382 4383 4384 4385
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
4386
        ret = true;
4387 4388 4389 4390 4391 4392
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4393
            temp->type = VIR_TYPED_PARAM_UINT;
4394 4395 4396 4397 4398 4399 4400 4401

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
H
Hu Tao 已提交
4402
        if (virDomainSetBlkioParameters(dom, params, nparams, flags) != 0)
4403 4404
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
4405
            ret = true;
4406 4407 4408 4409 4410 4411 4412 4413
    }

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

4414 4415 4416 4417
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
4418 4419 4420
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
4421 4422 4423 4424 4425 4426 4427
                "    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")},
4428
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4429
     N_("Max memory in kilobytes")},
4430
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4431
     N_("Memory during contention in kilobytes")},
4432
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4433
     N_("Max memory plus swap in kilobytes")},
4434
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
4435
     N_("Min guaranteed memory in kilobytes")},
4436 4437 4438
    {"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")},
4439 4440 4441
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4442
static bool
4443 4444 4445
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
4446 4447
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
4448 4449
    int nparams = 0;
    unsigned int i = 0;
4450
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4451
    bool ret = false;
4452 4453 4454 4455 4456 4457 4458 4459 4460 4461
    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;
        }
4462
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4463 4464
    } else {
        if (config)
4465
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4466
        if (live)
4467
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4468
    }
4469 4470

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4471
        return false;
4472 4473

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

4476 4477 4478 4479 4480 4481 4482 4483 4484
    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;
    }

4485 4486 4487 4488 4489 4490 4491 4492 4493
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

4494 4495 4496
    if (min_guarantee)
        nparams++;

4497 4498
    if (nparams == 0) {
        /* get the number of memory parameters */
4499
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
4500 4501 4502 4503 4504
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

4505 4506
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4507
            ret = true;
4508 4509 4510
            goto cleanup;
        }

4511
        /* now go get all the memory parameters */
E
Eric Blake 已提交
4512
        params = vshCalloc(ctl, nparams, sizeof(*params));
4513
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
4514 4515 4516 4517 4518 4519
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4520
                case VIR_TYPED_PARAM_INT:
4521 4522 4523
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4524
                case VIR_TYPED_PARAM_UINT:
4525 4526 4527
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4528
                case VIR_TYPED_PARAM_LLONG:
4529 4530 4531
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4532
                case VIR_TYPED_PARAM_ULLONG:
4533 4534 4535 4536 4537
                    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);
4538
                    break;
4539
                case VIR_TYPED_PARAM_DOUBLE:
4540 4541 4542
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4543
                case VIR_TYPED_PARAM_BOOLEAN:
4544 4545 4546 4547
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
4548
                    vshPrint(ctl, "unimplemented memory parameter type\n");
4549 4550 4551
            }
        }

E
Eric Blake 已提交
4552
        ret = true;
4553 4554
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
4555
        params = vshCalloc(ctl, nparams, sizeof(*params));
4556 4557 4558

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4559
            temp->type = VIR_TYPED_PARAM_ULLONG;
4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578

            /*
             * 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;
4579
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
4580 4581
                        sizeof(temp->field));
                swap_hard_limit = 0;
4582 4583 4584 4585 4586
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
4587
            }
4588 4589 4590 4591

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
4592
        }
4593
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
4594
            vshError(ctl, "%s", _("Unable to change memory parameters"));
4595
        else
E
Eric Blake 已提交
4596
            ret = true;
4597 4598 4599
    }

  cleanup:
E
Eric Blake 已提交
4600
    VIR_FREE(params);
4601 4602 4603 4604
    virDomainFree(dom);
    return ret;
}

4605 4606 4607
/*
 * "nodeinfo" command
 */
4608
static const vshCmdInfo info_nodeinfo[] = {
4609 4610
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
4611 4612 4613
    {NULL, NULL}
};

E
Eric Blake 已提交
4614
static bool
4615
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4616 4617
{
    virNodeInfo info;
4618

4619
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4620
        return false;
4621 4622

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
4623
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
4624
        return false;
4625 4626 4627 4628 4629 4630 4631 4632 4633 4634
    }
    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 已提交
4635
    return true;
4636 4637
}

4638 4639 4640 4641 4642
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
4643
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
4644 4645 4646 4647 4648 4649 4650 4651 4652 4653
    {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
4654
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
4655 4656 4657 4658
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
4659 4660
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703
    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;

4704
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
4705
                cpu_stats[i].sys = value;
4706
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
4707
                cpu_stats[i].user = value;
4708
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
4709
                cpu_stats[i].idle = value;
4710
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
4711
                cpu_stats[i].iowait = value;
4712
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726
                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) {
4727
            vshPrint(ctl, "%-15s %20llu\n", _("user:"), cpu_stats[0].user);
4728
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
4729
            vshPrint(ctl, "%-15s %20llu\n", _("idle:"), cpu_stats[0].idle);
4730 4731 4732 4733 4734 4735 4736
            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);
4737
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle:"), 100 - usage);
4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749
        } 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",
4750
                     _("user:"), user_time / total_time * 100);
4751
            vshPrint(ctl, "%-15s %5.1lf%%\n",
4752
                     _("system:"), sys_time  / total_time * 100);
4753
            vshPrint(ctl, "%-15s %5.1lf%%\n",
4754
                     _("idle:"), idle_time     / total_time * 100);
4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785
/*
 * "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;
4786 4787
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827
    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;
}

4828 4829 4830
/*
 * "capabilities" command
 */
4831
static const vshCmdInfo info_capabilities[] = {
4832 4833
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
4834 4835 4836
    {NULL, NULL}
};

E
Eric Blake 已提交
4837
static bool
4838
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4839 4840 4841
{
    char *caps;

4842
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4843
        return false;
4844 4845

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
4846
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
4847
        return false;
4848 4849
    }
    vshPrint (ctl, "%s\n", caps);
4850
    VIR_FREE(caps);
4851

E
Eric Blake 已提交
4852
    return true;
4853 4854
}

4855 4856 4857
/*
 * "dumpxml" command
 */
4858
static const vshCmdInfo info_dumpxml[] = {
4859 4860
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
4861
    {NULL, NULL}
4862 4863
};

4864
static const vshCmdOptDef opts_dumpxml[] = {
4865 4866 4867
    {"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")},
4868
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
4869
    {NULL, 0, 0, NULL}
4870 4871
};

E
Eric Blake 已提交
4872
static bool
4873
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
4874
{
4875
    virDomainPtr dom;
E
Eric Blake 已提交
4876
    bool ret = true;
4877
    char *dump;
E
Eric Blake 已提交
4878
    unsigned int flags = 0;
4879 4880
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
4881
    int update = vshCommandOptBool(cmd, "update-cpu");
4882 4883 4884 4885 4886

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
4887 4888
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
4889

4890
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4891
        return false;
4892

J
Jim Meyering 已提交
4893
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4894
        return false;
4895

4896
    dump = virDomainGetXMLDesc(dom, flags);
4897
    if (dump != NULL) {
4898
        vshPrint(ctl, "%s", dump);
4899
        VIR_FREE(dump);
4900
    } else {
E
Eric Blake 已提交
4901
        ret = false;
4902
    }
4903

4904 4905 4906 4907
    virDomainFree(dom);
    return ret;
}

4908 4909 4910 4911
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
4912 4913
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
4914 4915 4916 4917
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
4918 4919
    {"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")},
4920 4921 4922
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4923
static bool
4924 4925
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4926
    bool ret = true;
4927 4928
    const char *format = NULL;
    const char *configFile = NULL;
4929 4930
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
4931
    unsigned int flags = 0;
4932

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

4936 4937
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
4938
        return false;
4939

4940
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
4941
        return false;
4942 4943 4944

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
4945
        vshPrint(ctl, "%s", xmlData);
4946
        VIR_FREE(xmlData);
4947
    } else {
E
Eric Blake 已提交
4948
        ret = false;
4949 4950 4951 4952 4953 4954 4955 4956 4957
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
4958 4959
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
4960 4961 4962 4963
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
4964 4965
    {"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")},
4966 4967 4968
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4969
static bool
4970 4971
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4972
    bool ret = true;
4973 4974
    const char *format = NULL;
    const char *xmlFile = NULL;
4975 4976
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
4977
    unsigned int flags = 0;
4978

4979
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4980
        return false;
4981

4982 4983
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
4984
        return false;
4985

4986
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
4987
        return false;
4988 4989 4990

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
4991
        vshPrint(ctl, "%s", configData);
4992
        VIR_FREE(configData);
4993
    } else {
E
Eric Blake 已提交
4994
        ret = false;
4995 4996 4997 4998 4999
    }

    return ret;
}

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

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

E
Eric Blake 已提交
5014
static bool
5015
cmdDomname(vshControl *ctl, const vshCmd *cmd)
5016
{
K
Karel Zak 已提交
5017 5018
    virDomainPtr dom;

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

K
Karel Zak 已提交
5025 5026
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
5027
    return true;
K
Karel Zak 已提交
5028 5029 5030
}

/*
K
Karel Zak 已提交
5031
 * "domid" command
K
Karel Zak 已提交
5032
 */
5033
static const vshCmdInfo info_domid[] = {
5034
    {"help", N_("convert a domain name or UUID to domain id")},
5035
    {"desc", ""},
5036
    {NULL, NULL}
K
Karel Zak 已提交
5037 5038
};

5039
static const vshCmdOptDef opts_domid[] = {
5040
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
5041
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5042 5043
};

E
Eric Blake 已提交
5044
static bool
5045
cmdDomid(vshControl *ctl, const vshCmd *cmd)
5046
{
5047
    virDomainPtr dom;
5048
    unsigned int id;
K
Karel Zak 已提交
5049

5050
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5051
        return false;
J
Jim Meyering 已提交
5052
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5053
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
5054
        return false;
5055

5056 5057
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
5058
        vshPrint(ctl, "%s\n", "-");
5059
    else
5060
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
5061
    virDomainFree(dom);
E
Eric Blake 已提交
5062
    return true;
K
Karel Zak 已提交
5063
}
5064

K
Karel Zak 已提交
5065 5066 5067
/*
 * "domuuid" command
 */
5068
static const vshCmdInfo info_domuuid[] = {
5069
    {"help", N_("convert a domain name or id to domain UUID")},
5070
    {"desc", ""},
K
Karel Zak 已提交
5071 5072 5073
    {NULL, NULL}
};

5074
static const vshCmdOptDef opts_domuuid[] = {
5075
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
5076 5077 5078
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5079
static bool
5080
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
5081 5082
{
    virDomainPtr dom;
5083
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
5084

5085
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5086
        return false;
J
Jim Meyering 已提交
5087
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5088
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
5089
        return false;
5090

K
Karel Zak 已提交
5091 5092 5093
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
5094
        vshError(ctl, "%s", _("failed to get domain UUID"));
5095

5096
    virDomainFree(dom);
E
Eric Blake 已提交
5097
    return true;
K
Karel Zak 已提交
5098 5099
}

5100 5101 5102
/*
 * "migrate" command
 */
5103
static const vshCmdInfo info_migrate[] = {
5104 5105
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
5106 5107 5108
    {NULL, NULL}
};

5109
static const vshCmdOptDef opts_migrate[] = {
5110 5111 5112 5113 5114 5115 5116
    {"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")},
5117 5118
    {"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)")},
5119 5120
    {"change-protection", VSH_OT_BOOL, 0,
     N_("prevent any configuration changes to domain until migration ends)")},
W
Wen Congyang 已提交
5121
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
5122
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
5123
    {"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)")},
5124 5125
    {"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 已提交
5126
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
5127
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
5128 5129 5130
    {NULL, 0, 0, NULL}
};

5131 5132 5133 5134 5135 5136 5137 5138
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
5139
{
5140
    char ret = '1';
5141
    virDomainPtr dom = NULL;
5142 5143 5144
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
E
Eric Blake 已提交
5145
    unsigned int flags = 0;
5146 5147 5148
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
5149 5150
    const char *xmlfile = NULL;
    char *xml = NULL;
5151
    sigset_t sigmask, oldsigmask;
5152 5153 5154 5155 5156

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

5158
    if (!vshConnectionUsability (ctl, ctl->conn))
5159
        goto out;
5160

J
Jim Meyering 已提交
5161
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
5162
        goto out;
5163

5164 5165
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
5166 5167
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
5168
        goto out;
5169
    }
5170

5171 5172 5173 5174 5175
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

5176 5177
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
5178 5179
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
5180
    if (vshCommandOptBool (cmd, "tunnelled"))
5181
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
5182

C
Chris Lalancette 已提交
5183 5184 5185 5186 5187
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

5188 5189 5190
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

5191 5192 5193 5194 5195 5196
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

5197 5198
    if (vshCommandOptBool (cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;
5199 5200 5201 5202 5203 5204

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


5205 5206 5207 5208
    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. */
5209

5210
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
5211
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
5212
            goto out;
5213
        }
5214

5215
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
5216
            ret = '0';
5217 5218 5219 5220 5221 5222
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
5223
        if (!dconn) goto out;
5224

5225
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
5226 5227
        if (ddom) {
            virDomainFree(ddom);
5228
            ret = '0';
5229 5230 5231
        }
        virConnectClose (dconn);
    }
5232

5233 5234 5235
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
5236
    if (dom) virDomainFree (dom);
5237
    VIR_FREE(xml);
5238 5239 5240
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
5241
static void
5242 5243
print_job_progress(const char *label, unsigned long long remaining,
                   unsigned long long total)
W
Wen Congyang 已提交
5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262
{
    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;
        }
    }

5263 5264
    /* see comments in vshError about why we must flush */
    fflush(stdout);
5265
    fprintf(stderr, "\r%s: [%3d %%]", label, progress);
5266
    fflush(stderr);
W
Wen Congyang 已提交
5267 5268
}

E
Eric Blake 已提交
5269
static bool
5270 5271 5272 5273 5274
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
5275
    bool functionReturn = false;
5276 5277 5278 5279 5280
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
5281 5282
    virDomainJobInfo jobinfo;
    bool verbose = false;
5283
    int timeout = 0;
W
Wen Congyang 已提交
5284 5285
    struct timeval start, curr;
    bool live_flag = false;
5286
    vshCtrlData data;
5287 5288 5289 5290
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
5291 5292

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

W
Wen Congyang 已提交
5295 5296 5297
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
5298
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
5299
        live_flag = true;
5300
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317
        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;
        }
    }

5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340
    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 已提交
5341
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
5342
    while (1) {
5343
repoll:
W
Wen Congyang 已提交
5344 5345 5346 5347
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
5348
                    functionReturn = true;
W
Wen Congyang 已提交
5349 5350
                    if (verbose) {
                        /* print [100 %] */
5351
                        print_job_progress("Migration", 0, 1);
W
Wen Congyang 已提交
5352 5353
                    }
                } else
W
Wen Congyang 已提交
5354
                    functionReturn = false;
5355
            } else
W
Wen Congyang 已提交
5356
                functionReturn = false;
W
Wen Congyang 已提交
5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
5368
            functionReturn = false;
W
Wen Congyang 已提交
5369 5370 5371
            break;
        }

W
Wen Congyang 已提交
5372 5373 5374 5375
        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. */
5376 5377
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "suspend the domain when migration timeouts\n");
W
Wen Congyang 已提交
5378 5379 5380 5381
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
5382 5383 5384 5385 5386
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
5387 5388
                print_job_progress("Migration", jobinfo.dataRemaining,
                                   jobinfo.dataTotal);
5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
5400
    return functionReturn;
5401 5402
}

5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413
/*
 * "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")},
5414
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
5415 5416 5417
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5418
static bool
5419 5420 5421
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
5422
    long long downtime = 0;
E
Eric Blake 已提交
5423
    bool ret = false;
5424

5425
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5426
        return false;
5427 5428

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

5431 5432
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
5433 5434 5435 5436 5437 5438 5439
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
5440
    ret = true;
5441 5442 5443 5444 5445 5446

done:
    virDomainFree(dom);
    return ret;
}

5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490
/*
 * "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;
}

5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529
/*
 * "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;
}

5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546
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))
5547
        goto cleanup;
5548 5549

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
5550
        goto cleanup;
5551 5552

    if (vshCommandOptString(cmd, "path", &path) < 0)
5553
        goto cleanup;
5554

5555 5556
    if (vshCommandOptUL(cmd, "bandwidth", &bandwidth) < 0) {
        vshError(ctl, "%s", _("bandwidth must be a number"));
5557
        goto cleanup;
5558
    }
5559 5560 5561 5562 5563 5564 5565 5566 5567 5568

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

5569
cleanup:
5570 5571
    if (dom)
        virDomainFree(dom);
5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655
    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;
}


5656 5657 5658
/*
 * "net-autostart" command
 */
5659
static const vshCmdInfo info_network_autostart[] = {
5660
    {"help", N_("autostart a network")},
5661
    {"desc",
5662
     N_("Configure a network to be automatically started at boot.")},
5663 5664 5665
    {NULL, NULL}
};

5666
static const vshCmdOptDef opts_network_autostart[] = {
5667 5668
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5669 5670 5671
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5672
static bool
5673
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
5674 5675
{
    virNetworkPtr network;
5676
    const char *name;
5677 5678
    int autostart;

5679
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5680
        return false;
5681

J
Jim Meyering 已提交
5682
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5683
        return false;
5684 5685 5686 5687

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
5688
        if (autostart)
5689
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
5690
        else
5691
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
5692
        virNetworkFree(network);
E
Eric Blake 已提交
5693
        return false;
5694 5695
    }

5696
    if (autostart)
5697
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
5698
    else
5699
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
5700

L
Laine Stump 已提交
5701
    virNetworkFree(network);
E
Eric Blake 已提交
5702
    return true;
5703
}
K
Karel Zak 已提交
5704

5705 5706 5707
/*
 * "net-create" command
 */
5708
static const vshCmdInfo info_network_create[] = {
5709 5710
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
5711 5712 5713
    {NULL, NULL}
};

5714
static const vshCmdOptDef opts_network_create[] = {
5715
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5716 5717 5718
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5719
static bool
5720
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
5721 5722
{
    virNetworkPtr network;
5723
    const char *from = NULL;
E
Eric Blake 已提交
5724
    bool ret = true;
5725
    char *buffer;
5726

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

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

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

    network = virNetworkCreateXML(ctl->conn, buffer);
5737
    VIR_FREE(buffer);
5738

5739 5740 5741
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
5742
        virNetworkFree(network);
5743
    } else {
5744
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
5745
        ret = false;
5746 5747 5748 5749 5750 5751 5752 5753
    }
    return ret;
}


/*
 * "net-define" command
 */
5754
static const vshCmdInfo info_network_define[] = {
5755 5756
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
5757 5758 5759
    {NULL, NULL}
};

5760
static const vshCmdOptDef opts_network_define[] = {
5761
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5762 5763 5764
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5765
static bool
5766
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
5767 5768
{
    virNetworkPtr network;
5769
    const char *from = NULL;
E
Eric Blake 已提交
5770
    bool ret = true;
5771
    char *buffer;
5772

5773
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5774
        return false;
5775

5776
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5777
        return false;
5778

5779
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5780
        return false;
5781 5782

    network = virNetworkDefineXML(ctl->conn, buffer);
5783
    VIR_FREE(buffer);
5784

5785 5786 5787
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
5788
        virNetworkFree(network);
5789
    } else {
5790
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
5791
        ret = false;
5792 5793 5794 5795 5796 5797 5798 5799
    }
    return ret;
}


/*
 * "net-destroy" command
 */
5800
static const vshCmdInfo info_network_destroy[] = {
5801 5802
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
5803 5804 5805
    {NULL, NULL}
};

5806
static const vshCmdOptDef opts_network_destroy[] = {
5807
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5808 5809 5810
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5811
static bool
5812
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
5813 5814
{
    virNetworkPtr network;
E
Eric Blake 已提交
5815
    bool ret = true;
5816
    const char *name;
5817

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

J
Jim Meyering 已提交
5821
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5822
        return false;
5823 5824 5825 5826

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

5831
    virNetworkFree(network);
5832 5833 5834 5835 5836 5837 5838
    return ret;
}


/*
 * "net-dumpxml" command
 */
5839
static const vshCmdInfo info_network_dumpxml[] = {
5840 5841
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
5842 5843 5844
    {NULL, NULL}
};

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

E
Eric Blake 已提交
5850
static bool
5851
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
5852 5853
{
    virNetworkPtr network;
E
Eric Blake 已提交
5854
    bool ret = true;
5855 5856
    char *dump;

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

J
Jim Meyering 已提交
5860
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
5861
        return false;
5862 5863 5864

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
5865
        vshPrint(ctl, "%s", dump);
5866
        VIR_FREE(dump);
5867
    } else {
E
Eric Blake 已提交
5868
        ret = false;
5869 5870 5871 5872 5873 5874
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888
/*
 * "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 已提交
5889
static bool
O
Osier Yang 已提交
5890 5891 5892 5893 5894 5895 5896 5897 5898 5899
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 已提交
5900
        return false;
O
Osier Yang 已提交
5901 5902 5903

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5904
        return false;
O
Osier Yang 已提交
5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929

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

5930
    VIR_FREE(bridge);
O
Osier Yang 已提交
5931
    virNetworkFree(network);
E
Eric Blake 已提交
5932
    return true;
O
Osier Yang 已提交
5933
}
5934

5935 5936 5937 5938
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
5939 5940
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
5941 5942 5943 5944
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
5945
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5946 5947 5948
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5949
static bool
5950 5951
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5952
    bool ret = false;
5953 5954 5955 5956 5957
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
5958
    unsigned int flags = VIR_INTERFACE_XML_INACTIVE;
5959

5960
    if (!vshConnectionUsability(ctl, ctl->conn))
5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986
        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 已提交
5987
        ret = true;
5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999
        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)) {
6000 6001
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013
        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 已提交
6014
    ret = true;
6015 6016 6017 6018 6019

cleanup:
    if (iface)
        virInterfaceFree (iface);

6020 6021 6022
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
6023 6024 6025

    if (tmp) {
        unlink (tmp);
6026
        VIR_FREE(tmp);
6027 6028 6029 6030 6031
    }

    return ret;
}

6032 6033 6034
/*
 * "net-list" command
 */
6035
static const vshCmdInfo info_network_list[] = {
6036 6037
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
6038 6039 6040
    {NULL, NULL}
};

6041
static const vshCmdOptDef opts_network_list[] = {
6042 6043
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
6044 6045 6046
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6047
static bool
6048
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6049 6050 6051 6052 6053
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
6054
    char **activeNames = NULL, **inactiveNames = NULL;
6055 6056
    inactive |= all;

6057
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6058
        return false;
6059 6060

    if (active) {
6061 6062
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
6063
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
6064
            return false;
6065
        }
6066
        if (maxactive) {
6067
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
6068

6069
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
6070
                                                    maxactive)) < 0) {
6071
                vshError(ctl, "%s", _("Failed to list active networks"));
6072
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6073
                return false;
6074
            }
6075

6076
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
6077
        }
6078 6079
    }
    if (inactive) {
6080 6081
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
6082
            vshError(ctl, "%s", _("Failed to list inactive networks"));
6083
            VIR_FREE(activeNames);
E
Eric Blake 已提交
6084
            return false;
6085
        }
6086 6087 6088
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

6089 6090 6091
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
6092
                vshError(ctl, "%s", _("Failed to list inactive networks"));
6093 6094
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6095
                return false;
6096
            }
6097

6098 6099
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
6100
    }
6101 6102
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
6103
    vshPrintExtra(ctl, "-----------------------------------------\n");
6104 6105

    for (i = 0; i < maxactive; i++) {
6106 6107
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
6108 6109
        const char *autostartStr;
        int autostart = 0;
6110 6111 6112

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6113
            VIR_FREE(activeNames[i]);
6114
            continue;
6115
        }
6116

6117 6118 6119
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6120
            autostartStr = autostart ? _("yes") : _("no");
6121 6122 6123 6124 6125

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
6126
        virNetworkFree(network);
6127
        VIR_FREE(activeNames[i]);
6128 6129 6130
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
6131 6132
        const char *autostartStr;
        int autostart = 0;
6133 6134 6135

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6136
            VIR_FREE(inactiveNames[i]);
6137
            continue;
6138
        }
6139

6140 6141 6142
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6143
            autostartStr = autostart ? _("yes") : _("no");
6144

6145
        vshPrint(ctl, "%-20s %-10s %-10s\n",
6146 6147 6148
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
6149 6150

        virNetworkFree(network);
6151
        VIR_FREE(inactiveNames[i]);
6152
    }
6153 6154
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6155
    return true;
6156 6157 6158 6159 6160 6161
}


/*
 * "net-name" command
 */
6162
static const vshCmdInfo info_network_name[] = {
6163
    {"help", N_("convert a network UUID to network name")},
6164
    {"desc", ""},
6165 6166 6167
    {NULL, NULL}
};

6168
static const vshCmdOptDef opts_network_name[] = {
6169
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
6170 6171 6172
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6173
static bool
6174
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
6175 6176 6177
{
    virNetworkPtr network;

6178
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6179
        return false;
J
Jim Meyering 已提交
6180
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
6181
                                           VSH_BYUUID)))
E
Eric Blake 已提交
6182
        return false;
6183 6184 6185

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
6186
    return true;
6187 6188 6189 6190 6191 6192
}


/*
 * "net-start" command
 */
6193
static const vshCmdInfo info_network_start[] = {
6194 6195
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
6196 6197 6198
    {NULL, NULL}
};

6199
static const vshCmdOptDef opts_network_start[] = {
6200
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
6201 6202 6203
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6204
static bool
6205
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
6206 6207
{
    virNetworkPtr network;
E
Eric Blake 已提交
6208
    bool ret = true;
6209

6210
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6211
        return false;
6212

J
Jim Meyering 已提交
6213
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
6214
         return false;
6215 6216 6217

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
6218
                 virNetworkGetName(network));
6219
    } else {
6220
        vshError(ctl, _("Failed to start network %s"),
6221
                 virNetworkGetName(network));
E
Eric Blake 已提交
6222
        ret = false;
6223
    }
L
Laine Stump 已提交
6224
    virNetworkFree(network);
6225 6226 6227 6228 6229 6230 6231
    return ret;
}


/*
 * "net-undefine" command
 */
6232
static const vshCmdInfo info_network_undefine[] = {
6233 6234
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
6235 6236 6237
    {NULL, NULL}
};

6238
static const vshCmdOptDef opts_network_undefine[] = {
6239
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6240 6241 6242
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6243
static bool
6244
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
6245 6246
{
    virNetworkPtr network;
E
Eric Blake 已提交
6247
    bool ret = true;
6248
    const char *name;
6249

6250
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6251
        return false;
6252

J
Jim Meyering 已提交
6253
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6254
        return false;
6255 6256 6257 6258

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

L
Laine Stump 已提交
6263
    virNetworkFree(network);
6264 6265 6266 6267 6268 6269 6270
    return ret;
}


/*
 * "net-uuid" command
 */
6271
static const vshCmdInfo info_network_uuid[] = {
6272
    {"help", N_("convert a network name to network UUID")},
6273
    {"desc", ""},
6274 6275 6276
    {NULL, NULL}
};

6277
static const vshCmdOptDef opts_network_uuid[] = {
6278
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
6279 6280 6281
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6282
static bool
6283
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
6284 6285 6286 6287
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

6288
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6289
        return false;
6290

J
Jim Meyering 已提交
6291
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
6292
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6293
        return false;
6294 6295 6296 6297

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

L
Laine Stump 已提交
6300
    virNetworkFree(network);
E
Eric Blake 已提交
6301
    return true;
6302 6303 6304
}


6305 6306 6307 6308 6309
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
6310 6311
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
6312 6313 6314 6315
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
6316 6317
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
6318 6319
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
6320
static bool
6321 6322 6323 6324 6325 6326 6327 6328 6329
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;

6330
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6331
        return false;
6332 6333 6334 6335

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
6336
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
6337
            return false;
6338 6339 6340 6341 6342 6343
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
6344
                vshError(ctl, "%s", _("Failed to list active interfaces"));
6345
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6346
                return false;
6347 6348 6349 6350 6351 6352 6353 6354
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
6355
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6356
            VIR_FREE(activeNames);
E
Eric Blake 已提交
6357
            return false;
6358 6359 6360 6361
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

6362 6363 6364
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
6365
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6366 6367
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6368
                return false;
6369 6370 6371 6372 6373
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
6374 6375
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
6376 6377 6378
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
6379 6380
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
6381 6382 6383

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6384
            VIR_FREE(activeNames[i]);
6385 6386 6387 6388 6389 6390 6391 6392
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6393
        VIR_FREE(activeNames[i]);
6394 6395
    }
    for (i = 0; i < maxinactive; i++) {
6396 6397
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
6398 6399 6400

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6401
            VIR_FREE(inactiveNames[i]);
6402 6403 6404 6405 6406 6407 6408 6409
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6410
        VIR_FREE(inactiveNames[i]);
6411
    }
6412 6413
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6414
    return true;
6415 6416 6417 6418 6419 6420 6421

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
6422
    {"help", N_("convert an interface MAC address to interface name")},
6423 6424 6425 6426 6427
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
6428
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
6429 6430 6431
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6432
static bool
6433 6434 6435 6436
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6437
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6438
        return false;
6439 6440
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
6441
        return false;
6442 6443 6444

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6445
    return true;
6446 6447 6448 6449 6450 6451
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
6452
    {"help", N_("convert an interface name to interface MAC address")},
6453 6454 6455 6456 6457
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
6458
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
6459 6460 6461
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6462
static bool
6463 6464 6465 6466
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6467
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6468
        return false;
6469 6470
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6471
        return false;
6472 6473 6474

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6475
    return true;
6476 6477 6478 6479 6480 6481
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
6482 6483
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
6484 6485 6486 6487
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
6488 6489
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
6490 6491 6492
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6493
static bool
6494 6495 6496
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6497
    bool ret = true;
6498
    char *dump;
E
Eric Blake 已提交
6499
    unsigned int flags = 0;
6500 6501 6502 6503
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
6504

6505
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6506
        return false;
6507 6508

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

6511
    dump = virInterfaceGetXMLDesc(iface, flags);
6512
    if (dump != NULL) {
6513
        vshPrint(ctl, "%s", dump);
6514
        VIR_FREE(dump);
6515
    } else {
E
Eric Blake 已提交
6516
        ret = false;
6517 6518 6519 6520 6521 6522 6523 6524 6525 6526
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
6527 6528
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
6529 6530 6531 6532
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
6533
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
6534 6535 6536
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6537
static bool
6538 6539
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
6540
    virInterfacePtr iface;
6541
    const char *from = NULL;
E
Eric Blake 已提交
6542
    bool ret = true;
6543 6544
    char *buffer;

6545
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6546
        return false;
6547

6548
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6549
        return false;
6550 6551

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

6554
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
6555
    VIR_FREE(buffer);
6556

6557
    if (iface != NULL) {
6558
        vshPrint(ctl, _("Interface %s defined from %s\n"),
6559
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
6560
        virInterfaceFree (iface);
6561
    } else {
6562
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
6563
        ret = false;
6564 6565 6566 6567 6568 6569 6570 6571
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
6572 6573
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
6574 6575 6576 6577
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
6578
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6579 6580 6581
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6582
static bool
6583 6584 6585
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6586
    bool ret = true;
6587
    const char *name;
6588

6589
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6590
        return false;
6591 6592

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6593
        return false;
6594 6595 6596 6597

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
6598
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
6599
        ret = false;
6600 6601 6602 6603 6604 6605 6606 6607 6608 6609
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
6610 6611
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
6612 6613 6614 6615
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
6616
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6617 6618 6619
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6620
static bool
6621 6622 6623
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6624
    bool ret = true;
6625
    const char *name;
6626

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

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6631
        return false;
6632 6633 6634 6635

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
6636
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
6637
        ret = false;
6638 6639 6640 6641 6642 6643 6644 6645 6646 6647
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
6648
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
6649
    {"desc", N_("forcefully stop a physical host interface.")},
6650 6651 6652 6653
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
6654
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6655 6656 6657
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6658
static bool
6659 6660 6661
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6662
    bool ret = true;
6663
    const char *name;
6664

6665
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6666
        return false;
6667 6668

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6669
        return false;
6670 6671 6672 6673

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
6674
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
6675
        ret = false;
6676 6677 6678 6679 6680 6681
    }

    virInterfaceFree(iface);
    return ret;
}

6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766
/*
 * "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;
}
6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781

/*
 * "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 已提交
6782
static bool
6783 6784 6785
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
6786
    const char *from = NULL;
E
Eric Blake 已提交
6787
    bool ret = true;
6788 6789
    char *buffer;

6790
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6791
        return false;
6792

6793
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6794
        return false;
6795 6796

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6797
        return false;
6798 6799 6800 6801 6802 6803 6804 6805 6806 6807

    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 已提交
6808
        ret = false;
6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827
    }
    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 已提交
6828
static bool
6829 6830 6831
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6832
    bool ret = true;
6833
    const char *name;
6834

6835
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6836
        return false;
6837 6838

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
6839
        return false;
6840 6841 6842 6843 6844

    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 已提交
6845
        ret = false;
6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866
    }

    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 已提交
6867
static bool
6868 6869 6870
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6871
    bool ret = true;
6872 6873
    char *dump;

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

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
6878
        return false;
6879 6880 6881

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
6882
        vshPrint(ctl, "%s", dump);
6883 6884
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
6885
        ret = false;
6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904
    }

    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 已提交
6905
static bool
6906 6907 6908 6909 6910 6911
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

6912
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6913
        return false;
6914 6915 6916 6917

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
6918
        return false;
6919 6920 6921 6922 6923 6924 6925 6926
    }

    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 已提交
6927
        return false;
6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954
    }

    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 已提交
6955
    return true;
6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972
}


/*
 * "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 已提交
6973
static bool
6974 6975
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6976
    bool ret = false;
6977 6978 6979 6980 6981 6982
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

6983
    if (!vshConnectionUsability(ctl, ctl->conn))
6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009
        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 已提交
7010
        ret = true;
7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036
        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 已提交
7037
    ret = true;
7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055

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


7056
/**************************************************************************/
7057
/*
7058
 * "pool-autostart" command
7059
 */
7060
static const vshCmdInfo info_pool_autostart[] = {
7061
    {"help", N_("autostart a pool")},
7062
    {"desc",
7063
     N_("Configure a pool to be automatically started at boot.")},
7064
    {NULL, NULL}
7065 7066
};

7067
static const vshCmdOptDef opts_pool_autostart[] = {
7068 7069
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
7070 7071
    {NULL, 0, 0, NULL}
};
7072

E
Eric Blake 已提交
7073
static bool
7074
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
7075
{
7076
    virStoragePoolPtr pool;
7077
    const char *name;
7078
    int autostart;
7079

7080
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7081
        return false;
7082

7083
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7084
        return false;
7085

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

7088 7089
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
7090
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
7091
        else
7092
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
7093
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7094
        return false;
7095 7096
    }

7097
    if (autostart)
7098
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
7099
    else
7100
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
7101

L
Laine Stump 已提交
7102
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7103
    return true;
7104 7105
}

7106
/*
7107
 * "pool-create" command
7108
 */
7109
static const vshCmdInfo info_pool_create[] = {
7110 7111
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
7112 7113 7114
    {NULL, NULL}
};

7115
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
7116
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
7117
     N_("file containing an XML pool description")},
7118 7119 7120
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7121
static bool
7122
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
7123
{
7124
    virStoragePoolPtr pool;
7125
    const char *from = NULL;
E
Eric Blake 已提交
7126
    bool ret = true;
7127
    char *buffer;
7128

7129
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7130
        return false;
7131

7132
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7133
        return false;
7134

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

7138
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
7139
    VIR_FREE(buffer);
7140 7141 7142 7143

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7144
        virStoragePoolFree(pool);
7145
    } else {
7146
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
7147
        ret = false;
7148 7149
    }
    return ret;
7150 7151
}

7152

7153 7154 7155 7156
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
7157
    {"help", N_("create a device defined "
7158
                          "by an XML file on the node")},
7159
    {"desc", N_("Create a device on the node.  Note that this "
7160 7161 7162 7163 7164 7165 7166
                          "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,
7167
     N_("file containing an XML description of the device")},
7168 7169 7170
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7171
static bool
7172 7173 7174
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
7175
    const char *from = NULL;
E
Eric Blake 已提交
7176
    bool ret = true;
7177 7178
    char *buffer;

7179
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7180
        return false;
7181

7182
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7183
        return false;
7184

7185
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
7186
        return false;
7187 7188

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
7189
    VIR_FREE(buffer);
7190 7191 7192 7193

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
7194
        virNodeDeviceFree(dev);
7195
    } else {
7196
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
7197
        ret = false;
7198 7199 7200 7201 7202 7203 7204 7205 7206 7207
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
7208
    {"help", N_("destroy (stop) a device on the node")},
7209
    {"desc", N_("Destroy a device on the node.  Note that this "
7210
                "command destroys devices on the physical host")},
7211 7212 7213 7214 7215
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
7216
     N_("name of the device to be destroyed")},
7217 7218 7219
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7220
static bool
7221 7222 7223
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
7224
    bool ret = true;
7225
    const char *name = NULL;
7226

7227
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
7228
        return false;
7229 7230
    }

7231
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
7232
        return false;
7233 7234 7235 7236 7237 7238

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
7239
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
7240
        ret = false;
7241 7242 7243 7244 7245 7246 7247
    }

    virNodeDeviceFree(dev);
    return ret;
}


7248
/*
7249
 * XML Building helper for pool-define-as and pool-create-as
7250
 */
7251
static const vshCmdOptDef opts_pool_X_as[] = {
7252 7253 7254 7255 7256 7257 7258 7259
    {"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")},
7260
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
7261 7262 7263
    {NULL, 0, 0, NULL}
};

7264
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
7265

7266 7267
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
7268
    virBuffer buf = VIR_BUFFER_INITIALIZER;
7269

7270
    if (vshCommandOptString(cmd, "name", &name) <= 0)
7271
        goto cleanup;
7272
    if (vshCommandOptString(cmd, "type", &type) <= 0)
7273 7274
        goto cleanup;

7275 7276 7277 7278 7279
    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 ||
7280 7281
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
7282
        goto cleanup;
7283
    }
7284

7285 7286
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
7287
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
7288
        virBufferAddLit(&buf, "  <source>\n");
7289

7290
        if (srcHost)
7291
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
7292
        if (srcPath)
7293
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
7294
        if (srcDev)
7295
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
7296
        if (srcFormat)
7297
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
7298
        if (srcName)
7299
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
7300 7301

        virBufferAddLit(&buf, "  </source>\n");
7302 7303
    }
    if (target) {
7304
        virBufferAddLit(&buf, "  <target>\n");
7305
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
7306
        virBufferAddLit(&buf, "  </target>\n");
7307
    }
7308 7309 7310 7311
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7312
        return false;
7313
    }
7314 7315 7316

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
7317
    return true;
7318 7319

cleanup:
7320
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7321
    return false;
7322 7323 7324 7325 7326 7327
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
7328 7329
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
7330 7331 7332
    {NULL, NULL}
};

E
Eric Blake 已提交
7333
static bool
7334 7335 7336
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
7337 7338
    const char *name;
    char *xml;
7339
    int printXML = vshCommandOptBool(cmd, "print-xml");
7340

7341
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7342
        return false;
7343 7344

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

7347
    if (printXML) {
7348
        vshPrint(ctl, "%s", xml);
7349
        VIR_FREE(xml);
7350
    } else {
7351
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
7352
        VIR_FREE(xml);
7353

7354 7355 7356 7357
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
7358
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
7359
            return false;
7360 7361
        }
    }
E
Eric Blake 已提交
7362
    return true;
7363 7364
}

7365

7366
/*
7367
 * "pool-define" command
7368
 */
7369
static const vshCmdInfo info_pool_define[] = {
7370 7371
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
7372 7373 7374
    {NULL, NULL}
};

7375
static const vshCmdOptDef opts_pool_define[] = {
7376
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
7377 7378 7379
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7380
static bool
7381
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
7382
{
7383
    virStoragePoolPtr pool;
7384
    const char *from = NULL;
E
Eric Blake 已提交
7385
    bool ret = true;
7386
    char *buffer;
7387

7388
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7389
        return false;
7390

7391
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7392
        return false;
7393

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

7397
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
7398
    VIR_FREE(buffer);
7399 7400 7401 7402

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7403
        virStoragePoolFree(pool);
7404
    } else {
7405
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
7406
        ret = false;
7407 7408
    }
    return ret;
7409 7410
}

7411

7412 7413 7414
/*
 * "pool-define-as" command
 */
7415
static const vshCmdInfo info_pool_define_as[] = {
7416 7417
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
7418 7419 7420
    {NULL, NULL}
};

E
Eric Blake 已提交
7421
static bool
7422
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
7423 7424
{
    virStoragePoolPtr pool;
7425 7426
    const char *name;
    char *xml;
7427
    int printXML = vshCommandOptBool(cmd, "print-xml");
7428

7429
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7430
        return false;
7431

7432
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
7433
        return false;
7434

7435
    if (printXML) {
7436
        vshPrint(ctl, "%s", xml);
7437
        VIR_FREE(xml);
7438
    } else {
7439
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
7440
        VIR_FREE(xml);
7441

7442 7443 7444 7445
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
7446
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
7447
            return false;
7448 7449
        }
    }
E
Eric Blake 已提交
7450
    return true;
7451 7452 7453
}


7454
/*
7455
 * "pool-build" command
7456
 */
7457
static const vshCmdInfo info_pool_build[] = {
7458 7459
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
7460 7461 7462
    {NULL, NULL}
};

7463
static const vshCmdOptDef opts_pool_build[] = {
7464
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7465 7466
    {"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")},
7467 7468 7469
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7470
static bool
7471
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
7472
{
7473
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7474
    bool ret = true;
7475
    const char *name;
7476
    unsigned int flags = 0;
7477

7478
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7479
        return false;
7480

7481
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7482
        return false;
7483

7484 7485 7486 7487 7488 7489 7490 7491 7492
    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) {
7493
        vshPrint(ctl, _("Pool %s built\n"), name);
7494
    } else {
7495
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
7496
        ret = false;
7497 7498
    }

7499 7500
    virStoragePoolFree(pool);

7501 7502 7503
    return ret;
}

7504
/*
7505
 * "pool-destroy" command
7506
 */
7507
static const vshCmdInfo info_pool_destroy[] = {
7508 7509 7510
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
7511 7512 7513
    {NULL, NULL}
};

7514
static const vshCmdOptDef opts_pool_destroy[] = {
7515
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7516 7517 7518
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7519
static bool
7520
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
7521
{
7522
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7523
    bool ret = true;
7524
    const char *name;
7525

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

7529
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7530
        return false;
7531

7532 7533 7534
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
7535
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
7536
        ret = false;
7537 7538
    }

7539
    virStoragePoolFree(pool);
7540 7541 7542
    return ret;
}

7543

7544
/*
7545 7546
 * "pool-delete" command
 */
7547
static const vshCmdInfo info_pool_delete[] = {
7548 7549
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
7550 7551 7552
    {NULL, NULL}
};

7553
static const vshCmdOptDef opts_pool_delete[] = {
7554
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7555 7556 7557
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7558
static bool
7559
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
7560 7561
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7562
    bool ret = true;
7563
    const char *name;
7564

7565
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7566
        return false;
7567 7568

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7569
        return false;
7570 7571

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
7572
        vshPrint(ctl, _("Pool %s deleted\n"), name);
7573
    } else {
7574
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
7575
        ret = false;
7576 7577
    }

L
Laine Stump 已提交
7578
    virStoragePoolFree(pool);
7579 7580 7581 7582 7583 7584 7585
    return ret;
}


/*
 * "pool-refresh" command
 */
7586
static const vshCmdInfo info_pool_refresh[] = {
7587 7588
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
7589 7590 7591
    {NULL, NULL}
};

7592
static const vshCmdOptDef opts_pool_refresh[] = {
7593
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7594 7595 7596
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7597
static bool
7598
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
7599 7600
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7601
    bool ret = true;
7602
    const char *name;
7603

7604
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7605
        return false;
7606 7607

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7608
        return false;
7609 7610 7611 7612

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
7613
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
7614
        ret = false;
7615 7616 7617 7618 7619 7620 7621 7622 7623 7624
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
7625
static const vshCmdInfo info_pool_dumpxml[] = {
7626 7627
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
7628 7629 7630
    {NULL, NULL}
};

7631
static const vshCmdOptDef opts_pool_dumpxml[] = {
7632
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7633 7634 7635
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7636
static bool
7637
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
7638 7639
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7640
    bool ret = true;
7641 7642
    char *dump;

7643
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7644
        return false;
7645 7646

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7647
        return false;
7648 7649 7650

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
7651
        vshPrint(ctl, "%s", dump);
7652
        VIR_FREE(dump);
7653
    } else {
E
Eric Blake 已提交
7654
        ret = false;
7655 7656 7657 7658 7659 7660 7661 7662 7663 7664
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
7665
static const vshCmdInfo info_pool_list[] = {
7666 7667
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
7668 7669 7670
    {NULL, NULL}
};

7671
static const vshCmdOptDef opts_pool_list[] = {
7672 7673
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
7674
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
7675 7676 7677
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7678
static bool
7679
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7680
{
7681 7682
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
7683 7684
    int i, ret;
    bool functionReturn;
7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700
    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 */
7701
    int all = vshCommandOptBool(cmd, "all");
7702 7703
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
7704 7705 7706
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

7707
    /* Check the connection to libvirtd daemon is still working */
7708
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7709
        return false;
7710

7711
    /* Retrieve the number of active storage pools */
7712
    if (active) {
7713 7714
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
7715
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
7716
            return false;
7717 7718
        }
    }
7719 7720

    /* Retrieve the number of inactive storage pools */
7721
    if (inactive) {
7722 7723
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
7724
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
7725
            return false;
7726
        }
7727
    }
7728

7729 7730
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
7731

7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743
    /* 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 已提交
7744
            return false;
7745 7746 7747
        }
    }

7748 7749 7750 7751 7752 7753 7754 7755
    /* 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 已提交
7756
            return false;
7757 7758
        }
    }
7759

7760 7761 7762 7763 7764 7765 7766 7767 7768 7769
    /* 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]);
7770
        if (!pool) {
7771
            VIR_FREE(poolNames[i]);
7772 7773 7774
            continue;
        }

7775
        /* Retrieve the autostart status of the pool */
7776
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
7777
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
7778
        else
7779 7780 7781 7782 7783 7784
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
7785 7786
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797
            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;
        }
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 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 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
        /* 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 */
7911 7912 7913
        virStoragePoolFree(pool);
    }

7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931
    /* 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);
7932 7933
        }

7934
        /* Cleanup and return */
E
Eric Blake 已提交
7935
        functionReturn = true;
7936 7937
        goto cleanup;
    }
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 7969 7970 7971 7972 7973 7974 7975 7976
    /* 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. */
7977
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
7978
             (unsigned long) nameStrLength);
7979
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
7980
             (unsigned long) stateStrLength);
7981
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
7982
             (unsigned long) autostartStrLength);
7983
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
7984
             (unsigned long) persistStrLength);
7985
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
7986
             (unsigned long) capStrLength);
7987
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
7988
             (unsigned long) allocStrLength);
7989
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032
             (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 已提交
8033
    functionReturn = true;
8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047
    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 已提交
8048
    functionReturn = false;
8049

8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061
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]);
8062
    }
8063 8064 8065 8066 8067 8068 8069

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

    /* Return the desired value */
    return functionReturn;
8070 8071
}

8072 8073 8074 8075
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
8076 8077
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
8078 8079 8080 8081 8082
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
8083 8084 8085
     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")},
8086
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
8087 8088 8089
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8090
static bool
8091 8092
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
8093
    const char *type = NULL, *host = NULL;
8094 8095
    char *srcSpec = NULL;
    char *srcList;
8096
    const char *initiator = NULL;
8097

8098 8099
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
8100 8101
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
8102
        return false;
8103
    }
8104

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

    if (host) {
8109
        const char *port = NULL;
8110
        virBuffer buf = VIR_BUFFER_INITIALIZER;
8111 8112 8113 8114

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
8115
            return false;
8116
        }
8117
        virBufferAddLit(&buf, "<source>\n");
8118
        virBufferAsprintf(&buf, "  <host name='%s'", host);
8119
        if (port)
8120
            virBufferAsprintf(&buf, " port='%s'", port);
8121
        virBufferAddLit(&buf, "/>\n");
8122 8123
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
8124
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
8125 8126
            virBufferAddLit(&buf, "  </initiator>\n");
        }
8127 8128 8129
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
8130
            return false;
8131
        }
8132
        srcSpec = virBufferContentAndReset(&buf);
8133 8134 8135
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
8136
    VIR_FREE(srcSpec);
8137
    if (srcList == NULL) {
8138
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
8139
        return false;
8140 8141
    }
    vshPrint(ctl, "%s", srcList);
8142
    VIR_FREE(srcList);
8143

E
Eric Blake 已提交
8144
    return true;
8145 8146 8147 8148 8149 8150 8151
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
8152 8153
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
8154 8155 8156 8157 8158
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
8159
     N_("type of storage pool sources to discover")},
8160
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
8161
     N_("optional file of source xml to query for pools")},
8162 8163 8164
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8165
static bool
8166 8167
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
8168
    const char *type = NULL, *srcSpecFile = NULL;
8169
    char *srcSpec = NULL, *srcList;
8170

8171
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
8172
        return false;
8173

8174 8175
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
8176
        return false;
8177
    }
8178

8179
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8180
        return false;
8181 8182

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
8183
        return false;
8184 8185

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
8186
    VIR_FREE(srcSpec);
8187
    if (srcList == NULL) {
8188
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
8189
        return false;
8190 8191
    }
    vshPrint(ctl, "%s", srcList);
8192
    VIR_FREE(srcList);
8193

E
Eric Blake 已提交
8194
    return true;
8195 8196 8197
}


8198 8199 8200
/*
 * "pool-info" command
 */
8201
static const vshCmdInfo info_pool_info[] = {
8202 8203
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
8204 8205 8206
    {NULL, NULL}
};

8207
static const vshCmdOptDef opts_pool_info[] = {
8208
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8209 8210 8211
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8212
static bool
8213
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
8214 8215 8216
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
8217 8218
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
8219
    bool ret = true;
8220 8221
    char uuid[VIR_UUID_STRING_BUFLEN];

8222
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8223
        return false;
8224 8225

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8226
        return false;
8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252

    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;
8253 8254 8255 8256
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
8257 8258
        }

8259 8260
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
8261 8262
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
8263 8264 8265 8266 8267 8268 8269
        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);
8270 8271
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
8272 8273 8274 8275 8276
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288
        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 已提交
8289
        ret = false;
8290 8291 8292 8293 8294 8295 8296 8297 8298 8299
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
8300
static const vshCmdInfo info_pool_name[] = {
8301
    {"help", N_("convert a pool UUID to pool name")},
8302
    {"desc", ""},
8303 8304 8305
    {NULL, NULL}
};

8306
static const vshCmdOptDef opts_pool_name[] = {
8307
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
8308 8309 8310
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8311
static bool
8312
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
8313 8314 8315
{
    virStoragePoolPtr pool;

8316
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8317
        return false;
8318
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8319
                                           VSH_BYUUID)))
E
Eric Blake 已提交
8320
        return false;
8321 8322 8323

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8324
    return true;
8325 8326 8327 8328 8329 8330
}


/*
 * "pool-start" command
 */
8331
static const vshCmdInfo info_pool_start[] = {
8332 8333
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
8334 8335 8336
    {NULL, NULL}
};

8337
static const vshCmdOptDef opts_pool_start[] = {
8338
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
8339 8340 8341
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8342
static bool
8343
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
8344 8345
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8346
    bool ret = true;
8347

8348
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8349
        return false;
8350

8351
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
8352
         return false;
8353 8354 8355 8356 8357

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
8358
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
8359
        ret = false;
8360
    }
L
Laine Stump 已提交
8361 8362

    virStoragePoolFree(pool);
8363 8364 8365 8366
    return ret;
}


8367 8368 8369
/*
 * "vol-create-as" command
 */
8370
static const vshCmdInfo info_vol_create_as[] = {
8371 8372
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
8373 8374 8375
    {NULL, NULL}
};

8376
static const vshCmdOptDef opts_vol_create_as[] = {
8377 8378 8379 8380 8381
    {"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")},
8382 8383
    {"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")},
8384 8385 8386 8387 8388 8389 8390 8391 8392 8393
    {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 已提交
8394
        /* Deliberate fallthrough cases here :-) */
8395 8396 8397
        switch (*end) {
        case 'T':
            *val *= 1024;
8398
            /* fallthrough */
8399 8400
        case 'G':
            *val *= 1024;
8401
            /* fallthrough */
8402 8403
        case 'M':
            *val *= 1024;
8404
            /* fallthrough */
8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
8418
static bool
8419
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
8420 8421 8422
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8423
    char *xml;
8424 8425
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
8426
    unsigned long long capacity, allocation = 0;
8427
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8428

8429
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8430
        return false;
8431 8432 8433

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

8436
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8437 8438
        goto cleanup;

8439
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
8440 8441
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
8442
        vshError(ctl, _("Malformed size %s"), capacityStr);
8443

8444 8445
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
8446
        vshError(ctl, _("Malformed size %s"), allocationStr);
8447

8448 8449 8450 8451 8452 8453 8454
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

8455

8456
    virBufferAddLit(&buf, "<volume>\n");
8457 8458
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
8459
    if (allocationStr)
8460
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
8461 8462

    if (format) {
8463
        virBufferAddLit(&buf, "  <target>\n");
8464
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
8465
        virBufferAddLit(&buf, "  </target>\n");
8466
    }
8467

8468 8469 8470 8471
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
8472 8473
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
8474 8475 8476
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
8477 8478
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
8479 8480 8481 8482 8483
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
8484 8485
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
8486 8487 8488
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
8489 8490
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
8491 8492 8493 8494 8495
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
8496 8497
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
8498 8499 8500
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
8501 8502
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
8503 8504 8505 8506
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
8507
            goto cleanup;
8508 8509 8510 8511 8512
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
8513
            goto cleanup;
8514 8515 8516 8517
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
8518
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
8519
        if (snapshotStrFormat)
8520
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
8521 8522 8523 8524 8525 8526 8527 8528
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

8530 8531
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
8532
        goto cleanup;
8533 8534 8535
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
8536
    VIR_FREE(xml);
8537 8538 8539 8540 8541
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
8542
        return true;
8543
    } else {
8544
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
8545
        return false;
8546 8547 8548
    }

 cleanup:
8549
    virBufferFreeAndReset(&buf);
8550
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8551
    return false;
8552 8553 8554
}


8555 8556 8557
/*
 * "pool-undefine" command
 */
8558
static const vshCmdInfo info_pool_undefine[] = {
8559 8560
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
8561 8562 8563
    {NULL, NULL}
};

8564
static const vshCmdOptDef opts_pool_undefine[] = {
8565
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8566 8567 8568
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8569
static bool
8570
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
8571 8572
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8573
    bool ret = true;
8574
    const char *name;
8575

8576
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8577
        return false;
8578 8579

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8580
        return false;
8581 8582 8583 8584

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

L
Laine Stump 已提交
8589
    virStoragePoolFree(pool);
8590 8591 8592 8593 8594 8595 8596
    return ret;
}


/*
 * "pool-uuid" command
 */
8597
static const vshCmdInfo info_pool_uuid[] = {
8598
    {"help", N_("convert a pool name to pool UUID")},
8599
    {"desc", ""},
8600 8601 8602
    {NULL, NULL}
};

8603
static const vshCmdOptDef opts_pool_uuid[] = {
8604
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
8605 8606 8607
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8608
static bool
8609
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
8610 8611 8612 8613
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

8614
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8615
        return false;
8616 8617

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8618
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8619
        return false;
8620 8621 8622 8623

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

L
Laine Stump 已提交
8626
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8627
    return true;
8628 8629 8630 8631 8632 8633
}


/*
 * "vol-create" command
 */
8634
static const vshCmdInfo info_vol_create[] = {
8635 8636
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
8637 8638 8639
    {NULL, NULL}
};

8640
static const vshCmdOptDef opts_vol_create[] = {
8641 8642
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
8643 8644 8645
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8646
static bool
8647
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
8648 8649 8650
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8651
    const char *from = NULL;
E
Eric Blake 已提交
8652
    bool ret = true;
8653 8654
    char *buffer;

8655
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8656
        return false;
8657 8658

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

8662
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8663
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8664
        return false;
8665 8666 8667
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8668
        virshReportError(ctl);
8669
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8670
        return false;
8671 8672 8673
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
8674
    VIR_FREE(buffer);
8675 8676 8677 8678 8679 8680 8681
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
8682
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
8683
        ret = false;
8684 8685 8686 8687
    }
    return ret;
}

8688 8689 8690 8691
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
8692 8693
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
8694 8695 8696 8697
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
8698 8699 8700
    {"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 已提交
8701
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
8702 8703 8704
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8705
static bool
8706 8707 8708 8709
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
8710
    const char *from = NULL;
E
Eric Blake 已提交
8711
    bool ret = false;
8712 8713
    char *buffer = NULL;

8714
    if (!vshConnectionUsability(ctl, ctl->conn))
8715 8716 8717 8718 8719
        goto cleanup;

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

8720
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8721 8722 8723 8724 8725 8726 8727
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8728
        virshReportError(ctl);
8729 8730 8731 8732 8733 8734 8735 8736 8737
        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 {
8738
        vshError(ctl, _("Failed to create vol from %s"), from);
8739 8740 8741
        goto cleanup;
    }

E
Eric Blake 已提交
8742
    ret = true;
8743
cleanup:
8744
    VIR_FREE(buffer);
8745 8746 8747 8748
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
8749 8750
    if (newvol)
        virStorageVolFree(newvol);
8751 8752 8753 8754
    return ret;
}

static xmlChar *
8755
makeCloneXML(const char *origxml, const char *newname) {
8756

8757 8758 8759
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
8760 8761 8762
    xmlChar *newxml = NULL;
    int size;

8763
    doc = virXMLParseStringCtxt(origxml, "domain.xml", &ctxt);
8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785
    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[] = {
8786 8787
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
8788 8789 8790 8791
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
8792 8793
    {"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 已提交
8794
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8795 8796 8797
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8798
static bool
8799 8800 8801 8802
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
8803
    const char *name = NULL;
8804
    char *origxml = NULL;
8805
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
8806
    bool ret = false;
8807

8808
    if (!vshConnectionUsability(ctl, ctl->conn))
8809 8810 8811 8812 8813 8814 8815
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
8816
        vshError(ctl, "%s", _("failed to get parent pool"));
8817 8818 8819
        goto cleanup;
    }

8820
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838
        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 {
8839
        vshError(ctl, _("Failed to clone vol from %s"),
8840 8841 8842 8843
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
8844
    ret = true;
8845 8846

cleanup:
8847
    VIR_FREE(origxml);
8848 8849 8850
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
8851 8852
    if (newvol)
        virStorageVolFree(newvol);
8853 8854 8855 8856 8857
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870

/*
 * "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 已提交
8871
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885
    {"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 已提交
8886
static bool
8887 8888 8889 8890
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8891
    bool ret = false;
8892 8893 8894 8895 8896 8897 8898 8899 8900 8901
    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 已提交
8902
        return false;
8903 8904 8905 8906
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8907
        return false;
8908 8909 8910
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8911
        return false;
8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945
    }

    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 已提交
8946
    ret = true;
8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970

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 已提交
8971
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8972 8973 8974 8975 8976
    {"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 已提交
8977
static bool
8978 8979 8980 8981
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8982
    bool ret = false;
8983 8984 8985 8986
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
8987
    bool created = false;
8988 8989

    if (!vshConnectionUsability(ctl, ctl->conn))
8990
        return false;
8991 8992 8993

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8994
        return false;
8995 8996 8997 8998
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8999
        return false;
9000 9001 9002
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
9003
        return false;
9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015

    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;
        }
9016 9017
    } else {
        created = true;
9018 9019 9020 9021 9022 9023 9024 9025
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

9026
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041
        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 已提交
9042
    ret = true;
9043 9044

cleanup:
9045
    VIR_FORCE_CLOSE(fd);
9046
    if (!ret && created)
9047 9048 9049 9050 9051 9052 9053 9054 9055
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


9056 9057 9058
/*
 * "vol-delete" command
 */
9059
static const vshCmdInfo info_vol_delete[] = {
9060 9061
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
9062 9063 9064
    {NULL, NULL}
};

9065
static const vshCmdOptDef opts_vol_delete[] = {
9066
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9067
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9068 9069 9070
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9071
static bool
9072
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
9073 9074
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9075
    bool ret = true;
9076
    const char *name;
9077

9078
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9079
        return false;
9080 9081

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9082
        return false;
9083 9084 9085
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
9086
        vshPrint(ctl, _("Vol %s deleted\n"), name);
9087
    } else {
9088
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
9089
        ret = false;
9090 9091
    }

L
Laine Stump 已提交
9092
    virStorageVolFree(vol);
9093 9094 9095 9096
    return ret;
}


D
David Allan 已提交
9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107
/*
 * "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 已提交
9108
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
9109 9110 9111
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9112
static bool
D
David Allan 已提交
9113 9114 9115
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9116
    bool ret = true;
9117
    const char *name;
D
David Allan 已提交
9118

9119
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9120
        return false;
D
David Allan 已提交
9121 9122

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9123
        return false;
D
David Allan 已提交
9124 9125 9126 9127 9128 9129
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
9130
        ret = false;
D
David Allan 已提交
9131 9132 9133 9134 9135 9136 9137
    }

    virStorageVolFree(vol);
    return ret;
}


9138 9139 9140
/*
 * "vol-info" command
 */
9141
static const vshCmdInfo info_vol_info[] = {
9142 9143
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
9144 9145 9146
    {NULL, NULL}
};

9147
static const vshCmdOptDef opts_vol_info[] = {
9148
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9149
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9150 9151 9152
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9153
static bool
9154
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
9155 9156 9157
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
9158
    bool ret = true;
9159

9160
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9161
        return false;
9162 9163

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9164
        return false;
9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180

    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 已提交
9181
        ret = false;
9182 9183 9184 9185 9186 9187 9188 9189 9190 9191
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
9192
static const vshCmdInfo info_vol_dumpxml[] = {
9193 9194
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
9195 9196 9197
    {NULL, NULL}
};

9198
static const vshCmdOptDef opts_vol_dumpxml[] = {
9199
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9200
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9201 9202 9203
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9204
static bool
9205
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
9206 9207
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9208
    bool ret = true;
9209 9210
    char *dump;

9211
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9212
        return false;
9213 9214

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9215
        return false;
9216 9217 9218

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
9219
        vshPrint(ctl, "%s", dump);
9220
        VIR_FREE(dump);
9221
    } else {
E
Eric Blake 已提交
9222
        ret = false;
9223 9224 9225 9226 9227 9228 9229 9230 9231 9232
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
9233
static const vshCmdInfo info_vol_list[] = {
9234 9235
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
9236 9237 9238
    {NULL, NULL}
};

9239
static const vshCmdOptDef opts_vol_list[] = {
9240
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9241
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
9242 9243 9244
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9245
static bool
9246
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9247
{
9248
    virStorageVolInfo volumeInfo;
9249 9250
    virStoragePoolPtr pool;
    char **activeNames = NULL;
9251 9252 9253 9254 9255
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
9256 9257
    int ret;
    bool functionReturn;
9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268
    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;
9269

9270
    /* Check the connection to libvirtd daemon is still working */
9271
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9272
        return false;
9273

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

9278 9279
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
9280

9281 9282 9283
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9284
        return false;
9285 9286
    }

9287 9288 9289 9290 9291
    /* 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) {
9292
            vshError(ctl, "%s", _("Failed to list active vols"));
9293
            VIR_FREE(activeNames);
9294
            virStoragePoolFree(pool);
E
Eric Blake 已提交
9295
            return false;
9296 9297
        }

9298 9299 9300 9301 9302
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

9305 9306 9307 9308 9309
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
9310

9311 9312 9313 9314
        /* 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"));
9315 9316
        }

9317 9318 9319 9320 9321 9322 9323 9324 9325
        /* 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 */
9326

9327
                /* Volume type */
9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340
                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"));
                }
9341 9342 9343 9344 9345 9346 9347 9348 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 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390

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

9392
        /* Cleanup memory allocation */
9393
        virStorageVolFree(vol);
9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411
    }

    /* 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 已提交
9412
        functionReturn = true;
9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443
        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 */
9444 9445 9446 9447 9448 9449 9450 9451 9452 9453
    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);
9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487

    /* 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 已提交
9488
    functionReturn = true;
9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502
    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 已提交
9503
    functionReturn = false;
9504 9505 9506 9507 9508 9509 9510 9511 9512 9513

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);
9514
        VIR_FREE(activeNames[i]);
9515
    }
9516 9517 9518 9519

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
9520
    VIR_FREE(activeNames);
9521
    virStoragePoolFree(pool);
9522 9523 9524

    /* Return the desired value */
    return functionReturn;
9525 9526 9527 9528 9529 9530
}


/*
 * "vol-name" command
 */
9531
static const vshCmdInfo info_vol_name[] = {
9532
    {"help", N_("returns the volume name for a given volume key or path")},
9533
    {"desc", ""},
9534 9535 9536
    {NULL, NULL}
};

9537
static const vshCmdOptDef opts_vol_name[] = {
9538
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
9539 9540 9541
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9542
static bool
9543
cmdVolName(vshControl *ctl, const vshCmd *cmd)
9544 9545 9546
{
    virStorageVolPtr vol;

9547
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9548
        return false;
9549

9550
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
9551
                                   VSH_BYUUID)))
E
Eric Blake 已提交
9552
        return false;
9553 9554 9555

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9556
    return true;
9557 9558 9559
}


J
Justin Clift 已提交
9560 9561 9562 9563 9564 9565 9566 9567 9568 9569
/*
 * "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[] = {
9570
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
9571 9572 9573 9574
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9575
static bool
J
Justin Clift 已提交
9576 9577 9578 9579
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9580
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
9581 9582

    /* Check the connection to libvirtd daemon is still working */
9583
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9584
        return false;
J
Justin Clift 已提交
9585 9586

    /* Use the supplied string to locate the volume */
9587
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
9588
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
9589
        return false;
J
Justin Clift 已提交
9590 9591 9592 9593 9594 9595 9596
    }

    /* 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 已提交
9597
        return false;
J
Justin Clift 已提交
9598 9599
    }

9600 9601 9602 9603 9604 9605 9606 9607 9608
    /* 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 已提交
9609 9610 9611 9612

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9613
    return true;
J
Justin Clift 已提交
9614 9615
}

9616 9617 9618 9619

/*
 * "vol-key" command
 */
9620
static const vshCmdInfo info_vol_key[] = {
9621
    {"help", N_("returns the volume key for a given volume name or path")},
9622
    {"desc", ""},
9623 9624 9625
    {NULL, NULL}
};

9626
static const vshCmdOptDef opts_vol_key[] = {
9627
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
9628
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9629 9630 9631
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9632
static bool
9633
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
9634 9635 9636
{
    virStorageVolPtr vol;

9637
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9638
        return false;
9639

9640
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9641
        return false;
9642 9643 9644

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9645
    return true;
9646 9647 9648 9649 9650 9651 9652
}



/*
 * "vol-path" command
 */
9653
static const vshCmdInfo info_vol_path[] = {
9654
    {"help", N_("returns the volume path for a given volume name or key")},
9655
    {"desc", ""},
9656 9657 9658
    {NULL, NULL}
};

9659
static const vshCmdOptDef opts_vol_path[] = {
9660
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
9661
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9662 9663 9664
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9665
static bool
9666
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
9667 9668
{
    virStorageVolPtr vol;
9669
    const char *name = NULL;
9670
    char * StorageVolPath;
9671

9672
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9673
        return false;
9674 9675

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9676
        return false;
9677
    }
9678

9679 9680 9681 9682 9683 9684 9685
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
9686
    virStorageVolFree(vol);
E
Eric Blake 已提交
9687
    return true;
9688 9689 9690
}


9691 9692 9693 9694
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
9695 9696
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
9697 9698
    {NULL, NULL}
};
9699

9700
static const vshCmdOptDef opts_secret_define[] = {
9701
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
9702 9703
    {NULL, 0, 0, NULL}
};
9704

E
Eric Blake 已提交
9705
static bool
9706 9707
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
9708
    const char *from = NULL;
9709
    char *buffer;
9710
    virSecretPtr res;
9711
    char uuid[VIR_UUID_STRING_BUFLEN];
9712

9713
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9714
        return false;
9715

9716
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9717
        return false;
9718 9719

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
9723
    VIR_FREE(buffer);
9724 9725

    if (res == NULL) {
9726
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
9727
        return false;
9728
    }
9729
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
9730
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
9731
        virSecretFree(res);
E
Eric Blake 已提交
9732
        return false;
9733 9734 9735
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
9736
    return true;
9737 9738 9739 9740 9741 9742
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
9743 9744
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
9745 9746 9747 9748
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
9749
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9750 9751 9752
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9753
static bool
9754 9755 9756
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9757
    bool ret = false;
9758 9759
    char *xml;

9760
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9761
        return false;
9762 9763 9764

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9765
        return false;
9766 9767 9768 9769

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
9770
    vshPrint(ctl, "%s", xml);
9771
    VIR_FREE(xml);
E
Eric Blake 已提交
9772
    ret = true;
9773 9774 9775 9776 9777 9778 9779 9780 9781 9782

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
9783 9784
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
9785 9786 9787 9788
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
9789 9790
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
9791 9792 9793
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9794
static bool
9795 9796 9797 9798
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
9799
    const char *base64 = NULL;
9800
    char *value;
E
Eric Blake 已提交
9801 9802
    int res;
    bool ret = false;
9803

9804
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9805
        return false;
9806 9807 9808

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

9811
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
9812 9813 9814
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
9815
        vshError(ctl, "%s", _("Invalid base64 data"));
9816 9817 9818
        goto cleanup;
    }
    if (value == NULL) {
9819
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
9820
        return false;
9821 9822 9823 9824
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
9825
    VIR_FREE(value);
9826 9827

    if (res != 0) {
9828
        vshError(ctl, "%s", _("Failed to set secret value"));
9829 9830 9831
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
9832
    ret = true;
9833 9834 9835 9836 9837 9838 9839 9840 9841 9842

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
9843 9844
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
9845 9846 9847 9848
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
9849
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9850 9851 9852
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9853
static bool
9854 9855 9856 9857 9858 9859
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
9860
    bool ret = false;
9861

9862
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9863
        return false;
9864 9865 9866

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9867
        return false;
9868 9869 9870 9871 9872 9873 9874

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
9875
    VIR_FREE(value);
9876 9877

    if (base64 == NULL) {
9878
        vshError(ctl, "%s", _("Failed to allocate memory"));
9879 9880
        goto cleanup;
    }
9881
    vshPrint(ctl, "%s", base64);
9882
    memset(base64, 0, strlen(base64));
9883
    VIR_FREE(base64);
E
Eric Blake 已提交
9884
    ret = true;
9885 9886 9887 9888 9889 9890 9891 9892 9893 9894

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
9895 9896
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
9897 9898 9899 9900
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
9901
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9902 9903 9904
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9905
static bool
9906 9907 9908
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9909
    bool ret = false;
9910
    const char *uuid;
9911

9912
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9913
        return false;
9914 9915 9916

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
9917
        return false;
9918 9919

    if (virSecretUndefine(secret) < 0) {
9920
        vshError(ctl, _("Failed to delete secret %s"), uuid);
9921 9922 9923
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
9924
    ret = true;
9925 9926 9927 9928 9929 9930 9931 9932 9933 9934

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
9935 9936
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
9937 9938 9939
    {NULL, NULL}
};

E
Eric Blake 已提交
9940
static bool
9941 9942 9943 9944 9945
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

9946
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9947
        return false;
9948 9949 9950

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
9951
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
9952
        return false;
9953 9954 9955 9956 9957
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
9958
        vshError(ctl, "%s", _("Failed to list secrets"));
9959
        VIR_FREE(uuids);
E
Eric Blake 已提交
9960
        return false;
9961 9962 9963 9964
    }

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

9965 9966
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
9967 9968

    for (i = 0; i < maxuuids; i++) {
9969 9970 9971 9972
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
9973
            VIR_FREE(uuids[i]);
9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991
            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);
9992
        VIR_FREE(uuids[i]);
9993
    }
9994
    VIR_FREE(uuids);
E
Eric Blake 已提交
9995
    return true;
9996
}
9997 9998 9999 10000 10001


/*
 * "version" command
 */
10002
static const vshCmdInfo info_version[] = {
10003 10004
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
10005 10006 10007
    {NULL, NULL}
};

10008 10009 10010 10011
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
10012

E
Eric Blake 已提交
10013
static bool
10014
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10015 10016 10017 10018 10019 10020
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
10021
    unsigned long daemonVersion;
10022 10023 10024 10025 10026
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

10027
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10028
        return false;
10029 10030 10031

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
10032
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
10033
        return false;
10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045
    }

    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) {
10046
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
10047
        return false;
10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064
    }
    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) {
10065
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
10066
        return false;
10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079
    }
    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);
    }
10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094

    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 已提交
10095
    return true;
10096 10097
}

10098 10099 10100 10101
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
10102
    {"help", N_("enumerate devices on this host")},
10103
    {"desc", ""},
10104 10105 10106 10107
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
10108 10109
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
10110 10111 10112
    {NULL, 0, 0, NULL}
};

10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134
#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] = '-';
10135 10136
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
10137 10138 10139
    }

    /* Print this device */
10140
    vshPrint(ctl, "%s", indentBuf);
10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163
    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) {
10164
        vshPrint(ctl, "%s", indentBuf);
10165
        vshPrint(ctl, " |\n");
10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187
    }

    /* 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) {
10188
        vshPrint(ctl, "%s", indentBuf);
10189 10190 10191 10192
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
10193
static bool
10194 10195
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
10196
    const char *cap = NULL;
10197
    char **devices;
10198
    int num_devices, i;
10199
    int tree = vshCommandOptBool(cmd, "tree");
10200

10201
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10202
        return false;
10203

10204
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
10205 10206 10207 10208
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
10209
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
10210
        return false;
10211
    } else if (num_devices == 0) {
E
Eric Blake 已提交
10212
        return true;
10213 10214 10215 10216 10217 10218
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
10219
        vshError(ctl, "%s", _("Failed to list node devices"));
10220
        VIR_FREE(devices);
E
Eric Blake 已提交
10221
        return false;
10222
    }
10223
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
10224 10225 10226 10227 10228 10229 10230
    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 已提交
10231
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250
            } 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++) {
10251 10252
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
10253
        }
10254
        VIR_FREE(parents);
10255 10256 10257
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
10258
            VIR_FREE(devices[i]);
10259
        }
10260
    }
10261
    VIR_FREE(devices);
E
Eric Blake 已提交
10262
    return true;
10263 10264 10265 10266 10267 10268
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
10269 10270
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
10271 10272 10273 10274 10275
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
10276
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10277 10278 10279
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10280
static bool
10281 10282
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
10283
    const char *name = NULL;
10284
    virNodeDevicePtr device;
L
Laine Stump 已提交
10285
    char *xml;
10286

10287
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10288
        return false;
10289
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10290
        return false;
10291
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10292
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10293
        return false;
10294 10295
    }

L
Laine Stump 已提交
10296 10297 10298
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
10299
        return false;
L
Laine Stump 已提交
10300 10301 10302
    }

    vshPrint(ctl, "%s\n", xml);
10303
    VIR_FREE(xml);
10304
    virNodeDeviceFree(device);
E
Eric Blake 已提交
10305
    return true;
10306 10307
}

10308 10309 10310 10311
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
10312 10313
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
10314 10315 10316 10317 10318
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
10319
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10320 10321 10322
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10323
static bool
10324 10325
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
10326
    const char *name = NULL;
10327
    virNodeDevicePtr device;
E
Eric Blake 已提交
10328
    bool ret = true;
10329

10330
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10331
        return false;
10332
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10333
        return false;
10334
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10335
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10336
        return false;
10337 10338 10339 10340 10341
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
10342
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
10343
        ret = false;
10344 10345 10346 10347 10348 10349 10350 10351 10352
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
10353 10354
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
10355 10356 10357 10358 10359
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
10360
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10361 10362 10363
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10364
static bool
10365 10366
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
10367
    const char *name = NULL;
10368
    virNodeDevicePtr device;
E
Eric Blake 已提交
10369
    bool ret = true;
10370

10371
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10372
        return false;
10373
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10374
        return false;
10375
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10376
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10377
        return false;
10378 10379 10380 10381 10382
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
10383
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
10384
        ret = false;
10385 10386 10387 10388 10389 10390 10391 10392 10393
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
10394 10395
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
10396 10397 10398 10399 10400
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
10401
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10402 10403 10404
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10405
static bool
10406 10407
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
10408
    const char *name = NULL;
10409
    virNodeDevicePtr device;
E
Eric Blake 已提交
10410
    bool ret = true;
10411

10412
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10413
        return false;
10414
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10415
        return false;
10416
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10417
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10418
        return false;
10419 10420 10421 10422 10423
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
10424
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
10425
        ret = false;
10426 10427 10428 10429 10430
    }
    virNodeDeviceFree(device);
    return ret;
}

10431
/*
E
Eric Blake 已提交
10432
 * "hostname" command
10433
 */
10434
static const vshCmdInfo info_hostname[] = {
10435
    {"help", N_("print the hypervisor hostname")},
10436
    {"desc", ""},
10437 10438 10439
    {NULL, NULL}
};

E
Eric Blake 已提交
10440
static bool
10441
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10442 10443 10444
{
    char *hostname;

10445
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10446
        return false;
10447 10448 10449

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
10450
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
10451
        return false;
10452 10453 10454
    }

    vshPrint (ctl, "%s\n", hostname);
10455
    VIR_FREE(hostname);
10456

E
Eric Blake 已提交
10457
    return true;
10458 10459 10460 10461 10462
}

/*
 * "uri" command
 */
10463
static const vshCmdInfo info_uri[] = {
10464
    {"help", N_("print the hypervisor canonical URI")},
10465
    {"desc", ""},
10466 10467 10468
    {NULL, NULL}
};

E
Eric Blake 已提交
10469
static bool
10470
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10471 10472 10473
{
    char *uri;

10474
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10475
        return false;
10476 10477 10478

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
10479
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
10480
        return false;
10481 10482 10483
    }

    vshPrint (ctl, "%s\n", uri);
10484
    VIR_FREE(uri);
10485

E
Eric Blake 已提交
10486
    return true;
10487 10488
}

E
Eric Blake 已提交
10489 10490 10491 10492 10493 10494 10495 10496 10497 10498
/*
 * "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 已提交
10499
static bool
E
Eric Blake 已提交
10500 10501 10502 10503 10504
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10505
        return false;
E
Eric Blake 已提交
10506 10507 10508 10509

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
10510
        return false;
E
Eric Blake 已提交
10511 10512 10513 10514 10515
    }

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

E
Eric Blake 已提交
10516
    return true;
E
Eric Blake 已提交
10517 10518
}

10519 10520 10521
/*
 * "vncdisplay" command
 */
10522
static const vshCmdInfo info_vncdisplay[] = {
10523 10524
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
10525 10526 10527
    {NULL, NULL}
};

10528
static const vshCmdOptDef opts_vncdisplay[] = {
10529
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10530 10531 10532
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10533
static bool
10534
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
10535 10536 10537 10538 10539
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10540
    bool ret = false;
10541 10542 10543
    int port = 0;
    char *doc;

10544
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10545
        return false;
10546

J
Jim Meyering 已提交
10547
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10548
        return false;
10549 10550 10551 10552 10553

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10554
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10555
    VIR_FREE(doc);
10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570
    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) ||
10571
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
10572 10573 10574 10575 10576 10577
        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 已提交
10578
    ret = true;
10579 10580 10581 10582

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10583
    xmlFreeDoc(xml);
10584 10585 10586 10587 10588 10589 10590
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
10591
static const vshCmdInfo info_ttyconsole[] = {
10592 10593
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
10594 10595 10596
    {NULL, NULL}
};

10597
static const vshCmdOptDef opts_ttyconsole[] = {
10598
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10599 10600 10601
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10602
static bool
10603
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
10604 10605 10606 10607 10608
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10609
    bool ret = false;
10610 10611
    char *doc;

10612
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10613
        return false;
10614

J
Jim Meyering 已提交
10615
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10616
        return false;
10617 10618 10619 10620 10621

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10622
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10623
    VIR_FREE(doc);
10624 10625 10626 10627 10628 10629 10630 10631 10632
    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 已提交
10633
    ret = true;
10634 10635 10636 10637

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10638
    xmlFreeDoc(xml);
10639 10640 10641 10642 10643 10644
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
10645
 */
10646
static const vshCmdInfo info_attach_device[] = {
10647 10648
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
10649 10650 10651
    {NULL, NULL}
};

10652
static const vshCmdOptDef opts_attach_device[] = {
10653 10654 10655
    {"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")},
10656 10657 10658
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10659
static bool
10660
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
10661 10662
{
    virDomainPtr dom;
10663
    const char *from = NULL;
10664
    char *buffer;
W
Wen Congyang 已提交
10665
    int ret;
J
Jim Fehlig 已提交
10666
    unsigned int flags;
10667

10668
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10669
        return false;
10670

J
Jim Meyering 已提交
10671
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10672
        return false;
10673

10674
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10675
        virDomainFree(dom);
E
Eric Blake 已提交
10676
        return false;
10677 10678
    }

10679
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10680
        virshReportError(ctl);
10681
        virDomainFree(dom);
E
Eric Blake 已提交
10682
        return false;
10683
    }
10684

J
Jim Fehlig 已提交
10685
    if (vshCommandOptBool(cmd, "persistent")) {
10686
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10687
        if (virDomainIsActive(dom) == 1)
10688
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10689 10690 10691 10692
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
10693
    VIR_FREE(buffer);
10694 10695

    if (ret < 0) {
10696
        vshError(ctl, _("Failed to attach device from %s"), from);
10697
        virDomainFree(dom);
E
Eric Blake 已提交
10698
        return false;
10699
    } else {
J
Jim Meyering 已提交
10700
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
10701 10702 10703
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10704
    return true;
10705 10706 10707 10708 10709 10710
}


/*
 * "detach-device" command
 */
10711
static const vshCmdInfo info_detach_device[] = {
10712 10713
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
10714 10715 10716
    {NULL, NULL}
};

10717
static const vshCmdOptDef opts_detach_device[] = {
10718 10719 10720
    {"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")},
10721 10722 10723
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10724
static bool
10725
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
10726 10727
{
    virDomainPtr dom;
10728
    const char *from = NULL;
10729
    char *buffer;
W
Wen Congyang 已提交
10730
    int ret;
J
Jim Fehlig 已提交
10731
    unsigned int flags;
10732

10733
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10734
        return false;
10735

J
Jim Meyering 已提交
10736
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10737
        return false;
10738

10739
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10740
        virDomainFree(dom);
E
Eric Blake 已提交
10741
        return false;
10742 10743
    }

10744
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10745
        virshReportError(ctl);
10746
        virDomainFree(dom);
E
Eric Blake 已提交
10747
        return false;
10748
    }
10749

J
Jim Fehlig 已提交
10750
    if (vshCommandOptBool(cmd, "persistent")) {
10751
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10752
        if (virDomainIsActive(dom) == 1)
10753
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10754 10755 10756 10757
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
10758
    VIR_FREE(buffer);
10759 10760

    if (ret < 0) {
10761
        vshError(ctl, _("Failed to detach device from %s"), from);
10762
        virDomainFree(dom);
E
Eric Blake 已提交
10763
        return false;
10764
    } else {
J
Jim Meyering 已提交
10765
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
10766 10767 10768
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10769
    return true;
10770 10771
}

10772

10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785
/*
 * "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")},
10786
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
10787 10788 10789
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10790
static bool
10791 10792 10793
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
10794
    const char *from = NULL;
10795
    char *buffer;
W
Wen Congyang 已提交
10796
    int ret;
10797 10798
    unsigned int flags;

10799
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10800
        return false;
10801 10802

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

10805
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10806
        virDomainFree(dom);
E
Eric Blake 已提交
10807
        return false;
10808 10809 10810
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10811
        virshReportError(ctl);
10812
        virDomainFree(dom);
E
Eric Blake 已提交
10813
        return false;
10814 10815 10816
    }

    if (vshCommandOptBool(cmd, "persistent")) {
10817
        flags = VIR_DOMAIN_AFFECT_CONFIG;
10818
        if (virDomainIsActive(dom) == 1)
10819
           flags |= VIR_DOMAIN_AFFECT_LIVE;
10820
    } else {
10821
        flags = VIR_DOMAIN_AFFECT_LIVE;
10822
    }
10823 10824 10825 10826

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

10827 10828 10829 10830 10831 10832
    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 已提交
10833
        return false;
10834 10835 10836 10837 10838
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10839
    return true;
10840 10841 10842
}


10843 10844 10845
/*
 * "attach-interface" command
 */
10846
static const vshCmdInfo info_attach_interface[] = {
10847 10848
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
10849 10850 10851
    {NULL, NULL}
};

10852
static const vshCmdOptDef opts_attach_interface[] = {
10853 10854 10855 10856 10857 10858
    {"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")},
10859
    {"model", VSH_OT_DATA, 0, N_("model type")},
10860
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
10861 10862 10863
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10864
static bool
10865
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
10866 10867
{
    virDomainPtr dom = NULL;
10868 10869
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
10870
    int typ;
W
Wen Congyang 已提交
10871 10872
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
10873
    unsigned int flags;
10874 10875
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10876

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

J
Jim Meyering 已提交
10880
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10881 10882
        goto cleanup;

10883
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10884 10885
        goto cleanup;

10886 10887 10888 10889
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
10890 10891
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
10892
        goto cleanup;
10893
    }
10894 10895

    /* check interface type */
10896
    if (STREQ(type, "network")) {
10897
        typ = 1;
10898
    } else if (STREQ(type, "bridge")) {
10899 10900
        typ = 2;
    } else {
E
Eric Blake 已提交
10901 10902
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
10903 10904 10905 10906
        goto cleanup;
    }

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

10909
    if (typ == 1)
10910
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
10911
    else if (typ == 2)
10912
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
10913

10914
    if (target != NULL)
10915
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10916
    if (mac != NULL)
10917
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
10918
    if (script != NULL)
10919
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
10920
    if (model != NULL)
10921
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
10922

10923
    virBufferAddLit(&buf, "</interface>\n");
10924

10925 10926
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
10927
        goto cleanup;
10928 10929
    }

10930
    xml = virBufferContentAndReset(&buf);
10931

J
Jim Fehlig 已提交
10932
    if (vshCommandOptBool(cmd, "persistent")) {
10933
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10934
        if (virDomainIsActive(dom) == 1)
10935
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10936
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
10937
    } else {
10938
        ret = virDomainAttachDevice(dom, xml);
10939
    }
10940

10941 10942
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10943
    if (ret != 0) {
L
Laine Stump 已提交
10944
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
10945 10946
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
10947
        functionReturn = true;
J
Jim Fehlig 已提交
10948
    }
10949 10950 10951 10952

 cleanup:
    if (dom)
        virDomainFree(dom);
10953
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10954
    return functionReturn;
10955 10956 10957 10958 10959
}

/*
 * "detach-interface" command
 */
10960
static const vshCmdInfo info_detach_interface[] = {
10961 10962
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
10963 10964 10965
    {NULL, NULL}
};

10966
static const vshCmdOptDef opts_detach_interface[] = {
10967 10968 10969 10970
    {"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")},
10971 10972 10973
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10974
static bool
10975
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
10976 10977 10978 10979 10980 10981 10982
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
10983
    const char *mac =NULL, *type = NULL;
10984
    char *doc;
10985
    char buf[64];
E
Eric Blake 已提交
10986
    int i = 0, diff_mac;
W
Wen Congyang 已提交
10987 10988
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
10989
    unsigned int flags;
10990

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

J
Jim Meyering 已提交
10994
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10995 10996
        goto cleanup;

10997
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10998 10999
        goto cleanup;

11000 11001
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
11002
        goto cleanup;
11003
    }
11004 11005 11006 11007 11008

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11009
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
11010
    VIR_FREE(doc);
11011
    if (!xml) {
11012
        vshError(ctl, "%s", _("Failed to get interface information"));
11013 11014 11015
        goto cleanup;
    }

E
Eric Blake 已提交
11016
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
11017 11018 11019
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11020
        vshError(ctl, _("No found interface whose type is %s"), type);
11021 11022 11023
        goto cleanup;
    }

11024 11025 11026 11027 11028 11029
    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;
    }

11030 11031 11032 11033 11034 11035 11036
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11037 11038 11039 11040 11041
            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);
11042 11043 11044 11045 11046 11047 11048
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11049
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
11050 11051 11052 11053 11054
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11055
        vshError(ctl, "%s", _("Failed to allocate memory"));
11056 11057 11058
        goto cleanup;
    }

11059
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
11060
        vshError(ctl, "%s", _("Failed to create XML"));
11061 11062 11063
        goto cleanup;
    }

J
Jim Fehlig 已提交
11064
    if (vshCommandOptBool(cmd, "persistent")) {
11065
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11066
        if (virDomainIsActive(dom) == 1)
11067
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11068 11069 11070 11071 11072 11073 11074 11075
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11076
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
11077
    } else {
J
Jim Meyering 已提交
11078
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
11079
        functionReturn = true;
11080
    }
11081 11082 11083 11084

 cleanup:
    if (dom)
        virDomainFree(dom);
11085
    xmlXPathFreeObject(obj);
11086
    xmlXPathFreeContext(ctxt);
11087 11088
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
11089
    return functionReturn;
11090 11091 11092 11093 11094
}

/*
 * "attach-disk" command
 */
11095
static const vshCmdInfo info_attach_disk[] = {
11096 11097
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
11098 11099 11100
    {NULL, NULL}
};

11101
static const vshCmdOptDef opts_attach_disk[] = {
11102 11103 11104 11105 11106
    {"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")},
11107
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
11108 11109 11110
    {"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")},
11111
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
11112 11113 11114
    {"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")},
11115 11116 11117
    {NULL, 0, 0, NULL}
};

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 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264
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 已提交
11265
static bool
11266
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
11267 11268
{
    virDomainPtr dom = NULL;
11269
    const char *source = NULL, *target = NULL, *driver = NULL,
11270 11271 11272
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
11273 11274
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
11275
    unsigned int flags;
11276
    const char *stype = NULL;
11277 11278
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
11279

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

J
Jim Meyering 已提交
11283
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11284 11285
        goto cleanup;

11286
    if (vshCommandOptString(cmd, "source", &source) <= 0)
11287 11288
        goto cleanup;

11289
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11290 11291
        goto cleanup;

11292 11293 11294 11295
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
11296 11297 11298
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
11299
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
11300
        vshError(ctl, "%s", _("missing option"));
11301 11302
        goto cleanup;
    }
11303

11304 11305
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
11306
            isFile = true;
11307
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
11308
        isFile = true;
11309 11310 11311
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
11312 11313 11314
    }

    if (mode) {
11315
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
11316 11317
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
11318 11319 11320 11321 11322
            goto cleanup;
        }
    }

    /* Make XML of disk */
11323
    virBufferAsprintf(&buf, "<disk type='%s'",
11324 11325
                      (isFile) ? "file" : "block");
    if (type)
11326
        virBufferAsprintf(&buf, " device='%s'", type);
11327 11328
    virBufferAddLit(&buf, ">\n");

11329
    if (driver || subdriver)
11330
        virBufferAsprintf(&buf, "  <driver");
11331 11332

    if (driver)
11333
        virBufferAsprintf(&buf, " name='%s'", driver);
11334
    if (subdriver)
11335
        virBufferAsprintf(&buf, " type='%s'", subdriver);
11336 11337
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
11338

11339
    if (driver || subdriver || cache)
11340
        virBufferAddLit(&buf, "/>\n");
11341

11342
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
11343 11344
                      (isFile) ? "file" : "dev",
                      source);
11345
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11346
    if (mode)
11347
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
11348

11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396
    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;
            }
        }
    }

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

11399 11400
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
11401
        return false;
11402 11403
    }

11404
    xml = virBufferContentAndReset(&buf);
11405

J
Jim Fehlig 已提交
11406
    if (vshCommandOptBool(cmd, "persistent")) {
11407
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11408
        if (virDomainIsActive(dom) == 1)
11409
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11410
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
11411
    } else {
11412
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
11413
    }
11414

11415 11416
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11417
    if (ret != 0) {
L
Laine Stump 已提交
11418
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
11419 11420
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
11421
        functionReturn = true;
J
Jim Fehlig 已提交
11422
    }
11423 11424 11425 11426

 cleanup:
    if (dom)
        virDomainFree(dom);
11427
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11428
    return functionReturn;
11429 11430 11431 11432 11433
}

/*
 * "detach-disk" command
 */
11434
static const vshCmdInfo info_detach_disk[] = {
11435 11436
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
11437 11438 11439
    {NULL, NULL}
};

11440
static const vshCmdOptDef opts_detach_disk[] = {
11441 11442 11443
    {"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")},
11444 11445 11446
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11447
static bool
11448
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
11449 11450 11451 11452 11453 11454 11455
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
11456
    const char *target = NULL;
11457
    char *doc;
E
Eric Blake 已提交
11458
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
11459 11460
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11461
    unsigned int flags;
11462

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

J
Jim Meyering 已提交
11466
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11467 11468
        goto cleanup;

11469
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11470 11471 11472 11473 11474 11475
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11476
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
11477
    VIR_FREE(doc);
11478
    if (!xml) {
11479
        vshError(ctl, "%s", _("Failed to get disk information"));
11480 11481 11482 11483 11484 11485
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11486
        vshError(ctl, "%s", _("Failed to get disk information"));
11487 11488 11489 11490 11491 11492 11493
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11494 11495 11496 11497 11498
            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);
11499 11500 11501 11502 11503 11504 11505
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11506
    vshError(ctl, _("No found disk whose target is %s"), target);
11507 11508 11509 11510 11511
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11512
        vshError(ctl, "%s", _("Failed to allocate memory"));
11513 11514 11515
        goto cleanup;
    }

11516
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
11517
        vshError(ctl, "%s", _("Failed to create XML"));
11518 11519 11520
        goto cleanup;
    }

J
Jim Fehlig 已提交
11521
    if (vshCommandOptBool(cmd, "persistent")) {
11522
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11523
        if (virDomainIsActive(dom) == 1)
11524
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11525 11526 11527 11528 11529 11530 11531 11532
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11533
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
11534
    } else {
J
Jim Meyering 已提交
11535
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
11536
        functionReturn = true;
11537
    }
11538 11539

 cleanup:
11540
    xmlXPathFreeObject(obj);
11541
    xmlXPathFreeContext(ctxt);
11542 11543
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
11544 11545
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
11546
    return functionReturn;
11547 11548
}

11549 11550 11551 11552
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
11553 11554
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
11555 11556 11557 11558
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
11559
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
11560 11561 11562
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11563
static bool
11564 11565
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
11566
    const char *from = NULL;
E
Eric Blake 已提交
11567
    bool ret = true;
11568 11569 11570
    char *buffer;
    int result;

11571
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11572
        return false;
11573

11574
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11575
        return false;
11576 11577

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
11581
    VIR_FREE(buffer);
11582 11583 11584 11585 11586

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
11587
        ret = false;
11588 11589 11590 11591 11592
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
11593
        ret = true;
11594 11595 11596 11597 11598
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
11599
        ret = true;
11600 11601 11602 11603 11604
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
11605
        ret = false;
11606 11607 11608 11609 11610
    }

    return ret;
}

11611 11612 11613 11614
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
11615 11616
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
11617 11618 11619 11620
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
11621
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
11622 11623 11624
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11625
static bool
11626 11627
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
11628
    const char *from = NULL;
E
Eric Blake 已提交
11629
    bool ret = true;
11630 11631 11632 11633 11634
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
11635
    xmlNodePtr node_list;
11636 11637 11638 11639 11640 11641
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

11642
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11643
        return false;
11644

11645
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11646
        return false;
11647 11648

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
11649
        return false;
11650 11651 11652 11653 11654

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

L
Laine Stump 已提交
11655 11656
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
11657 11658
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
11659
        ret = false;
11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695
        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 已提交
11696
        ret = false;
11697 11698 11699 11700 11701 11702 11703 11704
        goto cleanup;
    }

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

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
11705
        ret = false;
11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722

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 已提交
11723
    ret = false;
11724
    goto cleanup;
11725 11726
}

11727 11728 11729 11730 11731 11732 11733 11734
/* 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;

11735
    ret = vshMalloc(ctl, PATH_MAX);
11736 11737 11738

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
11739 11740
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
11741
    if (fd == -1) {
11742
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
11743
                 strerror(errno));
11744
        VIR_FREE(ret);
11745 11746 11747 11748
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
11749 11750
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
11751
        VIR_FORCE_CLOSE(fd);
11752
        unlink (ret);
11753
        VIR_FREE(ret);
11754 11755
        return NULL;
    }
S
Stefan Berger 已提交
11756
    if (VIR_CLOSE(fd) < 0) {
11757 11758
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
11759
        unlink (ret);
11760
        VIR_FREE(ret);
11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775
        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 已提交
11776 11777 11778 11779
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
11780

11781
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
11782 11783 11784 11785
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
11786

11787 11788 11789 11790 11791
    /* 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 已提交
11792 11793
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
11794
     */
E
Eric Blake 已提交
11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806
    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);
11807 11808
    }

E
Eric Blake 已提交
11809 11810 11811 11812 11813 11814 11815
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
11816
    }
E
Eric Blake 已提交
11817
    ret = 0;
11818

E
Eric Blake 已提交
11819 11820 11821
cleanup:
    virCommandFree(cmd);
    return ret;
11822 11823 11824 11825 11826 11827 11828 11829
}

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

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
11830
        vshError(ctl,
11831
                 _("%s: failed to read temporary file: %s"),
11832
                 filename, strerror(errno));
11833 11834 11835 11836 11837
        return NULL;
    }
    return ret;
}

11838

P
Paolo Bonzini 已提交
11839 11840 11841 11842
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
11843 11844
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
11845 11846 11847 11848
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11853
static bool
11854
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
11855
{
11856
    const char *dir = NULL;
11857
    char *dir_malloced = NULL;
E
Eric Blake 已提交
11858
    bool ret = true;
P
Paolo Bonzini 已提交
11859 11860

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

11865
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
11866
        uid_t uid = geteuid();
11867
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
11868 11869 11870 11871
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
11872
    if (chdir(dir) == -1) {
11873
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
11874
        ret = false;
P
Paolo Bonzini 已提交
11875 11876
    }

11877
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
11878
    return ret;
P
Paolo Bonzini 已提交
11879 11880 11881 11882 11883 11884
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
11885 11886
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
11887 11888 11889
    {NULL, NULL}
};

E
Eric Blake 已提交
11890
static bool
P
Paolo Bonzini 已提交
11891 11892 11893
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
11894
    bool ret = true;
P
Paolo Bonzini 已提交
11895

11896 11897
    cwd = getcwd(NULL, 0);
    if (!cwd) {
11898 11899
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
11900 11901
        ret = false;
    } else {
P
Paolo Bonzini 已提交
11902
        vshPrint (ctl, _("%s\n"), cwd);
11903 11904
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
11905

11906
    return ret;
P
Paolo Bonzini 已提交
11907 11908
}

E
Eric Blake 已提交
11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920
/*
 * "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")},
11921
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
11922 11923 11924 11925 11926 11927
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
11928
static bool
E
Eric Blake 已提交
11929 11930 11931 11932 11933
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
11934
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
11935 11936 11937 11938 11939 11940 11941 11942
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

11943
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
11944 11945 11946
        bool close_quote = false;
        char *q;

11947
        arg = opt->data;
E
Eric Blake 已提交
11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975
        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 已提交
11976
        return false;
E
Eric Blake 已提交
11977 11978 11979 11980 11981
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
11982
    return true;
E
Eric Blake 已提交
11983 11984
}

11985 11986 11987 11988
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
11989 11990
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
11991 11992 11993 11994
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
11995
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11996 11997 11998 11999 12000 12001
    {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 已提交
12002
static bool
12003 12004
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
12005
    bool ret = false;
12006 12007 12008 12009 12010
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
12011
    unsigned int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
12012

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

J
Jim Meyering 已提交
12016
    dom = vshCommandOptDomain (ctl, cmd, NULL);
12017 12018 12019 12020
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
12021
    doc = virDomainGetXMLDesc (dom, flags);
12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039
    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 已提交
12040
        ret = true;
12041 12042 12043 12044 12045 12046 12047
        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.
     */
12048
    doc_reread = virDomainGetXMLDesc (dom, flags);
12049 12050 12051 12052
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
12053 12054
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066
        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 已提交
12067
    ret = true;
12068 12069 12070 12071 12072

 cleanup:
    if (dom)
        virDomainFree (dom);

12073 12074 12075
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
12076 12077 12078

    if (tmp) {
        unlink (tmp);
12079
        VIR_FREE(tmp);
12080 12081 12082 12083 12084
    }

    return ret;
}

12085

12086 12087 12088 12089
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
12090 12091
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
12092 12093 12094 12095
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
12096
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
12097 12098 12099 12100 12101 12102 12103 12104 12105 12106
    {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[] = {
12107 12108
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
12109 12110 12111 12112
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
12113
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
12114 12115 12116 12117 12118 12119
    {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 已提交
12120 12121 12122
/*
 * "quit" command
 */
12123
static const vshCmdInfo info_quit[] = {
12124
    {"help", N_("quit this interactive terminal")},
12125
    {"desc", ""},
12126
    {NULL, NULL}
K
Karel Zak 已提交
12127 12128
};

E
Eric Blake 已提交
12129
static bool
12130
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
12131
{
E
Eric Blake 已提交
12132 12133
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
12134 12135
}

12136 12137 12138 12139 12140 12141 12142
/* 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;
12143
    bool halt = false;
12144 12145 12146 12147 12148 12149
    char *doc = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *name = NULL;

    snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173

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

12174 12175 12176
    if (snapshot == NULL)
        goto cleanup;

12177 12178 12179 12180 12181
    if (halt && virDomainDestroy(dom) < 0) {
        virshReportError(ctl);
        goto cleanup;
    }

12182 12183 12184 12185
    if (flags & VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA)
        doc = vshStrdup(ctl, buffer);
    else
        doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216
    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;
}

12217 12218 12219 12220
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
12221 12222
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
12223 12224 12225 12226 12227 12228
    {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")},
12229 12230 12231
    {"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")},
12232
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
12233
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
12234 12235 12236
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12237
static bool
12238 12239 12240
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12241
    bool ret = false;
12242
    const char *from = NULL;
12243
    char *buffer = NULL;
12244 12245 12246 12247 12248 12249 12250 12251
    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;
12252 12253
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
12254 12255
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
12256

12257
    if (!vshConnectionUsability(ctl, ctl->conn))
12258 12259 12260 12261 12262 12263
        goto cleanup;

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

12264
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
12265
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280
    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;
    }

12281
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, from);
12282 12283 12284 12285 12286 12287 12288 12289 12290

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

    return ret;
}

12291 12292 12293
/*
 * "snapshot-create-as" command
 */
12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349
static int
vshParseSnapshotDiskspec(vshControl *ctl, virBufferPtr buf, const char *str)
{
    int ret = -1;
    char *name = NULL;
    char *snapshot = NULL;
    char *driver = NULL;
    char *file = NULL;
    char *spec = vshStrdup(ctl, str);
    char *tmp = spec;
    size_t len = strlen(str);

    if (*str == ',')
        goto cleanup;
    name = tmp;
    while ((tmp = strchr(tmp, ','))) {
        if (tmp[1] == ',') {
            /* Recognize ,, as an escape for a literal comma */
            memmove(&tmp[1], &tmp[2], len - (tmp - spec) + 2);
            len--;
            tmp++;
            continue;
        }
        /* Terminate previous string, look for next recognized one */
        *tmp++ = '\0';
        if (!snapshot && STRPREFIX(tmp, "snapshot="))
            snapshot = tmp + strlen("snapshot=");
        else if (!driver && STRPREFIX(tmp, "driver="))
            driver = tmp + strlen("driver=");
        else if (!file && STRPREFIX(tmp, "file="))
            file = tmp + strlen("file=");
        else
            goto cleanup;
    }

    virBufferEscapeString(buf, "    <disk name='%s'", name);
    if (snapshot)
        virBufferAsprintf(buf, " snapshot='%s'", snapshot);
    if (driver || file) {
        virBufferAddLit(buf, ">\n");
        if (driver)
            virBufferAsprintf(buf, "      <driver type='%s'/>\n", driver);
        if (file)
            virBufferEscapeString(buf, "      <source file='%s'/>\n", file);
        virBufferAddLit(buf, "    </disk>\n");
    } else {
        virBufferAddLit(buf, "/>\n");
    }
    ret = 0;
cleanup:
    if (ret < 0)
        vshError(ctl, _("unable to parse diskspec: %s"), str);
    VIR_FREE(spec);
    return ret;
}

12350 12351 12352 12353 12354 12355 12356 12357 12358 12359
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 已提交
12360
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
12361
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
12362
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
12363 12364 12365
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
    {"diskspec", VSH_OT_ARGV, 0,
     N_("disk attributes: disk[,snapshot=type][,driver=type][,file=name]")},
12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377
    {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;
12378
    unsigned int flags = 0;
12379
    const vshCmdOpt *opt = NULL;
12380 12381 12382

    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
12383 12384
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
12385 12386
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402

    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)
12403
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
12404
    if (desc)
12405
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
12406 12407 12408 12409 12410 12411 12412 12413 12414 12415
    if (vshCommandOptBool(cmd, "diskspec")) {
        virBufferAddLit(&buf, "  <disks>\n");
        while ((opt = vshCommandOptArgv(cmd, opt))) {
            if (vshParseSnapshotDiskspec(ctl, &buf, opt->data) < 0) {
                virBufferFreeAndReset(&buf);
                goto cleanup;
            }
        }
        virBufferAddLit(&buf, "  </disks>\n");
    }
12416 12417 12418 12419 12420 12421 12422 12423
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
12424 12425 12426 12427 12428 12429
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

12430
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, NULL);
12431 12432 12433 12434 12435 12436 12437 12438 12439

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

    return ret;
}

12440 12441 12442 12443 12444 12445 12446 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 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540
/*
 * "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;
}

12541 12542 12543 12544
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
12545 12546
    {"help", N_("Get or set the current snapshot")},
    {"desc", N_("Get or set the current snapshot")},
12547 12548 12549 12550 12551
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12552
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
12553 12554
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
12555 12556
    {"snapshotname", VSH_OT_DATA, 0,
     N_("name of existing snapshot to make current")},
12557 12558 12559
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12560
static bool
12561 12562 12563
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12564
    bool ret = false;
12565 12566
    int current;
    virDomainSnapshotPtr snapshot = NULL;
12567
    char *xml = NULL;
12568
    const char *snapshotname = NULL;
12569 12570 12571 12572
    unsigned int flags = 0;

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

12574
    if (!vshConnectionUsability(ctl, ctl->conn))
12575 12576 12577 12578 12579 12580
        goto cleanup;

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

12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609
    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;
    }

12610 12611 12612 12613
    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
12614
        char *name = NULL;
12615 12616 12617 12618

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

12619
        xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
12620 12621 12622
        if (!xml)
            goto cleanup;

12623 12624 12625 12626
        if (vshCommandOptBool(cmd, "name")) {
            xmlDocPtr xmldoc = NULL;
            xmlXPathContextPtr ctxt = NULL;

12627
            xmldoc = virXMLParseStringCtxt(xml, "domainsnapshot.xml", &ctxt);
12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639
            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);
12640 12641
    }

E
Eric Blake 已提交
12642
    ret = true;
12643 12644

cleanup:
12645
    VIR_FREE(xml);
12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664
    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")},
12665
    {"parent", VSH_OT_BOOL, 0, N_("add a column showing parent snapshot")},
12666 12667 12668
    {"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")},
12669 12670 12671
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12672
static bool
12673 12674 12675
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12676
    bool ret = false;
12677
    unsigned int flags = 0;
12678 12679
    int parent_filter = 0; /* -1 for roots filtering, 0 for no parent
                              information needed, 1 for parent column */
12680 12681
    int numsnaps;
    char **names = NULL;
12682
    int actual = 0;
12683 12684 12685 12686 12687 12688
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
12689
    char *parent = NULL;
12690 12691
    long long creation_longlong;
    time_t creation_time_t;
12692 12693 12694
    char timestr[100];
    struct tm time_info;

12695
    if (vshCommandOptBool(cmd, "parent")) {
12696 12697 12698 12699 12700
        if (vshCommandOptBool(cmd, "roots")) {
            vshError(ctl, "%s",
                     _("--parent and --roots are mutually exlusive"));
            return false;
        }
12701
        parent_filter = 1;
12702 12703 12704 12705 12706 12707
    } else if (vshCommandOptBool(cmd, "roots")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
    }

    if (vshCommandOptBool(cmd, "metadata")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_METADATA;
12708 12709
    }

12710
    if (!vshConnectionUsability(ctl, ctl->conn))
12711 12712 12713 12714 12715 12716
        goto cleanup;

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

12717
    numsnaps = virDomainSnapshotNum(dom, flags);
12718

12719 12720 12721 12722 12723 12724 12725 12726 12727 12728
    /* 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);
    }

12729 12730 12731
    if (numsnaps < 0)
        goto cleanup;

12732 12733 12734 12735 12736 12737 12738 12739
    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");
12740 12741 12742 12743 12744

    if (numsnaps) {
        if (VIR_ALLOC_N(names, numsnaps) < 0)
            goto cleanup;

12745
        actual = virDomainSnapshotListNames(dom, names, numsnaps, flags);
12746 12747 12748 12749 12750 12751 12752
        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 */
12753
            VIR_FREE(parent);
12754 12755 12756 12757
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
12758
            xmlFreeDoc(xml);
12759 12760 12761 12762 12763 12764 12765 12766 12767 12768
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

12769
            xml = virXMLParseStringCtxt(doc, "domainsnapshot.xml", &ctxt);
12770 12771 12772
            if (!xml)
                continue;

12773 12774 12775
            if (parent_filter) {
                parent = virXPathString("string(/domainsnapshot/parent/name)",
                                        ctxt);
12776 12777
                if (!parent && parent_filter < 0)
                    continue;
12778 12779
            }

12780 12781 12782
            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
12783 12784
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
12785
                continue;
12786 12787 12788 12789 12790 12791
            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);
12792 12793
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z",
                     &time_info);
12794

12795 12796 12797 12798 12799
            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);
12800 12801 12802
        }
    }

E
Eric Blake 已提交
12803
    ret = true;
12804 12805 12806

cleanup:
    /* this frees up memory from the last iteration of the loop */
12807
    VIR_FREE(parent);
12808 12809 12810 12811
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    xmlXPathFreeContext(ctxt);
12812
    xmlFreeDoc(xml);
12813
    VIR_FREE(doc);
12814 12815
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834
    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")},
12835 12836
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
12837 12838 12839
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12840
static bool
12841 12842 12843
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12844
    bool ret = false;
12845
    const char *name = NULL;
12846 12847
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
12848 12849 12850 12851
    unsigned int flags = 0;

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

12853
    if (!vshConnectionUsability(ctl, ctl->conn))
12854 12855 12856 12857 12858 12859
        goto cleanup;

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

12860
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12861 12862 12863 12864 12865 12866
        goto cleanup;

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

12867
    xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
12868 12869 12870
    if (!xml)
        goto cleanup;

12871
    vshPrint(ctl, "%s", xml);
12872

E
Eric Blake 已提交
12873
    ret = true;
12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884

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

    return ret;
}

E
Eric Blake 已提交
12885 12886 12887 12888
/*
 * "snapshot-parent" command
 */
static const vshCmdInfo info_snapshot_parent[] = {
E
Eric Blake 已提交
12889
    {"help", N_("Get the name of the parent of a snapshot")},
E
Eric Blake 已提交
12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929
    {"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;

12930
    xmldoc = virXMLParseStringCtxt(xml, "domainsnapshot.xml", &ctxt);
E
Eric Blake 已提交
12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944
    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);
12945
    xmlFreeDoc(xmldoc);
E
Eric Blake 已提交
12946 12947 12948 12949 12950 12951 12952 12953 12954
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12955
/*
12956
 * "snapshot-revert" command
12957
 */
12958
static const vshCmdInfo info_snapshot_revert[] = {
12959 12960 12961 12962 12963
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

12964
static const vshCmdOptDef opts_snapshot_revert[] = {
12965 12966
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
12967 12968
    {"running", VSH_OT_BOOL, 0, N_("after reverting, change state to running")},
    {"paused", VSH_OT_BOOL, 0, N_("after reverting, change state to paused")},
12969 12970 12971
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12972
static bool
12973
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
12974 12975
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12976
    bool ret = false;
12977
    const char *name = NULL;
12978
    virDomainSnapshotPtr snapshot = NULL;
12979 12980 12981 12982 12983 12984
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED;
12985

12986
    if (!vshConnectionUsability(ctl, ctl->conn))
12987 12988 12989 12990 12991 12992
        goto cleanup;

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

12993
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12994 12995 12996 12997 12998 12999
        goto cleanup;

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

13000
    if (virDomainRevertToSnapshot(snapshot, flags) < 0)
13001 13002
        goto cleanup;

E
Eric Blake 已提交
13003
    ret = true;
13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026

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")},
13027 13028 13029
    {"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")},
13030 13031 13032
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13033
static bool
13034 13035 13036
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13037
    bool ret = false;
13038
    const char *name = NULL;
13039 13040 13041
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

13042
    if (!vshConnectionUsability(ctl, ctl->conn))
13043 13044 13045 13046 13047 13048
        goto cleanup;

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

13049
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13050 13051 13052 13053
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;
13054 13055 13056 13057
    if (vshCommandOptBool(cmd, "children-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY;
    if (vshCommandOptBool(cmd, "metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY;
13058 13059 13060 13061 13062

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

13063 13064 13065
    /* 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.  */
13066
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
13067 13068 13069 13070
        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);
13071 13072
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
13073
        goto cleanup;
13074
    }
13075

E
Eric Blake 已提交
13076
    ret = true;
13077 13078 13079 13080 13081 13082 13083 13084 13085 13086

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

    return ret;
}

13087 13088 13089 13090
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
13091 13092
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
13093 13094 13095 13096 13097
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
13098
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
13099
    {"cmd", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("command")},
13100 13101 13102
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13103
static bool
13104 13105 13106
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13107
    bool ret = false;
13108
    char *monitor_cmd = NULL;
13109
    char *result = NULL;
13110
    unsigned int flags = 0;
13111 13112 13113
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
13114 13115 13116 13117 13118 13119 13120 13121

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

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

13122 13123 13124 13125 13126 13127 13128 13129
    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"));
13130 13131
        goto cleanup;
    }
13132
    monitor_cmd = virBufferContentAndReset(&buf);
13133

13134 13135 13136 13137
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
13138 13139 13140 13141
        goto cleanup;

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

E
Eric Blake 已提交
13142
    ret = true;
13143 13144 13145

cleanup:
    VIR_FREE(result);
13146
    VIR_FREE(monitor_cmd);
13147 13148 13149 13150 13151 13152
    if (dom)
        virDomainFree(dom);

    return ret;
}

13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198
/*
 * "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;
}

13199
static const vshCmdDef domManagementCmds[] = {
13200 13201 13202 13203 13204 13205 13206 13207
    {"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},
13208 13209
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
13210
#ifndef WIN32
13211
    {"console", cmdConsole, opts_console, info_console, 0},
13212
#endif
13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235
    {"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},
13236
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
13237 13238 13239 13240 13241 13242 13243 13244
    {"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},
13245 13246
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
13247 13248
    {"migrate-getspeed", cmdMigrateGetMaxSpeed,
     opts_migrate_getspeed, info_migrate_getspeed, 0},
13249 13250 13251 13252
    {"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},
13253 13254 13255 13256 13257 13258
    {"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},
13259
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
13260
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272
    {"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 已提交
13273
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
13274
    {"version", cmdVersion, opts_version, info_version, 0},
13275 13276
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
13277 13278 13279
};

static const vshCmdDef domMonitoringCmds[] = {
13280
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
13281
    {"domblklist", cmdDomblklist, opts_domblklist, info_domblklist, 0},
13282
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
13283
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
13284 13285 13286 13287 13288 13289
    {"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}
13290 13291 13292
};

static const vshCmdDef storagePoolCmds[] = {
13293
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
13294
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
13295
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310 13311 13312 13313 13314 13315 13316
     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}
13317 13318 13319
};

static const vshCmdDef storageVolCmds[] = {
13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337
    {"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}
13338
};
13339

13340
static const vshCmdDef networkCmds[] = {
13341 13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359
    {"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}
13360
};
13361

13362
static const vshCmdDef nodedevCmds[] = {
13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377
    {"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}
13378 13379 13380
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
13381 13382 13383 13384
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398
    {"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 已提交
13399 13400
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
13401 13402 13403 13404 13405
    {"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}
13406
};
13407

13408
static const vshCmdDef nwfilterCmds[] = {
13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419
    {"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}
13420
};
13421

13422
static const vshCmdDef secretCmds[] = {
13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434
    {"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}
13435
};
13436

13437
static const vshCmdDef virshCmds[] = {
13438 13439 13440 13441 13442 13443 13444
    {"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}
13445
};
13446

13447
static const vshCmdDef snapshotCmds[] = {
13448 13449
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
13450 13451
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
13452 13453 13454 13455 13456 13457
    {"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},
13458 13459
    {"snapshot-edit", cmdSnapshotEdit, opts_snapshot_edit,
     info_snapshot_edit, 0},
13460 13461
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
E
Eric Blake 已提交
13462 13463
    {"snapshot-parent", cmdSnapshotParent, opts_snapshot_parent,
     info_snapshot_parent, 0},
13464 13465 13466
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
13467
};
13468

13469
static const vshCmdDef hostAndHypervisorCmds[] = {
13470 13471 13472 13473 13474
    {"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},
13475
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
13476
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
13477
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
13478
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
13479 13480 13481 13482 13483
    {"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 已提交
13484 13485
};

13486 13487 13488 13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 13499 13500 13501 13502
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 已提交
13503 13504 13505 13506
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
13507
static const char *
13508
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
13509
{
13510
    const vshCmdInfo *info;
13511

K
Karel Zak 已提交
13512
    for (info = cmd->info; info && info->name; info++) {
13513
        if (STREQ(info->name, name))
K
Karel Zak 已提交
13514 13515 13516 13517 13518
            return info->data;
    }
    return NULL;
}

13519
static int
E
Eric Blake 已提交
13520
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
13521 13522 13523 13524 13525
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
13526 13527 13528
    *opts_need_arg = 0;
    *opts_required = 0;

13529 13530 13531 13532 13533 13534 13535 13536 13537
    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 已提交
13538
            if (opt->flags & VSH_OFLAG_REQ)
13539 13540 13541
                return -1; /* bool options can't be mandatory */
            continue;
        }
E
Eric Blake 已提交
13542 13543
        if (opt->flags & VSH_OFLAG_REQ_OPT) {
            if (opt->flags & VSH_OFLAG_REQ)
L
Lai Jiangshan 已提交
13544 13545 13546 13547
                *opts_required |= 1 << i;
            continue;
        }

13548
        *opts_need_arg |= 1 << i;
E
Eric Blake 已提交
13549
        if (opt->flags & VSH_OFLAG_REQ) {
13550 13551 13552 13553 13554 13555 13556 13557 13558 13559
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
    }
    return 0;
}

13560
static const vshCmdOptDef *
13561 13562
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
13563
{
13564 13565 13566 13567
    int i;

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

13569 13570 13571 13572 13573
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
13574 13575
            if (opt->type != VSH_OT_ARGV)
                *opts_seen |= 1 << i;
K
Karel Zak 已提交
13576
            return opt;
13577 13578 13579 13580 13581
        }
    }

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

13585
static const vshCmdOptDef *
13586 13587
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
13588
{
13589
    int i;
13590
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
13591

13592 13593 13594 13595
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
13596
    i = ffs(*opts_need_arg) - 1;
13597 13598 13599 13600 13601
    opt = &cmd->opts[i];
    if (opt->type != VSH_OT_ARGV)
        *opts_need_arg &= ~(1 << i);
    *opts_seen |= 1 << i;
    return opt;
K
Karel Zak 已提交
13602 13603
}

13604 13605 13606
/*
 * Checks for required options
 */
13607
static int
13608 13609
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
13610
{
13611
    const vshCmdDef *def = cmd->def;
13612 13613 13614 13615 13616 13617 13618 13619 13620
    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];
13621

13622
            vshError(ctl,
13623
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
13624 13625 13626
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
13627 13628
        }
    }
13629
    return -1;
13630 13631
}

13632
static const vshCmdDef *
13633 13634
vshCmddefSearch(const char *cmdname)
{
13635
    const vshCmdGrp *g;
13636
    const vshCmdDef *c;
13637

13638 13639
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
13640
            if (STREQ(c->name, cmdname))
13641 13642 13643 13644
                return c;
        }
    }

K
Karel Zak 已提交
13645 13646 13647
    return NULL;
}

13648 13649 13650 13651 13652 13653
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
13654
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
13655 13656 13657 13658 13659 13660
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
13661
static bool
13662 13663 13664 13665 13666 13667 13668
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 已提交
13669
        return false;
13670 13671 13672 13673 13674 13675 13676 13677 13678 13679
    } 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 已提交
13680
    return true;
13681 13682
}

E
Eric Blake 已提交
13683
static bool
13684
vshCmddefHelp(vshControl *ctl, const char *cmdname)
13685
{
13686
    const vshCmdDef *def = vshCmddefSearch(cmdname);
13687

K
Karel Zak 已提交
13688
    if (!def) {
13689
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
13690
        return false;
13691
    } else {
E
Eric Blake 已提交
13692 13693
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
13694
        const char *help = _(vshCmddefGetInfo(def, "help"));
13695
        char buf[256];
13696 13697 13698 13699 13700 13701
        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 已提交
13702
            return false;
13703
        }
K
Karel Zak 已提交
13704

13705
        fputs(_("  NAME\n"), stdout);
13706 13707
        fprintf(stdout, "    %s - %s\n", def->name, help);

13708 13709 13710 13711 13712
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
13713
                const char *fmt = "%s";
13714 13715
                switch (opt->type) {
                case VSH_OT_BOOL:
13716
                    fmt = "[--%s]";
13717 13718
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
13719
                    /* xgettext:c-format */
E
Eric Blake 已提交
13720
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>"
13721
                           : _("[--%s <number>]"));
13722 13723
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
13724 13725
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
13726 13727
                    break;
                case VSH_OT_DATA:
E
Eric Blake 已提交
13728
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
13729 13730 13731
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
E
Eric Blake 已提交
13732
                    fmt = (opt->flags & VSH_OFLAG_REQ) ? _("<%s>...")
13733
                           : _("[<%s>]...");
13734 13735
                    break;
                default:
13736
                    assert(0);
13737
                }
13738
                fputc(' ', stdout);
E
Eric Blake 已提交
13739
                fprintf(stdout, fmt, opt->name);
13740
            }
K
Karel Zak 已提交
13741
        }
13742 13743 13744
        fputc('\n', stdout);

        if (desc[0]) {
13745
            /* Print the description only if it's not empty.  */
13746
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
13747
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
13748
        }
13749

K
Karel Zak 已提交
13750
        if (def->opts) {
13751
            const vshCmdOptDef *opt;
13752
            fputs(_("\n  OPTIONS\n"), stdout);
13753
            for (opt = def->opts; opt->name; opt++) {
13754 13755
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
13756
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
13757 13758
                    break;
                case VSH_OT_INT:
13759
                    snprintf(buf, sizeof(buf),
E
Eric Blake 已提交
13760
                             (opt->flags & VSH_OFLAG_REQ) ? _("[--%s] <number>")
13761
                             : _("--%s <number>"), opt->name);
13762 13763
                    break;
                case VSH_OT_STRING:
13764
                    /* OT_STRING should never be VSH_OFLAG_REQ */
13765
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
13766 13767
                    break;
                case VSH_OT_DATA:
13768 13769
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
13770 13771 13772
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
13773 13774
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
13775 13776 13777
                default:
                    assert(0);
                }
13778

E
Eric Blake 已提交
13779
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
13780
            }
K
Karel Zak 已提交
13781 13782 13783
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
13784
    return true;
K
Karel Zak 已提交
13785 13786 13787 13788 13789 13790
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
13791 13792 13793
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
13794 13795
    vshCmdOpt *a = arg;

13796
    while (a) {
K
Karel Zak 已提交
13797
        vshCmdOpt *tmp = a;
13798

K
Karel Zak 已提交
13799 13800
        a = a->next;

13801 13802
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
13803 13804 13805 13806
    }
}

static void
13807
vshCommandFree(vshCmd *cmd)
13808
{
K
Karel Zak 已提交
13809 13810
    vshCmd *c = cmd;

13811
    while (c) {
K
Karel Zak 已提交
13812
        vshCmd *tmp = c;
13813

K
Karel Zak 已提交
13814 13815 13816 13817
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
13818
        VIR_FREE(tmp);
K
Karel Zak 已提交
13819 13820 13821
    }
}

E
Eric Blake 已提交
13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832
/**
 * 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 已提交
13833
 */
E
Eric Blake 已提交
13834 13835
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
13836
{
E
Eric Blake 已提交
13837 13838
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
13839

E
Eric Blake 已提交
13840 13841 13842 13843 13844 13845 13846
    /* 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 已提交
13847
    }
E
Eric Blake 已提交
13848 13849 13850 13851 13852 13853 13854

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
E
Eric Blake 已提交
13855
            return (valid->flags & VSH_OFLAG_REQ) == 0 ? 0 : -1;
E
Eric Blake 已提交
13856 13857 13858 13859
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
13860 13861
}

E
Eric Blake 已提交
13862 13863
/**
 * vshCommandOptInt:
13864 13865 13866 13867 13868 13869 13870
 * @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 已提交
13871
 * 0 if option not found and not required (@value untouched)
13872
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
13873 13874
 */
static int
13875
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
13876
{
E
Eric Blake 已提交
13877 13878 13879
    vshCmdOpt *arg;
    int ret;
    int num;
13880
    char *end_p = NULL;
13881

E
Eric Blake 已提交
13882 13883 13884 13885 13886 13887 13888
    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;
13889
    }
E
Eric Blake 已提交
13890 13891 13892 13893 13894 13895 13896

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
13897 13898
}

13899

E
Eric Blake 已提交
13900 13901 13902 13903 13904 13905
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
13906 13907 13908 13909 13910 13911
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
13912 13913 13914
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
13915 13916
    char *end_p = NULL;

E
Eric Blake 已提交
13917 13918 13919 13920 13921 13922 13923
    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;
13924
    }
E
Eric Blake 已提交
13925 13926 13927 13928 13929 13930 13931

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13932 13933 13934
}


13935
/*
E
Eric Blake 已提交
13936 13937 13938 13939 13940
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
13941 13942 13943 13944 13945
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
13946
{
E
Eric Blake 已提交
13947 13948
    vshCmdOpt *arg;
    int ret;
13949
    unsigned long num;
13950 13951
    char *end_p = NULL;

E
Eric Blake 已提交
13952 13953 13954 13955 13956 13957 13958
    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;
13959
    }
E
Eric Blake 已提交
13960 13961 13962 13963 13964 13965 13966

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13967 13968
}

E
Eric Blake 已提交
13969 13970 13971 13972 13973 13974
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
13975
 * Returns option as STRING
E
Eric Blake 已提交
13976 13977 13978 13979
 * 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 已提交
13980
 */
13981 13982
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
13983
{
E
Eric Blake 已提交
13984 13985 13986 13987 13988 13989 13990 13991 13992 13993
    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;
13994
    }
13995

E
Eric Blake 已提交
13996
    if (!*arg->data && !(arg->def->flags & VSH_OFLAG_EMPTY_OK)) {
E
Eric Blake 已提交
13997 13998 13999 14000
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
14001 14002
}

E
Eric Blake 已提交
14003 14004 14005 14006 14007 14008
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
14009
 * Returns option as long long
14010
 * See vshCommandOptInt()
14011
 */
14012 14013 14014
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
14015
{
E
Eric Blake 已提交
14016 14017
    vshCmdOpt *arg;
    int ret;
14018
    long long num;
14019 14020
    char *end_p = NULL;

E
Eric Blake 已提交
14021 14022 14023 14024 14025 14026 14027
    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;
14028
    }
E
Eric Blake 已提交
14029 14030 14031 14032 14033 14034 14035

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14036 14037
}

E
Eric Blake 已提交
14038 14039 14040 14041 14042 14043 14044 14045 14046
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
14047 14048 14049 14050
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
14051 14052
    vshCmdOpt *arg;
    int ret;
14053 14054 14055
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
14056 14057 14058 14059 14060 14061 14062
    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;
14063
    }
E
Eric Blake 已提交
14064 14065 14066 14067 14068 14069 14070

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14071 14072 14073
}


E
Eric Blake 已提交
14074 14075 14076 14077 14078 14079 14080 14081 14082
/**
 * 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 已提交
14083
 */
E
Eric Blake 已提交
14084
static bool
14085
vshCommandOptBool(const vshCmd *cmd, const char *name)
14086
{
E
Eric Blake 已提交
14087 14088 14089
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
14090 14091
}

E
Eric Blake 已提交
14092 14093 14094 14095 14096
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
14097 14098
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
14099
 *
14100
 * Requires that a VSH_OT_ARGV option be last in the
14101 14102
 * list of supported options in CMD->def->opts.
 */
14103 14104
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
14105
{
14106
    opt = opt ? opt->next : cmd->opts;
14107 14108

    while (opt) {
E
Eric Blake 已提交
14109
        if (opt->def->type == VSH_OT_ARGV) {
14110
            return opt;
14111 14112 14113 14114 14115 14116
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134
/* 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)
14135
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
14136 14137 14138
                 cmd->def->name, optname);
    return found;
}
14139

K
Karel Zak 已提交
14140
static virDomainPtr
J
Jim Meyering 已提交
14141
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
14142
                      const char **name, int flag)
14143
{
K
Karel Zak 已提交
14144
    virDomainPtr dom = NULL;
14145
    const char *n = NULL;
K
Karel Zak 已提交
14146
    int id;
J
Jim Meyering 已提交
14147 14148 14149
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
14150

14151
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14152 14153
        return NULL;

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

K
Karel Zak 已提交
14157 14158
    if (name)
        *name = n;
14159

K
Karel Zak 已提交
14160
    /* try it by ID */
14161
    if (flag & VSH_BYID) {
14162
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
14163 14164
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
14165 14166 14167
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
14168
    }
K
Karel Zak 已提交
14169
    /* try it by UUID */
14170
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
14171
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
14172
                 cmd->def->name, optname);
K
Karel Zak 已提交
14173
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
14174
    }
K
Karel Zak 已提交
14175
    /* try it by NAME */
14176
    if (dom==NULL && (flag & VSH_BYNAME)) {
14177
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
14178
                 cmd->def->name, optname);
K
Karel Zak 已提交
14179
        dom = virDomainLookupByName(ctl->conn, n);
14180
    }
K
Karel Zak 已提交
14181

14182
    if (!dom)
14183
        vshError(ctl, _("failed to get domain '%s'"), n);
14184

K
Karel Zak 已提交
14185 14186 14187
    return dom;
}

14188
static virNetworkPtr
J
Jim Meyering 已提交
14189
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
14190
                       const char **name, int flag)
14191 14192
{
    virNetworkPtr network = NULL;
14193
    const char *n = NULL;
J
Jim Meyering 已提交
14194 14195 14196
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
14197

14198
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14199 14200
        return NULL;

14201
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14202 14203 14204 14205 14206 14207
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
14208
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14209
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
14210
                 cmd->def->name, optname);
14211 14212 14213 14214
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
14215
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
14216 14217 14218 14219 14220
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
14221
        vshError(ctl, _("failed to get network '%s'"), n);
14222 14223 14224 14225

    return network;
}

14226 14227 14228

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
14229
                        const char **name, int flag)
14230 14231
{
    virNWFilterPtr nwfilter = NULL;
14232
    const char *n = NULL;
14233 14234 14235 14236
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14237
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14238 14239
        return NULL;

14240
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14241 14242 14243 14244 14245 14246 14247
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14248
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
14249 14250 14251 14252 14253
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
14254
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
14255 14256 14257 14258 14259 14260 14261 14262 14263 14264
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

14265 14266
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
14267
                         const char **name, int flag)
14268 14269
{
    virInterfacePtr iface = NULL;
14270
    const char *n = NULL;
14271 14272 14273 14274
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14275
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14276 14277
        return NULL;

14278
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14279 14280 14281 14282 14283 14284
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
14285
    if ((flag & VSH_BYNAME)) {
14286
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
14287 14288 14289 14290 14291
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
14292
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
14293 14294 14295 14296 14297
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
14298
        vshError(ctl, _("failed to get interface '%s'"), n);
14299 14300 14301 14302

    return iface;
}

14303
static virStoragePoolPtr
14304
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
14305
                    const char **name, int flag)
14306 14307
{
    virStoragePoolPtr pool = NULL;
14308
    const char *n = NULL;
14309

14310
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14311 14312
        return NULL;

14313
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14314 14315 14316 14317 14318 14319
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
14320
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14321
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
14322
                 cmd->def->name, optname);
14323 14324 14325
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
14326
    if (pool == NULL && (flag & VSH_BYNAME)) {
14327
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
14328 14329 14330 14331 14332
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
14333
        vshError(ctl, _("failed to get pool '%s'"), n);
14334 14335 14336 14337 14338

    return pool;
}

static virStorageVolPtr
14339
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
14340 14341
                   const char *optname,
                   const char *pooloptname,
14342
                   const char **name, int flag)
14343 14344 14345
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
14346
    const char *n = NULL, *p = NULL;
14347

14348
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14349 14350
        return NULL;

14351
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
14352
        vshError(ctl, "%s", _("missing option"));
14353
        return NULL;
14354
    }
14355 14356 14357 14358

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

14359
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
14360 14361 14362 14363 14364
             cmd->def->name, optname, n);

    if (name)
        *name = n;

14365
    /* try it by name */
14366
    if (pool && (flag & VSH_BYNAME)) {
14367
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
14368 14369 14370
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
14371
    /* try it by key */
14372
    if (vol == NULL && (flag & VSH_BYUUID)) {
14373
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
14374 14375 14376
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
14377
    /* try it by path */
14378
    if (vol == NULL && (flag & VSH_BYUUID)) {
14379
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
14380 14381 14382 14383 14384
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
14385
        vshError(ctl, _("failed to get vol '%s'"), n);
14386 14387 14388 14389 14390 14391 14392

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

14393
static virSecretPtr
14394
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
14395 14396
{
    virSecretPtr secret = NULL;
14397
    const char *n = NULL;
14398 14399 14400 14401 14402
    const char *optname = "secret";

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

14403
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14404 14405
        return NULL;

14406 14407
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
14408 14409 14410 14411 14412 14413 14414

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
14415
        vshError(ctl, _("failed to get secret '%s'"), n);
14416 14417 14418 14419

    return secret;
}

K
Karel Zak 已提交
14420 14421 14422
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
14423
static bool
14424
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
14425
{
E
Eric Blake 已提交
14426
    bool ret = true;
14427 14428

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

14432 14433
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
14434 14435
            vshReconnect(ctl);

14436
        if (enable_timing)
K
Karel Zak 已提交
14437
            GETTIMEOFDAY(&before);
14438

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

14441
        if (enable_timing)
K
Karel Zak 已提交
14442
            GETTIMEOFDAY(&after);
14443

14444
        if (!ret)
J
John Levon 已提交
14445 14446
            virshReportError(ctl);

14447
        /* try to automatically catch disconnections */
14448
        if (!ret &&
14449 14450 14451 14452 14453 14454 14455 14456 14457
            ((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);

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

14461
        if (enable_timing)
14462
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
14463 14464
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
14465
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
14466 14467 14468 14469 14470 14471
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
14472
 * Command parsing
K
Karel Zak 已提交
14473 14474 14475
 * ---------------
 */

14476 14477 14478 14479 14480 14481 14482 14483 14484 14485
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 已提交
14486
    /* vshCommandStringGetArg() */
14487
    char *pos;
L
Lai Jiangshan 已提交
14488 14489 14490
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
14491 14492
} vshCommandParser;

E
Eric Blake 已提交
14493
static bool
14494
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
14495
{
K
Karel Zak 已提交
14496 14497 14498
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
14499

K
Karel Zak 已提交
14500 14501 14502 14503
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
14504

14505
    while (1) {
K
Karel Zak 已提交
14506
        vshCmdOpt *last = NULL;
14507
        const vshCmdDef *cmd = NULL;
14508
        vshCommandToken tk;
L
Lai Jiangshan 已提交
14509
        bool data_only = false;
14510 14511 14512
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
14513

K
Karel Zak 已提交
14514
        first = NULL;
14515

14516
        while (1) {
14517
            const vshCmdOptDef *opt = NULL;
14518

K
Karel Zak 已提交
14519
            tkdata = NULL;
14520
            tk = parser->getNextArg(ctl, parser, &tkdata);
14521 14522

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14523
                goto syntaxError;
H
Hu Tao 已提交
14524 14525
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
14526
                break;
H
Hu Tao 已提交
14527
            }
14528 14529

            if (cmd == NULL) {
K
Karel Zak 已提交
14530 14531
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
14532
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
14533
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
14534
                }
14535 14536 14537 14538 14539 14540 14541
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
14542
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
14543 14544 14545 14546
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
14547 14548 14549 14550 14551
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
14552 14553
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
14554
                    VIR_FREE(optstr);
K
Karel Zak 已提交
14555 14556
                    goto syntaxError;
                }
14557
                VIR_FREE(tkdata);
K
Karel Zak 已提交
14558 14559 14560

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
14561 14562 14563
                    if (optstr)
                        tkdata = optstr;
                    else
14564
                        tk = parser->getNextArg(ctl, parser, &tkdata);
14565
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14566
                        goto syntaxError;
14567
                    if (tk != VSH_TK_ARG) {
14568
                        vshError(ctl,
14569
                                 _("expected syntax: --%s <%s>"),
14570 14571
                                 opt->name,
                                 opt->type ==
14572
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
14573 14574
                        goto syntaxError;
                    }
14575
                    opts_need_arg &= ~opts_seen;
14576 14577 14578 14579 14580 14581 14582 14583
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
14584
                }
L
Lai Jiangshan 已提交
14585 14586 14587 14588
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
14589
            } else {
L
Lai Jiangshan 已提交
14590
get_data:
14591 14592
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
14593
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
14594 14595 14596 14597 14598
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
14599
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
14600

K
Karel Zak 已提交
14601 14602 14603 14604
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
14605

K
Karel Zak 已提交
14606 14607 14608 14609 14610
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
14611

14612
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
14613 14614
                         cmd->name,
                         opt->name,
14615 14616
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
14617 14618
            }
        }
14619

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

K
Karel Zak 已提交
14624 14625 14626 14627
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

14628
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
14629
                VIR_FREE(c);
14630
                goto syntaxError;
14631
            }
14632

K
Karel Zak 已提交
14633 14634 14635 14636 14637 14638
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
14639 14640 14641

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
14642
    }
14643

E
Eric Blake 已提交
14644
    return true;
K
Karel Zak 已提交
14645

14646
 syntaxError:
14647
    if (ctl->cmd) {
K
Karel Zak 已提交
14648
        vshCommandFree(ctl->cmd);
14649 14650
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
14651 14652
    if (first)
        vshCommandOptFree(first);
14653
    VIR_FREE(tkdata);
E
Eric Blake 已提交
14654
    return false;
K
Karel Zak 已提交
14655 14656
}

14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674
/* --------------------
 * 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 已提交
14675 14676
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
14677 14678 14679 14680
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
14681
        return false;
14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 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

    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 已提交
14754 14755
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
14756 14757 14758 14759
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
14760
        return false;
14761 14762 14763 14764 14765 14766

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

K
Karel Zak 已提交
14767
/* ---------------
14768
 * Misc utils
K
Karel Zak 已提交
14769 14770
 * ---------------
 */
14771 14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782 14783 14784 14785 14786 14787 14788 14789 14790 14791 14792 14793 14794 14795 14796 14797 14798
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 已提交
14799
static const char *
14800 14801
vshDomainStateToString(int state)
{
14802 14803
    /* Can't use virDomainStateTypeToString, because we want to mark
     * strings for translation.  */
14804
    switch ((virDomainState) state) {
14805
    case VIR_DOMAIN_RUNNING:
14806
        return N_("running");
14807
    case VIR_DOMAIN_BLOCKED:
14808
        return N_("idle");
14809
    case VIR_DOMAIN_PAUSED:
14810
        return N_("paused");
14811
    case VIR_DOMAIN_SHUTDOWN:
14812
        return N_("in shutdown");
14813
    case VIR_DOMAIN_SHUTOFF:
14814
        return N_("shut off");
14815
    case VIR_DOMAIN_CRASHED:
14816
        return N_("crashed");
14817
    case VIR_DOMAIN_NOSTATE:
14818
    default:
14819
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
14820
    }
14821
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
14822 14823
}

14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919
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;
14920 14921 14922

    default:
        ;
14923 14924 14925 14926 14927
    }

    return N_("unknown");
}

14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944
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");
}

14945 14946 14947 14948
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
14949
    case VIR_VCPU_OFFLINE:
14950
        return N_("offline");
14951
    case VIR_VCPU_BLOCKED:
14952
        return N_("idle");
14953
    case VIR_VCPU_RUNNING:
14954
        return N_("running");
14955
    default:
14956
        ;/*FALLTHROUGH*/
14957
    }
14958
    return N_("no state");
14959 14960
}

E
Eric Blake 已提交
14961
static bool
14962
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
14963
{
14964 14965
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
14966 14967
     */
    if (!conn) {
14968
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
14969
        return false;
K
Karel Zak 已提交
14970
    }
E
Eric Blake 已提交
14971
    return true;
K
Karel Zak 已提交
14972 14973
}

K
Karel Zak 已提交
14974
static void
14975
vshDebug(vshControl *ctl, int level, const char *format, ...)
14976
{
K
Karel Zak 已提交
14977
    va_list ap;
14978
    char *str;
K
Karel Zak 已提交
14979

14980 14981 14982 14983 14984 14985 14986
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

14987
    va_start(ap, format);
14988
    vshOutputLogFile(ctl, level, format, ap);
14989 14990
    va_end(ap);

K
Karel Zak 已提交
14991
    va_start(ap, format);
14992 14993 14994 14995 14996
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
14997
    va_end(ap);
14998 14999
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
15000 15001 15002
}

static void
15003
vshPrintExtra(vshControl *ctl, const char *format, ...)
15004
{
K
Karel Zak 已提交
15005
    va_list ap;
15006
    char *str;
15007

15008
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
15009
        return;
15010

K
Karel Zak 已提交
15011
    va_start(ap, format);
15012 15013 15014 15015 15016
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
15017
    va_end(ap);
15018
    fputs(str, stdout);
15019
    VIR_FREE(str);
K
Karel Zak 已提交
15020 15021
}

K
Karel Zak 已提交
15022

K
Karel Zak 已提交
15023
static void
15024
vshError(vshControl *ctl, const char *format, ...)
15025
{
K
Karel Zak 已提交
15026
    va_list ap;
15027
    char *str;
15028

15029 15030 15031 15032 15033
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
15034

15035 15036 15037 15038
    /* 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);
15039
    fputs(_("error: "), stderr);
15040

K
Karel Zak 已提交
15041
    va_start(ap, format);
15042 15043 15044
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
15045 15046
    va_end(ap);

15047
    fprintf(stderr, "%s\n", NULLSTR(str));
15048
    fflush(stderr);
15049
    VIR_FREE(str);
K
Karel Zak 已提交
15050 15051
}

15052

K
Karel Zak 已提交
15053
/*
15054
 * Initialize connection.
K
Karel Zak 已提交
15055
 */
E
Eric Blake 已提交
15056
static bool
15057
vshInit(vshControl *ctl)
15058
{
15059 15060
    char *debugEnv;

K
Karel Zak 已提交
15061
    if (ctl->conn)
E
Eric Blake 已提交
15062
        return false;
K
Karel Zak 已提交
15063

J
Jiri Denemark 已提交
15064
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
15065 15066 15067
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
15068 15069 15070
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
15071 15072
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
15073 15074
            } else {
                ctl->debug = debug;
15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

15087 15088
    vshOpenLogFile(ctl);

15089 15090
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
15091

15092 15093 15094
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

15095
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
15096
        return false;
15097

15098 15099 15100 15101
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
15102

15103 15104 15105 15106 15107 15108 15109 15110 15111 15112 15113
        /* 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;
        }
15114
    }
K
Karel Zak 已提交
15115

E
Eric Blake 已提交
15116
    return true;
K
Karel Zak 已提交
15117 15118
}

15119 15120
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139
/**
 * 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:
15140
                vshError(ctl, "%s",
J
Jim Meyering 已提交
15141
                         _("failed to get the log file information"));
15142
                exit(EXIT_FAILURE);
15143 15144 15145
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
15146 15147
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
15148 15149 15150 15151
        }
    }

    /* log file open */
15152
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
15153
        vshError(ctl, "%s",
J
Jim Meyering 已提交
15154
                 _("failed to open the log file. check the log file path"));
15155
        exit(EXIT_FAILURE);
15156 15157 15158 15159 15160 15161 15162 15163 15164
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
15165 15166
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
15167
{
15168 15169 15170
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
15171 15172 15173 15174 15175 15176 15177 15178 15179 15180 15181 15182 15183 15184
    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);
15185
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
15186 15187 15188 15189 15190 15191
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
15192 15193
                      SIGN_NAME,
                      (int) getpid());
15194 15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205 15206 15207 15208 15209 15210 15211 15212 15213
    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;
    }
15214 15215 15216
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
15217

15218 15219
    if (virBufferError(&buf))
        goto error;
15220

15221 15222 15223 15224 15225
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
15226
    }
15227

15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238
    /* 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);
15239 15240 15241 15242 15243 15244 15245 15246 15247 15248 15249
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
15250 15251 15252
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
15253 15254 15255
    }

    if (ctl->logfile) {
15256
        VIR_FREE(ctl->logfile);
15257 15258 15259 15260
        ctl->logfile = NULL;
    }
}

15261
#ifdef USE_READLINE
15262

K
Karel Zak 已提交
15263 15264 15265 15266 15267
/* -----------------
 * Readline stuff
 * -----------------
 */

15268
/*
K
Karel Zak 已提交
15269 15270
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
15271
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
15272 15273
 */
static char *
15274 15275
vshReadlineCommandGenerator(const char *text, int state)
{
15276
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
15277
    const char *name;
15278 15279
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
15280 15281

    if (!state) {
15282 15283
        grp_list_index = 0;
        cmd_list_index = 0;
15284
        len = strlen(text);
K
Karel Zak 已提交
15285 15286
    }

15287 15288
    grp = cmdGroups;

K
Karel Zak 已提交
15289
    /* Return the next name which partially matches from the
15290
     * command list.
K
Karel Zak 已提交
15291
     */
15292 15293 15294 15295 15296 15297 15298 15299 15300 15301 15302 15303 15304 15305
    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 已提交
15306 15307 15308 15309 15310 15311 15312
    }

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

static char *
15313 15314
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
15315
    static int list_index, len;
15316
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
15317
    const char *name;
K
Karel Zak 已提交
15318 15319 15320 15321 15322 15323 15324 15325 15326

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

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

15327
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
15328
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
15329 15330 15331

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
15332
        len = strlen(text);
15333
        VIR_FREE(cmdname);
K
Karel Zak 已提交
15334 15335 15336 15337
    }

    if (!cmd)
        return NULL;
15338

15339 15340 15341
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
15342
    while ((name = cmd->opts[list_index].name)) {
15343
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
15344
        char *res;
15345

K
Karel Zak 已提交
15346
        list_index++;
15347

15348
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
15349 15350
            /* ignore non --option */
            continue;
15351

K
Karel Zak 已提交
15352
        if (len > 2) {
15353
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
15354 15355
                continue;
        }
15356
        res = vshMalloc(NULL, strlen(name) + 3);
15357
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
15358 15359 15360 15361 15362 15363 15364 15365
        return res;
    }

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

static char **
15366 15367 15368
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
15369 15370
    char **matches = (char **) NULL;

15371
    if (start == 0)
K
Karel Zak 已提交
15372
        /* command name generator */
15373
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
15374 15375
    else
        /* commands options */
15376
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
15377 15378 15379 15380
    return matches;
}


15381 15382
static int
vshReadlineInit(vshControl *ctl)
15383
{
15384 15385
    char *userdir = NULL;

K
Karel Zak 已提交
15386 15387 15388 15389 15390
    /* 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;
15391 15392 15393

    /* Limit the total size of the history buffer */
    stifle_history(500);
15394 15395

    /* Prepare to read/write history from/to the ~/.virsh/history file */
15396
    userdir = virGetUserDirectory(getuid());
15397

15398 15399
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
15400
        return -1;
15401
    }
15402 15403 15404

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15405
        VIR_FREE(userdir);
15406 15407 15408 15409 15410
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15411
        VIR_FREE(userdir);
15412 15413 15414
        return -1;
    }

15415
    VIR_FREE(userdir);
15416 15417 15418 15419 15420 15421 15422 15423 15424 15425 15426 15427 15428 15429 15430 15431 15432 15433

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

15434 15435
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
15436 15437
}

15438 15439 15440 15441 15442 15443
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

15444
#else /* !USE_READLINE */
15445

15446 15447 15448 15449 15450 15451 15452
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

15453
static void
15454
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
15455 15456 15457 15458 15459 15460 15461 15462 15463 15464 15465 15466 15467 15468 15469 15470 15471 15472 15473 15474 15475 15476 15477
{
    /* 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);
}

15478
#endif /* !USE_READLINE */
15479

K
Karel Zak 已提交
15480
/*
J
Jim Meyering 已提交
15481
 * Deinitialize virsh
K
Karel Zak 已提交
15482
 */
E
Eric Blake 已提交
15483
static bool
15484
vshDeinit(vshControl *ctl)
15485
{
15486
    vshReadlineDeinit(ctl);
15487
    vshCloseLogFile(ctl);
15488
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
15489
    if (ctl->conn) {
15490 15491 15492
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
15493 15494
        }
    }
D
Daniel P. Berrange 已提交
15495 15496
    virResetLastError();

E
Eric Blake 已提交
15497
    return true;
K
Karel Zak 已提交
15498
}
15499

K
Karel Zak 已提交
15500 15501 15502 15503
/*
 * Print usage
 */
static void
15504
vshUsage(void)
15505
{
15506
    const vshCmdGrp *grp;
15507
    const vshCmdDef *cmd;
15508

L
Lai Jiangshan 已提交
15509 15510
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
15511 15512 15513
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
15514
                      "    -d | --debug <num>      debug level [0-4]\n"
15515 15516 15517 15518
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
15519
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
15520
                      "    -V | --version=long     version and full options\n\n"
15521
                      "  commands (non interactive mode):\n\n"), progname, progname);
15522

15523 15524
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
15525

15526 15527 15528 15529 15530 15531 15532 15533 15534
        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"));
15535 15536 15537
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
15538 15539
}

15540 15541 15542 15543 15544 15545 15546 15547 15548 15549
/*
 * 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 已提交
15550 15551
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
15552 15553 15554 15555 15556 15557 15558 15559 15560 15561 15562 15563 15564 15565 15566 15567 15568 15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586
#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 已提交
15587
    vshPrint(ctl, "%s", _(" Networking:"));
15588 15589 15590 15591 15592 15593 15594 15595 15596 15597 15598 15599 15600 15601 15602 15603 15604 15605 15606 15607 15608 15609 15610 15611 15612 15613
#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 已提交
15614
    vshPrint(ctl, "%s", _(" Storage:"));
15615 15616 15617 15618 15619 15620 15621 15622 15623 15624 15625 15626 15627 15628 15629 15630 15631 15632 15633 15634 15635 15636 15637
#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 已提交
15638
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
15639
#ifdef WITH_SECDRIVER_APPARMOR
15640 15641 15642 15643 15644 15645 15646 15647 15648 15649 15650 15651 15652 15653 15654 15655 15656 15657 15658 15659 15660 15661 15662
    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 已提交
15663 15664 15665 15666
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
15667
static bool
15668
vshParseArgv(vshControl *ctl, int argc, char **argv)
15669
{
15670 15671
    bool help = false;
    int arg;
K
Karel Zak 已提交
15672
    struct option opt[] = {
E
Eric Blake 已提交
15673 15674 15675 15676 15677 15678 15679 15680 15681
        {"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}
15682 15683
    };

15684 15685 15686
    /* 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. */
15687
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
15688
        switch (arg) {
15689
        case 'd':
D
Daniel Veillard 已提交
15690
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
15691
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
15692 15693
                exit(EXIT_FAILURE);
            }
15694 15695
            break;
        case 'h':
15696
            help = true;
15697 15698
            break;
        case 'q':
E
Eric Blake 已提交
15699
            ctl->quiet = true;
15700 15701
            break;
        case 't':
E
Eric Blake 已提交
15702
            ctl->timing = true;
15703 15704 15705 15706
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
15707 15708 15709 15710 15711 15712
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
15713 15714 15715
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
15716
        case 'r':
E
Eric Blake 已提交
15717
            ctl->readonly = true;
15718
            break;
15719 15720 15721
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
15722
        default:
15723 15724
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
15725 15726 15727 15728
        }
    }

    if (help) {
15729 15730
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
15731 15732
            exit(EXIT_FAILURE);
        }
15733 15734 15735

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
15736
        exit(EXIT_SUCCESS);
15737 15738
    }

15739
    if (argc > optind) {
K
Karel Zak 已提交
15740
        /* parse command */
E
Eric Blake 已提交
15741
        ctl->imode = false;
15742
        if (argc - optind == 1) {
15743
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
15744
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
15745
        } else {
15746
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
15747 15748
        }
    }
E
Eric Blake 已提交
15749
    return true;
K
Karel Zak 已提交
15750 15751
}

15752 15753 15754 15755
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
15756
    char *defaultConn;
E
Eric Blake 已提交
15757
    bool ret = true;
K
Karel Zak 已提交
15758

15759 15760 15761
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
15762
    ctl->debug = VSH_DEBUG_DEFAULT;
15763

15764 15765
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
15766
        /* failure to setup locale is not fatal */
15767
    }
15768
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
15769
        perror("bindtextdomain");
E
Eric Blake 已提交
15770
        return EXIT_FAILURE;
15771
    }
15772
    if (!textdomain(PACKAGE)) {
15773
        perror("textdomain");
E
Eric Blake 已提交
15774
        return EXIT_FAILURE;
15775 15776
    }

15777 15778 15779 15780 15781
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

15782
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
15783 15784 15785
        progname = argv[0];
    else
        progname++;
15786

15787
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
15788
        ctl->name = vshStrdup(ctl, defaultConn);
15789 15790
    }

D
Daniel P. Berrange 已提交
15791 15792
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
15793
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
15794
    }
15795

D
Daniel P. Berrange 已提交
15796 15797
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
15798
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
15799
    }
15800

K
Karel Zak 已提交
15801
    if (!ctl->imode) {
15802
        ret = vshCommandRun(ctl, ctl->cmd);
15803
    } else {
K
Karel Zak 已提交
15804 15805
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
15806
            vshPrint(ctl,
15807
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
15808
                     progname);
J
Jim Meyering 已提交
15809
            vshPrint(ctl, "%s",
15810
                     _("Type:  'help' for help with commands\n"
15811
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
15812
        }
15813 15814 15815 15816 15817 15818

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
15819
        do {
15820
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
15821
            ctl->cmdstr =
15822
                vshReadline(ctl, prompt);
15823 15824
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
15825
            if (*ctl->cmdstr) {
15826
#if USE_READLINE
K
Karel Zak 已提交
15827
                add_history(ctl->cmdstr);
15828
#endif
15829
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
15830 15831
                    vshCommandRun(ctl, ctl->cmd);
            }
15832
            VIR_FREE(ctl->cmdstr);
15833
        } while (ctl->imode);
K
Karel Zak 已提交
15834

15835 15836
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
15837
    }
15838

K
Karel Zak 已提交
15839 15840
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
15841
}