virsh.c 426.7 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 185
    vshCmdOptType type;         /* option type */
    int flag;                   /* flags */
E
Eric Blake 已提交
186
    const char *help;           /* non-NULL help string */
K
Karel Zak 已提交
187 188 189 190
} vshCmdOptDef;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

E
Eric Blake 已提交
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
static void *
_vshMalloc(vshControl *ctl, size_t size, const char *filename, int line)
{
    void *x;

    if ((x = malloc(size)))
        return x;
    vshError(ctl, _("%s: %d: failed to allocate %d bytes"),
             filename, line, (int) size);
    exit(EXIT_FAILURE);
}

static void *
_vshCalloc(vshControl *ctl, size_t nmemb, size_t size, const char *filename, int line)
{
    void *x;

    if ((x = calloc(nmemb, size)))
        return x;
    vshError(ctl, _("%s: %d: failed to allocate %d bytes"),
             filename, line, (int) (size*nmemb));
    exit(EXIT_FAILURE);
}

static void *
_vshRealloc(vshControl *ctl, void *ptr, size_t size, const char *filename, int line)
{
    void *x;

    if ((x = realloc(ptr, size)))
        return x;
    VIR_FREE(ptr);
    vshError(ctl, _("%s: %d: failed to allocate %d bytes"),
             filename, line, (int) size);
    exit(EXIT_FAILURE);
}

static char *
_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line)
{
    char *x;

    if (s == NULL)
        return(NULL);
    if ((x = strdup(s)))
        return x;
    vshError(ctl, _("%s: %d: failed to allocate %lu bytes"),
             filename, line, (unsigned long)strlen(s));
    exit(EXIT_FAILURE);
}

/* Poison the raw allocating identifiers in favor of our vsh variants.  */
#undef malloc
#undef calloc
#undef realloc
#undef strdup
#define malloc use_vshMalloc_instead_of_malloc
#define calloc use_vshCalloc_instead_of_calloc
#define realloc use_vshRealloc_instead_of_realloc
#define strdup use_vshStrdup_instead_of_strdup
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463

static int idsorter(const void *a, const void *b) {
  const int *ia = (const int *)a;
  const int *ib = (const int *)b;

  if (*ia > *ib)
    return 1;
  else if (*ia < *ib)
    return -1;
  return 0;
}
static int namesorter(const void *a, const void *b) {
  const char **sa = (const char**)a;
  const char **sb = (const char**)b;

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

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
static double
prettyCapacity(unsigned long long val,
               const char **unit) {
    if (val < 1024) {
        *unit = "";
        return (double)val;
    } else if (val < (1024.0l * 1024.0l)) {
        *unit = "KB";
        return (((double)val / 1024.0l));
    } else if (val < (1024.0l * 1024.0l * 1024.0l)) {
        *unit = "MB";
        return ((double)val / (1024.0l * 1024.0l));
    } else if (val < (1024.0l * 1024.0l * 1024.0l * 1024.0l)) {
        *unit = "GB";
        return ((double)val / (1024.0l * 1024.0l * 1024.0l));
    } else {
        *unit = "TB";
        return ((double)val / (1024.0l * 1024.0l * 1024.0l * 1024.0l));
    }
}


J
John Levon 已提交
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
static virErrorPtr last_error;

/*
 * Quieten libvirt until we're done with the command.
 */
static void
virshErrorHandler(void *unused ATTRIBUTE_UNUSED, virErrorPtr error)
{
    virFreeError(last_error);
    last_error = virSaveLastError();
    if (getenv("VIRSH_DEBUG") != NULL)
        virDefaultErrorFunc(error);
}

/*
 * Report an error when a command finishes.  This is better than before
 * (when correct operation would report errors), but it has some
 * problems: we lose the smarter formatting of virDefaultErrorFunc(),
 * and it can become harder to debug problems, if errors get reported
 * twice during one command.  This case shouldn't really happen anyway,
 * and it's IMHO a bug that libvirt does that sometimes.
 */
static void
virshReportError(vshControl *ctl)
{
515 516 517 518 519 520 521 522
    if (last_error == NULL) {
        /* Calling directly into libvirt util functions won't trigger the
         * error callback (which sets last_error), so check it ourselves.
         *
         * If the returned error has CODE_OK, this most likely means that
         * no error was ever raised, so just ignore */
        last_error = virSaveLastError();
        if (!last_error || last_error->code == VIR_ERR_OK)
523
            goto out;
524
    }
J
John Levon 已提交
525 526

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

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

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

538 539 540 541 542 543 544 545 546
static volatile sig_atomic_t intCaught = 0;

static void vshCatchInt(int sig ATTRIBUTE_UNUSED,
                        siginfo_t *siginfo ATTRIBUTE_UNUSED,
                        void *context ATTRIBUTE_UNUSED)
{
    intCaught = 1;
}

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

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

557 558 559 560 561 562
/*
 * vshCatchDisconnect:
 *
 * We get here when a SIGPIPE is being raised, we can't do much in the
 * handler, just save the fact it was raised
 */
563 564 565 566
static void vshCatchDisconnect(int sig, siginfo_t *siginfo,
                               void *context ATTRIBUTE_UNUSED) {
    if ((sig == SIGPIPE) ||
        (SA_SIGINFO && siginfo->si_signo == SIGPIPE))
567 568 569 570 571 572 573 574 575
        disconnected++;
}

/*
 * vshSetupSignals:
 *
 * Catch SIGPIPE signals which may arise when disconnection
 * from libvirtd occurs
 */
L
Laine Stump 已提交
576
static void
577 578 579 580 581 582 583 584 585 586 587 588 589
vshSetupSignals(void) {
    struct sigaction sig_action;

    sig_action.sa_sigaction = vshCatchDisconnect;
    sig_action.sa_flags = SA_SIGINFO;
    sigemptyset(&sig_action.sa_mask);

    sigaction(SIGPIPE, &sig_action, NULL);
}

/*
 * vshReconnect:
 *
L
Laine Stump 已提交
590
 * Reconnect after a disconnect from libvirtd
591 592
 *
 */
L
Laine Stump 已提交
593
static void
594 595 596 597 598 599
vshReconnect(vshControl *ctl)
{
    bool connected = false;

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

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

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

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

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

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

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

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

644 645 646 647 648 649 650 651 652 653 654 655 656
        vshPrint(ctl, "%s", _("Grouped commands:\n\n"));

        for (grp = cmdGroups; grp->name; grp++) {
            vshPrint(ctl, _(" %s (help keyword '%s'):\n"), grp->name,
                     grp->keyword);

            for (def = grp->commands; def->name; def++)
                vshPrint(ctl, "    %-30s %s\n", def->name,
                         _(vshCmddefGetInfo(def, "help")));

            vshPrint(ctl, "\n");
        }

E
Eric Blake 已提交
657
        return true;
658
    }
659

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

770 771
#ifndef WIN32

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

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

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

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

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

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

 cleanup:
810

811 812 813
    return ret;
}

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

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

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

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

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

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

839 840 841
#endif /* WIN32 */


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

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

K
Karel Zak 已提交
859

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cleanup:
    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

    virDomainFree(dom);
E
Eric Blake 已提交
1107
    return true;
1108 1109 1110 1111
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    virDomainFree(dom);
E
Eric Blake 已提交
1173
    return true;
1174 1175
}

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

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

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

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

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

    nr_stats = virDomainMemoryStats (dom, stats, VIR_DOMAIN_MEMORY_STAT_NR, 0);
    if (nr_stats == -1) {
        vshError(ctl, _("Failed to get memory statistics for domain %s"), name);
        virDomainFree(dom);
E
Eric Blake 已提交
1208
        return false;
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
    }

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

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

1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
/*
 * "domblkinfo" command
 */
static const vshCmdInfo info_domblkinfo[] = {
    {"help", N_("domain block device size information")},
    {"desc", N_("Get block device size info for a domain.")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
1247
static bool
1248 1249 1250 1251
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1252
    bool ret = true;
1253
    const char *device = NULL;
1254

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

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

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

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

    vshPrint(ctl, "%-15s %llu\n", _("Capacity:"), info.capacity);
    vshPrint(ctl, "%-15s %llu\n", _("Allocation:"), info.allocation);
    vshPrint(ctl, "%-15s %llu\n", _("Physical:"), info.physical);

    virDomainFree(dom);
    return ret;
}

1279 1280 1281
/*
 * "suspend" command
 */
1282
static const vshCmdInfo info_suspend[] = {
1283 1284
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1285
    {NULL, NULL}
1286 1287
};

1288
static const vshCmdOptDef opts_suspend[] = {
1289
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1290
    {NULL, 0, 0, NULL}
1291 1292
};

E
Eric Blake 已提交
1293
static bool
1294
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1295
{
1296
    virDomainPtr dom;
1297
    const char *name;
E
Eric Blake 已提交
1298
    bool ret = true;
1299

1300
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1301
        return false;
1302

J
Jim Meyering 已提交
1303
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1304
        return false;
1305 1306

    if (virDomainSuspend(dom) == 0) {
1307
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1308
    } else {
1309
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1310
        ret = false;
1311
    }
1312

1313 1314 1315 1316
    virDomainFree(dom);
    return ret;
}

1317 1318 1319
/*
 * "create" command
 */
1320
static const vshCmdInfo info_create[] = {
1321 1322
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1323 1324 1325
    {NULL, NULL}
};

1326
static const vshCmdOptDef opts_create[] = {
1327
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1328
#ifndef WIN32
1329
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1330
#endif
1331
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1332
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1333 1334 1335
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1336
static bool
1337
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1338 1339
{
    virDomainPtr dom;
1340
    const char *from = NULL;
E
Eric Blake 已提交
1341
    bool ret = true;
1342
    char *buffer;
1343
#ifndef WIN32
1344
    int console = vshCommandOptBool(cmd, "console");
1345
#endif
1346
    unsigned int flags = VIR_DOMAIN_NONE;
1347

1348
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1349
        return false;
1350

1351
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1352
        return false;
1353

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

1357 1358
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1359 1360
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1361 1362

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1363
    VIR_FREE(buffer);
1364

1365
    if (dom != NULL) {
1366
        vshPrint(ctl, _("Domain %s created from %s\n"),
1367
                 virDomainGetName(dom), from);
1368
#ifndef WIN32
1369
        if (console)
1370
            cmdRunConsole(ctl, dom, NULL);
1371
#endif
1372
        virDomainFree(dom);
1373
    } else {
1374
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1375
        ret = false;
1376 1377 1378 1379
    }
    return ret;
}

1380 1381 1382
/*
 * "define" command
 */
1383
static const vshCmdInfo info_define[] = {
1384 1385
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1386 1387 1388
    {NULL, NULL}
};

1389
static const vshCmdOptDef opts_define[] = {
1390
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1391 1392 1393
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1394
static bool
1395
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1396 1397
{
    virDomainPtr dom;
1398
    const char *from = NULL;
E
Eric Blake 已提交
1399
    bool ret = true;
1400
    char *buffer;
1401

1402
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1403
        return false;
1404

1405
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1406
        return false;
1407

1408
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1409
        return false;
1410 1411

    dom = virDomainDefineXML(ctl->conn, buffer);
1412
    VIR_FREE(buffer);
1413

1414
    if (dom != NULL) {
1415
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1416
                 virDomainGetName(dom), from);
1417
        virDomainFree(dom);
1418
    } else {
1419
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1420
        ret = false;
1421 1422 1423 1424 1425 1426 1427
    }
    return ret;
}

/*
 * "undefine" command
 */
1428
static const vshCmdInfo info_undefine[] = {
1429 1430
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1431 1432 1433
    {NULL, NULL}
};

1434
static const vshCmdOptDef opts_undefine[] = {
1435
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1436
    {"managed-save", VSH_OT_BOOL, 0, N_("remove domain managed state file")},
1437 1438 1439
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1440
static bool
1441
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1442 1443
{
    virDomainPtr dom;
E
Eric Blake 已提交
1444
    bool ret = true;
1445
    const char *name = NULL;
1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
    int flags = 0;
    int managed_save = vshCommandOptBool(cmd, "managed-save");
    int has_managed_save = 0;
    int rc = -1;

    if (managed_save)
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;

    if (!managed_save)
        flags = -1;
1456

1457
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1458
        return false;
1459

1460
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1461
        return false;
1462

1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
    has_managed_save = virDomainHasManagedSaveImage(dom, 0);
    if (has_managed_save < 0) {
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virshReportError(ctl);
            virDomainFree(dom);
            return false;
        } else {
            virFreeError(last_error);
            last_error = NULL;
        }
    }

    if (flags == -1) {
        if (has_managed_save == 1) {
            vshError(ctl,
                     _("Refusing to undefine while domain managed save "
                       "image exists"));
            virDomainFree(dom);
            return false;
        }

        rc = virDomainUndefine(dom);
    } else {
        rc = virDomainUndefineFlags(dom, flags);

        /* It might fail when virDomainUndefineFlags is not
         * supported on older libvirt, try to undefine the
         * domain with combo virDomainManagedSaveRemove and
         * virDomainUndefine.
         */
        if (rc < 0) {
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
                goto end;
            } else {
                virFreeError(last_error);
                last_error = NULL;
            }

            if ((has_managed_save == 1) &&
                virDomainManagedSaveRemove(dom, 0) < 0)
                goto end;

            rc = virDomainUndefine(dom);
        }
    }

end:
    if (rc == 0) {
1512
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1513
    } else {
1514
        vshError(ctl, _("Failed to undefine domain %s"), name);
E
Eric Blake 已提交
1515
        ret = false;
1516 1517
    }

1518
    virDomainFree(dom);
1519 1520 1521 1522 1523 1524 1525
    return ret;
}


/*
 * "start" command
 */
1526
static const vshCmdInfo info_start[] = {
1527
    {"help", N_("start a (previously defined) inactive domain")},
1528 1529 1530
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1531 1532 1533
    {NULL, NULL}
};

1534
static const vshCmdOptDef opts_start[] = {
1535
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1536
#ifndef WIN32
1537
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1538
#endif
E
Eric Blake 已提交
1539
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1540 1541
    {"autodestroy", VSH_OT_BOOL, 0,
     N_("automatically destroy the guest when virsh disconnects")},
1542 1543
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when loading")},
1544 1545
    {"force-boot", VSH_OT_BOOL, 0,
     N_("force fresh boot by discarding any managed save")},
1546 1547 1548
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1549
static bool
1550
cmdStart(vshControl *ctl, const vshCmd *cmd)
1551 1552
{
    virDomainPtr dom;
E
Eric Blake 已提交
1553
    bool ret = true;
1554
#ifndef WIN32
1555
    int console = vshCommandOptBool(cmd, "console");
1556
#endif
E
Eric Blake 已提交
1557
    unsigned int flags = VIR_DOMAIN_NONE;
1558

1559
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1560
        return false;
1561

1562 1563
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
1564
        return false;
1565 1566

    if (virDomainGetID(dom) != (unsigned int)-1) {
1567
        vshError(ctl, "%s", _("Domain is already active"));
1568
        virDomainFree(dom);
E
Eric Blake 已提交
1569
        return false;
1570 1571
    }

E
Eric Blake 已提交
1572 1573
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1574 1575
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1576 1577
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_START_BYPASS_CACHE;
1578 1579
    if (vshCommandOptBool(cmd, "force-boot"))
        flags |= VIR_DOMAIN_START_FORCE_BOOT;
E
Eric Blake 已提交
1580 1581 1582 1583

    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
         : virDomainCreate(dom)) == 0) {
1584
        vshPrint(ctl, _("Domain %s started\n"),
1585
                 virDomainGetName(dom));
1586
#ifndef WIN32
1587
        if (console)
1588
            cmdRunConsole(ctl, dom, NULL);
1589
#endif
1590
    } else {
1591
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
E
Eric Blake 已提交
1592
        ret = false;
1593
    }
1594
    virDomainFree(dom);
1595 1596 1597
    return ret;
}

1598 1599 1600
/*
 * "save" command
 */
1601
static const vshCmdInfo info_save[] = {
1602
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
1603
    {"desc", N_("Save the RAM state of a running domain.")},
1604
    {NULL, NULL}
1605 1606
};

1607
static const vshCmdOptDef opts_save[] = {
1608
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
1609 1610
    {"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")},
1611 1612
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
1613
    {NULL, 0, 0, NULL}
1614 1615
};

E
Eric Blake 已提交
1616
static bool
1617
cmdSave(vshControl *ctl, const vshCmd *cmd)
1618
{
1619
    virDomainPtr dom;
1620 1621
    const char *name = NULL;
    const char *to = NULL;
1622 1623
    bool ret = false;
    int flags = 0;
1624 1625
    const char *xmlfile = NULL;
    char *xml = NULL;
1626

1627
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1628
        return false;
1629

1630
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1631
        return false;
1632

1633 1634 1635
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;

1636 1637 1638 1639 1640
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

1644 1645 1646 1647 1648 1649
    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
        goto cleanup;

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
1650
         : virDomainSave(dom, to)) < 0) {
1651
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
1652
        goto cleanup;
1653
    }
1654

1655 1656 1657 1658
    vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
    ret = true;

cleanup:
1659
    VIR_FREE(xml);
1660 1661 1662 1663
    virDomainFree(dom);
    return ret;
}

1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 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 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835
/*
 * "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;
    int flags = 0;
    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")},
    {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;

    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")},
    {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;
    int flags = VIR_DOMAIN_XML_SECURE;

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

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

    /* Get the XML configuration of the saved image.  */
    doc = virDomainSaveImageGetXMLDesc(ctl->conn, file, 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, _("Saved image %s XML configuration not changed.\n"),
                 file);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
    if (virDomainSaveImageDefineXML(ctl->conn, file, doc_edited, 0) < 0) {
        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;
}

1836 1837 1838 1839 1840
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1841 1842 1843 1844
    {"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.")},
1845 1846 1847 1848
    {NULL, NULL}
};

static const vshCmdOptDef opts_managedsave[] = {
1849
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
1850 1851 1852 1853
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1854
static bool
1855 1856 1857
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1858
    const char *name;
1859 1860
    bool ret = false;
    int flags = 0;
1861

1862
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1863
        return false;
1864

1865 1866 1867
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;

1868
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1869
        return false;
1870

1871
    if (virDomainManagedSave(dom, flags) < 0) {
1872
        vshError(ctl, _("Failed to save domain %s state"), name);
1873
        goto cleanup;
1874 1875
    }

1876 1877 1878 1879
    vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    ret = true;

cleanup:
1880 1881 1882 1883
    virDomainFree(dom);
    return ret;
}

1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897
/*
 * "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 已提交
1898
static bool
1899 1900 1901
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1902
    const char *name;
E
Eric Blake 已提交
1903
    bool ret = false;
1904 1905
    int hassave;

1906
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1907
        return false;
1908 1909

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1910
        return false;
1911 1912 1913

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1914
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930
        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 已提交
1931
    ret = true;
1932 1933 1934 1935 1936 1937

cleanup:
    virDomainFree(dom);
    return ret;
}

1938 1939 1940
/*
 * "schedinfo" command
 */
1941
static const vshCmdInfo info_schedinfo[] = {
1942 1943
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1944 1945 1946
    {NULL, NULL}
};

1947
static const vshCmdOptDef opts_schedinfo[] = {
1948 1949 1950 1951
    {"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")},
1952 1953 1954
    {"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")},
1955 1956 1957
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
1958
static int
1959
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
1960
                   virTypedParameterPtr param)
1961
{
1962
    const char *data = NULL;
1963 1964 1965

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
1966
        param->type == VIR_TYPED_PARAM_UINT &&
1967 1968
        vshCommandOptBool(cmd, "weight")) {
        int val;
1969
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
1970
            vshError(ctl, "%s", _("Invalid value of weight"));
1971
            return -1;
1972
        } else {
1973
            param->value.ui = val;
1974
        }
1975
        return 1;
1976 1977
    }

1978 1979
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
1980
        param->type == VIR_TYPED_PARAM_UINT &&
1981 1982
        vshCommandOptBool(cmd, "cap")) {
        int val;
1983
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
1984
            vshError(ctl, "%s", _("Invalid value of cap"));
1985
            return -1;
1986
        } else {
1987
            param->value.ui = val;
1988
        }
1989
        return 1;
1990
    }
1991

1992
    if (vshCommandOptString(cmd, "set", &data) > 0) {
1993 1994 1995
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
1996
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
1997
            return -1;
1998
        }
1999 2000 2001 2002 2003 2004 2005 2006 2007
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
2008
        case VIR_TYPED_PARAM_INT:
2009
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
2010
                vshError(ctl, "%s",
2011 2012 2013 2014
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
2015
        case VIR_TYPED_PARAM_UINT:
2016
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
2017
                vshError(ctl, "%s",
2018 2019 2020 2021
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
2022
        case VIR_TYPED_PARAM_LLONG:
2023
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
2024
                vshError(ctl, "%s",
J
Jim Meyering 已提交
2025
                         _("Invalid value for parameter, expecting a long long"));
2026 2027 2028
                return -1;
            }
            break;
2029
        case VIR_TYPED_PARAM_ULLONG:
2030
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
2031
                vshError(ctl, "%s",
2032 2033 2034 2035
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
2036
        case VIR_TYPED_PARAM_DOUBLE:
2037
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
2038
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
2039 2040 2041
                return -1;
            }
            break;
2042
        case VIR_TYPED_PARAM_BOOLEAN:
2043
            param->value.b = STREQ(val, "0") ? 0 : 1;
2044
        }
2045
        return 1;
2046
    }
2047

2048 2049
    return 0;
}
2050

2051

E
Eric Blake 已提交
2052
static bool
2053 2054 2055 2056
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
2057
    virTypedParameterPtr params = NULL;
2058 2059 2060
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
2061
    bool ret_val = false;
2062 2063 2064 2065 2066 2067 2068 2069 2070 2071
    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;
        }
2072
        flags = VIR_DOMAIN_AFFECT_CURRENT;
2073 2074
    } else {
        if (config)
2075
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
2076
        if (live)
2077
            flags |= VIR_DOMAIN_AFFECT_LIVE;
2078
    }
2079

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

2083
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2084
        return false;
2085 2086 2087

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
2088
    if (schedulertype != NULL) {
2089
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
2090
             schedulertype);
2091
        VIR_FREE(schedulertype);
2092
    } else {
2093
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
2094
        goto cleanup;
2095 2096
    }

2097
    if (nparams) {
2098
        params = vshMalloc(ctl, sizeof(*params) * nparams);
2099

2100
        memset(params, 0, sizeof(*params) * nparams);
2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111
        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);
        }
2112 2113 2114 2115
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
2116
        for (i = 0; i < nparams; i++) {
2117 2118 2119 2120 2121 2122 2123 2124 2125 2126
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
2127 2128 2129 2130 2131
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
2132 2133 2134
            if (ret == -1)
                goto cleanup;

2135 2136 2137 2138 2139 2140 2141
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
2142 2143
            if (ret == -1)
                goto cleanup;
2144 2145 2146 2147
        } 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.  */
2148 2149
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
2150 2151 2152 2153
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
2154 2155 2156 2157 2158 2159
            /* 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;
            }
2160 2161
        }

E
Eric Blake 已提交
2162
        ret_val = true;
2163
        for (i = 0; i < nparams; i++) {
2164
            switch (params[i].type) {
2165
            case VIR_TYPED_PARAM_INT:
2166
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
2167
                 break;
2168
            case VIR_TYPED_PARAM_UINT:
2169
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
2170
                 break;
2171
            case VIR_TYPED_PARAM_LLONG:
2172
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
2173
                 break;
2174
            case VIR_TYPED_PARAM_ULLONG:
2175
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
2176
                 break;
2177
            case VIR_TYPED_PARAM_DOUBLE:
2178
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
2179
                 break;
2180
            case VIR_TYPED_PARAM_BOOLEAN:
2181
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
2182 2183
                 break;
            default:
2184
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
2185 2186 2187
            }
        }
    }
2188

2189
 cleanup:
2190
    VIR_FREE(params);
2191
    virDomainFree(dom);
2192
    return ret_val;
2193 2194
}

2195 2196 2197
/*
 * "restore" command
 */
2198
static const vshCmdInfo info_restore[] = {
2199 2200
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
2201
    {NULL, NULL}
2202 2203
};

2204
static const vshCmdOptDef opts_restore[] = {
2205
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
2206 2207
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when restoring")},
2208 2209
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2210
    {NULL, 0, 0, NULL}
2211 2212
};

E
Eric Blake 已提交
2213
static bool
2214
cmdRestore(vshControl *ctl, const vshCmd *cmd)
2215
{
2216
    const char *from = NULL;
2217 2218
    bool ret = false;
    int flags = 0;
2219 2220
    const char *xmlfile = NULL;
    char *xml = NULL;
2221

2222
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2223
        return false;
2224

2225
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2226
        return false;
2227

2228 2229 2230
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;

2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241
    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)
2242
         : virDomainRestore(ctl->conn, from)) < 0) {
2243
        vshError(ctl, _("Failed to restore domain from %s"), from);
2244
        goto cleanup;
2245
    }
2246 2247 2248 2249 2250

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

cleanup:
2251
    VIR_FREE(xml);
2252 2253 2254
    return ret;
}

D
Daniel Veillard 已提交
2255 2256 2257
/*
 * "dump" command
 */
2258
static const vshCmdInfo info_dump[] = {
2259 2260
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
2261 2262 2263
    {NULL, NULL}
};

2264
static const vshCmdOptDef opts_dump[] = {
2265 2266
    {"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")},
2267 2268
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when saving")},
2269 2270
    {"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 已提交
2271 2272 2273
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2274
static bool
2275
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
2276 2277
{
    virDomainPtr dom;
2278 2279
    const char *name = NULL;
    const char *to = NULL;
2280
    bool ret = false;
2281
    int flags = 0;
D
Daniel Veillard 已提交
2282

2283
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2284
        return false;
D
Daniel Veillard 已提交
2285

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

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

P
Paolo Bonzini 已提交
2292 2293
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
2294 2295
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;
2296 2297
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DUMP_BYPASS_CACHE;
2298

2299
    if (virDomainCoreDump(dom, to, flags) < 0) {
2300
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
2301
        goto cleanup;
D
Daniel Veillard 已提交
2302 2303
    }

2304 2305 2306 2307
    vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
    ret = true;

cleanup:
D
Daniel Veillard 已提交
2308 2309 2310 2311
    virDomainFree(dom);
    return ret;
}

2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458
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;
}

2459 2460 2461
/*
 * "resume" command
 */
2462
static const vshCmdInfo info_resume[] = {
2463 2464
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
2465
    {NULL, NULL}
2466 2467
};

2468
static const vshCmdOptDef opts_resume[] = {
2469
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2470
    {NULL, 0, 0, NULL}
2471 2472
};

E
Eric Blake 已提交
2473
static bool
2474
cmdResume(vshControl *ctl, const vshCmd *cmd)
2475
{
2476
    virDomainPtr dom;
E
Eric Blake 已提交
2477
    bool ret = true;
2478
    const char *name;
2479

2480
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2481
        return false;
2482

J
Jim Meyering 已提交
2483
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2484
        return false;
2485 2486

    if (virDomainResume(dom) == 0) {
2487
        vshPrint(ctl, _("Domain %s resumed\n"), name);
2488
    } else {
2489
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
2490
        ret = false;
2491
    }
2492

2493 2494 2495 2496
    virDomainFree(dom);
    return ret;
}

2497 2498 2499
/*
 * "shutdown" command
 */
2500
static const vshCmdInfo info_shutdown[] = {
2501 2502
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
2503
    {NULL, NULL}
2504 2505
};

2506
static const vshCmdOptDef opts_shutdown[] = {
2507
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2508
    {NULL, 0, 0, NULL}
2509 2510
};

E
Eric Blake 已提交
2511
static bool
2512
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
2513
{
2514
    virDomainPtr dom;
E
Eric Blake 已提交
2515
    bool ret = true;
2516
    const char *name;
2517

2518
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2519
        return false;
2520

J
Jim Meyering 已提交
2521
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2522
        return false;
2523 2524

    if (virDomainShutdown(dom) == 0) {
2525
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
2526
    } else {
2527
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
2528
        ret = false;
2529
    }
2530

2531 2532 2533 2534
    virDomainFree(dom);
    return ret;
}

2535 2536 2537
/*
 * "reboot" command
 */
2538
static const vshCmdInfo info_reboot[] = {
2539 2540
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
2541 2542 2543
    {NULL, NULL}
};

2544
static const vshCmdOptDef opts_reboot[] = {
2545
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2546 2547 2548
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2549
static bool
2550
cmdReboot(vshControl *ctl, const vshCmd *cmd)
2551 2552
{
    virDomainPtr dom;
E
Eric Blake 已提交
2553
    bool ret = true;
2554
    const char *name;
2555

2556
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2557
        return false;
2558

J
Jim Meyering 已提交
2559
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2560
        return false;
2561 2562

    if (virDomainReboot(dom, 0) == 0) {
2563
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
2564
    } else {
2565
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
2566
        ret = false;
2567 2568 2569 2570 2571 2572
    }

    virDomainFree(dom);
    return ret;
}

2573 2574 2575
/*
 * "destroy" command
 */
2576
static const vshCmdInfo info_destroy[] = {
2577 2578 2579
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
2580
    {NULL, NULL}
2581 2582
};

2583
static const vshCmdOptDef opts_destroy[] = {
2584
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2585
    {NULL, 0, 0, NULL}
2586 2587
};

E
Eric Blake 已提交
2588
static bool
2589
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2590
{
2591
    virDomainPtr dom;
E
Eric Blake 已提交
2592
    bool ret = true;
2593
    const char *name;
2594

2595
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2596
        return false;
2597

J
Jim Meyering 已提交
2598
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2599
        return false;
2600 2601

    if (virDomainDestroy(dom) == 0) {
2602
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2603
    } else {
2604
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
2605
        ret = false;
2606
    }
2607

2608
    virDomainFree(dom);
K
Karel Zak 已提交
2609 2610 2611 2612
    return ret;
}

/*
2613
 * "dominfo" command
K
Karel Zak 已提交
2614
 */
2615
static const vshCmdInfo info_dominfo[] = {
2616 2617
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2618
    {NULL, NULL}
K
Karel Zak 已提交
2619 2620
};

2621
static const vshCmdOptDef opts_dominfo[] = {
2622
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2623
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2624 2625
};

E
Eric Blake 已提交
2626
static bool
2627
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2628
{
K
Karel Zak 已提交
2629 2630
    virDomainInfo info;
    virDomainPtr dom;
2631
    virSecurityModel secmodel;
2632
    virSecurityLabelPtr seclabel;
2633
    int persistent = 0;
E
Eric Blake 已提交
2634 2635
    bool ret = true;
    int autostart;
2636
    unsigned int id;
2637
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2638
    int has_managed_save = 0;
2639

2640
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2641
        return false;
K
Karel Zak 已提交
2642

J
Jim Meyering 已提交
2643
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2644
        return false;
2645

2646 2647
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2648
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2649
    else
2650
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2651 2652
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2653
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2654
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2655 2656

    if ((str = virDomainGetOSType(dom))) {
2657
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2658
        VIR_FREE(str);
2659 2660 2661
    }

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

2665
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2666 2667

        if (info.cpuTime != 0) {
2668
            double cpuUsed = info.cpuTime;
2669

2670
            cpuUsed /= 1000000000.0;
2671

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

2675 2676
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2677
                 info.maxMem);
2678
        else
2679
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2680 2681
                 _("no limit"));

2682
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2683 2684
                 info.memory);

K
Karel Zak 已提交
2685
    } else {
E
Eric Blake 已提交
2686
        ret = false;
K
Karel Zak 已提交
2687
    }
2688

2689 2690
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
2691 2692
    vshDebug(ctl, VSH_ERR_DEBUG, "Domain persistent flag value: %d\n",
             persistent);
2693 2694 2695 2696 2697 2698
    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 */
2699
    if (!virDomainGetAutostart(dom, &autostart)) {
2700
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2701 2702 2703
                 autostart ? _("enable") : _("disable") );
    }

2704 2705 2706 2707 2708 2709 2710
    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"));

2711 2712 2713
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2714 2715
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
2716
            return false;
2717 2718 2719
        } else {
            virFreeError(last_error);
            last_error = NULL;
2720
        }
2721 2722 2723 2724 2725 2726 2727
    } 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 */
2728
            if (VIR_ALLOC(seclabel) < 0) {
2729
                virDomainFree(dom);
E
Eric Blake 已提交
2730
                return false;
2731 2732 2733 2734 2735
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
2736
                return false;
2737
            } else {
2738
                if (seclabel->label[0] != '\0')
2739
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
2740
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
2741
            }
2742 2743

            VIR_FREE(seclabel);
2744 2745
        }
    }
2746
    virDomainFree(dom);
K
Karel Zak 已提交
2747 2748 2749
    return ret;
}

2750 2751 2752 2753
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2754 2755
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2756 2757 2758 2759
    {NULL, NULL}
};

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


E
Eric Blake 已提交
2765
static bool
2766 2767 2768 2769
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
2770
    bool ret = true;
2771

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2776
        return false;
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802

    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 已提交
2803
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2804
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2805
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2806
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2807
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2808 2809 2810
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2811
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2812
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2813
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2814
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2815
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2816 2817 2818
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2819
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2820
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2821
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2822
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2823
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2824 2825
        }
    } else {
E
Eric Blake 已提交
2826
        ret = false;
2827 2828 2829 2830 2831 2832
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2833 2834 2835 2836
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2837 2838
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2839 2840 2841 2842
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2843
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2844 2845 2846
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2847
static bool
2848 2849 2850
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2851
    bool ret = true;
2852

2853
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2854
        return false;
2855 2856

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
2860
        ret = false;
2861 2862 2863 2864 2865

    virDomainFree(dom);
    return ret;
}

2866 2867 2868
/*
 * "freecell" command
 */
2869
static const vshCmdInfo info_freecell[] = {
2870 2871
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2872 2873 2874
    {NULL, NULL}
};

2875
static const vshCmdOptDef opts_freecell[] = {
2876
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2877
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
2878 2879 2880
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2881
static bool
2882
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2883
{
W
Wen Congyang 已提交
2884
    bool func_ret = false;
2885
    int ret;
2886
    int cell = -1, cell_given;
2887
    unsigned long long memory;
2888 2889 2890 2891
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
2892
    int all_given;
2893 2894 2895 2896
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
2897

2898

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

2902 2903 2904 2905
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
2906 2907 2908 2909 2910 2911 2912 2913 2914
    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) {
2915 2916 2917
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2918 2919 2920
            goto cleanup;
        }

2921
        xml = virXMLParseStringCtxt(cap_xml, "node.xml", &ctxt);
2922 2923
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2924 2925
            goto cleanup;
        }
2926 2927 2928 2929
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
2930
            vshError(ctl, "%s", _("could not get information about "
2931
                                  "NUMA topology"));
2932 2933 2934
            goto cleanup;
        }

2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955
        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;
            }
        }

2956
        memory = 0;
2957 2958 2959 2960
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
2961 2962 2963 2964
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
2965
    } else {
2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979
        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));
2980 2981
    }

E
Eric Blake 已提交
2982
    func_ret = true;
2983

2984
cleanup:
2985
    xmlXPathFreeContext(ctxt);
2986
    xmlFreeDoc(xml);
2987
    VIR_FREE(nodes);
2988 2989 2990
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
2991
    return func_ret;
2992 2993
}

E
Eric Blake 已提交
2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007
/*
 * "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 已提交
3008
static bool
E
Eric Blake 已提交
3009 3010
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
3011
    const char *type = NULL;
E
Eric Blake 已提交
3012 3013
    int vcpus;

3014 3015
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
3016
        return false;
3017
    }
E
Eric Blake 已提交
3018 3019

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3020
        return false;
E
Eric Blake 已提交
3021 3022 3023

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

E
Eric Blake 已提交
3027
    return true;
E
Eric Blake 已提交
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041
}

/*
 * "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")},
3042
    {"active", VSH_OT_BOOL, 0, N_("get number of currently active vcpus")},
E
Eric Blake 已提交
3043
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
3044 3045 3046
    {"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 已提交
3047 3048 3049
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3050
static bool
E
Eric Blake 已提交
3051 3052 3053
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3054
    bool ret = true;
E
Eric Blake 已提交
3055
    int maximum = vshCommandOptBool(cmd, "maximum");
3056
    int active = vshCommandOptBool(cmd, "active");
E
Eric Blake 已提交
3057 3058
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3059 3060
    int current = vshCommandOptBool(cmd, "current");
    bool all = maximum + active + current + config + live == 0;
E
Eric Blake 已提交
3061 3062
    int count;

3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077
    /* 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 已提交
3078
        return false;
E
Eric Blake 已提交
3079
    }
3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092

    /* 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 已提交
3093
        vshError(ctl, "%s",
3094
                 _("--maximum and --active cannot both be specified"));
E
Eric Blake 已提交
3095
        return false;
E
Eric Blake 已提交
3096
    }
3097 3098 3099
    if (current + config + live > 1) {
        vshError(ctl, "%s",
                 _("--config, --live, and --current are mutually exclusive"));
E
Eric Blake 已提交
3100
        return false;
E
Eric Blake 已提交
3101 3102 3103
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3104
        return false;
E
Eric Blake 已提交
3105 3106

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

    /* In all cases, try the new API first; if it fails because we are
3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123
     * 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 已提交
3124 3125
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
3126
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
3127 3128 3129 3130 3131 3132 3133 3134 3135
        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;
            }
3136 3137
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
3138 3139 3140 3141 3142
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
3143
            ret = false;
E
Eric Blake 已提交
3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155
        } 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 |
3156
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
3157 3158 3159 3160 3161 3162 3163
        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 已提交
3164
            ret = false;
E
Eric Blake 已提交
3165 3166 3167 3168 3169 3170 3171 3172 3173 3174
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3175
    if (all || (active && config)) {
3176
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200
        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 已提交
3201
            ret = false;
E
Eric Blake 已提交
3202 3203 3204 3205 3206 3207 3208 3209 3210 3211
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3212
    if (all || (active && live)) {
3213
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
3214 3215 3216 3217 3218 3219 3220 3221 3222
        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 已提交
3223
            ret = false;
E
Eric Blake 已提交
3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237
        } 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;
}

3238 3239 3240
/*
 * "vcpuinfo" command
 */
3241
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
3242
    {"help", N_("detailed domain vcpu information")},
3243
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
3244 3245 3246
    {NULL, NULL}
};

3247
static const vshCmdOptDef opts_vcpuinfo[] = {
3248
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3249 3250 3251
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3252
static bool
3253
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
3254 3255 3256 3257 3258
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
3259 3260
    unsigned char *cpumaps;
    int ncpus, maxcpu;
3261
    size_t cpumaplen;
E
Eric Blake 已提交
3262
    bool ret = true;
3263
    int n, m;
3264

3265
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3266
        return false;
3267

J
Jim Meyering 已提交
3268
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3269
        return false;
3270 3271 3272

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3273
        return false;
3274 3275 3276 3277
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3278
        return false;
3279 3280
    }

3281
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
3282 3283 3284
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
3285

3286 3287
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
3288
                                   cpumaps, cpumaplen)) >= 0) {
3289 3290 3291 3292
        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 已提交
3293
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
3294 3295 3296 3297 3298 3299 3300 3301
            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:"));
3302 3303
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
3304 3305 3306 3307 3308 3309
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
3310
    } else {
3311
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
3312
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3313 3314 3315
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
3316
            /* fallback plan to use virDomainGetVcpuPinInfo */
3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334

            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;
3335
        }
3336 3337
    }

3338
    VIR_FREE(cpumaps);
3339
    VIR_FREE(cpuinfo);
3340 3341 3342 3343 3344 3345 3346
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
3347
static const vshCmdInfo info_vcpupin[] = {
3348
    {"help", N_("control or query domain vcpu affinity")},
3349
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
3350 3351 3352
    {NULL, NULL}
};

3353
static const vshCmdOptDef opts_vcpupin[] = {
3354
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3355 3356 3357
    {"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")},
3358 3359 3360
    {"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")},
3361 3362 3363
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3364
static bool
E
Eric Blake 已提交
3365
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
3366 3367 3368 3369
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
3370
    int vcpu = -1;
3371
    const char *cpulist = NULL;
E
Eric Blake 已提交
3372
    bool ret = true;
3373 3374
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
3375
    size_t cpumaplen;
3376 3377
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
3378
    bool unuse = false;
3379
    const char *cur;
3380 3381 3382
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
3383
    bool query = false; /* Query mode if no cpulist */
3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400
    int flags = 0;

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

3402
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3403
        return false;
3404

J
Jim Meyering 已提交
3405
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3406
        return false;
3407

3408 3409
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
3410
        virDomainFree(dom);
E
Eric Blake 已提交
3411
        return false;
3412
    }
3413
    query = !cpulist;
3414

3415 3416 3417 3418
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
3419
        virDomainFree(dom);
E
Eric Blake 已提交
3420
        return false;
3421
    }
3422

3423 3424
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3425
        return false;
3426 3427 3428
    }

    if (virDomainGetInfo(dom, &info) != 0) {
3429
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
3430
        virDomainFree(dom);
E
Eric Blake 已提交
3431
        return false;
3432 3433 3434
    }

    if (vcpu >= info.nrVirtCpu) {
3435
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
3436
        virDomainFree(dom);
E
Eric Blake 已提交
3437
        return false;
3438 3439
    }

3440 3441
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
3442

3443 3444 3445 3446 3447 3448 3449 3450
    /* 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 已提交
3451
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496
                                             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);
3497 3498
    /* Parse cpulist */
    cur = cpulist;
3499
    if (*cur == 0) {
3500
        goto parse_error;
3501 3502 3503
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
3504
        cur = "";
3505
    }
3506 3507 3508 3509 3510 3511 3512

    while (*cur != 0) {

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

3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526
        /* 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);
3527

3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554
        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);
        }
3555

3556 3557 3558 3559 3560 3561
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
3562
        } else {
3563
            goto parse_error;
3564
        }
3565
    }
3566

3567 3568 3569 3570 3571 3572 3573 3574
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
3575 3576
    }

3577
cleanup:
3578
    VIR_FREE(cpumap);
3579 3580
    virDomainFree(dom);
    return ret;
3581 3582 3583 3584 3585

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

3588 3589 3590
/*
 * "setvcpus" command
 */
3591
static const vshCmdInfo info_setvcpus[] = {
3592 3593
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
3594 3595 3596
    {NULL, NULL}
};

3597
static const vshCmdOptDef opts_setvcpus[] = {
3598
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3599
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
3600 3601 3602
    {"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")},
3603
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3604 3605 3606
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3607
static bool
3608
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
3609 3610
{
    virDomainPtr dom;
3611
    int count = 0;
E
Eric Blake 已提交
3612
    bool ret = true;
E
Eric Blake 已提交
3613 3614 3615
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633
    int current = vshCommandOptBool(cmd, "current");
    int flags = 0;

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

3635
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3636
        return false;
3637

J
Jim Meyering 已提交
3638
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3639
        return false;
3640

3641 3642 3643 3644
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
3645

3646
    if (flags == -1) {
E
Eric Blake 已提交
3647
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
3648
            ret = false;
E
Eric Blake 已提交
3649 3650
        }
    } else {
3651 3652 3653
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
3654
            vshDebug(ctl, VSH_ERR_DEBUG, "--maximum flag was given\n");
3655

3656 3657
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

3658 3659 3660 3661 3662 3663 3664 3665
            /* 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 已提交
3666
                ret = false;
3667 3668 3669 3670 3671
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
3672
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
3673
            ret = false;
E
Eric Blake 已提交
3674
        }
3675 3676
    }

3677
  cleanup:
3678 3679 3680 3681
    virDomainFree(dom);
    return ret;
}

3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715
/*
 * "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;
}

3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 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 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807
/*
 * "send-key" command
 */
static const vshCmdInfo info_send_key[] = {
    {"help", N_("Send keycodes to the guest")},
    {"desc", N_("Send keycodes to the guest, the keycodes must be integers\n"
                "    Examples:\n\n"
                "        virsh # send-key <domain> 37 18 21\n"
                "        virsh # send-key <domain> KEY_RIGHTCTRL KEY_C\n"
                "        virsh # send-key <domain> --codeset xt 37 18 21\n"
                "        virsh # send-key <domain> --holdtime 1000 0x15 18 0xf\n"
                )},
    {NULL, NULL}
};

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT, N_("the codeset of keycodes, default:linux")},
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
                 N_("the time (in millsecond) how long the keys will be held")},
    {"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;
}

3808 3809 3810
/*
 * "setmemory" command
 */
3811
static const vshCmdInfo info_setmem[] = {
3812 3813
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
3814 3815 3816
    {NULL, NULL}
};

3817
static const vshCmdOptDef opts_setmem[] = {
3818
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3819
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
3820 3821
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
3822
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3823 3824 3825
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3826
static bool
3827
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
3828 3829
{
    virDomainPtr dom;
3830
    virDomainInfo info;
3831
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
3832
    bool ret = true;
3833 3834
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3835
    int current = vshCommandOptBool(cmd, "current");
3836 3837
    int flags = 0;

3838 3839 3840
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3841
            return false;
3842
        }
3843
        flags = VIR_DOMAIN_AFFECT_CURRENT;
3844 3845
    } else {
        if (config)
3846
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3847
        if (live)
3848
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3849 3850 3851
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
3852
    }
3853

3854
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3855
        return false;
3856

J
Jim Meyering 已提交
3857
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3858
        return false;
3859

3860 3861
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3862
        return false;
3863 3864
    }

3865
    if (kilobytes <= 0) {
3866
        virDomainFree(dom);
3867
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
3868
        return false;
3869 3870
    }

3871 3872
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
3873
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
3874
        return false;
3875 3876 3877 3878
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
3879
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
3880
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
3881
        return false;
3882 3883
    }

3884
    if (flags == -1) {
3885
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
3886
            ret = false;
3887 3888 3889
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
3890
            ret = false;
3891
        }
3892 3893 3894 3895 3896 3897 3898 3899 3900
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
3901
static const vshCmdInfo info_setmaxmem[] = {
3902 3903
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
3904 3905 3906
    {NULL, NULL}
};

3907
static const vshCmdOptDef opts_setmaxmem[] = {
3908
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3909
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
3910 3911 3912
    {"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")},
3913 3914 3915
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3916
static bool
3917
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
3918 3919
{
    virDomainPtr dom;
3920
    int kilobytes = 0;
E
Eric Blake 已提交
3921
    bool ret = true;
3922 3923 3924 3925 3926 3927 3928 3929
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
    int flags = VIR_DOMAIN_MEM_MAXIMUM;

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3930
            return false;
3931 3932 3933
        }
    } else {
        if (config)
3934
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3935
        if (live)
3936
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3937 3938 3939 3940
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
3941

3942
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3943
        return false;
3944

J
Jim Meyering 已提交
3945
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3946
        return false;
3947

3948 3949
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3950
        return false;
3951 3952
    }

3953
    if (kilobytes <= 0) {
3954
        virDomainFree(dom);
3955
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
3956
        return false;
3957 3958
    }

3959 3960 3961
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3962
            ret = false;
3963 3964 3965 3966
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3967
            ret = false;
3968
        }
3969 3970
    }

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

3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990
/*
 * "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 已提交
3991 3992 3993
    {"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")},
3994 3995 3996
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3997
static bool
3998 3999 4000 4001 4002
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
4003
    int rv = 0;
4004
    unsigned int i = 0;
4005
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4006
    bool ret = false;
H
Hu Tao 已提交
4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023
    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;
    }
4024 4025

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4026
        return false;
4027 4028

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

4031
    if ((rv = vshCommandOptInt(cmd, "weight", &weight)) < 0) {
4032 4033 4034 4035 4036
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

4037
    if (rv > 0) {
4038
        nparams++;
4039
        if (weight <= 0) {
4040 4041 4042 4043 4044 4045 4046
            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 已提交
4047
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
4048 4049 4050 4051 4052 4053 4054
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4055
            ret = true;
4056 4057 4058 4059 4060
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
4061
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
4062 4063 4064 4065 4066 4067
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4068
                case VIR_TYPED_PARAM_INT:
4069 4070 4071
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4072
                case VIR_TYPED_PARAM_UINT:
4073 4074 4075
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4076
                case VIR_TYPED_PARAM_LLONG:
4077 4078 4079
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4080
                case VIR_TYPED_PARAM_ULLONG:
4081 4082 4083
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
4084
                case VIR_TYPED_PARAM_DOUBLE:
4085 4086 4087
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4088
                case VIR_TYPED_PARAM_BOOLEAN:
4089 4090 4091 4092 4093 4094 4095 4096
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
4097
        ret = true;
4098 4099 4100 4101 4102 4103
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4104
            temp->type = VIR_TYPED_PARAM_UINT;
4105 4106 4107 4108 4109 4110 4111 4112

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
H
Hu Tao 已提交
4113
        if (virDomainSetBlkioParameters(dom, params, nparams, flags) != 0)
4114 4115
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
4116
            ret = true;
4117 4118 4119 4120 4121 4122 4123 4124
    }

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

4125 4126 4127 4128
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
4129 4130 4131
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
4132 4133 4134 4135 4136 4137 4138
                "    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")},
4139
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4140
     N_("Max memory in kilobytes")},
4141
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4142
     N_("Memory during contention in kilobytes")},
4143
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4144
     N_("Max memory plus swap in kilobytes")},
4145
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
4146
     N_("Min guaranteed memory in kilobytes")},
4147 4148 4149
    {"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")},
4150 4151 4152
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4153
static bool
4154 4155 4156
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
4157 4158
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
4159 4160
    int nparams = 0;
    unsigned int i = 0;
4161
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4162
    bool ret = false;
4163 4164 4165 4166 4167 4168 4169 4170 4171 4172
    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;
        }
4173
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4174 4175
    } else {
        if (config)
4176
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4177
        if (live)
4178
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4179
    }
4180 4181

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4182
        return false;
4183 4184

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

4187 4188 4189 4190 4191 4192 4193 4194 4195
    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;
    }

4196 4197 4198 4199 4200 4201 4202 4203 4204
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

4205 4206 4207
    if (min_guarantee)
        nparams++;

4208 4209
    if (nparams == 0) {
        /* get the number of memory parameters */
4210
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
4211 4212 4213 4214 4215
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

4216 4217
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4218
            ret = true;
4219 4220 4221
            goto cleanup;
        }

4222
        /* now go get all the memory parameters */
E
Eric Blake 已提交
4223
        params = vshCalloc(ctl, nparams, sizeof(*params));
4224
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
4225 4226 4227 4228 4229 4230
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4231
                case VIR_TYPED_PARAM_INT:
4232 4233 4234
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4235
                case VIR_TYPED_PARAM_UINT:
4236 4237 4238
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4239
                case VIR_TYPED_PARAM_LLONG:
4240 4241 4242
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4243
                case VIR_TYPED_PARAM_ULLONG:
4244 4245 4246 4247 4248
                    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);
4249
                    break;
4250
                case VIR_TYPED_PARAM_DOUBLE:
4251 4252 4253
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4254
                case VIR_TYPED_PARAM_BOOLEAN:
4255 4256 4257 4258
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
4259
                    vshPrint(ctl, "unimplemented memory parameter type\n");
4260 4261 4262
            }
        }

E
Eric Blake 已提交
4263
        ret = true;
4264 4265
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
4266
        params = vshCalloc(ctl, nparams, sizeof(*params));
4267 4268 4269

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4270
            temp->type = VIR_TYPED_PARAM_ULLONG;
4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289

            /*
             * 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;
4290
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
4291 4292
                        sizeof(temp->field));
                swap_hard_limit = 0;
4293 4294 4295 4296 4297
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
4298
            }
4299 4300 4301 4302

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
4303
        }
4304
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
4305
            vshError(ctl, "%s", _("Unable to change memory parameters"));
4306
        else
E
Eric Blake 已提交
4307
            ret = true;
4308 4309 4310
    }

  cleanup:
E
Eric Blake 已提交
4311
    VIR_FREE(params);
4312 4313 4314 4315
    virDomainFree(dom);
    return ret;
}

4316 4317 4318
/*
 * "nodeinfo" command
 */
4319
static const vshCmdInfo info_nodeinfo[] = {
4320 4321
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
4322 4323 4324
    {NULL, NULL}
};

E
Eric Blake 已提交
4325
static bool
4326
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4327 4328
{
    virNodeInfo info;
4329

4330
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4331
        return false;
4332 4333

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
4334
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
4335
        return false;
4336 4337 4338 4339 4340 4341 4342 4343 4344 4345
    }
    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 已提交
4346
    return true;
4347 4348
}

4349 4350 4351 4352 4353
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
4354
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
4355 4356 4357 4358 4359 4360 4361 4362 4363 4364
    {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
4365
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
4366 4367 4368 4369
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
4370 4371
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414
    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;

4415
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
4416
                cpu_stats[i].sys = value;
4417
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
4418
                cpu_stats[i].user = value;
4419
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
4420
                cpu_stats[i].idle = value;
4421
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
4422
                cpu_stats[i].iowait = value;
4423
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437
                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) {
4438
            vshPrint(ctl, "%-15s %20llu\n", _("user:"), cpu_stats[0].user);
4439
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
4440
            vshPrint(ctl, "%-15s %20llu\n", _("idle:"), cpu_stats[0].idle);
4441 4442 4443 4444 4445 4446 4447
            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);
4448
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle:"), 100 - usage);
4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460
        } 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",
4461
                     _("user:"), user_time / total_time * 100);
4462
            vshPrint(ctl, "%-15s %5.1lf%%\n",
4463
                     _("system:"), sys_time  / total_time * 100);
4464
            vshPrint(ctl, "%-15s %5.1lf%%\n",
4465
                     _("idle:"), idle_time     / total_time * 100);
4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496
/*
 * "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;
4497 4498
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538
    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;
}

4539 4540 4541
/*
 * "capabilities" command
 */
4542
static const vshCmdInfo info_capabilities[] = {
4543 4544
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
4545 4546 4547
    {NULL, NULL}
};

E
Eric Blake 已提交
4548
static bool
4549
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4550 4551 4552
{
    char *caps;

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

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
4557
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
4558
        return false;
4559 4560
    }
    vshPrint (ctl, "%s\n", caps);
4561
    VIR_FREE(caps);
4562

E
Eric Blake 已提交
4563
    return true;
4564 4565
}

4566 4567 4568
/*
 * "dumpxml" command
 */
4569
static const vshCmdInfo info_dumpxml[] = {
4570 4571
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
4572
    {NULL, NULL}
4573 4574
};

4575
static const vshCmdOptDef opts_dumpxml[] = {
4576 4577 4578
    {"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")},
4579
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
4580
    {NULL, 0, 0, NULL}
4581 4582
};

E
Eric Blake 已提交
4583
static bool
4584
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
4585
{
4586
    virDomainPtr dom;
E
Eric Blake 已提交
4587
    bool ret = true;
4588
    char *dump;
4589 4590 4591
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
4592
    int update = vshCommandOptBool(cmd, "update-cpu");
4593 4594 4595 4596 4597

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
4598 4599
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
4600

4601
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4602
        return false;
4603

J
Jim Meyering 已提交
4604
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4605
        return false;
4606

4607
    dump = virDomainGetXMLDesc(dom, flags);
4608
    if (dump != NULL) {
4609
        vshPrint(ctl, "%s", dump);
4610
        VIR_FREE(dump);
4611
    } else {
E
Eric Blake 已提交
4612
        ret = false;
4613
    }
4614

4615 4616 4617 4618
    virDomainFree(dom);
    return ret;
}

4619 4620 4621 4622
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
4623 4624
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
4625 4626 4627 4628
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
4629 4630
    {"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")},
4631 4632 4633
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4634
static bool
4635 4636
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4637
    bool ret = true;
4638 4639
    const char *format = NULL;
    const char *configFile = NULL;
4640 4641 4642 4643
    char *configData;
    char *xmlData;
    int flags = 0;

4644
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4645
        return false;
4646

4647 4648
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
4649
        return false;
4650

4651
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
4652
        return false;
4653 4654 4655

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
4656
        vshPrint(ctl, "%s", xmlData);
4657
        VIR_FREE(xmlData);
4658
    } else {
E
Eric Blake 已提交
4659
        ret = false;
4660 4661 4662 4663 4664 4665 4666 4667 4668
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
4669 4670
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
4671 4672 4673 4674
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
4675 4676
    {"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")},
4677 4678 4679
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4680
static bool
4681 4682
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4683
    bool ret = true;
4684 4685
    const char *format = NULL;
    const char *xmlFile = NULL;
4686 4687 4688 4689
    char *configData;
    char *xmlData;
    int flags = 0;

4690
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4691
        return false;
4692

4693 4694
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
4695
        return false;
4696

4697
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
4698
        return false;
4699 4700 4701

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
4702
        vshPrint(ctl, "%s", configData);
4703
        VIR_FREE(configData);
4704
    } else {
E
Eric Blake 已提交
4705
        ret = false;
4706 4707 4708 4709 4710
    }

    return ret;
}

K
Karel Zak 已提交
4711
/*
K
Karel Zak 已提交
4712
 * "domname" command
K
Karel Zak 已提交
4713
 */
4714
static const vshCmdInfo info_domname[] = {
4715
    {"help", N_("convert a domain id or UUID to domain name")},
4716
    {"desc", ""},
4717
    {NULL, NULL}
K
Karel Zak 已提交
4718 4719
};

4720
static const vshCmdOptDef opts_domname[] = {
4721
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
4722
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4723 4724
};

E
Eric Blake 已提交
4725
static bool
4726
cmdDomname(vshControl *ctl, const vshCmd *cmd)
4727
{
K
Karel Zak 已提交
4728 4729
    virDomainPtr dom;

4730
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4731
        return false;
J
Jim Meyering 已提交
4732
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4733
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
4734
        return false;
4735

K
Karel Zak 已提交
4736 4737
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
4738
    return true;
K
Karel Zak 已提交
4739 4740 4741
}

/*
K
Karel Zak 已提交
4742
 * "domid" command
K
Karel Zak 已提交
4743
 */
4744
static const vshCmdInfo info_domid[] = {
4745
    {"help", N_("convert a domain name or UUID to domain id")},
4746
    {"desc", ""},
4747
    {NULL, NULL}
K
Karel Zak 已提交
4748 4749
};

4750
static const vshCmdOptDef opts_domid[] = {
4751
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
4752
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4753 4754
};

E
Eric Blake 已提交
4755
static bool
4756
cmdDomid(vshControl *ctl, const vshCmd *cmd)
4757
{
4758
    virDomainPtr dom;
4759
    unsigned int id;
K
Karel Zak 已提交
4760

4761
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4762
        return false;
J
Jim Meyering 已提交
4763
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4764
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
4765
        return false;
4766

4767 4768
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
4769
        vshPrint(ctl, "%s\n", "-");
4770
    else
4771
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
4772
    virDomainFree(dom);
E
Eric Blake 已提交
4773
    return true;
K
Karel Zak 已提交
4774
}
4775

K
Karel Zak 已提交
4776 4777 4778
/*
 * "domuuid" command
 */
4779
static const vshCmdInfo info_domuuid[] = {
4780
    {"help", N_("convert a domain name or id to domain UUID")},
4781
    {"desc", ""},
K
Karel Zak 已提交
4782 4783 4784
    {NULL, NULL}
};

4785
static const vshCmdOptDef opts_domuuid[] = {
4786
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
4787 4788 4789
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4790
static bool
4791
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
4792 4793
{
    virDomainPtr dom;
4794
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
4795

4796
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4797
        return false;
J
Jim Meyering 已提交
4798
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4799
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
4800
        return false;
4801

K
Karel Zak 已提交
4802 4803 4804
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
4805
        vshError(ctl, "%s", _("failed to get domain UUID"));
4806

4807
    virDomainFree(dom);
E
Eric Blake 已提交
4808
    return true;
K
Karel Zak 已提交
4809 4810
}

4811 4812 4813
/*
 * "migrate" command
 */
4814
static const vshCmdInfo info_migrate[] = {
4815 4816
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
4817 4818 4819
    {NULL, NULL}
};

4820
static const vshCmdOptDef opts_migrate[] = {
4821 4822 4823 4824 4825 4826 4827
    {"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")},
4828 4829
    {"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)")},
4830 4831
    {"change-protection", VSH_OT_BOOL, 0,
     N_("prevent any configuration changes to domain until migration ends)")},
W
Wen Congyang 已提交
4832
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
4833
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4834
    {"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)")},
4835 4836
    {"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 已提交
4837
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
4838
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
4839 4840 4841
    {NULL, 0, 0, NULL}
};

4842 4843 4844 4845 4846 4847 4848 4849
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
4850
{
4851
    char ret = '1';
4852
    virDomainPtr dom = NULL;
4853 4854 4855 4856
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
    int flags = 0;
4857 4858 4859
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
4860 4861
    const char *xmlfile = NULL;
    char *xml = NULL;
4862
    sigset_t sigmask, oldsigmask;
4863 4864 4865 4866 4867

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

4869
    if (!vshConnectionUsability (ctl, ctl->conn))
4870
        goto out;
4871

J
Jim Meyering 已提交
4872
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
4873
        goto out;
4874

4875 4876
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
4877 4878
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
4879
        goto out;
4880
    }
4881

4882 4883 4884 4885 4886
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

4887 4888
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
4889 4890
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
4891
    if (vshCommandOptBool (cmd, "tunnelled"))
4892
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
4893

C
Chris Lalancette 已提交
4894 4895 4896 4897 4898
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

4899 4900 4901
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

4902 4903 4904 4905 4906 4907
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

4908 4909
    if (vshCommandOptBool (cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;
4910 4911 4912 4913 4914 4915

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


4916 4917 4918 4919
    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. */
4920

4921
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
4922
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
4923
            goto out;
4924
        }
4925

4926
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
4927
            ret = '0';
4928 4929 4930 4931 4932 4933
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
4934
        if (!dconn) goto out;
4935

4936
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
4937 4938
        if (ddom) {
            virDomainFree(ddom);
4939
            ret = '0';
4940 4941 4942
        }
        virConnectClose (dconn);
    }
4943

4944 4945 4946
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
4947
    if (dom) virDomainFree (dom);
4948
    VIR_FREE(xml);
4949 4950 4951
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
4952
static void
4953 4954
print_job_progress(const char *label, unsigned long long remaining,
                   unsigned long long total)
W
Wen Congyang 已提交
4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973
{
    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;
        }
    }

4974 4975
    /* see comments in vshError about why we must flush */
    fflush(stdout);
4976
    fprintf(stderr, "\r%s: [%3d %%]", label, progress);
4977
    fflush(stderr);
W
Wen Congyang 已提交
4978 4979
}

E
Eric Blake 已提交
4980
static bool
4981 4982 4983 4984 4985
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
4986
    bool functionReturn = false;
4987 4988 4989 4990 4991
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
4992 4993
    virDomainJobInfo jobinfo;
    bool verbose = false;
4994
    int timeout = 0;
W
Wen Congyang 已提交
4995 4996
    struct timeval start, curr;
    bool live_flag = false;
4997
    vshCtrlData data;
4998 4999 5000 5001
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
5002 5003

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

W
Wen Congyang 已提交
5006 5007 5008
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
5009
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
5010
        live_flag = true;
5011
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028
        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;
        }
    }

5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051
    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 已提交
5052
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
5053
    while (1) {
5054
repoll:
W
Wen Congyang 已提交
5055 5056 5057 5058
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
5059
                    functionReturn = true;
W
Wen Congyang 已提交
5060 5061
                    if (verbose) {
                        /* print [100 %] */
5062
                        print_job_progress("Migration", 0, 1);
W
Wen Congyang 已提交
5063 5064
                    }
                } else
W
Wen Congyang 已提交
5065
                    functionReturn = false;
5066
            } else
W
Wen Congyang 已提交
5067
                functionReturn = false;
W
Wen Congyang 已提交
5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
5079
            functionReturn = false;
W
Wen Congyang 已提交
5080 5081 5082
            break;
        }

W
Wen Congyang 已提交
5083 5084 5085 5086
        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. */
5087 5088
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "suspend the domain when migration timeouts\n");
W
Wen Congyang 已提交
5089 5090 5091 5092
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
5093 5094 5095 5096 5097
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
5098 5099
                print_job_progress("Migration", jobinfo.dataRemaining,
                                   jobinfo.dataTotal);
5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
5111
    return functionReturn;
5112 5113
}

5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124
/*
 * "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")},
5125
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
5126 5127 5128
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5129
static bool
5130 5131 5132
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
5133
    long long downtime = 0;
E
Eric Blake 已提交
5134
    bool ret = false;
5135

5136
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5137
        return false;
5138 5139

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

5142 5143
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
5144 5145 5146 5147 5148 5149 5150
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
5151
    ret = true;
5152 5153 5154 5155 5156 5157

done:
    virDomainFree(dom);
    return ret;
}

5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201
/*
 * "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;
}

5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218
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))
5219
        goto cleanup;
5220 5221

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
5222
        goto cleanup;
5223 5224

    if (vshCommandOptString(cmd, "path", &path) < 0)
5225
        goto cleanup;
5226

5227 5228
    if (vshCommandOptUL(cmd, "bandwidth", &bandwidth) < 0) {
        vshError(ctl, "%s", _("bandwidth must be a number"));
5229
        goto cleanup;
5230
    }
5231 5232 5233 5234 5235 5236 5237 5238 5239 5240

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

5241
cleanup:
5242 5243
    if (dom)
        virDomainFree(dom);
5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327
    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;
}


5328 5329 5330
/*
 * "net-autostart" command
 */
5331
static const vshCmdInfo info_network_autostart[] = {
5332
    {"help", N_("autostart a network")},
5333
    {"desc",
5334
     N_("Configure a network to be automatically started at boot.")},
5335 5336 5337
    {NULL, NULL}
};

5338
static const vshCmdOptDef opts_network_autostart[] = {
5339 5340
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5341 5342 5343
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5344
static bool
5345
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
5346 5347
{
    virNetworkPtr network;
5348
    const char *name;
5349 5350
    int autostart;

5351
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5352
        return false;
5353

J
Jim Meyering 已提交
5354
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5355
        return false;
5356 5357 5358 5359

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
5360
        if (autostart)
5361
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
5362
        else
5363
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
5364
        virNetworkFree(network);
E
Eric Blake 已提交
5365
        return false;
5366 5367
    }

5368
    if (autostart)
5369
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
5370
    else
5371
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
5372

L
Laine Stump 已提交
5373
    virNetworkFree(network);
E
Eric Blake 已提交
5374
    return true;
5375
}
K
Karel Zak 已提交
5376

5377 5378 5379
/*
 * "net-create" command
 */
5380
static const vshCmdInfo info_network_create[] = {
5381 5382
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
5383 5384 5385
    {NULL, NULL}
};

5386
static const vshCmdOptDef opts_network_create[] = {
5387
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5388 5389 5390
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5391
static bool
5392
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
5393 5394
{
    virNetworkPtr network;
5395
    const char *from = NULL;
E
Eric Blake 已提交
5396
    bool ret = true;
5397
    char *buffer;
5398

5399
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5400
        return false;
5401

5402
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5403
        return false;
5404

5405
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5406
        return false;
5407 5408

    network = virNetworkCreateXML(ctl->conn, buffer);
5409
    VIR_FREE(buffer);
5410

5411 5412 5413
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
5414
        virNetworkFree(network);
5415
    } else {
5416
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
5417
        ret = false;
5418 5419 5420 5421 5422 5423 5424 5425
    }
    return ret;
}


/*
 * "net-define" command
 */
5426
static const vshCmdInfo info_network_define[] = {
5427 5428
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
5429 5430 5431
    {NULL, NULL}
};

5432
static const vshCmdOptDef opts_network_define[] = {
5433
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5434 5435 5436
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5437
static bool
5438
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
5439 5440
{
    virNetworkPtr network;
5441
    const char *from = NULL;
E
Eric Blake 已提交
5442
    bool ret = true;
5443
    char *buffer;
5444

5445
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5446
        return false;
5447

5448
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5449
        return false;
5450

5451
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5452
        return false;
5453 5454

    network = virNetworkDefineXML(ctl->conn, buffer);
5455
    VIR_FREE(buffer);
5456

5457 5458 5459
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
5460
        virNetworkFree(network);
5461
    } else {
5462
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
5463
        ret = false;
5464 5465 5466 5467 5468 5469 5470 5471
    }
    return ret;
}


/*
 * "net-destroy" command
 */
5472
static const vshCmdInfo info_network_destroy[] = {
5473 5474
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
5475 5476 5477
    {NULL, NULL}
};

5478
static const vshCmdOptDef opts_network_destroy[] = {
5479
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5480 5481 5482
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5483
static bool
5484
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
5485 5486
{
    virNetworkPtr network;
E
Eric Blake 已提交
5487
    bool ret = true;
5488
    const char *name;
5489

5490
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5491
        return false;
5492

J
Jim Meyering 已提交
5493
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5494
        return false;
5495 5496 5497 5498

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

5503
    virNetworkFree(network);
5504 5505 5506 5507 5508 5509 5510
    return ret;
}


/*
 * "net-dumpxml" command
 */
5511
static const vshCmdInfo info_network_dumpxml[] = {
5512 5513
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
5514 5515 5516
    {NULL, NULL}
};

5517
static const vshCmdOptDef opts_network_dumpxml[] = {
5518
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5519 5520 5521
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5522
static bool
5523
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
5524 5525
{
    virNetworkPtr network;
E
Eric Blake 已提交
5526
    bool ret = true;
5527 5528
    char *dump;

5529
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5530
        return false;
5531

J
Jim Meyering 已提交
5532
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
5533
        return false;
5534 5535 5536

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
5537
        vshPrint(ctl, "%s", dump);
5538
        VIR_FREE(dump);
5539
    } else {
E
Eric Blake 已提交
5540
        ret = false;
5541 5542 5543 5544 5545 5546
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560
/*
 * "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 已提交
5561
static bool
O
Osier Yang 已提交
5562 5563 5564 5565 5566 5567 5568 5569 5570 5571
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 已提交
5572
        return false;
O
Osier Yang 已提交
5573 5574 5575

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5576
        return false;
O
Osier Yang 已提交
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

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

5602
    VIR_FREE(bridge);
O
Osier Yang 已提交
5603
    virNetworkFree(network);
E
Eric Blake 已提交
5604
    return true;
O
Osier Yang 已提交
5605
}
5606

5607 5608 5609 5610
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
5611 5612
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
5613 5614 5615 5616
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
5617
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5618 5619 5620
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5621
static bool
5622 5623
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5624
    bool ret = false;
5625 5626 5627 5628 5629
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
5630
    int flags = VIR_INTERFACE_XML_INACTIVE;
5631

5632
    if (!vshConnectionUsability(ctl, ctl->conn))
5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658
        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 已提交
5659
        ret = true;
5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671
        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)) {
5672 5673
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685
        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 已提交
5686
    ret = true;
5687 5688 5689 5690 5691

cleanup:
    if (iface)
        virInterfaceFree (iface);

5692 5693 5694
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
5695 5696 5697

    if (tmp) {
        unlink (tmp);
5698
        VIR_FREE(tmp);
5699 5700 5701 5702 5703
    }

    return ret;
}

5704 5705 5706
/*
 * "net-list" command
 */
5707
static const vshCmdInfo info_network_list[] = {
5708 5709
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
5710 5711 5712
    {NULL, NULL}
};

5713
static const vshCmdOptDef opts_network_list[] = {
5714 5715
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
5716 5717 5718
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5719
static bool
5720
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5721 5722 5723 5724 5725
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
5726
    char **activeNames = NULL, **inactiveNames = NULL;
5727 5728
    inactive |= all;

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

    if (active) {
5733 5734
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
5735
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
5736
            return false;
5737
        }
5738
        if (maxactive) {
5739
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
5740

5741
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
5742
                                                    maxactive)) < 0) {
5743
                vshError(ctl, "%s", _("Failed to list active networks"));
5744
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5745
                return false;
5746
            }
5747

5748
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
5749
        }
5750 5751
    }
    if (inactive) {
5752 5753
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
5754
            vshError(ctl, "%s", _("Failed to list inactive networks"));
5755
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5756
            return false;
5757
        }
5758 5759 5760
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5761 5762 5763
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
5764
                vshError(ctl, "%s", _("Failed to list inactive networks"));
5765 5766
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5767
                return false;
5768
            }
5769

5770 5771
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
5772
    }
5773 5774
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
5775
    vshPrintExtra(ctl, "-----------------------------------------\n");
5776 5777

    for (i = 0; i < maxactive; i++) {
5778 5779
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
5780 5781
        const char *autostartStr;
        int autostart = 0;
5782 5783 5784

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5785
            VIR_FREE(activeNames[i]);
5786
            continue;
5787
        }
5788

5789 5790 5791
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5792
            autostartStr = autostart ? _("yes") : _("no");
5793 5794 5795 5796 5797

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
5798
        virNetworkFree(network);
5799
        VIR_FREE(activeNames[i]);
5800 5801 5802
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
5803 5804
        const char *autostartStr;
        int autostart = 0;
5805 5806 5807

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5808
            VIR_FREE(inactiveNames[i]);
5809
            continue;
5810
        }
5811

5812 5813 5814
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5815
            autostartStr = autostart ? _("yes") : _("no");
5816

5817
        vshPrint(ctl, "%-20s %-10s %-10s\n",
5818 5819 5820
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
5821 5822

        virNetworkFree(network);
5823
        VIR_FREE(inactiveNames[i]);
5824
    }
5825 5826
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5827
    return true;
5828 5829 5830 5831 5832 5833
}


/*
 * "net-name" command
 */
5834
static const vshCmdInfo info_network_name[] = {
5835
    {"help", N_("convert a network UUID to network name")},
5836
    {"desc", ""},
5837 5838 5839
    {NULL, NULL}
};

5840
static const vshCmdOptDef opts_network_name[] = {
5841
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
5842 5843 5844
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5845
static bool
5846
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
5847 5848 5849
{
    virNetworkPtr network;

5850
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5851
        return false;
J
Jim Meyering 已提交
5852
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5853
                                           VSH_BYUUID)))
E
Eric Blake 已提交
5854
        return false;
5855 5856 5857

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
5858
    return true;
5859 5860 5861 5862 5863 5864
}


/*
 * "net-start" command
 */
5865
static const vshCmdInfo info_network_start[] = {
5866 5867
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
5868 5869 5870
    {NULL, NULL}
};

5871
static const vshCmdOptDef opts_network_start[] = {
5872
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
5873 5874 5875
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5876
static bool
5877
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
5878 5879
{
    virNetworkPtr network;
E
Eric Blake 已提交
5880
    bool ret = true;
5881

5882
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5883
        return false;
5884

J
Jim Meyering 已提交
5885
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
5886
         return false;
5887 5888 5889

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
5890
                 virNetworkGetName(network));
5891
    } else {
5892
        vshError(ctl, _("Failed to start network %s"),
5893
                 virNetworkGetName(network));
E
Eric Blake 已提交
5894
        ret = false;
5895
    }
L
Laine Stump 已提交
5896
    virNetworkFree(network);
5897 5898 5899 5900 5901 5902 5903
    return ret;
}


/*
 * "net-undefine" command
 */
5904
static const vshCmdInfo info_network_undefine[] = {
5905 5906
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
5907 5908 5909
    {NULL, NULL}
};

5910
static const vshCmdOptDef opts_network_undefine[] = {
5911
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5912 5913 5914
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5915
static bool
5916
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
5917 5918
{
    virNetworkPtr network;
E
Eric Blake 已提交
5919
    bool ret = true;
5920
    const char *name;
5921

5922
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5923
        return false;
5924

J
Jim Meyering 已提交
5925
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5926
        return false;
5927 5928 5929 5930

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

L
Laine Stump 已提交
5935
    virNetworkFree(network);
5936 5937 5938 5939 5940 5941 5942
    return ret;
}


/*
 * "net-uuid" command
 */
5943
static const vshCmdInfo info_network_uuid[] = {
5944
    {"help", N_("convert a network name to network UUID")},
5945
    {"desc", ""},
5946 5947 5948
    {NULL, NULL}
};

5949
static const vshCmdOptDef opts_network_uuid[] = {
5950
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
5951 5952 5953
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5954
static bool
5955
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
5956 5957 5958 5959
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

5960
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5961
        return false;
5962

J
Jim Meyering 已提交
5963
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5964
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5965
        return false;
5966 5967 5968 5969

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

L
Laine Stump 已提交
5972
    virNetworkFree(network);
E
Eric Blake 已提交
5973
    return true;
5974 5975 5976
}


5977 5978 5979 5980 5981
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
5982 5983
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
5984 5985 5986 5987
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
5988 5989
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
5990 5991
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
5992
static bool
5993 5994 5995 5996 5997 5998 5999 6000 6001
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;

6002
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6003
        return false;
6004 6005 6006 6007

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
6008
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
6009
            return false;
6010 6011 6012 6013 6014 6015
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
6016
                vshError(ctl, "%s", _("Failed to list active interfaces"));
6017
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6018
                return false;
6019 6020 6021 6022 6023 6024 6025 6026
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
6027
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6028
            VIR_FREE(activeNames);
E
Eric Blake 已提交
6029
            return false;
6030 6031 6032 6033
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

6034 6035 6036
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
6037
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6038 6039
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6040
                return false;
6041 6042 6043 6044 6045
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
6046 6047
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
6048 6049 6050
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
6051 6052
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
6053 6054 6055

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6056
            VIR_FREE(activeNames[i]);
6057 6058 6059 6060 6061 6062 6063 6064
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6065
        VIR_FREE(activeNames[i]);
6066 6067
    }
    for (i = 0; i < maxinactive; i++) {
6068 6069
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
6070 6071 6072

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6073
            VIR_FREE(inactiveNames[i]);
6074 6075 6076 6077 6078 6079 6080 6081
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6082
        VIR_FREE(inactiveNames[i]);
6083
    }
6084 6085
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6086
    return true;
6087 6088 6089 6090 6091 6092 6093

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
6094
    {"help", N_("convert an interface MAC address to interface name")},
6095 6096 6097 6098 6099
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
6100
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
6101 6102 6103
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6104
static bool
6105 6106 6107 6108
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6109
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6110
        return false;
6111 6112
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
6113
        return false;
6114 6115 6116

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6117
    return true;
6118 6119 6120 6121 6122 6123
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
6124
    {"help", N_("convert an interface name to interface MAC address")},
6125 6126 6127 6128 6129
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
6130
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
6131 6132 6133
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6134
static bool
6135 6136 6137 6138
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6139
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6140
        return false;
6141 6142
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6143
        return false;
6144 6145 6146

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6147
    return true;
6148 6149 6150 6151 6152 6153
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
6154 6155
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
6156 6157 6158 6159
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
6160 6161
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
6162 6163 6164
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6165
static bool
6166 6167 6168
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6169
    bool ret = true;
6170
    char *dump;
6171 6172 6173 6174 6175
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
6176

6177
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6178
        return false;
6179 6180

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

6183
    dump = virInterfaceGetXMLDesc(iface, flags);
6184
    if (dump != NULL) {
6185
        vshPrint(ctl, "%s", dump);
6186
        VIR_FREE(dump);
6187
    } else {
E
Eric Blake 已提交
6188
        ret = false;
6189 6190 6191 6192 6193 6194 6195 6196 6197 6198
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
6199 6200
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
6201 6202 6203 6204
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
6205
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
6206 6207 6208
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6209
static bool
6210 6211
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
6212
    virInterfacePtr iface;
6213
    const char *from = NULL;
E
Eric Blake 已提交
6214
    bool ret = true;
6215 6216
    char *buffer;

6217
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6218
        return false;
6219

6220
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6221
        return false;
6222 6223

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

6226
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
6227
    VIR_FREE(buffer);
6228

6229
    if (iface != NULL) {
6230
        vshPrint(ctl, _("Interface %s defined from %s\n"),
6231
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
6232
        virInterfaceFree (iface);
6233
    } else {
6234
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
6235
        ret = false;
6236 6237 6238 6239 6240 6241 6242 6243
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
6244 6245
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
6246 6247 6248 6249
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
6250
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6251 6252 6253
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6254
static bool
6255 6256 6257
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6258
    bool ret = true;
6259
    const char *name;
6260

6261
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6262
        return false;
6263 6264

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6265
        return false;
6266 6267 6268 6269

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
6270
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
6271
        ret = false;
6272 6273 6274 6275 6276 6277 6278 6279 6280 6281
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
6282 6283
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
6284 6285 6286 6287
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
6288
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6289 6290 6291
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6292
static bool
6293 6294 6295
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6296
    bool ret = true;
6297
    const char *name;
6298

6299
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6300
        return false;
6301 6302

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6303
        return false;
6304 6305 6306 6307

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
6308
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
6309
        ret = false;
6310 6311 6312 6313 6314 6315 6316 6317 6318 6319
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
6320
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
6321
    {"desc", N_("forcefully stop a physical host interface.")},
6322 6323 6324 6325
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
6326
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6327 6328 6329
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6330
static bool
6331 6332 6333
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6334
    bool ret = true;
6335
    const char *name;
6336

6337
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6338
        return false;
6339 6340

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6341
        return false;
6342 6343 6344 6345

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
6346
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
6347
        ret = false;
6348 6349 6350 6351 6352 6353
    }

    virInterfaceFree(iface);
    return ret;
}

6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438
/*
 * "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;
}
6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453

/*
 * "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 已提交
6454
static bool
6455 6456 6457
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
6458
    const char *from = NULL;
E
Eric Blake 已提交
6459
    bool ret = true;
6460 6461
    char *buffer;

6462
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6463
        return false;
6464

6465
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6466
        return false;
6467 6468

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6469
        return false;
6470 6471 6472 6473 6474 6475 6476 6477 6478 6479

    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 已提交
6480
        ret = false;
6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499
    }
    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 已提交
6500
static bool
6501 6502 6503
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6504
    bool ret = true;
6505
    const char *name;
6506

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

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
6511
        return false;
6512 6513 6514 6515 6516

    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 已提交
6517
        ret = false;
6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538
    }

    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 已提交
6539
static bool
6540 6541 6542
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6543
    bool ret = true;
6544 6545
    char *dump;

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

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
6550
        return false;
6551 6552 6553

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
6554
        vshPrint(ctl, "%s", dump);
6555 6556
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
6557
        ret = false;
6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576
    }

    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 已提交
6577
static bool
6578 6579 6580 6581 6582 6583
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
6590
        return false;
6591 6592 6593 6594 6595 6596 6597 6598
    }

    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 已提交
6599
        return false;
6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626
    }

    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 已提交
6627
    return true;
6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644
}


/*
 * "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 已提交
6645
static bool
6646 6647
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6648
    bool ret = false;
6649 6650 6651 6652 6653 6654
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

6655
    if (!vshConnectionUsability(ctl, ctl->conn))
6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681
        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 已提交
6682
        ret = true;
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
        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 已提交
6709
    ret = true;
6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727

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


6728
/**************************************************************************/
6729
/*
6730
 * "pool-autostart" command
6731
 */
6732
static const vshCmdInfo info_pool_autostart[] = {
6733
    {"help", N_("autostart a pool")},
6734
    {"desc",
6735
     N_("Configure a pool to be automatically started at boot.")},
6736
    {NULL, NULL}
6737 6738
};

6739
static const vshCmdOptDef opts_pool_autostart[] = {
6740 6741
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6742 6743
    {NULL, 0, 0, NULL}
};
6744

E
Eric Blake 已提交
6745
static bool
6746
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
6747
{
6748
    virStoragePoolPtr pool;
6749
    const char *name;
6750
    int autostart;
6751

6752
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6753
        return false;
6754

6755
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6756
        return false;
6757

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

6760 6761
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
6762
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
6763
        else
6764
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
6765
        virStoragePoolFree(pool);
E
Eric Blake 已提交
6766
        return false;
6767 6768
    }

6769
    if (autostart)
6770
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
6771
    else
6772
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
6773

L
Laine Stump 已提交
6774
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6775
    return true;
6776 6777
}

6778
/*
6779
 * "pool-create" command
6780
 */
6781
static const vshCmdInfo info_pool_create[] = {
6782 6783
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
6784 6785 6786
    {NULL, NULL}
};

6787
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
6788
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
6789
     N_("file containing an XML pool description")},
6790 6791 6792
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6793
static bool
6794
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
6795
{
6796
    virStoragePoolPtr pool;
6797
    const char *from = NULL;
E
Eric Blake 已提交
6798
    bool ret = true;
6799
    char *buffer;
6800

6801
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6802
        return false;
6803

6804
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6805
        return false;
6806

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

6810
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
6811
    VIR_FREE(buffer);
6812 6813 6814 6815

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6816
        virStoragePoolFree(pool);
6817
    } else {
6818
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
6819
        ret = false;
6820 6821
    }
    return ret;
6822 6823
}

6824

6825 6826 6827 6828
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
6829
    {"help", N_("create a device defined "
6830
                          "by an XML file on the node")},
6831
    {"desc", N_("Create a device on the node.  Note that this "
6832 6833 6834 6835 6836 6837 6838
                          "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,
6839
     N_("file containing an XML description of the device")},
6840 6841 6842
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6843
static bool
6844 6845 6846
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
6847
    const char *from = NULL;
E
Eric Blake 已提交
6848
    bool ret = true;
6849 6850
    char *buffer;

6851
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6852
        return false;
6853

6854
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6855
        return false;
6856

6857
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6858
        return false;
6859 6860

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
6861
    VIR_FREE(buffer);
6862 6863 6864 6865

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
6866
        virNodeDeviceFree(dev);
6867
    } else {
6868
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
6869
        ret = false;
6870 6871 6872 6873 6874 6875 6876 6877 6878 6879
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
6880
    {"help", N_("destroy (stop) a device on the node")},
6881
    {"desc", N_("Destroy a device on the node.  Note that this "
6882
                "command destroys devices on the physical host")},
6883 6884 6885 6886 6887
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
6888
     N_("name of the device to be destroyed")},
6889 6890 6891
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6892
static bool
6893 6894 6895
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
6896
    bool ret = true;
6897
    const char *name = NULL;
6898

6899
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
6900
        return false;
6901 6902
    }

6903
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
6904
        return false;
6905 6906 6907 6908 6909 6910

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
6911
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
6912
        ret = false;
6913 6914 6915 6916 6917 6918 6919
    }

    virNodeDeviceFree(dev);
    return ret;
}


6920
/*
6921
 * XML Building helper for pool-define-as and pool-create-as
6922
 */
6923
static const vshCmdOptDef opts_pool_X_as[] = {
6924 6925 6926 6927 6928 6929 6930 6931
    {"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")},
6932
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
6933 6934 6935
    {NULL, 0, 0, NULL}
};

6936
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
6937

6938 6939
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
6940
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6941

6942
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6943
        goto cleanup;
6944
    if (vshCommandOptString(cmd, "type", &type) <= 0)
6945 6946
        goto cleanup;

6947 6948 6949 6950 6951
    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 ||
6952 6953
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
6954
        goto cleanup;
6955
    }
6956

6957 6958
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
6959
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
6960
        virBufferAddLit(&buf, "  <source>\n");
6961

6962
        if (srcHost)
6963
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
6964
        if (srcPath)
6965
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
6966
        if (srcDev)
6967
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
6968
        if (srcFormat)
6969
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
6970
        if (srcName)
6971
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
6972 6973

        virBufferAddLit(&buf, "  </source>\n");
6974 6975
    }
    if (target) {
6976
        virBufferAddLit(&buf, "  <target>\n");
6977
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
6978
        virBufferAddLit(&buf, "  </target>\n");
6979
    }
6980 6981 6982 6983
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
6984
        return false;
6985
    }
6986 6987 6988

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
6989
    return true;
6990 6991

cleanup:
6992
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6993
    return false;
6994 6995 6996 6997 6998 6999
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
7000 7001
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
7002 7003 7004
    {NULL, NULL}
};

E
Eric Blake 已提交
7005
static bool
7006 7007 7008
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
7009 7010
    const char *name;
    char *xml;
7011
    int printXML = vshCommandOptBool(cmd, "print-xml");
7012

7013
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7014
        return false;
7015 7016

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

7019
    if (printXML) {
7020
        vshPrint(ctl, "%s", xml);
7021
        VIR_FREE(xml);
7022
    } else {
7023
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
7024
        VIR_FREE(xml);
7025

7026 7027 7028 7029
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
7030
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
7031
            return false;
7032 7033
        }
    }
E
Eric Blake 已提交
7034
    return true;
7035 7036
}

7037

7038
/*
7039
 * "pool-define" command
7040
 */
7041
static const vshCmdInfo info_pool_define[] = {
7042 7043
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
7044 7045 7046
    {NULL, NULL}
};

7047
static const vshCmdOptDef opts_pool_define[] = {
7048
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
7049 7050 7051
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7052
static bool
7053
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
7054
{
7055
    virStoragePoolPtr pool;
7056
    const char *from = NULL;
E
Eric Blake 已提交
7057
    bool ret = true;
7058
    char *buffer;
7059

7060
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7061
        return false;
7062

7063
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7064
        return false;
7065

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

7069
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
7070
    VIR_FREE(buffer);
7071 7072 7073 7074

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7075
        virStoragePoolFree(pool);
7076
    } else {
7077
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
7078
        ret = false;
7079 7080
    }
    return ret;
7081 7082
}

7083

7084 7085 7086
/*
 * "pool-define-as" command
 */
7087
static const vshCmdInfo info_pool_define_as[] = {
7088 7089
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
7090 7091 7092
    {NULL, NULL}
};

E
Eric Blake 已提交
7093
static bool
7094
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
7095 7096
{
    virStoragePoolPtr pool;
7097 7098
    const char *name;
    char *xml;
7099
    int printXML = vshCommandOptBool(cmd, "print-xml");
7100

7101
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7102
        return false;
7103

7104
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
7105
        return false;
7106

7107
    if (printXML) {
7108
        vshPrint(ctl, "%s", xml);
7109
        VIR_FREE(xml);
7110
    } else {
7111
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
7112
        VIR_FREE(xml);
7113

7114 7115 7116 7117
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
7118
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
7119
            return false;
7120 7121
        }
    }
E
Eric Blake 已提交
7122
    return true;
7123 7124 7125
}


7126
/*
7127
 * "pool-build" command
7128
 */
7129
static const vshCmdInfo info_pool_build[] = {
7130 7131
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
7132 7133 7134
    {NULL, NULL}
};

7135
static const vshCmdOptDef opts_pool_build[] = {
7136
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7137 7138 7139
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7140
static bool
7141
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
7142
{
7143
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7144
    bool ret = true;
7145
    const char *name;
7146

7147
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7148
        return false;
7149

7150
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7151
        return false;
7152

7153
    if (virStoragePoolBuild(pool, 0) == 0) {
7154
        vshPrint(ctl, _("Pool %s built\n"), name);
7155
    } else {
7156
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
7157
        ret = false;
7158 7159
    }

7160 7161
    virStoragePoolFree(pool);

7162 7163 7164
    return ret;
}

7165

7166
/*
7167
 * "pool-destroy" command
7168
 */
7169
static const vshCmdInfo info_pool_destroy[] = {
7170 7171 7172
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
7173 7174 7175
    {NULL, NULL}
};

7176
static const vshCmdOptDef opts_pool_destroy[] = {
7177
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7178 7179 7180
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7181
static bool
7182
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
7183
{
7184
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7185
    bool ret = true;
7186
    const char *name;
7187

7188
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7189
        return false;
7190

7191
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7192
        return false;
7193

7194 7195 7196
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
7197
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
7198
        ret = false;
7199 7200
    }

7201
    virStoragePoolFree(pool);
7202 7203 7204
    return ret;
}

7205

7206
/*
7207 7208
 * "pool-delete" command
 */
7209
static const vshCmdInfo info_pool_delete[] = {
7210 7211
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
7212 7213 7214
    {NULL, NULL}
};

7215
static const vshCmdOptDef opts_pool_delete[] = {
7216
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7217 7218 7219
    {NULL, 0, 0, NULL}
};

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

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

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7231
        return false;
7232 7233

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
7234
        vshPrint(ctl, _("Pool %s deleted\n"), name);
7235
    } else {
7236
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
7237
        ret = false;
7238 7239
    }

L
Laine Stump 已提交
7240
    virStoragePoolFree(pool);
7241 7242 7243 7244 7245 7246 7247
    return ret;
}


/*
 * "pool-refresh" command
 */
7248
static const vshCmdInfo info_pool_refresh[] = {
7249 7250
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
7251 7252 7253
    {NULL, NULL}
};

7254
static const vshCmdOptDef opts_pool_refresh[] = {
7255
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7256 7257 7258
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7259
static bool
7260
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
7261 7262
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7263
    bool ret = true;
7264
    const char *name;
7265

7266
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7267
        return false;
7268 7269

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7270
        return false;
7271 7272 7273 7274

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
7275
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
7276
        ret = false;
7277 7278 7279 7280 7281 7282 7283 7284 7285 7286
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
7287
static const vshCmdInfo info_pool_dumpxml[] = {
7288 7289
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
7290 7291 7292
    {NULL, NULL}
};

7293
static const vshCmdOptDef opts_pool_dumpxml[] = {
7294
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7295 7296 7297
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7298
static bool
7299
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
7300 7301
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7302
    bool ret = true;
7303 7304
    char *dump;

7305
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7306
        return false;
7307 7308

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7309
        return false;
7310 7311 7312

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
7313
        vshPrint(ctl, "%s", dump);
7314
        VIR_FREE(dump);
7315
    } else {
E
Eric Blake 已提交
7316
        ret = false;
7317 7318 7319 7320 7321 7322 7323 7324 7325 7326
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
7327
static const vshCmdInfo info_pool_list[] = {
7328 7329
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
7330 7331 7332
    {NULL, NULL}
};

7333
static const vshCmdOptDef opts_pool_list[] = {
7334 7335
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
7336
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
7337 7338 7339
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7340
static bool
7341
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7342
{
7343 7344
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
7345 7346
    int i, ret;
    bool functionReturn;
7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362
    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 */
7363
    int all = vshCommandOptBool(cmd, "all");
7364 7365
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
7366 7367 7368
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

7369
    /* Check the connection to libvirtd daemon is still working */
7370
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7371
        return false;
7372

7373
    /* Retrieve the number of active storage pools */
7374
    if (active) {
7375 7376
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
7377
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
7378
            return false;
7379 7380
        }
    }
7381 7382

    /* Retrieve the number of inactive storage pools */
7383
    if (inactive) {
7384 7385
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
7386
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
7387
            return false;
7388
        }
7389
    }
7390

7391 7392
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
7393

7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405
    /* 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 已提交
7406
            return false;
7407 7408 7409
        }
    }

7410 7411 7412 7413 7414 7415 7416 7417
    /* 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 已提交
7418
            return false;
7419 7420
        }
    }
7421

7422 7423 7424 7425 7426 7427 7428 7429 7430 7431
    /* 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]);
7432
        if (!pool) {
7433
            VIR_FREE(poolNames[i]);
7434 7435 7436
            continue;
        }

7437
        /* Retrieve the autostart status of the pool */
7438
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
7439
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
7440
        else
7441 7442 7443 7444 7445 7446
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
7447 7448
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459
            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;
        }
7460

7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572
        /* 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 */
7573 7574 7575
        virStoragePoolFree(pool);
    }

7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593
    /* 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);
7594 7595
        }

7596
        /* Cleanup and return */
E
Eric Blake 已提交
7597
        functionReturn = true;
7598 7599
        goto cleanup;
    }
7600

7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638
    /* 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. */
7639
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
7640
             (unsigned long) nameStrLength);
7641
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
7642
             (unsigned long) stateStrLength);
7643
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
7644
             (unsigned long) autostartStrLength);
7645
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
7646
             (unsigned long) persistStrLength);
7647
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
7648
             (unsigned long) capStrLength);
7649
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
7650
             (unsigned long) allocStrLength);
7651
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694
             (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 已提交
7695
    functionReturn = true;
7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709
    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 已提交
7710
    functionReturn = false;
7711

7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723
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]);
7724
    }
7725 7726 7727 7728 7729 7730 7731

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

    /* Return the desired value */
    return functionReturn;
7732 7733
}

7734 7735 7736 7737
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
7738 7739
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7740 7741 7742 7743 7744
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7745 7746 7747
     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")},
7748
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
7749 7750 7751
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7752
static bool
7753 7754
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7755
    const char *type = NULL, *host = NULL;
7756 7757
    char *srcSpec = NULL;
    char *srcList;
7758
    const char *initiator = NULL;
7759

7760 7761
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
7762 7763
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
7764
        return false;
7765
    }
7766

7767
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7768
        return false;
7769 7770

    if (host) {
7771
        const char *port = NULL;
7772
        virBuffer buf = VIR_BUFFER_INITIALIZER;
7773 7774 7775 7776

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7777
            return false;
7778
        }
7779
        virBufferAddLit(&buf, "<source>\n");
7780
        virBufferAsprintf(&buf, "  <host name='%s'", host);
7781
        if (port)
7782
            virBufferAsprintf(&buf, " port='%s'", port);
7783
        virBufferAddLit(&buf, "/>\n");
7784 7785
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
7786
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
7787 7788
            virBufferAddLit(&buf, "  </initiator>\n");
        }
7789 7790 7791
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
7792
            return false;
7793
        }
7794
        srcSpec = virBufferContentAndReset(&buf);
7795 7796 7797
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7798
    VIR_FREE(srcSpec);
7799
    if (srcList == NULL) {
7800
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7801
        return false;
7802 7803
    }
    vshPrint(ctl, "%s", srcList);
7804
    VIR_FREE(srcList);
7805

E
Eric Blake 已提交
7806
    return true;
7807 7808 7809 7810 7811 7812 7813
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
7814 7815
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7816 7817 7818 7819 7820
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7821
     N_("type of storage pool sources to discover")},
7822
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
7823
     N_("optional file of source xml to query for pools")},
7824 7825 7826
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7827
static bool
7828 7829
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7830
    const char *type = NULL, *srcSpecFile = NULL;
7831
    char *srcSpec = NULL, *srcList;
7832

7833
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
7834
        return false;
7835

7836 7837
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
7838
        return false;
7839
    }
7840

7841
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7842
        return false;
7843 7844

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
7845
        return false;
7846 7847

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7848
    VIR_FREE(srcSpec);
7849
    if (srcList == NULL) {
7850
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7851
        return false;
7852 7853
    }
    vshPrint(ctl, "%s", srcList);
7854
    VIR_FREE(srcList);
7855

E
Eric Blake 已提交
7856
    return true;
7857 7858 7859
}


7860 7861 7862
/*
 * "pool-info" command
 */
7863
static const vshCmdInfo info_pool_info[] = {
7864 7865
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
7866 7867 7868
    {NULL, NULL}
};

7869
static const vshCmdOptDef opts_pool_info[] = {
7870
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7871 7872 7873
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7874
static bool
7875
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
7876 7877 7878
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
7879 7880
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
7881
    bool ret = true;
7882 7883
    char uuid[VIR_UUID_STRING_BUFLEN];

7884
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7885
        return false;
7886 7887

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7888
        return false;
7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914

    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;
7915 7916 7917 7918
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
7919 7920
        }

7921 7922
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
7923 7924
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
7925 7926 7927 7928 7929 7930 7931
        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);
7932 7933
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
7934 7935 7936 7937 7938
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950
        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 已提交
7951
        ret = false;
7952 7953 7954 7955 7956 7957 7958 7959 7960 7961
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
7962
static const vshCmdInfo info_pool_name[] = {
7963
    {"help", N_("convert a pool UUID to pool name")},
7964
    {"desc", ""},
7965 7966 7967
    {NULL, NULL}
};

7968
static const vshCmdOptDef opts_pool_name[] = {
7969
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
7970 7971 7972
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7973
static bool
7974
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
7975 7976 7977
{
    virStoragePoolPtr pool;

7978
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7979
        return false;
7980
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7981
                                           VSH_BYUUID)))
E
Eric Blake 已提交
7982
        return false;
7983 7984 7985

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7986
    return true;
7987 7988 7989 7990 7991 7992
}


/*
 * "pool-start" command
 */
7993
static const vshCmdInfo info_pool_start[] = {
7994 7995
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
7996 7997 7998
    {NULL, NULL}
};

7999
static const vshCmdOptDef opts_pool_start[] = {
8000
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
8001 8002 8003
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8004
static bool
8005
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
8006 8007
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8008
    bool ret = true;
8009

8010
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8011
        return false;
8012

8013
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
8014
         return false;
8015 8016 8017 8018 8019

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
8020
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
8021
        ret = false;
8022
    }
L
Laine Stump 已提交
8023 8024

    virStoragePoolFree(pool);
8025 8026 8027 8028
    return ret;
}


8029 8030 8031
/*
 * "vol-create-as" command
 */
8032
static const vshCmdInfo info_vol_create_as[] = {
8033 8034
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
8035 8036 8037
    {NULL, NULL}
};

8038
static const vshCmdOptDef opts_vol_create_as[] = {
8039 8040 8041 8042 8043
    {"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")},
8044 8045
    {"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")},
8046 8047 8048 8049 8050 8051 8052 8053 8054 8055
    {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 已提交
8056
        /* Deliberate fallthrough cases here :-) */
8057 8058 8059
        switch (*end) {
        case 'T':
            *val *= 1024;
8060
            /* fallthrough */
8061 8062
        case 'G':
            *val *= 1024;
8063
            /* fallthrough */
8064 8065
        case 'M':
            *val *= 1024;
8066
            /* fallthrough */
8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
8080
static bool
8081
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
8082 8083 8084
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8085
    char *xml;
8086 8087
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
8088
    unsigned long long capacity, allocation = 0;
8089
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8090

8091
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8092
        return false;
8093 8094 8095

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

8098
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8099 8100
        goto cleanup;

8101
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
8102 8103
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
8104
        vshError(ctl, _("Malformed size %s"), capacityStr);
8105

8106 8107
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
8108
        vshError(ctl, _("Malformed size %s"), allocationStr);
8109

8110 8111 8112 8113 8114 8115 8116
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

8117

8118
    virBufferAddLit(&buf, "<volume>\n");
8119 8120
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
8121
    if (allocationStr)
8122
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
8123 8124

    if (format) {
8125
        virBufferAddLit(&buf, "  <target>\n");
8126
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
8127
        virBufferAddLit(&buf, "  </target>\n");
8128
    }
8129

8130 8131 8132 8133
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
8134 8135
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
8136 8137 8138
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
8139 8140
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
8141 8142 8143 8144 8145
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
8146 8147
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
8148 8149 8150
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
8151 8152
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
8153 8154 8155 8156 8157
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
8158 8159
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
8160 8161 8162
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
8163 8164
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
8165 8166 8167 8168
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
E
Eric Blake 已提交
8169
            return false;
8170 8171 8172 8173 8174
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
8175
            return false;
8176 8177 8178 8179
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
8180
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
8181
        if (snapshotStrFormat)
8182
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
8183 8184 8185 8186 8187 8188 8189 8190
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

8192 8193
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
8194
        return false;
8195 8196 8197
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
8198
    VIR_FREE(xml);
8199 8200 8201 8202 8203
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
8204
        return true;
8205
    } else {
8206
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
8207
        return false;
8208 8209 8210
    }

 cleanup:
8211
    virBufferFreeAndReset(&buf);
8212
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8213
    return false;
8214 8215 8216
}


8217 8218 8219
/*
 * "pool-undefine" command
 */
8220
static const vshCmdInfo info_pool_undefine[] = {
8221 8222
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
8223 8224 8225
    {NULL, NULL}
};

8226
static const vshCmdOptDef opts_pool_undefine[] = {
8227
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8228 8229 8230
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8231
static bool
8232
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
8233 8234
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8235
    bool ret = true;
8236
    const char *name;
8237

8238
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8239
        return false;
8240 8241

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8242
        return false;
8243 8244 8245 8246

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

L
Laine Stump 已提交
8251
    virStoragePoolFree(pool);
8252 8253 8254 8255 8256 8257 8258
    return ret;
}


/*
 * "pool-uuid" command
 */
8259
static const vshCmdInfo info_pool_uuid[] = {
8260
    {"help", N_("convert a pool name to pool UUID")},
8261
    {"desc", ""},
8262 8263 8264
    {NULL, NULL}
};

8265
static const vshCmdOptDef opts_pool_uuid[] = {
8266
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
8267 8268 8269
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8270
static bool
8271
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
8272 8273 8274 8275
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

8276
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8277
        return false;
8278 8279

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8280
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8281
        return false;
8282 8283 8284 8285

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

L
Laine Stump 已提交
8288
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8289
    return true;
8290 8291 8292 8293 8294 8295
}


/*
 * "vol-create" command
 */
8296
static const vshCmdInfo info_vol_create[] = {
8297 8298
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
8299 8300 8301
    {NULL, NULL}
};

8302
static const vshCmdOptDef opts_vol_create[] = {
8303 8304
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
8305 8306 8307
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8308
static bool
8309
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
8310 8311 8312
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8313
    const char *from = NULL;
E
Eric Blake 已提交
8314
    bool ret = true;
8315 8316
    char *buffer;

8317
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8318
        return false;
8319 8320

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

8324
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8325
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8326
        return false;
8327 8328 8329
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8330
        virshReportError(ctl);
8331
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8332
        return false;
8333 8334 8335
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
8336
    VIR_FREE(buffer);
8337 8338 8339 8340 8341 8342 8343
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
8344
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
8345
        ret = false;
8346 8347 8348 8349
    }
    return ret;
}

8350 8351 8352 8353
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
8354 8355
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
8356 8357 8358 8359
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
8360 8361 8362
    {"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 已提交
8363
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
8364 8365 8366
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8367
static bool
8368 8369 8370 8371
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
8372
    const char *from = NULL;
E
Eric Blake 已提交
8373
    bool ret = false;
8374 8375
    char *buffer = NULL;

8376
    if (!vshConnectionUsability(ctl, ctl->conn))
8377 8378 8379 8380 8381
        goto cleanup;

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

8382
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8383 8384 8385 8386 8387 8388 8389
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8390
        virshReportError(ctl);
8391 8392 8393 8394 8395 8396 8397 8398 8399
        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 {
8400
        vshError(ctl, _("Failed to create vol from %s"), from);
8401 8402 8403
        goto cleanup;
    }

E
Eric Blake 已提交
8404
    ret = true;
8405
cleanup:
8406
    VIR_FREE(buffer);
8407 8408 8409 8410
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
8411 8412
    if (newvol)
        virStorageVolFree(newvol);
8413 8414 8415 8416
    return ret;
}

static xmlChar *
8417
makeCloneXML(const char *origxml, const char *newname) {
8418

8419 8420 8421
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
8422 8423 8424
    xmlChar *newxml = NULL;
    int size;

8425
    doc = virXMLParseStringCtxt(origxml, "domain.xml", &ctxt);
8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447
    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[] = {
8448 8449
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
8450 8451 8452 8453
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
8454 8455
    {"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 已提交
8456
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8457 8458 8459
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8460
static bool
8461 8462 8463 8464
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
8465
    const char *name = NULL;
8466
    char *origxml = NULL;
8467
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
8468
    bool ret = false;
8469

8470
    if (!vshConnectionUsability(ctl, ctl->conn))
8471 8472 8473 8474 8475 8476 8477
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
8478
        vshError(ctl, "%s", _("failed to get parent pool"));
8479 8480 8481
        goto cleanup;
    }

8482
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500
        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 {
8501
        vshError(ctl, _("Failed to clone vol from %s"),
8502 8503 8504 8505
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
8506
    ret = true;
8507 8508

cleanup:
8509
    VIR_FREE(origxml);
8510 8511 8512
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
8513 8514
    if (newvol)
        virStorageVolFree(newvol);
8515 8516 8517 8518 8519
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532

/*
 * "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 已提交
8533
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547
    {"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 已提交
8548
static bool
8549 8550 8551 8552
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8553
    bool ret = false;
8554 8555 8556 8557 8558 8559 8560 8561 8562 8563
    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 已提交
8564
        return false;
8565 8566 8567 8568
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8569
        return false;
8570 8571 8572
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8573
        return false;
8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607
    }

    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 已提交
8608
    ret = true;
8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632

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 已提交
8633
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8634 8635 8636 8637 8638
    {"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 已提交
8639
static bool
8640 8641 8642 8643
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8644
    bool ret = false;
8645 8646 8647 8648
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
8649
    bool created = false;
8650 8651

    if (!vshConnectionUsability(ctl, ctl->conn))
8652
        return false;
8653 8654 8655

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8656
        return false;
8657 8658 8659 8660
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8661
        return false;
8662 8663 8664
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
8665
        return false;
8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677

    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;
        }
8678 8679
    } else {
        created = true;
8680 8681 8682 8683 8684 8685 8686 8687
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

8688
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703
        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 已提交
8704
    ret = true;
8705 8706

cleanup:
8707
    VIR_FORCE_CLOSE(fd);
8708
    if (!ret && created)
8709 8710 8711 8712 8713 8714 8715 8716 8717
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


8718 8719 8720
/*
 * "vol-delete" command
 */
8721
static const vshCmdInfo info_vol_delete[] = {
8722 8723
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
8724 8725 8726
    {NULL, NULL}
};

8727
static const vshCmdOptDef opts_vol_delete[] = {
8728
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8729
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8730 8731 8732
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8733
static bool
8734
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
8735 8736
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8737
    bool ret = true;
8738
    const char *name;
8739

8740
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8741
        return false;
8742 8743

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8744
        return false;
8745 8746 8747
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
8748
        vshPrint(ctl, _("Vol %s deleted\n"), name);
8749
    } else {
8750
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
8751
        ret = false;
8752 8753
    }

L
Laine Stump 已提交
8754
    virStorageVolFree(vol);
8755 8756 8757 8758
    return ret;
}


D
David Allan 已提交
8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769
/*
 * "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 已提交
8770
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
8771 8772 8773
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8774
static bool
D
David Allan 已提交
8775 8776 8777
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8778
    bool ret = true;
8779
    const char *name;
D
David Allan 已提交
8780

8781
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8782
        return false;
D
David Allan 已提交
8783 8784

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8785
        return false;
D
David Allan 已提交
8786 8787 8788 8789 8790 8791
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
8792
        ret = false;
D
David Allan 已提交
8793 8794 8795 8796 8797 8798 8799
    }

    virStorageVolFree(vol);
    return ret;
}


8800 8801 8802
/*
 * "vol-info" command
 */
8803
static const vshCmdInfo info_vol_info[] = {
8804 8805
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
8806 8807 8808
    {NULL, NULL}
};

8809
static const vshCmdOptDef opts_vol_info[] = {
8810
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8811
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8812 8813 8814
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8815
static bool
8816
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
8817 8818 8819
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
8820
    bool ret = true;
8821

8822
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8823
        return false;
8824 8825

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8826
        return false;
8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842

    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 已提交
8843
        ret = false;
8844 8845 8846 8847 8848 8849 8850 8851 8852 8853
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
8854
static const vshCmdInfo info_vol_dumpxml[] = {
8855 8856
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
8857 8858 8859
    {NULL, NULL}
};

8860
static const vshCmdOptDef opts_vol_dumpxml[] = {
8861
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8862
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8863 8864 8865
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8866
static bool
8867
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
8868 8869
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8870
    bool ret = true;
8871 8872
    char *dump;

8873
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8874
        return false;
8875 8876

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8877
        return false;
8878 8879 8880

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
8881
        vshPrint(ctl, "%s", dump);
8882
        VIR_FREE(dump);
8883
    } else {
E
Eric Blake 已提交
8884
        ret = false;
8885 8886 8887 8888 8889 8890 8891 8892 8893 8894
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
8895
static const vshCmdInfo info_vol_list[] = {
8896 8897
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
8898 8899 8900
    {NULL, NULL}
};

8901
static const vshCmdOptDef opts_vol_list[] = {
8902
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8903
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
8904 8905 8906
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8907
static bool
8908
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8909
{
8910
    virStorageVolInfo volumeInfo;
8911 8912
    virStoragePoolPtr pool;
    char **activeNames = NULL;
8913 8914 8915 8916 8917
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
8918 8919
    int ret;
    bool functionReturn;
8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930
    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;
8931

8932
    /* Check the connection to libvirtd daemon is still working */
8933
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8934
        return false;
8935

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

8940 8941
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
8942

8943 8944 8945
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8946
        return false;
8947 8948
    }

8949 8950 8951 8952 8953
    /* 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) {
8954
            vshError(ctl, "%s", _("Failed to list active vols"));
8955
            VIR_FREE(activeNames);
8956
            virStoragePoolFree(pool);
E
Eric Blake 已提交
8957
            return false;
8958 8959
        }

8960 8961 8962 8963 8964
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

8967 8968 8969 8970 8971
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
8972

8973 8974 8975 8976
        /* 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"));
8977 8978
        }

8979 8980 8981 8982 8983 8984 8985 8986 8987
        /* 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 */
8988

8989
                /* Volume type */
8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002
                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"));
                }
9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052

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

9054
        /* Cleanup memory allocation */
9055
        virStorageVolFree(vol);
9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073
    }

    /* 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 已提交
9074
        functionReturn = true;
9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105
        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 */
9106 9107 9108 9109 9110 9111 9112 9113 9114 9115
    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);
9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149

    /* 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 已提交
9150
    functionReturn = true;
9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164
    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 已提交
9165
    functionReturn = false;
9166 9167 9168 9169 9170 9171 9172 9173 9174 9175

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);
9176
        VIR_FREE(activeNames[i]);
9177
    }
9178 9179 9180 9181

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
9182
    VIR_FREE(activeNames);
9183
    virStoragePoolFree(pool);
9184 9185 9186

    /* Return the desired value */
    return functionReturn;
9187 9188 9189 9190 9191 9192
}


/*
 * "vol-name" command
 */
9193
static const vshCmdInfo info_vol_name[] = {
9194
    {"help", N_("returns the volume name for a given volume key or path")},
9195
    {"desc", ""},
9196 9197 9198
    {NULL, NULL}
};

9199
static const vshCmdOptDef opts_vol_name[] = {
9200
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
9201 9202 9203
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9204
static bool
9205
cmdVolName(vshControl *ctl, const vshCmd *cmd)
9206 9207 9208
{
    virStorageVolPtr vol;

9209
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9210
        return false;
9211

9212
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
9213
                                   VSH_BYUUID)))
E
Eric Blake 已提交
9214
        return false;
9215 9216 9217

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9218
    return true;
9219 9220 9221
}


J
Justin Clift 已提交
9222 9223 9224 9225 9226 9227 9228 9229 9230 9231
/*
 * "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[] = {
9232
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
9233 9234 9235 9236
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9237
static bool
J
Justin Clift 已提交
9238 9239 9240 9241
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9242
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
9243 9244

    /* Check the connection to libvirtd daemon is still working */
9245
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9246
        return false;
J
Justin Clift 已提交
9247 9248

    /* Use the supplied string to locate the volume */
9249
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
9250
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
9251
        return false;
J
Justin Clift 已提交
9252 9253 9254 9255 9256 9257 9258
    }

    /* 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 已提交
9259
        return false;
J
Justin Clift 已提交
9260 9261
    }

9262 9263 9264 9265 9266 9267 9268 9269 9270
    /* 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 已提交
9271 9272 9273 9274

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9275
    return true;
J
Justin Clift 已提交
9276 9277
}

9278 9279 9280 9281

/*
 * "vol-key" command
 */
9282
static const vshCmdInfo info_vol_key[] = {
9283
    {"help", N_("returns the volume key for a given volume name or path")},
9284
    {"desc", ""},
9285 9286 9287
    {NULL, NULL}
};

9288
static const vshCmdOptDef opts_vol_key[] = {
9289
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
9290
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9291 9292 9293
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9294
static bool
9295
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
9296 9297 9298
{
    virStorageVolPtr vol;

9299
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9300
        return false;
9301

9302
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9303
        return false;
9304 9305 9306

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9307
    return true;
9308 9309 9310 9311 9312 9313 9314
}



/*
 * "vol-path" command
 */
9315
static const vshCmdInfo info_vol_path[] = {
9316
    {"help", N_("returns the volume path for a given volume name or key")},
9317
    {"desc", ""},
9318 9319 9320
    {NULL, NULL}
};

9321
static const vshCmdOptDef opts_vol_path[] = {
9322
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
9323
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9324 9325 9326
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9327
static bool
9328
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
9329 9330
{
    virStorageVolPtr vol;
9331
    const char *name = NULL;
9332
    char * StorageVolPath;
9333

9334
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9335
        return false;
9336 9337

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9338
        return false;
9339
    }
9340

9341 9342 9343 9344 9345 9346 9347
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
9348
    virStorageVolFree(vol);
E
Eric Blake 已提交
9349
    return true;
9350 9351 9352
}


9353 9354 9355 9356
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
9357 9358
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
9359 9360
    {NULL, NULL}
};
9361

9362
static const vshCmdOptDef opts_secret_define[] = {
9363
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
9364 9365
    {NULL, 0, 0, NULL}
};
9366

E
Eric Blake 已提交
9367
static bool
9368 9369
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
9370
    const char *from = NULL;
9371
    char *buffer;
9372
    virSecretPtr res;
9373
    char uuid[VIR_UUID_STRING_BUFLEN];
9374

9375
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9376
        return false;
9377

9378
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9379
        return false;
9380 9381

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
9385
    VIR_FREE(buffer);
9386 9387

    if (res == NULL) {
9388
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
9389
        return false;
9390
    }
9391
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
9392
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
9393
        virSecretFree(res);
E
Eric Blake 已提交
9394
        return false;
9395 9396 9397
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
9398
    return true;
9399 9400 9401 9402 9403 9404
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
9405 9406
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
9407 9408 9409 9410
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
9411
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9412 9413 9414
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9415
static bool
9416 9417 9418
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9419
    bool ret = false;
9420 9421
    char *xml;

9422
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9423
        return false;
9424 9425 9426

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9427
        return false;
9428 9429 9430 9431

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
9432
    vshPrint(ctl, "%s", xml);
9433
    VIR_FREE(xml);
E
Eric Blake 已提交
9434
    ret = true;
9435 9436 9437 9438 9439 9440 9441 9442 9443 9444

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
9445 9446
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
9447 9448 9449 9450
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
9451 9452
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
9453 9454 9455
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9456
static bool
9457 9458 9459 9460
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
9461
    const char *base64 = NULL;
9462
    char *value;
E
Eric Blake 已提交
9463 9464
    int res;
    bool ret = false;
9465

9466
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9467
        return false;
9468 9469 9470

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

9473
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
9474 9475 9476
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
9477
        vshError(ctl, "%s", _("Invalid base64 data"));
9478 9479 9480
        goto cleanup;
    }
    if (value == NULL) {
9481
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
9482
        return false;
9483 9484 9485 9486
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
9487
    VIR_FREE(value);
9488 9489

    if (res != 0) {
9490
        vshError(ctl, "%s", _("Failed to set secret value"));
9491 9492 9493
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
9494
    ret = true;
9495 9496 9497 9498 9499 9500 9501 9502 9503 9504

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
9505 9506
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
9507 9508 9509 9510
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
9511
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9512 9513 9514
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9515
static bool
9516 9517 9518 9519 9520 9521
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
9522
    bool ret = false;
9523

9524
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9525
        return false;
9526 9527 9528

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9529
        return false;
9530 9531 9532 9533 9534 9535 9536

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
9537
    VIR_FREE(value);
9538 9539

    if (base64 == NULL) {
9540
        vshError(ctl, "%s", _("Failed to allocate memory"));
9541 9542
        goto cleanup;
    }
9543
    vshPrint(ctl, "%s", base64);
9544
    memset(base64, 0, strlen(base64));
9545
    VIR_FREE(base64);
E
Eric Blake 已提交
9546
    ret = true;
9547 9548 9549 9550 9551 9552 9553 9554 9555 9556

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
9557 9558
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
9559 9560 9561 9562
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
9563
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9564 9565 9566
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9567
static bool
9568 9569 9570
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9571
    bool ret = false;
9572
    const char *uuid;
9573

9574
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9575
        return false;
9576 9577 9578

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
9579
        return false;
9580 9581

    if (virSecretUndefine(secret) < 0) {
9582
        vshError(ctl, _("Failed to delete secret %s"), uuid);
9583 9584 9585
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
9586
    ret = true;
9587 9588 9589 9590 9591 9592 9593 9594 9595 9596

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
9597 9598
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
9599 9600 9601
    {NULL, NULL}
};

E
Eric Blake 已提交
9602
static bool
9603 9604 9605 9606 9607
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

9608
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9609
        return false;
9610 9611 9612

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
9613
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
9614
        return false;
9615 9616 9617 9618 9619
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
9620
        vshError(ctl, "%s", _("Failed to list secrets"));
9621
        VIR_FREE(uuids);
E
Eric Blake 已提交
9622
        return false;
9623 9624 9625 9626
    }

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

9627 9628
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
9629 9630

    for (i = 0; i < maxuuids; i++) {
9631 9632 9633 9634
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
9635
            VIR_FREE(uuids[i]);
9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653
            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);
9654
        VIR_FREE(uuids[i]);
9655
    }
9656
    VIR_FREE(uuids);
E
Eric Blake 已提交
9657
    return true;
9658
}
9659 9660 9661 9662 9663


/*
 * "version" command
 */
9664
static const vshCmdInfo info_version[] = {
9665 9666
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
9667 9668 9669
    {NULL, NULL}
};

9670 9671 9672 9673
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
9674

E
Eric Blake 已提交
9675
static bool
9676
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9677 9678 9679 9680 9681 9682
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
9683
    unsigned long daemonVersion;
9684 9685 9686 9687 9688
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

9689
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9690
        return false;
9691 9692 9693

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
9694
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
9695
        return false;
9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707
    }

    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) {
9708
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
9709
        return false;
9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726
    }
    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) {
9727
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
9728
        return false;
9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741
    }
    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);
    }
9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756

    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 已提交
9757
    return true;
9758 9759
}

9760 9761 9762 9763
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
9764
    {"help", N_("enumerate devices on this host")},
9765
    {"desc", ""},
9766 9767 9768 9769
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
9770 9771
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
9772 9773 9774
    {NULL, 0, 0, NULL}
};

9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796
#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] = '-';
9797 9798
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
9799 9800 9801
    }

    /* Print this device */
9802
    vshPrint(ctl, "%s", indentBuf);
9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825
    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) {
9826
        vshPrint(ctl, "%s", indentBuf);
9827
        vshPrint(ctl, " |\n");
9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849
    }

    /* 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) {
9850
        vshPrint(ctl, "%s", indentBuf);
9851 9852 9853 9854
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
9855
static bool
9856 9857
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
9858
    const char *cap = NULL;
9859
    char **devices;
9860
    int num_devices, i;
9861
    int tree = vshCommandOptBool(cmd, "tree");
9862

9863
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9864
        return false;
9865

9866
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
9867 9868 9869 9870
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
9871
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
9872
        return false;
9873
    } else if (num_devices == 0) {
E
Eric Blake 已提交
9874
        return true;
9875 9876 9877 9878 9879 9880
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
9881
        vshError(ctl, "%s", _("Failed to list node devices"));
9882
        VIR_FREE(devices);
E
Eric Blake 已提交
9883
        return false;
9884
    }
9885
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
9886 9887 9888 9889 9890 9891 9892
    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 已提交
9893
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912
            } 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++) {
9913 9914
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
9915
        }
9916
        VIR_FREE(parents);
9917 9918 9919
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
9920
            VIR_FREE(devices[i]);
9921
        }
9922
    }
9923
    VIR_FREE(devices);
E
Eric Blake 已提交
9924
    return true;
9925 9926 9927 9928 9929 9930
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
9931 9932
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
9933 9934 9935 9936 9937
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
9938
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9939 9940 9941
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9942
static bool
9943 9944
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
9945
    const char *name = NULL;
9946
    virNodeDevicePtr device;
L
Laine Stump 已提交
9947
    char *xml;
9948

9949
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9950
        return false;
9951
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9952
        return false;
9953
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9954
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9955
        return false;
9956 9957
    }

L
Laine Stump 已提交
9958 9959 9960
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
9961
        return false;
L
Laine Stump 已提交
9962 9963 9964
    }

    vshPrint(ctl, "%s\n", xml);
9965
    VIR_FREE(xml);
9966
    virNodeDeviceFree(device);
E
Eric Blake 已提交
9967
    return true;
9968 9969
}

9970 9971 9972 9973
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
9974 9975
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
9976 9977 9978 9979 9980
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
9981
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9982 9983 9984
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9985
static bool
9986 9987
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
9988
    const char *name = NULL;
9989
    virNodeDevicePtr device;
E
Eric Blake 已提交
9990
    bool ret = true;
9991

9992
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9993
        return false;
9994
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9995
        return false;
9996
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9997
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9998
        return false;
9999 10000 10001 10002 10003
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
10004
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
10005
        ret = false;
10006 10007 10008 10009 10010 10011 10012 10013 10014
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
10015 10016
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
10017 10018 10019 10020 10021
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
10022
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10023 10024 10025
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10026
static bool
10027 10028
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
10029
    const char *name = NULL;
10030
    virNodeDevicePtr device;
E
Eric Blake 已提交
10031
    bool ret = true;
10032

10033
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10034
        return false;
10035
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10036
        return false;
10037
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10038
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10039
        return false;
10040 10041 10042 10043 10044
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
10045
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
10046
        ret = false;
10047 10048 10049 10050 10051 10052 10053 10054 10055
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
10056 10057
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
10058 10059 10060 10061 10062
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
10063
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10064 10065 10066
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10067
static bool
10068 10069
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
10070
    const char *name = NULL;
10071
    virNodeDevicePtr device;
E
Eric Blake 已提交
10072
    bool ret = true;
10073

10074
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10075
        return false;
10076
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10077
        return false;
10078
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10079
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10080
        return false;
10081 10082 10083 10084 10085
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
10086
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
10087
        ret = false;
10088 10089 10090 10091 10092
    }
    virNodeDeviceFree(device);
    return ret;
}

10093
/*
E
Eric Blake 已提交
10094
 * "hostname" command
10095
 */
10096
static const vshCmdInfo info_hostname[] = {
10097
    {"help", N_("print the hypervisor hostname")},
10098
    {"desc", ""},
10099 10100 10101
    {NULL, NULL}
};

E
Eric Blake 已提交
10102
static bool
10103
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10104 10105 10106
{
    char *hostname;

10107
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10108
        return false;
10109 10110 10111

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
10112
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
10113
        return false;
10114 10115 10116
    }

    vshPrint (ctl, "%s\n", hostname);
10117
    VIR_FREE(hostname);
10118

E
Eric Blake 已提交
10119
    return true;
10120 10121 10122 10123 10124
}

/*
 * "uri" command
 */
10125
static const vshCmdInfo info_uri[] = {
10126
    {"help", N_("print the hypervisor canonical URI")},
10127
    {"desc", ""},
10128 10129 10130
    {NULL, NULL}
};

E
Eric Blake 已提交
10131
static bool
10132
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10133 10134 10135
{
    char *uri;

10136
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10137
        return false;
10138 10139 10140

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
10141
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
10142
        return false;
10143 10144 10145
    }

    vshPrint (ctl, "%s\n", uri);
10146
    VIR_FREE(uri);
10147

E
Eric Blake 已提交
10148
    return true;
10149 10150
}

E
Eric Blake 已提交
10151 10152 10153 10154 10155 10156 10157 10158 10159 10160
/*
 * "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 已提交
10161
static bool
E
Eric Blake 已提交
10162 10163 10164 10165 10166
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10167
        return false;
E
Eric Blake 已提交
10168 10169 10170 10171

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
10172
        return false;
E
Eric Blake 已提交
10173 10174 10175 10176 10177
    }

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

E
Eric Blake 已提交
10178
    return true;
E
Eric Blake 已提交
10179 10180
}

10181 10182 10183
/*
 * "vncdisplay" command
 */
10184
static const vshCmdInfo info_vncdisplay[] = {
10185 10186
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
10187 10188 10189
    {NULL, NULL}
};

10190
static const vshCmdOptDef opts_vncdisplay[] = {
10191
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10192 10193 10194
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10195
static bool
10196
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
10197 10198 10199 10200 10201
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10202
    bool ret = false;
10203 10204 10205
    int port = 0;
    char *doc;

10206
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10207
        return false;
10208

J
Jim Meyering 已提交
10209
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10210
        return false;
10211 10212 10213 10214 10215

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10216
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10217
    VIR_FREE(doc);
10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232
    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) ||
10233
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
10234 10235 10236 10237 10238 10239
        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 已提交
10240
    ret = true;
10241 10242 10243 10244

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10245
    xmlFreeDoc(xml);
10246 10247 10248 10249 10250 10251 10252
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
10253
static const vshCmdInfo info_ttyconsole[] = {
10254 10255
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
10256 10257 10258
    {NULL, NULL}
};

10259
static const vshCmdOptDef opts_ttyconsole[] = {
10260
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10261 10262 10263
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10264
static bool
10265
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
10266 10267 10268 10269 10270
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10271
    bool ret = false;
10272 10273
    char *doc;

10274
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10275
        return false;
10276

J
Jim Meyering 已提交
10277
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10278
        return false;
10279 10280 10281 10282 10283

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10284
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10285
    VIR_FREE(doc);
10286 10287 10288 10289 10290 10291 10292 10293 10294
    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 已提交
10295
    ret = true;
10296 10297 10298 10299

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10300
    xmlFreeDoc(xml);
10301 10302 10303 10304 10305 10306
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
10307
 */
10308
static const vshCmdInfo info_attach_device[] = {
10309 10310
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
10311 10312 10313
    {NULL, NULL}
};

10314
static const vshCmdOptDef opts_attach_device[] = {
10315 10316 10317
    {"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")},
10318 10319 10320
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10321
static bool
10322
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
10323 10324
{
    virDomainPtr dom;
10325
    const char *from = NULL;
10326
    char *buffer;
W
Wen Congyang 已提交
10327
    int ret;
J
Jim Fehlig 已提交
10328
    unsigned int flags;
10329

10330
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10331
        return false;
10332

J
Jim Meyering 已提交
10333
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10334
        return false;
10335

10336
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10337
        virDomainFree(dom);
E
Eric Blake 已提交
10338
        return false;
10339 10340
    }

10341
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10342
        virshReportError(ctl);
10343
        virDomainFree(dom);
E
Eric Blake 已提交
10344
        return false;
10345
    }
10346

J
Jim Fehlig 已提交
10347
    if (vshCommandOptBool(cmd, "persistent")) {
10348
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10349
        if (virDomainIsActive(dom) == 1)
10350
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10351 10352 10353 10354
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
10355
    VIR_FREE(buffer);
10356 10357

    if (ret < 0) {
10358
        vshError(ctl, _("Failed to attach device from %s"), from);
10359
        virDomainFree(dom);
E
Eric Blake 已提交
10360
        return false;
10361
    } else {
J
Jim Meyering 已提交
10362
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
10363 10364 10365
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10366
    return true;
10367 10368 10369 10370 10371 10372
}


/*
 * "detach-device" command
 */
10373
static const vshCmdInfo info_detach_device[] = {
10374 10375
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
10376 10377 10378
    {NULL, NULL}
};

10379
static const vshCmdOptDef opts_detach_device[] = {
10380 10381 10382
    {"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")},
10383 10384 10385
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10386
static bool
10387
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
10388 10389
{
    virDomainPtr dom;
10390
    const char *from = NULL;
10391
    char *buffer;
W
Wen Congyang 已提交
10392
    int ret;
J
Jim Fehlig 已提交
10393
    unsigned int flags;
10394

10395
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10396
        return false;
10397

J
Jim Meyering 已提交
10398
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10399
        return false;
10400

10401
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10402
        virDomainFree(dom);
E
Eric Blake 已提交
10403
        return false;
10404 10405
    }

10406
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10407
        virshReportError(ctl);
10408
        virDomainFree(dom);
E
Eric Blake 已提交
10409
        return false;
10410
    }
10411

J
Jim Fehlig 已提交
10412
    if (vshCommandOptBool(cmd, "persistent")) {
10413
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10414
        if (virDomainIsActive(dom) == 1)
10415
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10416 10417 10418 10419
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
10420
    VIR_FREE(buffer);
10421 10422

    if (ret < 0) {
10423
        vshError(ctl, _("Failed to detach device from %s"), from);
10424
        virDomainFree(dom);
E
Eric Blake 已提交
10425
        return false;
10426
    } else {
J
Jim Meyering 已提交
10427
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
10428 10429 10430
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10431
    return true;
10432 10433
}

10434

10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447
/*
 * "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")},
10448
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
10449 10450 10451
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10452
static bool
10453 10454 10455
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
10456
    const char *from = NULL;
10457
    char *buffer;
W
Wen Congyang 已提交
10458
    int ret;
10459 10460
    unsigned int flags;

10461
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10462
        return false;
10463 10464

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

10467
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10468
        virDomainFree(dom);
E
Eric Blake 已提交
10469
        return false;
10470 10471 10472
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10473
        virshReportError(ctl);
10474
        virDomainFree(dom);
E
Eric Blake 已提交
10475
        return false;
10476 10477 10478
    }

    if (vshCommandOptBool(cmd, "persistent")) {
10479
        flags = VIR_DOMAIN_AFFECT_CONFIG;
10480
        if (virDomainIsActive(dom) == 1)
10481
           flags |= VIR_DOMAIN_AFFECT_LIVE;
10482
    } else {
10483
        flags = VIR_DOMAIN_AFFECT_LIVE;
10484
    }
10485 10486 10487 10488

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

10489 10490 10491 10492 10493 10494
    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 已提交
10495
        return false;
10496 10497 10498 10499 10500
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10501
    return true;
10502 10503 10504
}


10505 10506 10507
/*
 * "attach-interface" command
 */
10508
static const vshCmdInfo info_attach_interface[] = {
10509 10510
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
10511 10512 10513
    {NULL, NULL}
};

10514
static const vshCmdOptDef opts_attach_interface[] = {
10515 10516 10517 10518 10519 10520
    {"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")},
10521
    {"model", VSH_OT_DATA, 0, N_("model type")},
10522
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
10523 10524 10525
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10526
static bool
10527
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
10528 10529
{
    virDomainPtr dom = NULL;
10530 10531
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
10532
    int typ;
W
Wen Congyang 已提交
10533 10534
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
10535
    unsigned int flags;
10536 10537
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10538

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

J
Jim Meyering 已提交
10542
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10543 10544
        goto cleanup;

10545
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10546 10547
        goto cleanup;

10548 10549 10550 10551
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
10552 10553
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
10554
        goto cleanup;
10555
    }
10556 10557

    /* check interface type */
10558
    if (STREQ(type, "network")) {
10559
        typ = 1;
10560
    } else if (STREQ(type, "bridge")) {
10561 10562
        typ = 2;
    } else {
E
Eric Blake 已提交
10563 10564
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
10565 10566 10567 10568
        goto cleanup;
    }

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

10571
    if (typ == 1)
10572
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
10573
    else if (typ == 2)
10574
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
10575

10576
    if (target != NULL)
10577
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10578
    if (mac != NULL)
10579
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
10580
    if (script != NULL)
10581
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
10582
    if (model != NULL)
10583
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
10584

10585
    virBufferAddLit(&buf, "</interface>\n");
10586

10587 10588
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
10589
        goto cleanup;
10590 10591
    }

10592
    xml = virBufferContentAndReset(&buf);
10593

J
Jim Fehlig 已提交
10594
    if (vshCommandOptBool(cmd, "persistent")) {
10595
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10596
        if (virDomainIsActive(dom) == 1)
10597
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10598
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
10599
    } else {
10600
        ret = virDomainAttachDevice(dom, xml);
10601
    }
10602

10603 10604
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10605
    if (ret != 0) {
L
Laine Stump 已提交
10606
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
10607 10608
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
10609
        functionReturn = true;
J
Jim Fehlig 已提交
10610
    }
10611 10612 10613 10614

 cleanup:
    if (dom)
        virDomainFree(dom);
10615
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10616
    return functionReturn;
10617 10618 10619 10620 10621
}

/*
 * "detach-interface" command
 */
10622
static const vshCmdInfo info_detach_interface[] = {
10623 10624
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
10625 10626 10627
    {NULL, NULL}
};

10628
static const vshCmdOptDef opts_detach_interface[] = {
10629 10630 10631 10632
    {"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")},
10633 10634 10635
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10636
static bool
10637
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
10638 10639 10640 10641 10642 10643 10644
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
10645
    const char *mac =NULL, *type = NULL;
10646
    char *doc;
10647
    char buf[64];
E
Eric Blake 已提交
10648
    int i = 0, diff_mac;
W
Wen Congyang 已提交
10649 10650
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
10651
    unsigned int flags;
10652

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

J
Jim Meyering 已提交
10656
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10657 10658
        goto cleanup;

10659
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10660 10661
        goto cleanup;

10662 10663
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
10664
        goto cleanup;
10665
    }
10666 10667 10668 10669 10670

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10671
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10672
    VIR_FREE(doc);
10673
    if (!xml) {
10674
        vshError(ctl, "%s", _("Failed to get interface information"));
10675 10676 10677
        goto cleanup;
    }

E
Eric Blake 已提交
10678
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
10679 10680 10681
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10682
        vshError(ctl, _("No found interface whose type is %s"), type);
10683 10684 10685
        goto cleanup;
    }

10686 10687 10688 10689 10690 10691
    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;
    }

10692 10693 10694 10695 10696 10697 10698
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10699 10700 10701 10702 10703
            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);
10704 10705 10706 10707 10708 10709 10710
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10711
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
10712 10713 10714 10715 10716
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10717
        vshError(ctl, "%s", _("Failed to allocate memory"));
10718 10719 10720
        goto cleanup;
    }

10721
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
10722
        vshError(ctl, "%s", _("Failed to create XML"));
10723 10724 10725
        goto cleanup;
    }

J
Jim Fehlig 已提交
10726
    if (vshCommandOptBool(cmd, "persistent")) {
10727
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10728
        if (virDomainIsActive(dom) == 1)
10729
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10730 10731 10732 10733 10734 10735 10736 10737
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10738
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
10739
    } else {
J
Jim Meyering 已提交
10740
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
10741
        functionReturn = true;
10742
    }
10743 10744 10745 10746

 cleanup:
    if (dom)
        virDomainFree(dom);
10747
    xmlXPathFreeObject(obj);
10748
    xmlXPathFreeContext(ctxt);
10749 10750
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
10751
    return functionReturn;
10752 10753 10754 10755 10756
}

/*
 * "attach-disk" command
 */
10757
static const vshCmdInfo info_attach_disk[] = {
10758 10759
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
10760 10761 10762
    {NULL, NULL}
};

10763
static const vshCmdOptDef opts_attach_disk[] = {
10764 10765 10766 10767 10768
    {"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")},
10769
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
10770 10771 10772
    {"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")},
10773
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
10774 10775 10776
    {"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")},
10777 10778 10779
    {NULL, 0, 0, NULL}
};

10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926
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 已提交
10927
static bool
10928
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
10929 10930
{
    virDomainPtr dom = NULL;
10931
    const char *source = NULL, *target = NULL, *driver = NULL,
10932 10933 10934
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
10935 10936
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
10937
    unsigned int flags;
10938
    const char *stype = NULL;
10939 10940
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10941

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

J
Jim Meyering 已提交
10945
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10946 10947
        goto cleanup;

10948
    if (vshCommandOptString(cmd, "source", &source) <= 0)
10949 10950
        goto cleanup;

10951
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10952 10953
        goto cleanup;

10954 10955 10956 10957
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
10958 10959 10960
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
10961
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
10962
        vshError(ctl, "%s", _("missing option"));
10963 10964
        goto cleanup;
    }
10965

10966 10967
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
10968
            isFile = true;
10969
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
10970
        isFile = true;
10971 10972 10973
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
10974 10975 10976
    }

    if (mode) {
10977
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
10978 10979
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
10980 10981 10982 10983 10984
            goto cleanup;
        }
    }

    /* Make XML of disk */
10985
    virBufferAsprintf(&buf, "<disk type='%s'",
10986 10987
                      (isFile) ? "file" : "block");
    if (type)
10988
        virBufferAsprintf(&buf, " device='%s'", type);
10989 10990
    virBufferAddLit(&buf, ">\n");

10991
    if (driver || subdriver)
10992
        virBufferAsprintf(&buf, "  <driver");
10993 10994

    if (driver)
10995
        virBufferAsprintf(&buf, " name='%s'", driver);
10996
    if (subdriver)
10997
        virBufferAsprintf(&buf, " type='%s'", subdriver);
10998 10999
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
11000

11001
    if (driver || subdriver || cache)
11002
        virBufferAddLit(&buf, "/>\n");
11003

11004
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
11005 11006
                      (isFile) ? "file" : "dev",
                      source);
11007
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11008
    if (mode)
11009
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
11010

11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058
    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;
            }
        }
    }

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

11061 11062
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
11063
        return false;
11064 11065
    }

11066
    xml = virBufferContentAndReset(&buf);
11067

J
Jim Fehlig 已提交
11068
    if (vshCommandOptBool(cmd, "persistent")) {
11069
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11070
        if (virDomainIsActive(dom) == 1)
11071
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11072
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
11073
    } else {
11074
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
11075
    }
11076

11077 11078
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11079
    if (ret != 0) {
L
Laine Stump 已提交
11080
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
11081 11082
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
11083
        functionReturn = true;
J
Jim Fehlig 已提交
11084
    }
11085 11086 11087 11088

 cleanup:
    if (dom)
        virDomainFree(dom);
11089
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11090
    return functionReturn;
11091 11092 11093 11094 11095
}

/*
 * "detach-disk" command
 */
11096
static const vshCmdInfo info_detach_disk[] = {
11097 11098
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
11099 11100 11101
    {NULL, NULL}
};

11102
static const vshCmdOptDef opts_detach_disk[] = {
11103 11104 11105
    {"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")},
11106 11107 11108
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11109
static bool
11110
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
11111 11112 11113 11114 11115 11116 11117
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
11118
    const char *target = NULL;
11119
    char *doc;
E
Eric Blake 已提交
11120
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
11121 11122
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11123
    unsigned int flags;
11124

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

J
Jim Meyering 已提交
11128
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11129 11130
        goto cleanup;

11131
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11132 11133 11134 11135 11136 11137
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11138
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
11139
    VIR_FREE(doc);
11140
    if (!xml) {
11141
        vshError(ctl, "%s", _("Failed to get disk information"));
11142 11143 11144 11145 11146 11147
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11148
        vshError(ctl, "%s", _("Failed to get disk information"));
11149 11150 11151 11152 11153 11154 11155
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11156 11157 11158 11159 11160
            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);
11161 11162 11163 11164 11165 11166 11167
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11168
    vshError(ctl, _("No found disk whose target is %s"), target);
11169 11170 11171 11172 11173
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11174
        vshError(ctl, "%s", _("Failed to allocate memory"));
11175 11176 11177
        goto cleanup;
    }

11178
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
11179
        vshError(ctl, "%s", _("Failed to create XML"));
11180 11181 11182
        goto cleanup;
    }

J
Jim Fehlig 已提交
11183
    if (vshCommandOptBool(cmd, "persistent")) {
11184
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11185
        if (virDomainIsActive(dom) == 1)
11186
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11187 11188 11189 11190 11191 11192 11193 11194
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11195
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
11196
    } else {
J
Jim Meyering 已提交
11197
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
11198
        functionReturn = true;
11199
    }
11200 11201

 cleanup:
11202
    xmlXPathFreeObject(obj);
11203
    xmlXPathFreeContext(ctxt);
11204 11205
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
11206 11207
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
11208
    return functionReturn;
11209 11210
}

11211 11212 11213 11214
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
11215 11216
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
11217 11218 11219 11220
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
11221
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
11222 11223 11224
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11225
static bool
11226 11227
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
11228
    const char *from = NULL;
E
Eric Blake 已提交
11229
    bool ret = true;
11230 11231 11232
    char *buffer;
    int result;

11233
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11234
        return false;
11235

11236
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11237
        return false;
11238 11239

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
11243
    VIR_FREE(buffer);
11244 11245 11246 11247 11248

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
11249
        ret = false;
11250 11251 11252 11253 11254
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
11255
        ret = true;
11256 11257 11258 11259 11260
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
11261
        ret = true;
11262 11263 11264 11265 11266
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
11267
        ret = false;
11268 11269 11270 11271 11272
    }

    return ret;
}

11273 11274 11275 11276
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
11277 11278
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
11279 11280 11281 11282
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
11283
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
11284 11285 11286
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11287
static bool
11288 11289
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
11290
    const char *from = NULL;
E
Eric Blake 已提交
11291
    bool ret = true;
11292 11293 11294 11295 11296
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
11297
    xmlNodePtr node_list;
11298 11299 11300 11301 11302 11303
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

11304
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11305
        return false;
11306

11307
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11308
        return false;
11309 11310

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
11311
        return false;
11312 11313 11314 11315 11316

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

L
Laine Stump 已提交
11317 11318
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
11319 11320
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
11321
        ret = false;
11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357
        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 已提交
11358
        ret = false;
11359 11360 11361 11362 11363 11364 11365 11366
        goto cleanup;
    }

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

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
11367
        ret = false;
11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384

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 已提交
11385
    ret = false;
11386
    goto cleanup;
11387 11388
}

11389 11390 11391 11392 11393 11394 11395 11396
/* 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;

11397
    ret = vshMalloc(ctl, PATH_MAX);
11398 11399 11400

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
11401 11402
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
11403
    if (fd == -1) {
11404
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
11405
                 strerror(errno));
11406
        VIR_FREE(ret);
11407 11408 11409 11410
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
11411 11412
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
11413
        VIR_FORCE_CLOSE(fd);
11414
        unlink (ret);
11415
        VIR_FREE(ret);
11416 11417
        return NULL;
    }
S
Stefan Berger 已提交
11418
    if (VIR_CLOSE(fd) < 0) {
11419 11420
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
11421
        unlink (ret);
11422
        VIR_FREE(ret);
11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437
        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 已提交
11438 11439 11440 11441
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
11442

11443
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
11444 11445 11446 11447
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
11448

11449 11450 11451 11452 11453
    /* 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 已提交
11454 11455
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
11456
     */
E
Eric Blake 已提交
11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468
    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);
11469 11470
    }

E
Eric Blake 已提交
11471 11472 11473 11474 11475 11476 11477
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
11478
    }
E
Eric Blake 已提交
11479
    ret = 0;
11480

E
Eric Blake 已提交
11481 11482 11483
cleanup:
    virCommandFree(cmd);
    return ret;
11484 11485 11486 11487 11488 11489 11490 11491
}

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

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
11492
        vshError(ctl,
11493
                 _("%s: failed to read temporary file: %s"),
11494
                 filename, strerror(errno));
11495 11496 11497 11498 11499
        return NULL;
    }
    return ret;
}

11500

P
Paolo Bonzini 已提交
11501 11502 11503 11504
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
11505 11506
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
11507 11508 11509 11510
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11515
static bool
11516
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
11517
{
11518
    const char *dir = NULL;
11519
    char *dir_malloced = NULL;
E
Eric Blake 已提交
11520
    bool ret = true;
P
Paolo Bonzini 已提交
11521 11522

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

11527
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
11528
        uid_t uid = geteuid();
11529
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
11530 11531 11532 11533
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
11534
    if (chdir(dir) == -1) {
11535
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
11536
        ret = false;
P
Paolo Bonzini 已提交
11537 11538
    }

11539
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
11540
    return ret;
P
Paolo Bonzini 已提交
11541 11542 11543 11544 11545 11546
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
11547 11548
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
11549 11550 11551
    {NULL, NULL}
};

E
Eric Blake 已提交
11552
static bool
P
Paolo Bonzini 已提交
11553 11554 11555
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
11556
    bool ret = true;
P
Paolo Bonzini 已提交
11557

11558 11559
    cwd = getcwd(NULL, 0);
    if (!cwd) {
11560 11561
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
11562 11563
        ret = false;
    } else {
P
Paolo Bonzini 已提交
11564
        vshPrint (ctl, _("%s\n"), cwd);
11565 11566
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
11567

11568
    return ret;
P
Paolo Bonzini 已提交
11569 11570
}

E
Eric Blake 已提交
11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582
/*
 * "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")},
11583
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
11584 11585 11586 11587 11588 11589
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
11590
static bool
E
Eric Blake 已提交
11591 11592 11593 11594 11595
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
11596
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
11597 11598 11599 11600 11601 11602 11603 11604
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

11605
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
11606 11607 11608
        bool close_quote = false;
        char *q;

11609
        arg = opt->data;
E
Eric Blake 已提交
11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637
        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 已提交
11638
        return false;
E
Eric Blake 已提交
11639 11640 11641 11642 11643
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
11644
    return true;
E
Eric Blake 已提交
11645 11646
}

11647 11648 11649 11650
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
11651 11652
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
11653 11654 11655 11656
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
11657
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11658 11659 11660 11661 11662 11663
    {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 已提交
11664
static bool
11665 11666
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
11667
    bool ret = false;
11668 11669 11670 11671 11672
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
11673
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
11674

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

J
Jim Meyering 已提交
11678
    dom = vshCommandOptDomain (ctl, cmd, NULL);
11679 11680 11681 11682
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
11683
    doc = virDomainGetXMLDesc (dom, flags);
11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701
    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 已提交
11702
        ret = true;
11703 11704 11705 11706 11707 11708 11709
        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.
     */
11710
    doc_reread = virDomainGetXMLDesc (dom, flags);
11711 11712 11713 11714
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
11715 11716
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728
        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 已提交
11729
    ret = true;
11730 11731 11732 11733 11734

 cleanup:
    if (dom)
        virDomainFree (dom);

11735 11736 11737
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
11738 11739 11740

    if (tmp) {
        unlink (tmp);
11741
        VIR_FREE(tmp);
11742 11743 11744 11745 11746
    }

    return ret;
}

11747

11748 11749 11750 11751
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
11752 11753
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
11754 11755 11756 11757
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
11758
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
11759 11760 11761 11762 11763 11764 11765 11766 11767 11768
    {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[] = {
11769 11770
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
11771 11772 11773 11774
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
11775
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
11776 11777 11778 11779 11780 11781
    {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 已提交
11782 11783 11784
/*
 * "quit" command
 */
11785
static const vshCmdInfo info_quit[] = {
11786
    {"help", N_("quit this interactive terminal")},
11787
    {"desc", ""},
11788
    {NULL, NULL}
K
Karel Zak 已提交
11789 11790
};

E
Eric Blake 已提交
11791
static bool
11792
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11793
{
E
Eric Blake 已提交
11794 11795
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
11796 11797
}

11798 11799 11800 11801
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
11802 11803
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
11804 11805 11806 11807 11808 11809 11810 11811 11812
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11813
static bool
11814 11815 11816
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11817
    bool ret = false;
11818
    const char *from = NULL;
11819 11820 11821 11822 11823 11824 11825
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

11826
    if (!vshConnectionUsability(ctl, ctl->conn))
11827 11828 11829 11830 11831 11832
        goto cleanup;

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

11833
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
11834
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857
    else {
        if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
            /* we have to report the error here because during cleanup
             * we'll run through virDomainFree(), which loses the
             * last error
             */
            virshReportError(ctl);
            goto cleanup;
        }
    }
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

    snapshot = virDomainSnapshotCreateXML(dom, buffer, 0);
    if (snapshot == NULL)
        goto cleanup;

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

11858
    xml = virXMLParseStringCtxt(doc, "domainsnapshot.xml", &ctxt);
11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873
    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;
    }

    vshPrint(ctl, _("Domain snapshot %s created"), name);
    if (from)
        vshPrint(ctl, _(" from '%s'"), from);
    vshPrint(ctl, "\n");

E
Eric Blake 已提交
11874
    ret = true;
11875 11876 11877 11878

cleanup:
    VIR_FREE(name);
    xmlXPathFreeContext(ctxt);
11879
    xmlFreeDoc(xml);
11880 11881 11882 11883 11884 11885 11886 11887 11888 11889
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902
/*
 * "snapshot-create-as" command
 */
static const vshCmdInfo info_snapshot_create_as[] = {
    {"help", N_("Create a snapshot from a set of args")},
    {"desc", N_("Create a snapshot (disk and RAM) from arguments")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_create_as[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"name", VSH_OT_DATA, 0, N_("name of snapshot")},
    {"description", VSH_OT_DATA, 0, N_("description of snapshot")},
E
Eric Blake 已提交
11903
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    const char *name = NULL;
    const char *desc = NULL;
    char *parsed_name = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    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)
11937
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
11938
    if (desc)
11939
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
11940 11941 11942 11943 11944 11945 11946 11947
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
11948 11949 11950 11951 11952 11953
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

11954 11955 11956 11957 11958 11959 11960 11961
    snapshot = virDomainSnapshotCreateXML(dom, buffer, 0);
    if (snapshot == NULL)
        goto cleanup;

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

11962
    xml = virXMLParseStringCtxt(doc, "domainsnapshot.xml", &ctxt);
11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979
    if (!xml)
        goto cleanup;

    parsed_name = virXPathString("string(/domainsnapshot/name)", ctxt);
    if (!parsed_name) {
        vshError(ctl, "%s",
                 _("Could not find 'name' element in domain snapshot XML"));
        goto cleanup;
    }

    vshPrint(ctl, _("Domain snapshot %s created\n"), name ? name : parsed_name);

    ret = true;

cleanup:
    VIR_FREE(parsed_name);
    xmlXPathFreeContext(ctxt);
11980
    xmlFreeDoc(xml);
11981 11982 11983 11984 11985 11986 11987 11988 11989 11990
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
    {"help", N_("Get the current snapshot")},
    {"desc", N_("Get the current snapshot")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12002
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
12003 12004 12005
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12006
static bool
12007 12008 12009
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12010
    bool ret = false;
12011 12012
    int current;
    virDomainSnapshotPtr snapshot = NULL;
12013
    char *xml = NULL;
12014

12015
    if (!vshConnectionUsability(ctl, ctl->conn))
12016 12017 12018 12019 12020 12021 12022 12023 12024 12025
        goto cleanup;

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

    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
12026
        char *name = NULL;
12027 12028 12029 12030 12031 12032 12033 12034

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

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

12035 12036 12037 12038
        if (vshCommandOptBool(cmd, "name")) {
            xmlDocPtr xmldoc = NULL;
            xmlXPathContextPtr ctxt = NULL;

12039
            xmldoc = virXMLParseStringCtxt(xml, "domainsnapshot.xml", &ctxt);
12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051
            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);
12052 12053
    }

E
Eric Blake 已提交
12054
    ret = true;
12055 12056

cleanup:
12057
    VIR_FREE(xml);
12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-list" command
 */
static const vshCmdInfo info_snapshot_list[] = {
    {"help", N_("List snapshots for a domain")},
    {"desc", N_("Snapshot List")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
12080
static bool
12081 12082 12083
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12084
    bool ret = false;
12085 12086
    int numsnaps;
    char **names = NULL;
12087
    int actual = 0;
12088 12089 12090 12091 12092 12093
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
12094 12095
    long long creation_longlong;
    time_t creation_time_t;
12096 12097 12098
    char timestr[100];
    struct tm time_info;

12099
    if (!vshConnectionUsability(ctl, ctl->conn))
12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110
        goto cleanup;

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

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

12111 12112
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129

    if (numsnaps) {
        if (VIR_ALLOC_N(names, numsnaps) < 0)
            goto cleanup;

        actual = virDomainSnapshotListNames(dom, names, numsnaps, 0);
        if (actual < 0)
            goto cleanup;

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

        for (i = 0; i < actual; i++) {
            /* free up memory from previous iterations of the loop */
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
12130
            xmlFreeDoc(xml);
12131 12132 12133 12134 12135 12136 12137 12138 12139 12140
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

12141
            xml = virXMLParseStringCtxt(doc, "domainsnapshot.xml", &ctxt);
12142 12143 12144 12145 12146 12147
            if (!xml)
                continue;

            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
12148 12149
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
12150
                continue;
12151 12152 12153 12154 12155 12156
            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);
12157
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
12158 12159 12160 12161 12162

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

E
Eric Blake 已提交
12163
    ret = true;
12164 12165 12166 12167 12168 12169 12170

cleanup:
    /* this frees up memory from the last iteration of the loop */
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    xmlXPathFreeContext(ctxt);
12171
    xmlFreeDoc(xml);
12172
    VIR_FREE(doc);
12173 12174
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196
    VIR_FREE(names);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-dumpxml" command
 */
static const vshCmdInfo info_snapshot_dumpxml[] = {
    {"help", N_("Dump XML for a domain snapshot")},
    {"desc", N_("Snapshot Dump XML")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
12197
static bool
12198 12199 12200
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12201
    bool ret = false;
12202
    const char *name = NULL;
12203 12204 12205
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

12206
    if (!vshConnectionUsability(ctl, ctl->conn))
12207 12208 12209 12210 12211 12212
        goto cleanup;

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

12213
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12214 12215 12216 12217 12218 12219 12220 12221 12222 12223
        goto cleanup;

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

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

12224
    vshPrint(ctl, "%s", xml);
12225

E
Eric Blake 已提交
12226
    ret = true;
12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237

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

    return ret;
}

E
Eric Blake 已提交
12238 12239 12240 12241
/*
 * "snapshot-parent" command
 */
static const vshCmdInfo info_snapshot_parent[] = {
E
Eric Blake 已提交
12242
    {"help", N_("Get the name of the parent of a snapshot")},
E
Eric Blake 已提交
12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282
    {"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;

12283
    xmldoc = virXMLParseStringCtxt(xml, "domainsnapshot.xml", &ctxt);
E
Eric Blake 已提交
12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297
    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);
12298
    xmlFreeDoc(xmldoc);
E
Eric Blake 已提交
12299 12300 12301 12302 12303 12304 12305 12306 12307
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12308
/*
12309
 * "snapshot-revert" command
12310
 */
12311
static const vshCmdInfo info_snapshot_revert[] = {
12312 12313 12314 12315 12316
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

12317
static const vshCmdOptDef opts_snapshot_revert[] = {
12318 12319 12320 12321 12322
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12323
static bool
12324
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
12325 12326
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12327
    bool ret = false;
12328
    const char *name = NULL;
12329 12330
    virDomainSnapshotPtr snapshot = NULL;

12331
    if (!vshConnectionUsability(ctl, ctl->conn))
12332 12333 12334 12335 12336 12337
        goto cleanup;

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

12338
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12339 12340 12341 12342 12343 12344 12345 12346 12347
        goto cleanup;

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

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

E
Eric Blake 已提交
12348
    ret = true;
12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374

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

    return ret;
}

/*
 * "snapshot-delete" command
 */
static const vshCmdInfo info_snapshot_delete[] = {
    {"help", N_("Delete a domain snapshot")},
    {"desc", N_("Snapshot Delete")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_delete[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {"children", VSH_OT_BOOL, 0, N_("delete snapshot and all children")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12375
static bool
12376 12377 12378
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12379
    bool ret = false;
12380
    const char *name = NULL;
12381 12382 12383
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

12384
    if (!vshConnectionUsability(ctl, ctl->conn))
12385 12386 12387 12388 12389 12390
        goto cleanup;

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

12391
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12392 12393 12394 12395 12396 12397 12398 12399 12400
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;

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

12401 12402 12403 12404
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
        vshPrint(ctl, _("Domain snapshot %s deleted\n"), name);
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
12405
        goto cleanup;
12406
    }
12407

E
Eric Blake 已提交
12408
    ret = true;
12409 12410 12411 12412 12413 12414 12415 12416 12417 12418

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

    return ret;
}

12419 12420 12421 12422
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
12423 12424
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
12425 12426 12427 12428 12429
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12430
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
12431
    {"cmd", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("command")},
12432 12433 12434
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12435
static bool
12436 12437 12438
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12439
    bool ret = false;
12440
    char *monitor_cmd = NULL;
12441
    char *result = NULL;
12442
    unsigned int flags = 0;
12443 12444 12445
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
12446 12447 12448 12449 12450 12451 12452 12453

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

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

12454 12455 12456 12457 12458 12459 12460 12461
    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"));
12462 12463
        goto cleanup;
    }
12464
    monitor_cmd = virBufferContentAndReset(&buf);
12465

12466 12467 12468 12469
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
12470 12471 12472 12473
        goto cleanup;

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

E
Eric Blake 已提交
12474
    ret = true;
12475 12476 12477

cleanup:
    VIR_FREE(result);
12478
    VIR_FREE(monitor_cmd);
12479 12480 12481 12482 12483 12484
    if (dom)
        virDomainFree(dom);

    return ret;
}

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

12531
static const vshCmdDef domManagementCmds[] = {
12532 12533 12534 12535 12536 12537 12538 12539
    {"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},
12540 12541
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
12542
#ifndef WIN32
12543
    {"console", cmdConsole, opts_console, info_console, 0},
12544
#endif
12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567
    {"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},
12568
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
12569 12570 12571 12572 12573 12574 12575 12576
    {"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},
12577 12578
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
12579 12580 12581 12582
    {"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},
12583 12584 12585 12586 12587 12588
    {"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},
12589
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
12590
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602
    {"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 已提交
12603
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
12604
    {"version", cmdVersion, opts_version, info_version, 0},
12605 12606
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
12607 12608 12609
};

static const vshCmdDef domMonitoringCmds[] = {
12610 12611
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
12612
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
12613 12614 12615 12616 12617 12618
    {"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}
12619 12620 12621
};

static const vshCmdDef storagePoolCmds[] = {
12622
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
12623
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
12624
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645
     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}
12646 12647 12648
};

static const vshCmdDef storageVolCmds[] = {
12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666
    {"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}
12667
};
12668

12669
static const vshCmdDef networkCmds[] = {
12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688
    {"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}
12689
};
12690

12691
static const vshCmdDef nodedevCmds[] = {
12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706
    {"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}
12707 12708 12709
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
12710 12711 12712 12713
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727
    {"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 已提交
12728 12729
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
12730 12731 12732 12733 12734
    {"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}
12735
};
12736

12737
static const vshCmdDef nwfilterCmds[] = {
12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748
    {"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}
12749
};
12750

12751
static const vshCmdDef secretCmds[] = {
12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763
    {"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}
12764
};
12765

12766
static const vshCmdDef virshCmds[] = {
12767 12768 12769 12770 12771 12772 12773
    {"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}
12774
};
12775

12776
static const vshCmdDef snapshotCmds[] = {
12777 12778
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
12779 12780
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
12781 12782 12783 12784 12785 12786 12787 12788
    {"snapshot-current", cmdSnapshotCurrent, opts_snapshot_current,
     info_snapshot_current, 0},
    {"snapshot-delete", cmdSnapshotDelete, opts_snapshot_delete,
     info_snapshot_delete, 0},
    {"snapshot-dumpxml", cmdSnapshotDumpXML, opts_snapshot_dumpxml,
     info_snapshot_dumpxml, 0},
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
E
Eric Blake 已提交
12789 12790
    {"snapshot-parent", cmdSnapshotParent, opts_snapshot_parent,
     info_snapshot_parent, 0},
12791 12792 12793
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
12794
};
12795

12796
static const vshCmdDef hostAndHypervisorCmds[] = {
12797 12798 12799 12800 12801
    {"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},
12802
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
12803
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
12804
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
12805
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
12806 12807 12808 12809 12810
    {"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 已提交
12811 12812
};

12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829
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 已提交
12830 12831 12832 12833
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
12834
static const char *
12835
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
12836
{
12837
    const vshCmdInfo *info;
12838

K
Karel Zak 已提交
12839
    for (info = cmd->info; info && info->name; info++) {
12840
        if (STREQ(info->name, name))
K
Karel Zak 已提交
12841 12842 12843 12844 12845
            return info->data;
    }
    return NULL;
}

12846
static int
E
Eric Blake 已提交
12847
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
12848 12849 12850 12851 12852
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
12853 12854 12855
    *opts_need_arg = 0;
    *opts_required = 0;

12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868
    if (!cmd->opts)
        return 0;

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

        if (i > 31)
            return -1; /* too many options */
        if (opt->type == VSH_OT_BOOL) {
            if (opt->flag & VSH_OFLAG_REQ)
                return -1; /* bool options can't be mandatory */
            continue;
        }
L
Lai Jiangshan 已提交
12869 12870 12871 12872 12873 12874
        if (opt->flag & VSH_OFLAG_REQ_OPT) {
            if (opt->flag & VSH_OFLAG_REQ)
                *opts_required |= 1 << i;
            continue;
        }

12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886
        *opts_need_arg |= 1 << i;
        if (opt->flag & VSH_OFLAG_REQ) {
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
    }
    return 0;
}

12887
static const vshCmdOptDef *
12888 12889
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
12890
{
12891 12892 12893 12894
    int i;

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

12896 12897 12898 12899 12900
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
12901 12902 12903 12904 12905
            if (opt->type == VSH_OT_ARGV) {
                vshError(ctl, _("variable argument <%s> "
                         "should not be used with --<%s>"), name, name);
                return NULL;
            }
12906
            *opts_seen |= 1 << i;
K
Karel Zak 已提交
12907
            return opt;
12908 12909 12910 12911 12912
        }
    }

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

12916
static const vshCmdOptDef *
12917 12918
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
12919
{
12920
    int i;
12921
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
12922

12923 12924 12925 12926
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
12927
    i = ffs(*opts_need_arg) - 1;
12928 12929 12930 12931 12932
    opt = &cmd->opts[i];
    if (opt->type != VSH_OT_ARGV)
        *opts_need_arg &= ~(1 << i);
    *opts_seen |= 1 << i;
    return opt;
K
Karel Zak 已提交
12933 12934
}

12935 12936 12937
/*
 * Checks for required options
 */
12938
static int
12939 12940
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
12941
{
12942
    const vshCmdDef *def = cmd->def;
12943 12944 12945 12946 12947 12948 12949 12950 12951
    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];
12952

12953
            vshError(ctl,
12954
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
12955 12956 12957
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
12958 12959
        }
    }
12960
    return -1;
12961 12962
}

12963
static const vshCmdDef *
12964 12965
vshCmddefSearch(const char *cmdname)
{
12966
    const vshCmdGrp *g;
12967
    const vshCmdDef *c;
12968

12969 12970
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
12971
            if (STREQ(c->name, cmdname))
12972 12973 12974 12975
                return c;
        }
    }

K
Karel Zak 已提交
12976 12977 12978
    return NULL;
}

12979 12980 12981 12982 12983 12984
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
12985
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
12986 12987 12988 12989 12990 12991
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
12992
static bool
12993 12994 12995 12996 12997 12998 12999
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 已提交
13000
        return false;
13001 13002 13003 13004 13005 13006 13007 13008 13009 13010
    } 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 已提交
13011
    return true;
13012 13013
}

E
Eric Blake 已提交
13014
static bool
13015
vshCmddefHelp(vshControl *ctl, const char *cmdname)
13016
{
13017
    const vshCmdDef *def = vshCmddefSearch(cmdname);
13018

K
Karel Zak 已提交
13019
    if (!def) {
13020
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
13021
        return false;
13022
    } else {
E
Eric Blake 已提交
13023 13024
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
13025
        const char *help = _(vshCmddefGetInfo(def, "help"));
13026
        char buf[256];
13027 13028 13029 13030 13031 13032
        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 已提交
13033
            return false;
13034
        }
K
Karel Zak 已提交
13035

13036
        fputs(_("  NAME\n"), stdout);
13037 13038
        fprintf(stdout, "    %s - %s\n", def->name, help);

13039 13040 13041 13042 13043
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
13044
                const char *fmt = "%s";
13045 13046
                switch (opt->type) {
                case VSH_OT_BOOL:
13047
                    fmt = "[--%s]";
13048 13049
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
13050
                    /* xgettext:c-format */
13051 13052
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
13053 13054
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
13055 13056
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
13057 13058
                    break;
                case VSH_OT_DATA:
13059
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
13060 13061 13062
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
13063 13064
                    fmt = (opt->flag & VSH_OFLAG_REQ) ? _("<%s>...")
                           : _("[<%s>]...");
13065 13066
                    break;
                default:
13067
                    assert(0);
13068
                }
13069
                fputc(' ', stdout);
E
Eric Blake 已提交
13070
                fprintf(stdout, fmt, opt->name);
13071
            }
K
Karel Zak 已提交
13072
        }
13073 13074 13075
        fputc('\n', stdout);

        if (desc[0]) {
13076
            /* Print the description only if it's not empty.  */
13077
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
13078
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
13079
        }
13080

K
Karel Zak 已提交
13081
        if (def->opts) {
13082
            const vshCmdOptDef *opt;
13083
            fputs(_("\n  OPTIONS\n"), stdout);
13084
            for (opt = def->opts; opt->name; opt++) {
13085 13086
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
13087
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
13088 13089
                    break;
                case VSH_OT_INT:
13090 13091 13092
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
13093 13094
                    break;
                case VSH_OT_STRING:
13095
                    /* OT_STRING should never be VSH_OFLAG_REQ */
13096
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
13097 13098
                    break;
                case VSH_OT_DATA:
13099 13100
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
13101 13102 13103
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
13104 13105
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
13106 13107 13108
                default:
                    assert(0);
                }
13109

E
Eric Blake 已提交
13110
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
13111
            }
K
Karel Zak 已提交
13112 13113 13114
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
13115
    return true;
K
Karel Zak 已提交
13116 13117 13118 13119 13120 13121
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
13122 13123 13124
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
13125 13126
    vshCmdOpt *a = arg;

13127
    while (a) {
K
Karel Zak 已提交
13128
        vshCmdOpt *tmp = a;
13129

K
Karel Zak 已提交
13130 13131
        a = a->next;

13132 13133
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
13134 13135 13136 13137
    }
}

static void
13138
vshCommandFree(vshCmd *cmd)
13139
{
K
Karel Zak 已提交
13140 13141
    vshCmd *c = cmd;

13142
    while (c) {
K
Karel Zak 已提交
13143
        vshCmd *tmp = c;
13144

K
Karel Zak 已提交
13145 13146 13147 13148
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
13149
        VIR_FREE(tmp);
K
Karel Zak 已提交
13150 13151 13152
    }
}

E
Eric Blake 已提交
13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163
/**
 * 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 已提交
13164
 */
E
Eric Blake 已提交
13165 13166
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
13167
{
E
Eric Blake 已提交
13168 13169
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
13170

E
Eric Blake 已提交
13171 13172 13173 13174 13175 13176 13177
    /* 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 已提交
13178
    }
E
Eric Blake 已提交
13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
            return (valid->flag & VSH_OFLAG_REQ) == 0 ? 0 : -1;
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
13191 13192
}

E
Eric Blake 已提交
13193 13194
/**
 * vshCommandOptInt:
13195 13196 13197 13198 13199 13200 13201
 * @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 已提交
13202
 * 0 if option not found and not required (@value untouched)
13203
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
13204 13205
 */
static int
13206
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
13207
{
E
Eric Blake 已提交
13208 13209 13210
    vshCmdOpt *arg;
    int ret;
    int num;
13211
    char *end_p = NULL;
13212

E
Eric Blake 已提交
13213 13214 13215 13216 13217 13218 13219
    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;
13220
    }
E
Eric Blake 已提交
13221 13222 13223 13224 13225 13226 13227

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
13228 13229
}

13230

E
Eric Blake 已提交
13231 13232 13233 13234 13235 13236
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
13237 13238 13239 13240 13241 13242
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
13243 13244 13245
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
13246 13247
    char *end_p = NULL;

E
Eric Blake 已提交
13248 13249 13250 13251 13252 13253 13254
    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;
13255
    }
E
Eric Blake 已提交
13256 13257 13258 13259 13260 13261 13262

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13263 13264 13265
}


13266
/*
E
Eric Blake 已提交
13267 13268 13269 13270 13271
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
13272 13273 13274 13275 13276
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
13277
{
E
Eric Blake 已提交
13278 13279
    vshCmdOpt *arg;
    int ret;
13280
    unsigned long num;
13281 13282
    char *end_p = NULL;

E
Eric Blake 已提交
13283 13284 13285 13286 13287 13288 13289
    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;
13290
    }
E
Eric Blake 已提交
13291 13292 13293 13294 13295 13296 13297

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13298 13299
}

E
Eric Blake 已提交
13300 13301 13302 13303 13304 13305
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
13306
 * Returns option as STRING
E
Eric Blake 已提交
13307 13308 13309 13310
 * 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 已提交
13311
 */
13312 13313
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
13314
{
E
Eric Blake 已提交
13315 13316 13317 13318 13319 13320 13321 13322 13323 13324
    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;
13325
    }
13326

E
Eric Blake 已提交
13327 13328 13329 13330 13331
    if (!*arg->data && !(arg->def->flag & VSH_OFLAG_EMPTY_OK)) {
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
13332 13333
}

E
Eric Blake 已提交
13334 13335 13336 13337 13338 13339
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
13340
 * Returns option as long long
13341
 * See vshCommandOptInt()
13342
 */
13343 13344 13345
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
13346
{
E
Eric Blake 已提交
13347 13348
    vshCmdOpt *arg;
    int ret;
13349
    long long num;
13350 13351
    char *end_p = NULL;

E
Eric Blake 已提交
13352 13353 13354 13355 13356 13357 13358
    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;
13359
    }
E
Eric Blake 已提交
13360 13361 13362 13363 13364 13365 13366

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13367 13368
}

E
Eric Blake 已提交
13369 13370 13371 13372 13373 13374 13375 13376 13377
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
13378 13379 13380 13381
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
13382 13383
    vshCmdOpt *arg;
    int ret;
13384 13385 13386
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
13387 13388 13389 13390 13391 13392 13393
    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;
13394
    }
E
Eric Blake 已提交
13395 13396 13397 13398 13399 13400 13401

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13402 13403 13404
}


E
Eric Blake 已提交
13405 13406 13407 13408 13409 13410 13411 13412 13413
/**
 * 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 已提交
13414
 */
E
Eric Blake 已提交
13415
static bool
13416
vshCommandOptBool(const vshCmd *cmd, const char *name)
13417
{
E
Eric Blake 已提交
13418 13419 13420
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
13421 13422
}

E
Eric Blake 已提交
13423 13424 13425 13426 13427
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
13428 13429
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
13430
 *
13431
 * Requires that a VSH_OT_ARGV option be last in the
13432 13433
 * list of supported options in CMD->def->opts.
 */
13434 13435
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
13436
{
13437
    opt = opt ? opt->next : cmd->opts;
13438 13439

    while (opt) {
E
Eric Blake 已提交
13440
        if (opt->def->type == VSH_OT_ARGV) {
13441
            return opt;
13442 13443 13444 13445 13446 13447
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465
/* 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)
13466
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
13467 13468 13469
                 cmd->def->name, optname);
    return found;
}
13470

K
Karel Zak 已提交
13471
static virDomainPtr
J
Jim Meyering 已提交
13472
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
13473
                      const char **name, int flag)
13474
{
K
Karel Zak 已提交
13475
    virDomainPtr dom = NULL;
13476
    const char *n = NULL;
K
Karel Zak 已提交
13477
    int id;
J
Jim Meyering 已提交
13478 13479 13480
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
13481

13482
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13483 13484
        return NULL;

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

K
Karel Zak 已提交
13488 13489
    if (name)
        *name = n;
13490

K
Karel Zak 已提交
13491
    /* try it by ID */
13492
    if (flag & VSH_BYID) {
13493
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
13494 13495
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
13496 13497 13498
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
13499
    }
K
Karel Zak 已提交
13500
    /* try it by UUID */
13501
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
13502
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
13503
                 cmd->def->name, optname);
K
Karel Zak 已提交
13504
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
13505
    }
K
Karel Zak 已提交
13506
    /* try it by NAME */
13507
    if (dom==NULL && (flag & VSH_BYNAME)) {
13508
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
13509
                 cmd->def->name, optname);
K
Karel Zak 已提交
13510
        dom = virDomainLookupByName(ctl->conn, n);
13511
    }
K
Karel Zak 已提交
13512

13513
    if (!dom)
13514
        vshError(ctl, _("failed to get domain '%s'"), n);
13515

K
Karel Zak 已提交
13516 13517 13518
    return dom;
}

13519
static virNetworkPtr
J
Jim Meyering 已提交
13520
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
13521
                       const char **name, int flag)
13522 13523
{
    virNetworkPtr network = NULL;
13524
    const char *n = NULL;
J
Jim Meyering 已提交
13525 13526 13527
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
13528

13529
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13530 13531
        return NULL;

13532
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13533 13534 13535 13536 13537 13538
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
13539
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13540
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
13541
                 cmd->def->name, optname);
13542 13543 13544 13545
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
13546
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
13547 13548 13549 13550 13551
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
13552
        vshError(ctl, _("failed to get network '%s'"), n);
13553 13554 13555 13556

    return network;
}

13557 13558 13559

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
13560
                        const char **name, int flag)
13561 13562
{
    virNWFilterPtr nwfilter = NULL;
13563
    const char *n = NULL;
13564 13565 13566 13567
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13568
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13569 13570
        return NULL;

13571
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13572 13573 13574 13575 13576 13577 13578
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13579
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
13580 13581 13582 13583 13584
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
13585
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
13586 13587 13588 13589 13590 13591 13592 13593 13594 13595
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

13596 13597
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
13598
                         const char **name, int flag)
13599 13600
{
    virInterfacePtr iface = NULL;
13601
    const char *n = NULL;
13602 13603 13604 13605
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13606
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13607 13608
        return NULL;

13609
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13610 13611 13612 13613 13614 13615
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
13616
    if ((flag & VSH_BYNAME)) {
13617
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
13618 13619 13620 13621 13622
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
13623
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
13624 13625 13626 13627 13628
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
13629
        vshError(ctl, _("failed to get interface '%s'"), n);
13630 13631 13632 13633

    return iface;
}

13634
static virStoragePoolPtr
13635
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
13636
                    const char **name, int flag)
13637 13638
{
    virStoragePoolPtr pool = NULL;
13639
    const char *n = NULL;
13640

13641
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13642 13643
        return NULL;

13644
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13645 13646 13647 13648 13649 13650
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
13651
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13652
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
13653
                 cmd->def->name, optname);
13654 13655 13656
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
13657
    if (pool == NULL && (flag & VSH_BYNAME)) {
13658
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
13659 13660 13661 13662 13663
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
13664
        vshError(ctl, _("failed to get pool '%s'"), n);
13665 13666 13667 13668 13669

    return pool;
}

static virStorageVolPtr
13670
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
13671 13672
                   const char *optname,
                   const char *pooloptname,
13673
                   const char **name, int flag)
13674 13675 13676
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
13677
    const char *n = NULL, *p = NULL;
13678

13679
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13680 13681
        return NULL;

13682
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
13683
        vshError(ctl, "%s", _("missing option"));
13684
        return NULL;
13685
    }
13686 13687 13688 13689

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

13690
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
13691 13692 13693 13694 13695
             cmd->def->name, optname, n);

    if (name)
        *name = n;

13696
    /* try it by name */
13697
    if (pool && (flag & VSH_BYNAME)) {
13698
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
13699 13700 13701
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
13702
    /* try it by key */
13703
    if (vol == NULL && (flag & VSH_BYUUID)) {
13704
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
13705 13706 13707
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
13708
    /* try it by path */
13709
    if (vol == NULL && (flag & VSH_BYUUID)) {
13710
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
13711 13712 13713 13714 13715
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
13716
        vshError(ctl, _("failed to get vol '%s'"), n);
13717 13718 13719 13720 13721 13722 13723

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

13724
static virSecretPtr
13725
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
13726 13727
{
    virSecretPtr secret = NULL;
13728
    const char *n = NULL;
13729 13730 13731 13732 13733
    const char *optname = "secret";

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

13734
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13735 13736
        return NULL;

13737 13738
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
13739 13740 13741 13742 13743 13744 13745

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
13746
        vshError(ctl, _("failed to get secret '%s'"), n);
13747 13748 13749 13750

    return secret;
}

K
Karel Zak 已提交
13751 13752 13753
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
13754
static bool
13755
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
13756
{
E
Eric Blake 已提交
13757
    bool ret = true;
13758 13759

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

13763 13764
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
13765 13766
            vshReconnect(ctl);

13767
        if (enable_timing)
K
Karel Zak 已提交
13768
            GETTIMEOFDAY(&before);
13769

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

13772
        if (enable_timing)
K
Karel Zak 已提交
13773
            GETTIMEOFDAY(&after);
13774

13775
        if (!ret)
J
John Levon 已提交
13776 13777
            virshReportError(ctl);

13778
        /* try to automatically catch disconnections */
13779
        if (!ret &&
13780 13781 13782 13783 13784 13785 13786 13787 13788
            ((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);

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

13792
        if (enable_timing)
13793
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
13794 13795
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
13796
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
13797 13798 13799 13800 13801 13802
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
13803
 * Command parsing
K
Karel Zak 已提交
13804 13805 13806
 * ---------------
 */

13807 13808 13809 13810 13811 13812 13813 13814 13815 13816
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 已提交
13817
    /* vshCommandStringGetArg() */
13818
    char *pos;
L
Lai Jiangshan 已提交
13819 13820 13821
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
13822 13823
} vshCommandParser;

E
Eric Blake 已提交
13824
static bool
13825
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
13826
{
K
Karel Zak 已提交
13827 13828 13829
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
13830

K
Karel Zak 已提交
13831 13832 13833 13834
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
13835

13836
    while (1) {
K
Karel Zak 已提交
13837
        vshCmdOpt *last = NULL;
13838
        const vshCmdDef *cmd = NULL;
13839
        vshCommandToken tk;
L
Lai Jiangshan 已提交
13840
        bool data_only = false;
13841 13842 13843
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
13844

K
Karel Zak 已提交
13845
        first = NULL;
13846

13847
        while (1) {
13848
            const vshCmdOptDef *opt = NULL;
13849

K
Karel Zak 已提交
13850
            tkdata = NULL;
13851
            tk = parser->getNextArg(ctl, parser, &tkdata);
13852 13853

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
13854
                goto syntaxError;
H
Hu Tao 已提交
13855 13856
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
13857
                break;
H
Hu Tao 已提交
13858
            }
13859 13860

            if (cmd == NULL) {
K
Karel Zak 已提交
13861 13862
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
13863
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
13864
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
13865
                }
13866 13867 13868 13869 13870 13871 13872
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
13873
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
13874 13875 13876 13877
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
13878 13879 13880 13881 13882
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
13883 13884
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
13885
                    VIR_FREE(optstr);
K
Karel Zak 已提交
13886 13887
                    goto syntaxError;
                }
13888
                VIR_FREE(tkdata);
K
Karel Zak 已提交
13889 13890 13891

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
13892 13893 13894
                    if (optstr)
                        tkdata = optstr;
                    else
13895
                        tk = parser->getNextArg(ctl, parser, &tkdata);
13896
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
13897
                        goto syntaxError;
13898
                    if (tk != VSH_TK_ARG) {
13899
                        vshError(ctl,
13900
                                 _("expected syntax: --%s <%s>"),
13901 13902
                                 opt->name,
                                 opt->type ==
13903
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
13904 13905
                        goto syntaxError;
                    }
13906
                    opts_need_arg &= ~opts_seen;
13907 13908 13909 13910 13911 13912 13913 13914
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
13915
                }
L
Lai Jiangshan 已提交
13916 13917 13918 13919
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
13920
            } else {
L
Lai Jiangshan 已提交
13921
get_data:
13922 13923
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
13924
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
13925 13926 13927 13928 13929
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
13930
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
13931

K
Karel Zak 已提交
13932 13933 13934 13935
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
13936

K
Karel Zak 已提交
13937 13938 13939 13940 13941
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
13942

13943
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
13944 13945
                         cmd->name,
                         opt->name,
13946 13947
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
13948 13949
            }
        }
13950

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

K
Karel Zak 已提交
13955 13956 13957 13958
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

13959
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
13960
                VIR_FREE(c);
13961
                goto syntaxError;
13962
            }
13963

K
Karel Zak 已提交
13964 13965 13966 13967 13968 13969
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
13970 13971 13972

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
13973
    }
13974

E
Eric Blake 已提交
13975
    return true;
K
Karel Zak 已提交
13976

13977
 syntaxError:
13978
    if (ctl->cmd) {
K
Karel Zak 已提交
13979
        vshCommandFree(ctl->cmd);
13980 13981
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
13982 13983
    if (first)
        vshCommandOptFree(first);
13984
    VIR_FREE(tkdata);
E
Eric Blake 已提交
13985
    return false;
K
Karel Zak 已提交
13986 13987
}

13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005
/* --------------------
 * 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 已提交
14006 14007
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
14008 14009 14010 14011
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
14012
        return false;
14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080 14081 14082 14083 14084

    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 已提交
14085 14086
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
14087 14088 14089 14090
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
14091
        return false;
14092 14093 14094 14095 14096 14097

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

K
Karel Zak 已提交
14098
/* ---------------
14099
 * Misc utils
K
Karel Zak 已提交
14100 14101
 * ---------------
 */
14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129
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 已提交
14130
static const char *
14131 14132
vshDomainStateToString(int state)
{
14133
    switch ((virDomainState) state) {
14134
    case VIR_DOMAIN_RUNNING:
14135
        return N_("running");
14136
    case VIR_DOMAIN_BLOCKED:
14137
        return N_("idle");
14138
    case VIR_DOMAIN_PAUSED:
14139
        return N_("paused");
14140
    case VIR_DOMAIN_SHUTDOWN:
14141
        return N_("in shutdown");
14142
    case VIR_DOMAIN_SHUTOFF:
14143
        return N_("shut off");
14144
    case VIR_DOMAIN_CRASHED:
14145
        return N_("crashed");
14146
    case VIR_DOMAIN_NOSTATE:
14147
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
14148
    }
14149
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
14150 14151
}

14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200 14201 14202 14203 14204 14205 14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250 14251 14252
static const char *
vshDomainStateReasonToString(int state, int reason)
{
    switch ((virDomainState) state) {
    case VIR_DOMAIN_NOSTATE:
        switch ((virDomainNostateReason) reason) {
        case VIR_DOMAIN_NOSTATE_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_RUNNING:
        switch ((virDomainRunningReason) reason) {
        case VIR_DOMAIN_RUNNING_BOOTED:
            return N_("booted");
        case VIR_DOMAIN_RUNNING_MIGRATED:
            return N_("migrated");
        case VIR_DOMAIN_RUNNING_RESTORED:
            return N_("restored");
        case VIR_DOMAIN_RUNNING_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_RUNNING_UNPAUSED:
            return N_("unpaused");
        case VIR_DOMAIN_RUNNING_MIGRATION_CANCELED:
            return N_("migration canceled");
        case VIR_DOMAIN_RUNNING_SAVE_CANCELED:
            return N_("save canceled");
        case VIR_DOMAIN_RUNNING_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_BLOCKED:
        switch ((virDomainBlockedReason) reason) {
        case VIR_DOMAIN_BLOCKED_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_PAUSED:
        switch ((virDomainPausedReason) reason) {
        case VIR_DOMAIN_PAUSED_USER:
            return N_("user");
        case VIR_DOMAIN_PAUSED_MIGRATION:
            return N_("migrating");
        case VIR_DOMAIN_PAUSED_SAVE:
            return N_("saving");
        case VIR_DOMAIN_PAUSED_DUMP:
            return N_("dumping");
        case VIR_DOMAIN_PAUSED_IOERROR:
            return N_("I/O error");
        case VIR_DOMAIN_PAUSED_WATCHDOG:
            return N_("watchdog");
        case VIR_DOMAIN_PAUSED_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_PAUSED_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_SHUTDOWN:
        switch ((virDomainShutdownReason) reason) {
        case VIR_DOMAIN_SHUTDOWN_USER:
            return N_("user");
        case VIR_DOMAIN_SHUTDOWN_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_SHUTOFF:
        switch ((virDomainShutoffReason) reason) {
        case VIR_DOMAIN_SHUTOFF_SHUTDOWN:
            return N_("shutdown");
        case VIR_DOMAIN_SHUTOFF_DESTROYED:
            return N_("destroyed");
        case VIR_DOMAIN_SHUTOFF_CRASHED:
            return N_("crashed");
        case VIR_DOMAIN_SHUTOFF_MIGRATED:
            return N_("migrated");
        case VIR_DOMAIN_SHUTOFF_SAVED:
            return N_("saved");
        case VIR_DOMAIN_SHUTOFF_FAILED:
            return N_("failed");
        case VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_SHUTOFF_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_CRASHED:
        switch ((virDomainCrashedReason) reason) {
        case VIR_DOMAIN_CRASHED_UNKNOWN:
            ;
        }
        break;
    }

    return N_("unknown");
}

14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269
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");
}

14270 14271 14272 14273
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
14274
    case VIR_VCPU_OFFLINE:
14275
        return N_("offline");
14276
    case VIR_VCPU_BLOCKED:
14277
        return N_("idle");
14278
    case VIR_VCPU_RUNNING:
14279
        return N_("running");
14280
    default:
14281
        ;/*FALLTHROUGH*/
14282
    }
14283
    return N_("no state");
14284 14285
}

E
Eric Blake 已提交
14286
static bool
14287
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
14288
{
14289 14290
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
14291 14292
     */
    if (!conn) {
14293
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
14294
        return false;
K
Karel Zak 已提交
14295
    }
E
Eric Blake 已提交
14296
    return true;
K
Karel Zak 已提交
14297 14298
}

K
Karel Zak 已提交
14299
static void
14300
vshDebug(vshControl *ctl, int level, const char *format, ...)
14301
{
K
Karel Zak 已提交
14302
    va_list ap;
14303
    char *str;
K
Karel Zak 已提交
14304

14305 14306 14307 14308 14309 14310 14311
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

14312
    va_start(ap, format);
14313
    vshOutputLogFile(ctl, level, format, ap);
14314 14315
    va_end(ap);

K
Karel Zak 已提交
14316
    va_start(ap, format);
14317 14318 14319 14320 14321
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
14322
    va_end(ap);
14323 14324
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
14325 14326 14327
}

static void
14328
vshPrintExtra(vshControl *ctl, const char *format, ...)
14329
{
K
Karel Zak 已提交
14330
    va_list ap;
14331
    char *str;
14332

14333
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
14334
        return;
14335

K
Karel Zak 已提交
14336
    va_start(ap, format);
14337 14338 14339 14340 14341
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
14342
    va_end(ap);
14343
    fputs(str, stdout);
14344
    VIR_FREE(str);
K
Karel Zak 已提交
14345 14346
}

K
Karel Zak 已提交
14347

K
Karel Zak 已提交
14348
static void
14349
vshError(vshControl *ctl, const char *format, ...)
14350
{
K
Karel Zak 已提交
14351
    va_list ap;
14352
    char *str;
14353

14354 14355 14356 14357 14358
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
14359

14360 14361 14362 14363
    /* 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);
14364
    fputs(_("error: "), stderr);
14365

K
Karel Zak 已提交
14366
    va_start(ap, format);
14367 14368 14369
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
14370 14371
    va_end(ap);

14372
    fprintf(stderr, "%s\n", NULLSTR(str));
14373
    fflush(stderr);
14374
    VIR_FREE(str);
K
Karel Zak 已提交
14375 14376
}

14377

K
Karel Zak 已提交
14378
/*
14379
 * Initialize connection.
K
Karel Zak 已提交
14380
 */
E
Eric Blake 已提交
14381
static bool
14382
vshInit(vshControl *ctl)
14383
{
14384 14385
    char *debugEnv;

K
Karel Zak 已提交
14386
    if (ctl->conn)
E
Eric Blake 已提交
14387
        return false;
K
Karel Zak 已提交
14388

J
Jiri Denemark 已提交
14389
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
14390 14391 14392
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
14393 14394 14395
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
14396 14397
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
14398 14399
            } else {
                ctl->debug = debug;
14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

14412 14413
    vshOpenLogFile(ctl);

14414 14415
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
14416

14417 14418 14419
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

14420
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
14421
        return false;
14422

14423 14424 14425 14426
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
14427

14428 14429 14430 14431 14432 14433 14434 14435 14436 14437 14438
        /* 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;
        }
14439
    }
K
Karel Zak 已提交
14440

E
Eric Blake 已提交
14441
    return true;
K
Karel Zak 已提交
14442 14443
}

14444 14445
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464
/**
 * 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:
14465
                vshError(ctl, "%s",
J
Jim Meyering 已提交
14466
                         _("failed to get the log file information"));
14467
                exit(EXIT_FAILURE);
14468 14469 14470
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
14471 14472
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
14473 14474 14475 14476
        }
    }

    /* log file open */
14477
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
14478
        vshError(ctl, "%s",
J
Jim Meyering 已提交
14479
                 _("failed to open the log file. check the log file path"));
14480
        exit(EXIT_FAILURE);
14481 14482 14483 14484 14485 14486 14487 14488 14489
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
14490 14491
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
14492
{
14493 14494 14495
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507 14508 14509
    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);
14510
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
14511 14512 14513 14514 14515 14516
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
14517 14518
                      SIGN_NAME,
                      (int) getpid());
14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535 14536 14537 14538
    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;
    }
14539 14540 14541
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
14542

14543 14544
    if (virBufferError(&buf))
        goto error;
14545

14546 14547 14548 14549 14550
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
14551
    }
14552

14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563
    /* 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);
14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
14575 14576 14577
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
14578 14579 14580
    }

    if (ctl->logfile) {
14581
        VIR_FREE(ctl->logfile);
14582 14583 14584 14585
        ctl->logfile = NULL;
    }
}

14586
#ifdef USE_READLINE
14587

K
Karel Zak 已提交
14588 14589 14590 14591 14592
/* -----------------
 * Readline stuff
 * -----------------
 */

14593
/*
K
Karel Zak 已提交
14594 14595
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
14596
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
14597 14598
 */
static char *
14599 14600
vshReadlineCommandGenerator(const char *text, int state)
{
14601
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
14602
    const char *name;
14603 14604
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
14605 14606

    if (!state) {
14607 14608
        grp_list_index = 0;
        cmd_list_index = 0;
14609
        len = strlen(text);
K
Karel Zak 已提交
14610 14611
    }

14612 14613
    grp = cmdGroups;

K
Karel Zak 已提交
14614
    /* Return the next name which partially matches from the
14615
     * command list.
K
Karel Zak 已提交
14616
     */
14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630
    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 已提交
14631 14632 14633 14634 14635 14636 14637
    }

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

static char *
14638 14639
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
14640
    static int list_index, len;
14641
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
14642
    const char *name;
K
Karel Zak 已提交
14643 14644 14645 14646 14647 14648 14649 14650 14651

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

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

14652
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
14653
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
14654 14655 14656

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
14657
        len = strlen(text);
14658
        VIR_FREE(cmdname);
K
Karel Zak 已提交
14659 14660 14661 14662
    }

    if (!cmd)
        return NULL;
14663

14664 14665 14666
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
14667
    while ((name = cmd->opts[list_index].name)) {
14668
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
14669
        char *res;
14670

K
Karel Zak 已提交
14671
        list_index++;
14672

14673
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
14674 14675
            /* ignore non --option */
            continue;
14676

K
Karel Zak 已提交
14677
        if (len > 2) {
14678
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
14679 14680
                continue;
        }
14681
        res = vshMalloc(NULL, strlen(name) + 3);
14682
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
14683 14684 14685 14686 14687 14688 14689 14690
        return res;
    }

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

static char **
14691 14692 14693
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
14694 14695
    char **matches = (char **) NULL;

14696
    if (start == 0)
K
Karel Zak 已提交
14697
        /* command name generator */
14698
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
14699 14700
    else
        /* commands options */
14701
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
14702 14703 14704 14705
    return matches;
}


14706 14707
static int
vshReadlineInit(vshControl *ctl)
14708
{
14709 14710
    char *userdir = NULL;

K
Karel Zak 已提交
14711 14712 14713 14714 14715
    /* 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;
14716 14717 14718

    /* Limit the total size of the history buffer */
    stifle_history(500);
14719 14720

    /* Prepare to read/write history from/to the ~/.virsh/history file */
14721
    userdir = virGetUserDirectory(getuid());
14722

14723 14724
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
14725
        return -1;
14726
    }
14727 14728 14729

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
14730
        VIR_FREE(userdir);
14731 14732 14733 14734 14735
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
14736
        VIR_FREE(userdir);
14737 14738 14739
        return -1;
    }

14740
    VIR_FREE(userdir);
14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758

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

14759 14760
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
14761 14762
}

14763 14764 14765 14766 14767 14768
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

14769
#else /* !USE_READLINE */
14770

14771 14772 14773 14774 14775 14776 14777
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

14778
static void
14779
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
14780 14781 14782 14783 14784 14785 14786 14787 14788 14789 14790 14791 14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802
{
    /* 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);
}

14803
#endif /* !USE_READLINE */
14804

K
Karel Zak 已提交
14805
/*
J
Jim Meyering 已提交
14806
 * Deinitialize virsh
K
Karel Zak 已提交
14807
 */
E
Eric Blake 已提交
14808
static bool
14809
vshDeinit(vshControl *ctl)
14810
{
14811
    vshReadlineDeinit(ctl);
14812
    vshCloseLogFile(ctl);
14813
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
14814
    if (ctl->conn) {
14815 14816 14817
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
14818 14819
        }
    }
D
Daniel P. Berrange 已提交
14820 14821
    virResetLastError();

E
Eric Blake 已提交
14822
    return true;
K
Karel Zak 已提交
14823
}
14824

K
Karel Zak 已提交
14825 14826 14827 14828
/*
 * Print usage
 */
static void
14829
vshUsage(void)
14830
{
14831
    const vshCmdGrp *grp;
14832
    const vshCmdDef *cmd;
14833

L
Lai Jiangshan 已提交
14834 14835
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
14836 14837 14838
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
14839
                      "    -d | --debug <num>      debug level [0-4]\n"
14840 14841 14842 14843
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
14844
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
14845
                      "    -V | --version=long     version and full options\n\n"
14846
                      "  commands (non interactive mode):\n\n"), progname, progname);
14847

14848 14849
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
14850

14851 14852 14853 14854 14855 14856 14857 14858 14859
        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"));
14860 14861 14862
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
14863 14864
}

14865 14866 14867 14868 14869 14870 14871 14872 14873 14874
/*
 * 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 已提交
14875 14876
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
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
#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 已提交
14912
    vshPrint(ctl, "%s", _(" Networking:"));
14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938
#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 已提交
14939
    vshPrint(ctl, "%s", _(" Storage:"));
14940 14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962
#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 已提交
14963
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
14964
#ifdef WITH_SECDRIVER_APPARMOR
14965 14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985 14986 14987
    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 已提交
14988 14989 14990 14991
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
14992
static bool
14993
vshParseArgv(vshControl *ctl, int argc, char **argv)
14994
{
14995 14996
    bool help = false;
    int arg;
K
Karel Zak 已提交
14997
    struct option opt[] = {
E
Eric Blake 已提交
14998 14999 15000 15001 15002 15003 15004 15005 15006
        {"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}
15007 15008
    };

15009 15010 15011
    /* 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. */
15012
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
15013
        switch (arg) {
15014
        case 'd':
D
Daniel Veillard 已提交
15015
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
15016
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
15017 15018
                exit(EXIT_FAILURE);
            }
15019 15020
            break;
        case 'h':
15021
            help = true;
15022 15023
            break;
        case 'q':
E
Eric Blake 已提交
15024
            ctl->quiet = true;
15025 15026
            break;
        case 't':
E
Eric Blake 已提交
15027
            ctl->timing = true;
15028 15029 15030 15031
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
15032 15033 15034 15035 15036 15037
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
15038 15039 15040
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
15041
        case 'r':
E
Eric Blake 已提交
15042
            ctl->readonly = true;
15043
            break;
15044 15045 15046
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
15047
        default:
15048 15049
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
15050 15051 15052 15053
        }
    }

    if (help) {
15054 15055
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
15056 15057
            exit(EXIT_FAILURE);
        }
15058 15059 15060

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
15061
        exit(EXIT_SUCCESS);
15062 15063
    }

15064
    if (argc > optind) {
K
Karel Zak 已提交
15065
        /* parse command */
E
Eric Blake 已提交
15066
        ctl->imode = false;
15067
        if (argc - optind == 1) {
15068
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
15069
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
15070
        } else {
15071
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
15072 15073
        }
    }
E
Eric Blake 已提交
15074
    return true;
K
Karel Zak 已提交
15075 15076
}

15077 15078 15079 15080
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
15081
    char *defaultConn;
E
Eric Blake 已提交
15082
    bool ret = true;
K
Karel Zak 已提交
15083

15084 15085 15086
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
15087
    ctl->debug = VSH_DEBUG_DEFAULT;
15088

15089 15090
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
15091
        /* failure to setup locale is not fatal */
15092
    }
15093
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
15094
        perror("bindtextdomain");
E
Eric Blake 已提交
15095
        return EXIT_FAILURE;
15096
    }
15097
    if (!textdomain(PACKAGE)) {
15098
        perror("textdomain");
E
Eric Blake 已提交
15099
        return EXIT_FAILURE;
15100 15101
    }

15102 15103 15104 15105 15106
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

15107
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
15108 15109 15110
        progname = argv[0];
    else
        progname++;
15111

15112
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
15113
        ctl->name = vshStrdup(ctl, defaultConn);
15114 15115
    }

D
Daniel P. Berrange 已提交
15116 15117
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
15118
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
15119
    }
15120

D
Daniel P. Berrange 已提交
15121 15122
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
15123
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
15124
    }
15125

K
Karel Zak 已提交
15126
    if (!ctl->imode) {
15127
        ret = vshCommandRun(ctl, ctl->cmd);
15128
    } else {
K
Karel Zak 已提交
15129 15130
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
15131
            vshPrint(ctl,
15132
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
15133
                     progname);
J
Jim Meyering 已提交
15134
            vshPrint(ctl, "%s",
15135
                     _("Type:  'help' for help with commands\n"
15136
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
15137
        }
15138 15139 15140 15141 15142 15143

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
15144
        do {
15145
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
15146
            ctl->cmdstr =
15147
                vshReadline(ctl, prompt);
15148 15149
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
15150
            if (*ctl->cmdstr) {
15151
#if USE_READLINE
K
Karel Zak 已提交
15152
                add_history(ctl->cmdstr);
15153
#endif
15154
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
15155 15156
                    vshCommandRun(ctl, ctl->cmd);
            }
15157
            VIR_FREE(ctl->cmdstr);
15158
        } while (ctl->imode);
K
Karel Zak 已提交
15159

15160 15161
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
15162
    }
15163

K
Karel Zak 已提交
15164 15165
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
15166
}