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

13
#include <config.h>
14

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

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

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

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

static char *progname;

65 66
#define VIRSH_MAX_XML_FILE 10*1024*1024

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

70 71
#define VIR_FROM_THIS VIR_FROM_NONE

K
Karel Zak 已提交
72 73 74 75 76
#define GETTIMEOFDAY(T) gettimeofday(T, NULL)
#define DIFF_MSEC(T, U) \
        ((((int) ((T)->tv_sec - (U)->tv_sec)) * 1000000.0 + \
          ((int) ((T)->tv_usec - (U)->tv_usec))) / 1000.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

366
static int vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason);
K
Karel Zak 已提交
367
static const char *vshDomainStateToString(int state);
368
static const char *vshDomainStateReasonToString(int state, int reason);
369
static const char *vshDomainControlStateToString(int state);
370
static const char *vshDomainVcpuStateToString(int state);
E
Eric Blake 已提交
371
static bool vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
372 373 374 375
static virTypedParameterPtr vshFindTypedParamByName(const char *name,
                                                    virTypedParameterPtr list,
                                                    int count);
static char *vshGetTypedParamValue(vshControl *ctl, virTypedParameterPtr item);
K
Karel Zak 已提交
376

377 378 379 380
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

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

390
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
391 392
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
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 449 450 451 452
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
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467

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;

468
  /* User visible sort, so we want locale-specific case comparison.  */
469 470 471
  return strcasecmp(*sa, *sb);
}

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

    if (last_error->code == VIR_ERR_OK) {
531
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
532 533 534
        goto out;
    }

535
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
536 537 538 539 540 541

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

542 543 544 545 546 547 548 549 550
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;
}

551 552 553 554 555
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

556 557 558 559 560
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

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

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

    if (ctl->conn != NULL) {
        connected = true;
604
        virConnectClose(ctl->conn);
605
    }
606 607 608 609 610 611

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

K
Karel Zak 已提交
618 619 620 621 622 623
/* ---------------
 * Commands
 * ---------------
 */

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

631
    {NULL, NULL}
K
Karel Zak 已提交
632 633
};

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

E
Eric Blake 已提交
639
static bool
640
cmdHelp(vshControl *ctl, const vshCmd *cmd)
641
 {
642
    const char *name = NULL;
643

644
    if (vshCommandOptString(cmd, "command", &name) <= 0) {
645
        const vshCmdGrp *grp;
646
        const vshCmdDef *def;
647

648 649 650 651 652 653 654 655 656 657 658 659 660
        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 已提交
661
        return true;
662
    }
663

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

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

684
static const vshCmdOptDef opts_autostart[] = {
685 686
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
687 688 689
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
690
static bool
691
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
692 693
{
    virDomainPtr dom;
694
    const char *name;
695 696
    int autostart;

697
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
698
        return false;
699

J
Jim Meyering 已提交
700
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
701
        return false;
702 703 704 705

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

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

714
    if (autostart)
715
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
716
    else
717
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
718

719
    virDomainFree(dom);
E
Eric Blake 已提交
720
    return true;
721 722
}

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

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

E
Eric Blake 已提交
740
static bool
741
cmdConnect(vshControl *ctl, const vshCmd *cmd)
742
{
E
Eric Blake 已提交
743
    bool ro = vshCommandOptBool(cmd, "readonly");
744
    const char *name = NULL;
745

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

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

762
    ctl->useGetInfo = false;
E
Eric Blake 已提交
763
    ctl->readonly = ro;
K
Karel Zak 已提交
764

765 766 767
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

E
Eric Blake 已提交
771
    return !!ctl->conn;
K
Karel Zak 已提交
772 773
}

774 775
#ifndef WIN32

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

786
static const vshCmdOptDef opts_console[] = {
787
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
788
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
789 790 791
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
792
static bool
793
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
794
{
E
Eric Blake 已提交
795
    bool ret = false;
796
    int state;
797

798
    if ((state = vshDomainState(ctl, dom, NULL)) < 0) {
799 800 801 802
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

803
    if (state == VIR_DOMAIN_SHUTOFF) {
804 805 806 807
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

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

 cleanup:
814

815 816 817
    return ret;
}

E
Eric Blake 已提交
818
static bool
819 820 821
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
822
    bool ret = false;
823
    const char *name = NULL;
824

825
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
826
        return false;
827 828

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

831 832 833 834
    if (vshCommandOptString(cmd, "devname", &name) < 0) {
        vshError(ctl, "%s", _("Invalid devname"));
        goto cleanup;
    }
835

836
    ret = cmdRunConsole(ctl, dom, name);
837

838
cleanup:
839 840 841 842
    virDomainFree(dom);
    return ret;
}

843 844 845
#endif /* WIN32 */


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

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

K
Karel Zak 已提交
863

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

876
    inactive |= all;
K
Karel Zak 已提交
877

878
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
879
        return false;
880

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

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

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

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

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

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

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

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

        /* this kind of work with domains is not atomic operation */
939
        if (!dom) {
940
            VIR_FREE(names[i]);
941
            continue;
942
        }
943

E
Eric Blake 已提交
944 945 946 947 948
        state = vshDomainState(ctl, dom, NULL);
        if (managed && state == VIR_DOMAIN_SHUTOFF &&
            virDomainHasManagedSaveImage(dom, 0) > 0)
            state = -2;

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

954
        virDomainFree(dom);
955
        VIR_FREE(names[i]);
956
    }
957 958
    VIR_FREE(ids);
    VIR_FREE(names);
E
Eric Blake 已提交
959
    return true;
K
Karel Zak 已提交
960 961 962
}

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

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

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

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

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

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

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

1005
cleanup:
1006 1007 1008 1009
    virDomainFree(dom);
    return ret;
}

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 1053 1054 1055 1056
/*
 * "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;
}

1057 1058
/* "domblkstat" command
 */
1059
static const vshCmdInfo info_domblkstat[] = {
1060
    {"help", N_("get device block stats for a domain")},
1061 1062
    {"desc", N_("Get device block stats for a running domain. See man page or "
                "use --human for explanation of fields")},
1063 1064 1065
    {NULL,NULL}
};

1066
static const vshCmdOptDef opts_domblkstat[] = {
1067 1068
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
    {"human",  VSH_OT_BOOL, 0, N_("print a more human readable output")},
    {NULL, 0, 0, NULL}
};

struct _domblkstat_sequence {
    const char *field;  /* field name */
    const char *legacy; /* legacy name from previous releases */
    const char *human;  /* human-friendly explanation */
};

/* sequence of values for output to honor legacy format from previous
 * versions */
static const struct _domblkstat_sequence domblkstat_output[] = {
    { VIR_DOMAIN_BLOCK_STATS_READ_REQ,          "rd_req",
1083
      N_("number of read operations:") }, /* 0 */
1084
    { VIR_DOMAIN_BLOCK_STATS_READ_BYTES,        "rd_bytes",
1085
      N_("number of bytes read:") }, /* 1 */
1086
    { VIR_DOMAIN_BLOCK_STATS_WRITE_REQ,         "wr_req",
1087
      N_("number of write operations:") }, /* 2 */
1088
    { VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES,       "wr_bytes",
1089
      N_("number of bytes written:") }, /* 3 */
1090
    { VIR_DOMAIN_BLOCK_STATS_ERRS,              "errs",
1091
      N_("error count:") }, /* 4 */
1092
    { VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ,         NULL,
1093
      N_("number of flush operations:") }, /* 5 */
1094
    { VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES,  NULL,
1095
      N_("total duration of reads (ns):") }, /* 6 */
1096
    { VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES, NULL,
1097
      N_("total duration of writes (ns):") }, /* 7 */
1098 1099 1100 1101 1102 1103 1104
    { VIR_DOMAIN_BLOCK_STATS_FLUSH_TOTAL_TIMES, NULL,
      N_("total duration of flushes (ns):") }, /* 8 */
    { NULL, NULL, NULL }
};

#define DOMBLKSTAT_LEGACY_PRINT(ID, VALUE)              \
    if (VALUE >= 0)                                     \
1105 1106
        vshPrint(ctl, "%s %-*s %lld\n", device,         \
                 human ? 31 : 0,                        \
1107 1108 1109
                 human ? _(domblkstat_output[ID].human) \
                 : domblkstat_output[ID].legacy,        \
                 VALUE);
1110

E
Eric Blake 已提交
1111
static bool
1112
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
1113 1114
{
    virDomainPtr dom;
1115
    const char *name = NULL, *device = NULL;
1116
    struct _virDomainBlockStats stats;
1117
    virTypedParameterPtr params = NULL;
1118 1119 1120
    virTypedParameterPtr par = NULL;
    char *value = NULL;
    const char *field = NULL;
1121
    int rc, nparams = 0;
1122
    int i = 0;
1123
    bool ret = false;
1124
    bool human = vshCommandOptBool(cmd, "human"); /* human readable output */
1125

1126
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1127
        return false;
1128

1129
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1130
        return false;
1131

1132
    if (vshCommandOptString(cmd, "device", &device) <= 0)
1133
        goto cleanup;
1134

1135 1136 1137 1138 1139 1140 1141
    rc = virDomainBlockStatsFlags(dom, device, NULL, &nparams, 0);

    /* It might fail when virDomainBlockStatsFlags is not
     * supported on older libvirt, fallback to use virDomainBlockStats
     * then.
     */
    if (rc < 0) {
1142 1143
        /* try older API if newer is not supported */
        if (last_error->code != VIR_ERR_NO_SUPPORT)
1144 1145
            goto cleanup;

1146 1147
        virFreeError(last_error);
        last_error = NULL;
1148

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

1156 1157 1158 1159
        /* human friendly output */
        if (human) {
            vshPrint(ctl, N_("Device: %s\n"), device);
            device = "";
1160
        }
1161 1162 1163 1164 1165 1166

        DOMBLKSTAT_LEGACY_PRINT(0, stats.rd_req);
        DOMBLKSTAT_LEGACY_PRINT(1, stats.rd_bytes);
        DOMBLKSTAT_LEGACY_PRINT(2, stats.wr_req);
        DOMBLKSTAT_LEGACY_PRINT(3, stats.wr_bytes);
        DOMBLKSTAT_LEGACY_PRINT(4, stats.errs);
1167
    } else {
1168
        params = vshCalloc(ctl, nparams, sizeof(*params));
1169

1170 1171 1172 1173
        if (virDomainBlockStatsFlags (dom, device, params, &nparams, 0) < 0) {
            vshError(ctl, _("Failed to get block stats %s %s"), name, device);
            goto cleanup;
        }
1174

1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
        /* set for prettier output */
        if (human) {
            vshPrint(ctl, N_("Device: %s\n"), device);
            device = "";
        }

        /* at first print all known values in desired order */
        for (i = 0; domblkstat_output[i].field != NULL; i++) {
            if (!(par = vshFindTypedParamByName(domblkstat_output[i].field,
                                                params,
                                                nparams)))
                continue;

            if (!(value = vshGetTypedParamValue(ctl, par)))
                continue;

            /* to print other not supported fields, mark the already printed */
            par->field[0] = '\0'; /* set the name to empty string */

            /* translate into human readable or legacy spelling */
            field = NULL;
            if (human)
                field = _(domblkstat_output[i].human);
            else
                field = domblkstat_output[i].legacy;

            /* use the provided spelling if no translation is available */
            if (!field)
                field = domblkstat_output[i].field;

1205 1206
            vshPrint(ctl, "%s %-*s %s\n", device,
                     human ? 31 : 0, field, value);
1207 1208 1209 1210 1211

            VIR_FREE(value);
        }

        /* go through the fields again, for remaining fields */
1212
        for (i = 0; i < nparams; i++) {
1213 1214
            if (!*params[i].field)
                continue;
1215

1216 1217 1218 1219 1220
            if (!(value = vshGetTypedParamValue(ctl, params+i)))
                continue;

            vshPrint(ctl, "%s %s %s\n", device, params[i].field, value);
            VIR_FREE(value);
1221 1222 1223 1224 1225 1226 1227
        }
    }

    ret = true;

cleanup:
    VIR_FREE(params);
1228
    virDomainFree(dom);
1229
    return ret;
1230
}
1231
#undef DOMBLKSTAT_LEGACY_PRINT
1232 1233 1234

/* "domifstat" command
 */
1235
static const vshCmdInfo info_domifstat[] = {
1236 1237
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1238 1239 1240
    {NULL,NULL}
};

1241
static const vshCmdOptDef opts_domifstat[] = {
1242 1243
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1244 1245 1246
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1247
static bool
1248
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1249 1250
{
    virDomainPtr dom;
1251
    const char *name = NULL, *device = NULL;
1252 1253
    struct _virDomainInterfaceStats stats;

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

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

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

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1266
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1267
        virDomainFree(dom);
E
Eric Blake 已提交
1268
        return false;
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
    }

    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 已提交
1296
    return true;
1297 1298
}

1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
/* "domif-setlink" command
 */
static const vshCmdInfo info_domif_setlink[] = {
    {"help", N_("set link state of a virtual interface")},
    {"desc", N_("Set link state of a domain's virtual interface. This command wraps usage of update-device command.")},
    {NULL,NULL}
};

static const vshCmdOptDef opts_domif_setlink[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device (MAC Address)")},
    {"state", VSH_OT_DATA, VSH_OFLAG_REQ, N_("new state of the device")},
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface state")},
    {NULL, 0, 0, NULL}
};

static bool
cmdDomIfSetLink (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1319
    const char *iface;
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338
    const char *state;
    const char *mac;
    const char *desc;
    bool persistent;
    bool ret = false;
    unsigned int flags = 0;
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;

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

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

1339
    if (vshCommandOptString(cmd, "interface", &iface) <= 0)
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
        goto cleanup;

    if (vshCommandOptString(cmd, "state", &state) <= 0)
        goto cleanup;

    persistent = vshCommandOptBool(cmd, "persistent");

    if (STRNEQ(state, "up") && STRNEQ(state, "down")) {
        vshError(ctl, _("invalid link state '%s'"), state);
        goto cleanup;
    }

    /* get persistent or live description of network device */
    desc = virDomainGetXMLDesc(dom, persistent?VIR_DOMAIN_XML_INACTIVE:0);
    if (desc == NULL) {
        vshError(ctl, _("Failed to get domain description xml"));
        goto cleanup;
    }

    if (persistent)
        flags = VIR_DOMAIN_AFFECT_CONFIG;
    else
        flags = VIR_DOMAIN_AFFECT_LIVE;

    if (virDomainIsActive(dom) == 0)
        flags = VIR_DOMAIN_AFFECT_CONFIG;

    /* extract current network device description */
1368
    xml = virXMLParseStringCtxt(desc, _("(domain_definition)"), &ctxt);
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
    VIR_FREE(desc);
    if (!xml) {
        vshError(ctl, _("Failed to parse domain description xml"));
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/interface", ctxt);
    if (obj == NULL || obj->type != XPATH_NODESET ||
        obj->nodesetval == NULL || obj->nodesetval->nodeNr == 0) {
        vshError(ctl, _("Failed to extract interface information or no interfaces found"));
        goto cleanup;
    }

    /* find interface with matching mac addr */
    for (i = 0; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;

        while (cur) {
            if (cur->type == XML_ELEMENT_NODE &&
                xmlStrEqual(cur->name, BAD_CAST "mac")) {
                mac = virXMLPropString(cur, "address");

1391
                if (STRCASEEQ(mac, iface)) {
1392 1393 1394 1395 1396 1397 1398 1399 1400
                    VIR_FREE(mac);
                    goto hit;
                }
                VIR_FREE(mac);
            }
            cur = cur->next;
        }
    }

1401
    vshError(ctl, _("interface with address '%s' not found"), iface);
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
    goto cleanup;

hit:
    /* find and modify/add link state node */
    /* try to find <link> element */
    cur = obj->nodesetval->nodeTab[i]->children;

    while (cur) {
        if (cur->type == XML_ELEMENT_NODE &&
            xmlStrEqual(cur->name, BAD_CAST "link")) {
            /* found, just modify the property */
            xmlSetProp(cur, BAD_CAST "state", BAD_CAST state);

            break;
        }
        cur = cur->next;
    }

    if (!cur) {
        /* element <link> not found, add one */
        cur = xmlNewChild(obj->nodesetval->nodeTab[i],
                          NULL,
                          BAD_CAST "link",
                          NULL);
        if (!cur)
            goto cleanup;

        if (xmlNewProp(cur, BAD_CAST "state", BAD_CAST state) == NULL)
            goto cleanup;
    }

    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
        vshError(ctl, _("Failed to allocate memory"));
        goto cleanup;
    }

    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0 ) {
        vshError(ctl, _("Failed to create XML"));
        goto cleanup;
    }

    if (virDomainUpdateDeviceFlags(dom, (char *)xmlBufferContent(xml_buf), flags) < 0) {
        vshError(ctl, _("Failed to update interface link state"));
        goto cleanup;
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
        ret = true;
    }

cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);

    if (dom)
        virDomainFree(dom);

    return ret;
}

/* "domif-getlink" command
 */
static const vshCmdInfo info_domif_getlink[] = {
    {"help", N_("get link state of a virtual interface")},
    {"desc", N_("Get link state of a domain's virtual interface.")},
    {NULL,NULL}
};

static const vshCmdOptDef opts_domif_getlink[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device (MAC Address)")},
    {"persistent", VSH_OT_BOOL, 0, N_("Get persistent interface state")},
    {NULL, 0, 0, NULL}
};

static bool
cmdDomIfGetLink (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1483
    const char *iface = NULL;
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500
    int flags = 0;
    char *state = NULL;
    char *mac = NULL;
    bool ret = false;
    int i;
    char *desc;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlXPathObjectPtr obj = NULL;

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

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

1501
    if (vshCommandOptString (cmd, "interface", &iface) <= 0) {
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514
        virDomainFree(dom);
        return false;
    }

    if (vshCommandOptBool(cmd, "persistent"))
        flags = VIR_DOMAIN_XML_INACTIVE;

    desc = virDomainGetXMLDesc(dom, flags);
    if (desc == NULL) {
        vshError(ctl, _("Failed to get domain description xml"));
        goto cleanup;
    }

1515
    xml = virXMLParseStringCtxt(desc, _("(domain_definition)"), &ctxt);
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538
    VIR_FREE(desc);
    if (!xml) {
        vshError(ctl, _("Failed to parse domain description xml"));
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/interface", ctxt);
    if (obj == NULL || obj->type != XPATH_NODESET ||
        obj->nodesetval == NULL || obj->nodesetval->nodeNr == 0) {
        vshError(ctl, _("Failed to extract interface information or no interfaces found"));
        goto cleanup;
    }

    /* find interface with matching mac addr */
    for (i = 0; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;

        while (cur) {
            if (cur->type == XML_ELEMENT_NODE &&
                xmlStrEqual(cur->name, BAD_CAST "mac")) {

                mac = virXMLPropString(cur, "address");

1539
                if (STRCASEEQ(mac, iface)){
1540 1541 1542 1543 1544 1545 1546 1547
                    VIR_FREE(mac);
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }

1548
    vshError(ctl, _("Interface with address '%s' not found."), iface);
1549 1550 1551 1552 1553 1554 1555 1556 1557
    goto cleanup;

hit:
    cur = obj->nodesetval->nodeTab[i]->children;
    while (cur) {
        if (cur->type == XML_ELEMENT_NODE &&
            xmlStrEqual(cur->name, BAD_CAST "link")) {

            state = virXMLPropString(cur, "state");
1558
            vshPrint(ctl, "%s %s", iface, state);
1559 1560 1561 1562 1563 1564 1565 1566
            VIR_FREE(state);

            goto cleanup;
        }
        cur = cur->next;
    }

    /* attribute not found */
1567
    vshPrint(ctl, "%s default", iface);
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578

cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    if (dom)
        virDomainFree(dom);

    return ret;
}

1579 1580 1581
/*
 * "dommemstats" command
 */
1582
static const vshCmdInfo info_dommemstat[] = {
1583 1584
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1585 1586 1587
    {NULL,NULL}
};

1588
static const vshCmdOptDef opts_dommemstat[] = {
1589
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1590 1591 1592
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1593
static bool
1594
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1595 1596
{
    virDomainPtr dom;
1597
    const char *name;
1598 1599 1600
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1601
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1602
        return false;
1603 1604

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1605
        return false;
1606 1607 1608 1609 1610

    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 已提交
1611
        return false;
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
    }

    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);
1627 1628
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON)
            vshPrint (ctl, "actual %llu\n", stats[i].val);
1629 1630 1631
    }

    virDomainFree(dom);
E
Eric Blake 已提交
1632
    return true;
1633 1634
}

1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649
/*
 * "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 已提交
1650
static bool
1651 1652 1653 1654
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1655
    bool ret = true;
1656
    const char *device = NULL;
1657

1658
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1659
        return false;
1660 1661

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

1664
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1665
        virDomainFree(dom);
E
Eric Blake 已提交
1666
        return false;
1667 1668 1669 1670
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1671
        return false;
1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
    }

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

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
/*
 * "domblklist" command
 */
static const vshCmdInfo info_domblklist[] = {
    {"help", N_("list all domain blocks")},
    {"desc", N_("Get the names of block devices for a domain.")},
    {NULL, NULL}
};

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

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

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

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

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

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

1724
    xmldoc = virXMLParseStringCtxt(xml, _("(domain_definition)"), &ctxt);
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
    if (!xmldoc)
        goto cleanup;

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

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

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

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

    ret = 0;

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

1762 1763 1764
/*
 * "suspend" command
 */
1765
static const vshCmdInfo info_suspend[] = {
1766 1767
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1768
    {NULL, NULL}
1769 1770
};

1771
static const vshCmdOptDef opts_suspend[] = {
1772
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1773
    {NULL, 0, 0, NULL}
1774 1775
};

E
Eric Blake 已提交
1776
static bool
1777
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1778
{
1779
    virDomainPtr dom;
1780
    const char *name;
E
Eric Blake 已提交
1781
    bool ret = true;
1782

1783
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1784
        return false;
1785

J
Jim Meyering 已提交
1786
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1787
        return false;
1788 1789

    if (virDomainSuspend(dom) == 0) {
1790
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1791
    } else {
1792
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1793
        ret = false;
1794
    }
1795

1796 1797 1798 1799
    virDomainFree(dom);
    return ret;
}

1800 1801 1802
/*
 * "create" command
 */
1803
static const vshCmdInfo info_create[] = {
1804 1805
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1806 1807 1808
    {NULL, NULL}
};

1809
static const vshCmdOptDef opts_create[] = {
1810
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1811
#ifndef WIN32
1812
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1813
#endif
1814
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1815
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1816 1817 1818
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1819
static bool
1820
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1821 1822
{
    virDomainPtr dom;
1823
    const char *from = NULL;
E
Eric Blake 已提交
1824
    bool ret = true;
1825
    char *buffer;
1826
#ifndef WIN32
1827
    int console = vshCommandOptBool(cmd, "console");
1828
#endif
1829
    unsigned int flags = VIR_DOMAIN_NONE;
1830

1831
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1832
        return false;
1833

1834
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1835
        return false;
1836

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

1840 1841
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1842 1843
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1844 1845

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1846
    VIR_FREE(buffer);
1847

1848
    if (dom != NULL) {
1849
        vshPrint(ctl, _("Domain %s created from %s\n"),
1850
                 virDomainGetName(dom), from);
1851
#ifndef WIN32
1852
        if (console)
1853
            cmdRunConsole(ctl, dom, NULL);
1854
#endif
1855
        virDomainFree(dom);
1856
    } else {
1857
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1858
        ret = false;
1859 1860 1861 1862
    }
    return ret;
}

1863 1864 1865
/*
 * "define" command
 */
1866
static const vshCmdInfo info_define[] = {
1867 1868
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1869 1870 1871
    {NULL, NULL}
};

1872
static const vshCmdOptDef opts_define[] = {
1873
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1874 1875 1876
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1877
static bool
1878
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1879 1880
{
    virDomainPtr dom;
1881
    const char *from = NULL;
E
Eric Blake 已提交
1882
    bool ret = true;
1883
    char *buffer;
1884

1885
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1886
        return false;
1887

1888
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1889
        return false;
1890

1891
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1892
        return false;
1893 1894

    dom = virDomainDefineXML(ctl->conn, buffer);
1895
    VIR_FREE(buffer);
1896

1897
    if (dom != NULL) {
1898
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1899
                 virDomainGetName(dom), from);
1900
        virDomainFree(dom);
1901
    } else {
1902
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1903
        ret = false;
1904 1905 1906 1907 1908 1909 1910
    }
    return ret;
}

/*
 * "undefine" command
 */
1911
static const vshCmdInfo info_undefine[] = {
1912 1913
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1914 1915 1916
    {NULL, NULL}
};

1917
static const vshCmdOptDef opts_undefine[] = {
1918
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1919
    {"managed-save", VSH_OT_BOOL, 0, N_("remove domain managed state file")},
1920 1921
    {"snapshots-metadata", VSH_OT_BOOL, 0,
     N_("remove all domain snapshot metadata, if inactive")},
1922 1923 1924
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1925
static bool
1926
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1927 1928
{
    virDomainPtr dom;
1929
    bool ret = false;
1930
    const char *name = NULL;
1931
    /* Flags to attempt.  */
E
Eric Blake 已提交
1932
    unsigned int flags = 0;
1933 1934 1935 1936
    /* User-requested actions.  */
    bool managed_save = vshCommandOptBool(cmd, "managed-save");
    bool snapshots_metadata = vshCommandOptBool(cmd, "snapshots-metadata");
    /* Positive if these items exist.  */
1937
    int has_managed_save = 0;
1938 1939 1940 1941 1942
    int has_snapshots_metadata = 0;
    int has_snapshots = 0;
    /* True if undefine will not strand data, even on older servers.  */
    bool managed_save_safe = false;
    bool snapshots_safe = false;
1943
    int rc = -1;
1944
    int running;
1945

1946
    if (managed_save) {
1947
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
1948 1949 1950 1951 1952 1953
        managed_save_safe = true;
    }
    if (snapshots_metadata) {
        flags |= VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
1954

1955
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1956
        return false;
1957

1958
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1959
        return false;
1960

1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979
    /* Do some flag manipulation.  The goal here is to disable bits
     * from flags to reduce the likelihood of a server rejecting
     * unknown flag bits, as well as to track conditions which are
     * safe by default for the given hypervisor and server version.  */
    running = virDomainIsActive(dom);
    if (running < 0) {
        virshReportError(ctl);
        goto cleanup;
    }
    if (!running) {
        /* Undefine with snapshots only fails for inactive domains,
         * and managed save only exists on inactive domains; if
         * running, then we don't want to remove anything.  */
        has_managed_save = virDomainHasManagedSaveImage(dom, 0);
        if (has_managed_save < 0) {
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
                goto cleanup;
            }
1980 1981
            virFreeError(last_error);
            last_error = NULL;
1982
            has_managed_save = 0;
1983 1984
        }

1985 1986
        has_snapshots = virDomainSnapshotNum(dom, 0);
        if (has_snapshots < 0) {
1987 1988
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000
                goto cleanup;
            }
            virFreeError(last_error);
            last_error = NULL;
            has_snapshots = 0;
        }
        if (has_snapshots) {
            has_snapshots_metadata
                = virDomainSnapshotNum(dom, VIR_DOMAIN_SNAPSHOT_LIST_METADATA);
            if (has_snapshots_metadata < 0) {
                /* The server did not know the new flag, assume that all
                   snapshots have metadata.  */
2001 2002
                virFreeError(last_error);
                last_error = NULL;
2003 2004 2005 2006 2007
                has_snapshots_metadata = has_snapshots;
            } else {
                /* The server knew the new flag, all aspects of
                 * undefineFlags are safe.  */
                managed_save_safe = snapshots_safe = true;
2008
            }
2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021
        }
    }
    if (!has_managed_save) {
        flags &= ~VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
        managed_save_safe = true;
    }
    if (has_snapshots == 0) {
        snapshots_safe = true;
    }
    if (has_snapshots_metadata == 0) {
        flags &= ~VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
2022

2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036
    /* Generally we want to try the new API first.  However, while
     * virDomainUndefineFlags was introduced at the same time as
     * VIR_DOMAIN_UNDEFINE_MANAGED_SAVE in 0.9.4, the
     * VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA flag was not present
     * until 0.9.5; skip to piecewise emulation if we couldn't prove
     * above that the new API is safe.  */
    if (managed_save_safe && snapshots_safe) {
        rc = virDomainUndefineFlags(dom, flags);
        if (rc == 0 || (last_error->code != VIR_ERR_NO_SUPPORT &&
                        last_error->code != VIR_ERR_INVALID_ARG))
            goto out;
        virFreeError(last_error);
        last_error = NULL;
    }
2037

2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049
    /* The new API is unsupported or unsafe; fall back to doing things
     * piecewise.  */
    if (has_managed_save) {
        if (!managed_save) {
            vshError(ctl, "%s",
                     _("Refusing to undefine while domain managed save "
                       "image exists"));
            goto cleanup;
        }
        if (virDomainManagedSaveRemove(dom, 0) < 0) {
            virshReportError(ctl);
            goto cleanup;
2050 2051 2052
        }
    }

2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066
    /* No way to emulate deletion of just snapshot metadata
     * without support for the newer flags.  Oh well.  */
    if (has_snapshots_metadata) {
        vshError(ctl,
                 snapshots_metadata ?
                 _("Unable to remove metadata of %d snapshots") :
                 _("Refusing to undefine while %d snapshots exist"),
                 has_snapshots_metadata);
        goto cleanup;
    }

    rc = virDomainUndefine(dom);

out:
2067
    if (rc == 0) {
2068
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
2069
        ret = true;
2070
    } else {
2071
        vshError(ctl, _("Failed to undefine domain %s"), name);
2072 2073
    }

2074
cleanup:
2075
    virDomainFree(dom);
2076 2077 2078 2079 2080 2081 2082
    return ret;
}


/*
 * "start" command
 */
2083
static const vshCmdInfo info_start[] = {
2084
    {"help", N_("start a (previously defined) inactive domain")},
2085 2086 2087
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
2088 2089 2090
    {NULL, NULL}
};

2091
static const vshCmdOptDef opts_start[] = {
2092
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
2093
#ifndef WIN32
2094
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
2095
#endif
E
Eric Blake 已提交
2096
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
2097 2098
    {"autodestroy", VSH_OT_BOOL, 0,
     N_("automatically destroy the guest when virsh disconnects")},
2099 2100
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when loading")},
2101 2102
    {"force-boot", VSH_OT_BOOL, 0,
     N_("force fresh boot by discarding any managed save")},
2103 2104 2105
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2106
static bool
2107
cmdStart(vshControl *ctl, const vshCmd *cmd)
2108 2109
{
    virDomainPtr dom;
2110
    bool ret = false;
2111
#ifndef WIN32
2112
    int console = vshCommandOptBool(cmd, "console");
2113
#endif
E
Eric Blake 已提交
2114
    unsigned int flags = VIR_DOMAIN_NONE;
2115
    int rc;
2116

2117
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2118
        return false;
2119

2120 2121
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
2122
        return false;
2123 2124

    if (virDomainGetID(dom) != (unsigned int)-1) {
2125
        vshError(ctl, "%s", _("Domain is already active"));
2126
        virDomainFree(dom);
E
Eric Blake 已提交
2127
        return false;
2128 2129
    }

E
Eric Blake 已提交
2130 2131
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
2132 2133
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
2134 2135
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_START_BYPASS_CACHE;
2136 2137
    if (vshCommandOptBool(cmd, "force-boot"))
        flags |= VIR_DOMAIN_START_FORCE_BOOT;
E
Eric Blake 已提交
2138

2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163
    /* We can emulate force boot, even for older servers that reject it.  */
    if (flags & VIR_DOMAIN_START_FORCE_BOOT) {
        if (virDomainCreateWithFlags(dom, flags) == 0)
            goto started;
        if (last_error->code != VIR_ERR_NO_SUPPORT &&
            last_error->code != VIR_ERR_INVALID_ARG) {
            virshReportError(ctl);
            goto cleanup;
        }
        virFreeError(last_error);
        last_error = NULL;
        rc = virDomainHasManagedSaveImage(dom, 0);
        if (rc < 0) {
            /* No managed save image to remove */
            virFreeError(last_error);
            last_error = NULL;
        } else if (rc > 0) {
            if (virDomainManagedSaveRemove(dom, 0) < 0) {
                virshReportError(ctl);
                goto cleanup;
            }
        }
        flags &= ~VIR_DOMAIN_START_FORCE_BOOT;
    }

E
Eric Blake 已提交
2164 2165
    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
2166
         : virDomainCreate(dom)) < 0) {
2167
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
2168
        goto cleanup;
2169
    }
2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181

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

    ret = true;

cleanup:
2182
    virDomainFree(dom);
2183 2184 2185
    return ret;
}

2186 2187 2188
/*
 * "save" command
 */
2189
static const vshCmdInfo info_save[] = {
2190
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
2191
    {"desc", N_("Save the RAM state of a running domain.")},
2192
    {NULL, NULL}
2193 2194
};

2195
static const vshCmdOptDef opts_save[] = {
2196
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2197 2198
    {"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")},
2199 2200
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2201 2202
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on restore")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on restore")},
2203
    {NULL, 0, 0, NULL}
2204 2205
};

E
Eric Blake 已提交
2206
static bool
2207
cmdSave(vshControl *ctl, const vshCmd *cmd)
2208
{
2209
    virDomainPtr dom;
2210 2211
    const char *name = NULL;
    const char *to = NULL;
2212
    bool ret = false;
E
Eric Blake 已提交
2213
    unsigned int flags = 0;
2214 2215
    const char *xmlfile = NULL;
    char *xml = NULL;
2216

2217
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2218
        return false;
2219

2220
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
2221
        return false;
2222

2223 2224
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2225 2226 2227 2228
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2229

2230 2231 2232 2233 2234
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

2238 2239 2240 2241 2242 2243
    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
        goto cleanup;

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
2244
         : virDomainSave(dom, to)) < 0) {
2245
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
2246
        goto cleanup;
2247
    }
2248

2249 2250 2251 2252
    vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
    ret = true;

cleanup:
2253
    VIR_FREE(xml);
2254 2255 2256 2257
    virDomainFree(dom);
    return ret;
}

2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278
/*
 * "save-image-dumpxml" command
 */
static const vshCmdInfo info_save_image_dumpxml[] = {
    {"help", N_("saved state domain information in XML")},
    {"desc", N_("Output the domain information for a saved state file,\n"
                "as an XML dump to stdout.")},
    {NULL, NULL}
};

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

static bool
cmdSaveImageDumpxml(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
E
Eric Blake 已提交
2279
    unsigned int flags = 0;
2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315
    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")},
2316 2317
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on restore")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on restore")},
2318 2319 2320 2321 2322 2323 2324 2325 2326 2327
    {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;
2328 2329 2330 2331 2332 2333
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348

    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;

2349
    if (virDomainSaveImageDefineXML(ctl->conn, file, xml, flags) < 0) {
2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372
        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")},
2373 2374
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on restore")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on restore")},
2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385
    {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;
2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401
    unsigned int getxml_flags = VIR_DOMAIN_XML_SECURE;
    unsigned int define_flags = 0;

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

    /* Normally, we let the API reject mutually exclusive flags.
     * However, in the edit cycle, we let the user retry if the define
     * step fails, but the define step will always fail on invalid
     * flags, so we reject it up front to avoid looping.  */
    if (define_flags == (VIR_DOMAIN_SAVE_RUNNING | VIR_DOMAIN_SAVE_PAUSED)) {
        vshError(ctl, "%s", _("--running and --saved are mutually exclusive"));
        return false;
    }
2402 2403 2404 2405 2406 2407 2408 2409

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

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

    /* Get the XML configuration of the saved image.  */
2410
    doc = virDomainSaveImageGetXMLDesc(ctl->conn, file, getxml_flags);
2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
    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;

2428 2429 2430
    /* Compare original XML with edited.  Short-circuit if it did not
     * change, and we do not have any flags.  */
    if (STREQ(doc, doc_edited) && !define_flags) {
2431 2432 2433 2434 2435 2436 2437
        vshPrint(ctl, _("Saved image %s XML configuration not changed.\n"),
                 file);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
2438 2439
    if (virDomainSaveImageDefineXML(ctl->conn, file, doc_edited,
                                    define_flags) < 0) {
2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456
        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;
}

2457 2458 2459 2460 2461
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
2462 2463 2464 2465
    {"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.")},
2466 2467 2468 2469
    {NULL, NULL}
};

static const vshCmdOptDef opts_managedsave[] = {
2470
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2471
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2472 2473
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on next start")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on next start")},
2474 2475 2476
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2477
static bool
2478 2479 2480
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
2481
    const char *name;
2482
    bool ret = false;
E
Eric Blake 已提交
2483
    unsigned int flags = 0;
2484

2485
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2486
        return false;
2487

2488 2489
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2490 2491 2492 2493
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2494

2495
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2496
        return false;
2497

2498
    if (virDomainManagedSave(dom, flags) < 0) {
2499
        vshError(ctl, _("Failed to save domain %s state"), name);
2500
        goto cleanup;
2501 2502
    }

2503 2504 2505 2506
    vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    ret = true;

cleanup:
2507 2508 2509 2510
    virDomainFree(dom);
    return ret;
}

2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524
/*
 * "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 已提交
2525
static bool
2526 2527 2528
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
2529
    const char *name;
E
Eric Blake 已提交
2530
    bool ret = false;
2531 2532
    int hassave;

2533
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2534
        return false;
2535 2536

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2537
        return false;
2538 2539 2540

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
2541
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557
        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 已提交
2558
    ret = true;
2559 2560 2561 2562 2563 2564

cleanup:
    virDomainFree(dom);
    return ret;
}

2565 2566 2567
/*
 * "schedinfo" command
 */
2568
static const vshCmdInfo info_schedinfo[] = {
2569 2570
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
2571 2572 2573
    {NULL, NULL}
};

2574
static const vshCmdOptDef opts_schedinfo[] = {
2575 2576 2577 2578
    {"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")},
2579 2580 2581
    {"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")},
2582 2583 2584
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
2585
static int
2586
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
2587
                   virTypedParameterPtr param)
2588
{
2589
    const char *data = NULL;
2590 2591 2592

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
2593
        param->type == VIR_TYPED_PARAM_UINT &&
2594 2595
        vshCommandOptBool(cmd, "weight")) {
        int val;
2596
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
2597
            vshError(ctl, "%s", _("Invalid value of weight"));
2598
            return -1;
2599
        } else {
2600
            param->value.ui = val;
2601
        }
2602
        return 1;
2603 2604
    }

2605 2606
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
2607
        param->type == VIR_TYPED_PARAM_UINT &&
2608 2609
        vshCommandOptBool(cmd, "cap")) {
        int val;
2610
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
2611
            vshError(ctl, "%s", _("Invalid value of cap"));
2612
            return -1;
2613
        } else {
2614
            param->value.ui = val;
2615
        }
2616
        return 1;
2617
    }
2618

2619
    if (vshCommandOptString(cmd, "set", &data) > 0) {
2620 2621 2622
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
2623
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
2624
            return -1;
2625
        }
2626 2627 2628 2629 2630 2631 2632 2633 2634
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
2635
        case VIR_TYPED_PARAM_INT:
2636
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
2637
                vshError(ctl, "%s",
2638 2639 2640 2641
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
2642
        case VIR_TYPED_PARAM_UINT:
2643
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
2644
                vshError(ctl, "%s",
2645 2646 2647 2648
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
2649
        case VIR_TYPED_PARAM_LLONG:
2650
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
2651
                vshError(ctl, "%s",
J
Jim Meyering 已提交
2652
                         _("Invalid value for parameter, expecting a long long"));
2653 2654 2655
                return -1;
            }
            break;
2656
        case VIR_TYPED_PARAM_ULLONG:
2657
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
2658
                vshError(ctl, "%s",
2659 2660 2661 2662
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
2663
        case VIR_TYPED_PARAM_DOUBLE:
2664
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
2665
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
2666 2667 2668
                return -1;
            }
            break;
2669
        case VIR_TYPED_PARAM_BOOLEAN:
2670
            param->value.b = STREQ(val, "0") ? 0 : 1;
2671
        }
2672
        return 1;
2673
    }
2674

2675 2676
    return 0;
}
2677

2678

E
Eric Blake 已提交
2679
static bool
2680 2681 2682 2683
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
2684
    virTypedParameterPtr params = NULL;
2685 2686 2687
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
2688
    bool ret_val = false;
2689 2690 2691 2692 2693 2694 2695 2696 2697 2698
    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;
        }
2699
        flags = VIR_DOMAIN_AFFECT_CURRENT;
2700 2701
    } else {
        if (config)
2702
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
2703
        if (live)
2704
            flags |= VIR_DOMAIN_AFFECT_LIVE;
2705
    }
2706

2707
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2708
        return false;
2709

2710
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2711
        return false;
2712 2713 2714

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
2715
    if (schedulertype != NULL) {
2716
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
2717
             schedulertype);
2718
        VIR_FREE(schedulertype);
2719
    } else {
2720
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
2721
        goto cleanup;
2722 2723
    }

2724
    if (nparams) {
2725
        params = vshMalloc(ctl, sizeof(*params) * nparams);
2726

2727
        memset(params, 0, sizeof(*params) * nparams);
2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738
        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);
        }
2739 2740 2741 2742
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
2743
        for (i = 0; i < nparams; i++) {
2744 2745 2746 2747 2748 2749 2750 2751 2752 2753
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
2754 2755 2756 2757 2758
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
2759 2760 2761
            if (ret == -1)
                goto cleanup;

2762 2763 2764 2765 2766 2767 2768
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
2769 2770
            if (ret == -1)
                goto cleanup;
2771 2772 2773 2774
        } 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.  */
2775 2776
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
2777 2778 2779 2780
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
2781 2782 2783 2784 2785 2786
            /* 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;
            }
2787 2788
        }

E
Eric Blake 已提交
2789
        ret_val = true;
2790
        for (i = 0; i < nparams; i++) {
2791
            switch (params[i].type) {
2792
            case VIR_TYPED_PARAM_INT:
2793
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
2794
                 break;
2795
            case VIR_TYPED_PARAM_UINT:
2796
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
2797
                 break;
2798
            case VIR_TYPED_PARAM_LLONG:
2799
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
2800
                 break;
2801
            case VIR_TYPED_PARAM_ULLONG:
2802
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
2803
                 break;
2804
            case VIR_TYPED_PARAM_DOUBLE:
2805
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
2806
                 break;
2807
            case VIR_TYPED_PARAM_BOOLEAN:
2808
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
2809 2810
                 break;
            default:
2811
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
2812 2813 2814
            }
        }
    }
2815

2816
 cleanup:
2817
    VIR_FREE(params);
2818
    virDomainFree(dom);
2819
    return ret_val;
2820 2821
}

2822 2823 2824
/*
 * "restore" command
 */
2825
static const vshCmdInfo info_restore[] = {
2826 2827
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
2828
    {NULL, NULL}
2829 2830
};

2831
static const vshCmdOptDef opts_restore[] = {
2832
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
2833 2834
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when restoring")},
2835 2836
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2837 2838
    {"running", VSH_OT_BOOL, 0, N_("restore domain into running state")},
    {"paused", VSH_OT_BOOL, 0, N_("restore domain into paused state")},
2839
    {NULL, 0, 0, NULL}
2840 2841
};

E
Eric Blake 已提交
2842
static bool
2843
cmdRestore(vshControl *ctl, const vshCmd *cmd)
2844
{
2845
    const char *from = NULL;
2846
    bool ret = false;
E
Eric Blake 已提交
2847
    unsigned int flags = 0;
2848 2849
    const char *xmlfile = NULL;
    char *xml = NULL;
2850

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

2854
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2855
        return false;
2856

2857 2858
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2859 2860 2861 2862
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2863

2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874
    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)
2875
         : virDomainRestore(ctl->conn, from)) < 0) {
2876
        vshError(ctl, _("Failed to restore domain from %s"), from);
2877
        goto cleanup;
2878
    }
2879 2880 2881 2882 2883

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

cleanup:
2884
    VIR_FREE(xml);
2885 2886 2887
    return ret;
}

D
Daniel Veillard 已提交
2888 2889 2890
/*
 * "dump" command
 */
2891
static const vshCmdInfo info_dump[] = {
2892 2893
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
2894 2895 2896
    {NULL, NULL}
};

2897
static const vshCmdOptDef opts_dump[] = {
2898 2899
    {"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")},
2900 2901
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when saving")},
2902 2903
    {"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 已提交
2904 2905 2906
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2907
static bool
2908
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
2909 2910
{
    virDomainPtr dom;
2911 2912
    const char *name = NULL;
    const char *to = NULL;
2913
    bool ret = false;
E
Eric Blake 已提交
2914
    unsigned int flags = 0;
D
Daniel Veillard 已提交
2915

2916
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2917
        return false;
D
Daniel Veillard 已提交
2918

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

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

P
Paolo Bonzini 已提交
2925 2926
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
2927 2928
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;
2929 2930
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DUMP_BYPASS_CACHE;
2931

2932
    if (virDomainCoreDump(dom, to, flags) < 0) {
2933
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
2934
        goto cleanup;
D
Daniel Veillard 已提交
2935 2936
    }

2937 2938 2939 2940
    vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
    ret = true;

cleanup:
D
Daniel Veillard 已提交
2941 2942 2943 2944
    virDomainFree(dom);
    return ret;
}

2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091
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;
}

3092 3093 3094
/*
 * "resume" command
 */
3095
static const vshCmdInfo info_resume[] = {
3096 3097
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
3098
    {NULL, NULL}
3099 3100
};

3101
static const vshCmdOptDef opts_resume[] = {
3102
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3103
    {NULL, 0, 0, NULL}
3104 3105
};

E
Eric Blake 已提交
3106
static bool
3107
cmdResume(vshControl *ctl, const vshCmd *cmd)
3108
{
3109
    virDomainPtr dom;
E
Eric Blake 已提交
3110
    bool ret = true;
3111
    const char *name;
3112

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

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

    if (virDomainResume(dom) == 0) {
3120
        vshPrint(ctl, _("Domain %s resumed\n"), name);
3121
    } else {
3122
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
3123
        ret = false;
3124
    }
3125

3126 3127 3128 3129
    virDomainFree(dom);
    return ret;
}

3130 3131 3132
/*
 * "shutdown" command
 */
3133
static const vshCmdInfo info_shutdown[] = {
3134 3135
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
3136
    {NULL, NULL}
3137 3138
};

3139
static const vshCmdOptDef opts_shutdown[] = {
3140
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3141
    {NULL, 0, 0, NULL}
3142 3143
};

E
Eric Blake 已提交
3144
static bool
3145
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
3146
{
3147
    virDomainPtr dom;
E
Eric Blake 已提交
3148
    bool ret = true;
3149
    const char *name;
3150

3151
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3152
        return false;
3153

J
Jim Meyering 已提交
3154
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3155
        return false;
3156 3157

    if (virDomainShutdown(dom) == 0) {
3158
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
3159
    } else {
3160
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
3161
        ret = false;
3162
    }
3163

3164 3165 3166 3167
    virDomainFree(dom);
    return ret;
}

3168 3169 3170
/*
 * "reboot" command
 */
3171
static const vshCmdInfo info_reboot[] = {
3172 3173
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
3174 3175 3176
    {NULL, NULL}
};

3177
static const vshCmdOptDef opts_reboot[] = {
3178
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3179 3180 3181
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3182
static bool
3183
cmdReboot(vshControl *ctl, const vshCmd *cmd)
3184 3185
{
    virDomainPtr dom;
E
Eric Blake 已提交
3186
    bool ret = true;
3187
    const char *name;
3188

3189
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3190
        return false;
3191

J
Jim Meyering 已提交
3192
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3193
        return false;
3194 3195

    if (virDomainReboot(dom, 0) == 0) {
3196
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
3197
    } else {
3198
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
3199
        ret = false;
3200 3201 3202 3203 3204 3205
    }

    virDomainFree(dom);
    return ret;
}

3206 3207 3208
/*
 * "destroy" command
 */
3209
static const vshCmdInfo info_destroy[] = {
3210 3211 3212
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
3213
    {NULL, NULL}
3214 3215
};

3216
static const vshCmdOptDef opts_destroy[] = {
3217
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3218
    {NULL, 0, 0, NULL}
3219 3220
};

E
Eric Blake 已提交
3221
static bool
3222
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
3223
{
3224
    virDomainPtr dom;
E
Eric Blake 已提交
3225
    bool ret = true;
3226
    const char *name;
3227

3228
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3229
        return false;
3230

J
Jim Meyering 已提交
3231
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3232
        return false;
3233 3234

    if (virDomainDestroy(dom) == 0) {
3235
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
3236
    } else {
3237
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
3238
        ret = false;
3239
    }
3240

3241
    virDomainFree(dom);
K
Karel Zak 已提交
3242 3243 3244 3245
    return ret;
}

/*
3246
 * "dominfo" command
K
Karel Zak 已提交
3247
 */
3248
static const vshCmdInfo info_dominfo[] = {
3249 3250
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
3251
    {NULL, NULL}
K
Karel Zak 已提交
3252 3253
};

3254
static const vshCmdOptDef opts_dominfo[] = {
3255
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3256
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3257 3258
};

E
Eric Blake 已提交
3259
static bool
3260
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
3261
{
K
Karel Zak 已提交
3262 3263
    virDomainInfo info;
    virDomainPtr dom;
3264
    virSecurityModel secmodel;
3265
    virSecurityLabelPtr seclabel;
3266
    int persistent = 0;
E
Eric Blake 已提交
3267 3268
    bool ret = true;
    int autostart;
3269
    unsigned int id;
3270
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
3271
    int has_managed_save = 0;
3272

3273
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3274
        return false;
K
Karel Zak 已提交
3275

J
Jim Meyering 已提交
3276
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3277
        return false;
3278

3279 3280
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3281
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
3282
    else
3283
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
3284 3285
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
3286
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
3287
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
3288 3289

    if ((str = virDomainGetOSType(dom))) {
3290
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
3291
        VIR_FREE(str);
3292 3293 3294
    }

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

3298
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
3299 3300

        if (info.cpuTime != 0) {
3301
            double cpuUsed = info.cpuTime;
3302

3303
            cpuUsed /= 1000000000.0;
3304

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

3308 3309
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
3310
                 info.maxMem);
3311
        else
3312
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
3313 3314
                 _("no limit"));

3315
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
3316 3317
                 info.memory);

K
Karel Zak 已提交
3318
    } else {
E
Eric Blake 已提交
3319
        ret = false;
K
Karel Zak 已提交
3320
    }
3321

3322 3323
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
3324 3325
    vshDebug(ctl, VSH_ERR_DEBUG, "Domain persistent flag value: %d\n",
             persistent);
3326 3327 3328 3329 3330 3331
    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 */
3332
    if (!virDomainGetAutostart(dom, &autostart)) {
3333
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
3334 3335 3336
                 autostart ? _("enable") : _("disable") );
    }

3337 3338 3339 3340 3341 3342 3343
    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"));

3344 3345 3346
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
3347 3348
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
3349
            return false;
3350 3351 3352
        } else {
            virFreeError(last_error);
            last_error = NULL;
3353
        }
3354 3355 3356 3357 3358 3359 3360
    } 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 */
3361
            if (VIR_ALLOC(seclabel) < 0) {
3362
                virDomainFree(dom);
E
Eric Blake 已提交
3363
                return false;
3364 3365 3366 3367 3368
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
3369
                return false;
3370
            } else {
3371
                if (seclabel->label[0] != '\0')
3372
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
3373
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
3374
            }
3375 3376

            VIR_FREE(seclabel);
3377 3378
        }
    }
3379
    virDomainFree(dom);
K
Karel Zak 已提交
3380 3381 3382
    return ret;
}

3383 3384 3385 3386
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
3387 3388
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
3389 3390 3391 3392
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
3393
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3394 3395 3396 3397
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
3398
static bool
3399 3400 3401 3402
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
3403
    bool ret = true;
3404

3405
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3406
        return false;
3407 3408

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3409
        return false;
3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435

    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 已提交
3436
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
3437
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
3438
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
3439
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
3440
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
3441 3442 3443
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
3444
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
3445
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
3446
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
3447
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
3448
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
3449 3450 3451
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
3452
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
3453
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
3454
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
3455
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
3456
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
3457 3458
        }
    } else {
E
Eric Blake 已提交
3459
        ret = false;
3460 3461 3462 3463 3464 3465
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

3466 3467 3468 3469
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
3470 3471
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
3472 3473 3474 3475
    {NULL, NULL}
};

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

E
Eric Blake 已提交
3480
static bool
3481 3482 3483
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3484
    bool ret = true;
3485

3486
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3487
        return false;
3488 3489

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
3493
        ret = false;
3494 3495 3496 3497 3498

    virDomainFree(dom);
    return ret;
}

3499 3500 3501
/*
 * "freecell" command
 */
3502
static const vshCmdInfo info_freecell[] = {
3503 3504
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
3505 3506 3507
    {NULL, NULL}
};

3508
static const vshCmdOptDef opts_freecell[] = {
3509
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
3510
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
3511 3512 3513
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3514
static bool
3515
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
3516
{
W
Wen Congyang 已提交
3517
    bool func_ret = false;
3518
    int ret;
3519
    int cell = -1, cell_given;
3520
    unsigned long long memory;
3521 3522 3523 3524
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
3525
    int all_given;
3526 3527 3528 3529
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
3530

3531

3532
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3533
        return false;
3534

3535 3536 3537 3538
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
3539 3540 3541 3542 3543 3544 3545 3546 3547
    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) {
3548 3549 3550
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3551 3552 3553
            goto cleanup;
        }

3554
        xml = virXMLParseStringCtxt(cap_xml, _("(capabilities)"), &ctxt);
3555 3556
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3557 3558
            goto cleanup;
        }
3559 3560 3561 3562
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
3563
            vshError(ctl, "%s", _("could not get information about "
3564
                                  "NUMA topology"));
3565 3566 3567
            goto cleanup;
        }

3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588
        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;
            }
        }

3589
        memory = 0;
3590 3591 3592 3593
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
3594 3595 3596 3597
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
3598
    } else {
3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612
        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));
3613 3614
    }

E
Eric Blake 已提交
3615
    func_ret = true;
3616

3617
cleanup:
3618
    xmlXPathFreeContext(ctxt);
3619
    xmlFreeDoc(xml);
3620
    VIR_FREE(nodes);
3621 3622 3623
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
3624
    return func_ret;
3625 3626
}

E
Eric Blake 已提交
3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640
/*
 * "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 已提交
3641
static bool
E
Eric Blake 已提交
3642 3643
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
3644
    const char *type = NULL;
E
Eric Blake 已提交
3645 3646
    int vcpus;

3647 3648
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
3649
        return false;
3650
    }
E
Eric Blake 已提交
3651 3652

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3653
        return false;
E
Eric Blake 已提交
3654 3655 3656

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

E
Eric Blake 已提交
3660
    return true;
E
Eric Blake 已提交
3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674
}

/*
 * "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")},
3675
    {"active", VSH_OT_BOOL, 0, N_("get number of currently active vcpus")},
E
Eric Blake 已提交
3676
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
3677 3678 3679
    {"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 已提交
3680 3681 3682
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3683
static bool
E
Eric Blake 已提交
3684 3685 3686
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3687
    bool ret = true;
E
Eric Blake 已提交
3688
    int maximum = vshCommandOptBool(cmd, "maximum");
3689
    int active = vshCommandOptBool(cmd, "active");
E
Eric Blake 已提交
3690 3691
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3692 3693
    int current = vshCommandOptBool(cmd, "current");
    bool all = maximum + active + current + config + live == 0;
E
Eric Blake 已提交
3694 3695
    int count;

3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710
    /* 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 已提交
3711
        return false;
E
Eric Blake 已提交
3712
    }
3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725

    /* 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 已提交
3726
        vshError(ctl, "%s",
3727
                 _("--maximum and --active cannot both be specified"));
E
Eric Blake 已提交
3728
        return false;
E
Eric Blake 已提交
3729
    }
3730 3731 3732
    if (current + config + live > 1) {
        vshError(ctl, "%s",
                 _("--config, --live, and --current are mutually exclusive"));
E
Eric Blake 已提交
3733
        return false;
E
Eric Blake 已提交
3734 3735 3736
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3737
        return false;
E
Eric Blake 已提交
3738 3739

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

    /* In all cases, try the new API first; if it fails because we are
3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756
     * 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 已提交
3757 3758
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
3759
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
3760 3761 3762 3763 3764 3765 3766 3767 3768
        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;
            }
3769 3770
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
3771 3772 3773 3774 3775
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
3776
            ret = false;
E
Eric Blake 已提交
3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788
        } 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 |
3789
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
3790 3791 3792 3793 3794 3795 3796
        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 已提交
3797
            ret = false;
E
Eric Blake 已提交
3798 3799 3800 3801 3802 3803 3804 3805 3806 3807
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3808
    if (all || (active && config)) {
3809
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833
        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 已提交
3834
            ret = false;
E
Eric Blake 已提交
3835 3836 3837 3838 3839 3840 3841 3842 3843 3844
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3845
    if (all || (active && live)) {
3846
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
3847 3848 3849 3850 3851 3852 3853 3854 3855
        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 已提交
3856
            ret = false;
E
Eric Blake 已提交
3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870
        } 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;
}

3871 3872 3873
/*
 * "vcpuinfo" command
 */
3874
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
3875
    {"help", N_("detailed domain vcpu information")},
3876
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
3877 3878 3879
    {NULL, NULL}
};

3880
static const vshCmdOptDef opts_vcpuinfo[] = {
3881
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3882 3883 3884
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3885
static bool
3886
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
3887 3888 3889 3890 3891
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
3892 3893
    unsigned char *cpumaps;
    int ncpus, maxcpu;
3894
    size_t cpumaplen;
E
Eric Blake 已提交
3895
    bool ret = true;
3896
    int n, m;
3897

3898
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3899
        return false;
3900

J
Jim Meyering 已提交
3901
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3902
        return false;
3903 3904 3905

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3906
        return false;
3907 3908 3909 3910
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3911
        return false;
3912 3913
    }

3914
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
3915 3916 3917
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
3918

3919 3920
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
3921
                                   cpumaps, cpumaplen)) >= 0) {
3922 3923 3924 3925
        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 已提交
3926
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
3927 3928 3929 3930 3931 3932 3933 3934
            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:"));
3935 3936
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
3937 3938 3939 3940 3941 3942
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
3943
    } else {
3944
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
3945
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3946 3947 3948
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
3949
            /* fallback plan to use virDomainGetVcpuPinInfo */
3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967

            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;
3968
        }
3969 3970
    }

3971
    VIR_FREE(cpumaps);
3972
    VIR_FREE(cpuinfo);
3973 3974 3975 3976 3977 3978 3979
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
3980
static const vshCmdInfo info_vcpupin[] = {
3981
    {"help", N_("control or query domain vcpu affinity")},
3982
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
3983 3984 3985
    {NULL, NULL}
};

3986
static const vshCmdOptDef opts_vcpupin[] = {
3987
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3988 3989 3990
    {"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")},
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
E
Eric Blake 已提交
3998
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
3999 4000 4001 4002
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
4003
    int vcpu = -1;
4004
    const char *cpulist = NULL;
E
Eric Blake 已提交
4005
    bool ret = true;
4006 4007
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
4008
    size_t cpumaplen;
4009 4010
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
4011
    bool unuse = false;
4012
    const char *cur;
4013 4014 4015
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
4016
    bool query = false; /* Query mode if no cpulist */
E
Eric Blake 已提交
4017
    unsigned int flags = 0;
4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033

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

4035
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4036
        return false;
4037

J
Jim Meyering 已提交
4038
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4039
        return false;
4040

4041 4042
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
4043
        virDomainFree(dom);
E
Eric Blake 已提交
4044
        return false;
4045
    }
4046
    query = !cpulist;
4047

4048 4049 4050 4051
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
4052
        virDomainFree(dom);
E
Eric Blake 已提交
4053
        return false;
4054
    }
4055

4056 4057
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
4058
        return false;
4059 4060 4061
    }

    if (virDomainGetInfo(dom, &info) != 0) {
4062
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
4063
        virDomainFree(dom);
E
Eric Blake 已提交
4064
        return false;
4065 4066 4067
    }

    if (vcpu >= info.nrVirtCpu) {
4068
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
4069
        virDomainFree(dom);
E
Eric Blake 已提交
4070
        return false;
4071 4072
    }

4073 4074
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
4075

4076 4077 4078 4079 4080 4081 4082 4083
    /* 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 已提交
4084
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129
                                             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);
4130 4131
    /* Parse cpulist */
    cur = cpulist;
4132
    if (*cur == 0) {
4133
        goto parse_error;
4134 4135 4136
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
4137
        cur = "";
4138
    }
4139 4140 4141 4142 4143 4144 4145

    while (*cur != 0) {

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

4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159
        /* 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);
4160

4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187
        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);
        }
4188

4189 4190 4191 4192 4193 4194
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
4195
        } else {
4196
            goto parse_error;
4197
        }
4198
    }
4199

4200 4201 4202 4203 4204 4205 4206 4207
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
4208 4209
    }

4210
cleanup:
4211
    VIR_FREE(cpumap);
4212 4213
    virDomainFree(dom);
    return ret;
4214 4215 4216 4217 4218

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

4221 4222 4223
/*
 * "setvcpus" command
 */
4224
static const vshCmdInfo info_setvcpus[] = {
4225 4226
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
4227 4228 4229
    {NULL, NULL}
};

4230
static const vshCmdOptDef opts_setvcpus[] = {
4231
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4232
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
4233 4234 4235
    {"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")},
4236
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
4237 4238 4239
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4240
static bool
4241
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
4242 4243
{
    virDomainPtr dom;
4244
    int count = 0;
E
Eric Blake 已提交
4245
    bool ret = true;
E
Eric Blake 已提交
4246 4247 4248
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
4249
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4250
    unsigned int flags = 0;
4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266

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

4268
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4269
        return false;
4270

J
Jim Meyering 已提交
4271
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4272
        return false;
4273

4274 4275 4276 4277
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
4278

4279
    if (flags == -1) {
E
Eric Blake 已提交
4280
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
4281
            ret = false;
E
Eric Blake 已提交
4282 4283
        }
    } else {
4284 4285 4286
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
4287
            vshDebug(ctl, VSH_ERR_DEBUG, "--maximum flag was given\n");
4288

4289 4290
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

4291 4292 4293 4294 4295 4296 4297 4298
            /* 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 已提交
4299
                ret = false;
4300 4301 4302 4303 4304
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
4305
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
4306
            ret = false;
E
Eric Blake 已提交
4307
        }
4308 4309
    }

4310
  cleanup:
4311 4312 4313 4314
    virDomainFree(dom);
    return ret;
}

4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348
/*
 * "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;
}

4349 4350 4351 4352 4353
/*
 * "send-key" command
 */
static const vshCmdInfo info_send_key[] = {
    {"help", N_("Send keycodes to the guest")},
4354
    {"desc", N_("Send keycodes (integers or symbolic names) to the guest")},
4355 4356 4357 4358 4359
    {NULL, NULL}
};

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4360 4361
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT,
     N_("the codeset of keycodes, default:linux")},
4362
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
A
Alex Jia 已提交
4363
     N_("the time (in milliseconds) how long the keys will be held")},
4364 4365 4366 4367 4368 4369 4370 4371 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 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435
    {"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;
}

4436 4437 4438
/*
 * "setmemory" command
 */
4439
static const vshCmdInfo info_setmem[] = {
4440 4441
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
4442 4443 4444
    {NULL, NULL}
};

4445
static const vshCmdOptDef opts_setmem[] = {
4446
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4447
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
4448 4449
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
4450
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
4451 4452 4453
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4454
static bool
4455
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
4456 4457
{
    virDomainPtr dom;
4458
    virDomainInfo info;
4459
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
4460
    bool ret = true;
4461 4462
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
4463
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4464
    unsigned int flags = 0;
4465

4466 4467 4468
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4469
            return false;
4470
        }
4471
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4472 4473
    } else {
        if (config)
4474
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4475
        if (live)
4476
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4477 4478 4479
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
4480
    }
4481

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

J
Jim Meyering 已提交
4485
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4486
        return false;
4487

4488 4489
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4490
        return false;
4491 4492
    }

4493
    if (kilobytes <= 0) {
4494
        virDomainFree(dom);
4495
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
4496
        return false;
4497 4498
    }

4499 4500
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
4501
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
4502
        return false;
4503 4504 4505 4506
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
4507
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
4508
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
4509
        return false;
4510 4511
    }

4512
    if (flags == -1) {
4513
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
4514
            ret = false;
4515 4516 4517
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
4518
            ret = false;
4519
        }
4520 4521 4522 4523 4524 4525 4526 4527 4528
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
4529
static const vshCmdInfo info_setmaxmem[] = {
4530 4531
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
4532 4533 4534
    {NULL, NULL}
};

4535
static const vshCmdOptDef opts_setmaxmem[] = {
4536
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4537
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
4538 4539 4540
    {"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")},
4541 4542 4543
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4544
static bool
4545
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
4546 4547
{
    virDomainPtr dom;
4548
    int kilobytes = 0;
E
Eric Blake 已提交
4549
    bool ret = true;
4550 4551 4552
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4553
    unsigned int flags = VIR_DOMAIN_MEM_MAXIMUM;
4554 4555 4556 4557

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4558
            return false;
4559 4560 4561
        }
    } else {
        if (config)
4562
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4563
        if (live)
4564
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4565 4566 4567 4568
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
4569

4570
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4571
        return false;
4572

J
Jim Meyering 已提交
4573
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4574
        return false;
4575

4576 4577
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4578
        return false;
4579 4580
    }

4581
    if (kilobytes <= 0) {
4582
        virDomainFree(dom);
4583
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
4584
        return false;
4585 4586
    }

4587 4588 4589
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4590
            ret = false;
4591 4592 4593 4594
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4595
            ret = false;
4596
        }
4597 4598
    }

4599 4600 4601 4602
    virDomainFree(dom);
    return ret;
}

4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618
/*
 * "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 已提交
4619 4620 4621
    {"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")},
4622 4623 4624
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4625
static bool
4626 4627 4628 4629 4630
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
4631
    int rv = 0;
4632
    unsigned int i = 0;
4633
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4634
    bool ret = false;
H
Hu Tao 已提交
4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651
    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;
    }
4652 4653

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4654
        return false;
4655 4656

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

4659
    if ((rv = vshCommandOptInt(cmd, "weight", &weight)) < 0) {
4660 4661 4662 4663 4664
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

4665
    if (rv > 0) {
4666
        nparams++;
4667
        if (weight <= 0) {
4668 4669 4670 4671 4672 4673 4674
            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 已提交
4675
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
4676 4677 4678 4679 4680 4681 4682
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4683
            ret = true;
4684 4685 4686 4687 4688
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
4689
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
4690 4691 4692 4693 4694 4695
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4696
                case VIR_TYPED_PARAM_INT:
4697 4698 4699
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4700
                case VIR_TYPED_PARAM_UINT:
4701 4702 4703
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4704
                case VIR_TYPED_PARAM_LLONG:
4705 4706 4707
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4708
                case VIR_TYPED_PARAM_ULLONG:
4709 4710 4711
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
4712
                case VIR_TYPED_PARAM_DOUBLE:
4713 4714 4715
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4716
                case VIR_TYPED_PARAM_BOOLEAN:
4717 4718 4719 4720 4721 4722 4723 4724
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
4725
        ret = true;
4726 4727 4728 4729 4730 4731
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4732
            temp->type = VIR_TYPED_PARAM_UINT;
4733 4734 4735 4736 4737 4738 4739 4740

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
H
Hu Tao 已提交
4741
        if (virDomainSetBlkioParameters(dom, params, nparams, flags) != 0)
4742 4743
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
4744
            ret = true;
4745 4746 4747 4748 4749 4750 4751 4752
    }

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

4753 4754 4755 4756
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
4757 4758 4759
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
4760 4761 4762 4763 4764 4765 4766
                "    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")},
4767
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4768
     N_("Max memory in kilobytes")},
4769
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4770
     N_("Memory during contention in kilobytes")},
4771
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4772
     N_("Max memory plus swap in kilobytes")},
4773
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
4774
     N_("Min guaranteed memory in kilobytes")},
4775 4776 4777
    {"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")},
4778 4779 4780
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4781
static bool
4782 4783 4784
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
4785 4786
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
4787 4788
    int nparams = 0;
    unsigned int i = 0;
4789
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4790
    bool ret = false;
4791 4792 4793 4794 4795 4796 4797 4798 4799 4800
    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;
        }
4801
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4802 4803
    } else {
        if (config)
4804
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4805
        if (live)
4806
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4807
    }
4808 4809

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4810
        return false;
4811 4812

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

4815 4816 4817 4818 4819 4820 4821 4822 4823
    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;
    }

4824 4825 4826 4827 4828 4829 4830 4831 4832
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

4833 4834 4835
    if (min_guarantee)
        nparams++;

4836 4837
    if (nparams == 0) {
        /* get the number of memory parameters */
4838
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
4839 4840 4841 4842 4843
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

4844 4845
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4846
            ret = true;
4847 4848 4849
            goto cleanup;
        }

4850
        /* now go get all the memory parameters */
E
Eric Blake 已提交
4851
        params = vshCalloc(ctl, nparams, sizeof(*params));
4852
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
4853 4854 4855 4856 4857 4858
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4859
                case VIR_TYPED_PARAM_INT:
4860 4861 4862
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4863
                case VIR_TYPED_PARAM_UINT:
4864 4865 4866
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4867
                case VIR_TYPED_PARAM_LLONG:
4868 4869 4870
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4871
                case VIR_TYPED_PARAM_ULLONG:
4872 4873 4874 4875 4876
                    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);
4877
                    break;
4878
                case VIR_TYPED_PARAM_DOUBLE:
4879 4880 4881
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4882
                case VIR_TYPED_PARAM_BOOLEAN:
4883 4884 4885 4886
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
4887
                    vshPrint(ctl, "unimplemented memory parameter type\n");
4888 4889 4890
            }
        }

E
Eric Blake 已提交
4891
        ret = true;
4892 4893
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
4894
        params = vshCalloc(ctl, nparams, sizeof(*params));
4895 4896 4897

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4898
            temp->type = VIR_TYPED_PARAM_ULLONG;
4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917

            /*
             * 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;
4918
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
4919 4920
                        sizeof(temp->field));
                swap_hard_limit = 0;
4921 4922 4923 4924 4925
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
4926
            }
4927 4928 4929 4930

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
4931
        }
4932
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
4933
            vshError(ctl, "%s", _("Unable to change memory parameters"));
4934
        else
E
Eric Blake 已提交
4935
            ret = true;
4936 4937 4938
    }

  cleanup:
E
Eric Blake 已提交
4939
    VIR_FREE(params);
4940 4941 4942 4943
    virDomainFree(dom);
    return ret;
}

4944 4945 4946
/*
 * "nodeinfo" command
 */
4947
static const vshCmdInfo info_nodeinfo[] = {
4948 4949
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
4950 4951 4952
    {NULL, NULL}
};

E
Eric Blake 已提交
4953
static bool
4954
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4955 4956
{
    virNodeInfo info;
4957

4958
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4959
        return false;
4960 4961

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
4962
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
4963
        return false;
4964 4965 4966 4967 4968 4969 4970 4971 4972 4973
    }
    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 已提交
4974
    return true;
4975 4976
}

4977 4978 4979 4980 4981
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
4982
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
4983 4984 4985 4986 4987 4988 4989 4990 4991 4992
    {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
4993
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
4994 4995 4996 4997
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
4998 4999
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042
    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;

5043
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
5044
                cpu_stats[i].sys = value;
5045
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
5046
                cpu_stats[i].user = value;
5047
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
5048
                cpu_stats[i].idle = value;
5049
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
5050
                cpu_stats[i].iowait = value;
5051
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065
                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) {
5066
            vshPrint(ctl, "%-15s %20llu\n", _("user:"), cpu_stats[0].user);
5067
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
5068
            vshPrint(ctl, "%-15s %20llu\n", _("idle:"), cpu_stats[0].idle);
5069 5070 5071 5072 5073 5074 5075
            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);
5076
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle:"), 100 - usage);
5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088
        } 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",
5089
                     _("user:"), user_time / total_time * 100);
5090
            vshPrint(ctl, "%-15s %5.1lf%%\n",
5091
                     _("system:"), sys_time  / total_time * 100);
5092
            vshPrint(ctl, "%-15s %5.1lf%%\n",
5093
                     _("idle:"), idle_time     / total_time * 100);
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124
/*
 * "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;
5125 5126
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166
    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;
}

5167 5168 5169
/*
 * "capabilities" command
 */
5170
static const vshCmdInfo info_capabilities[] = {
5171 5172
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
5173 5174 5175
    {NULL, NULL}
};

E
Eric Blake 已提交
5176
static bool
5177
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5178 5179 5180
{
    char *caps;

5181
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5182
        return false;
5183 5184

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
5185
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
5186
        return false;
5187 5188
    }
    vshPrint (ctl, "%s\n", caps);
5189
    VIR_FREE(caps);
5190

E
Eric Blake 已提交
5191
    return true;
5192 5193
}

5194 5195 5196
/*
 * "dumpxml" command
 */
5197
static const vshCmdInfo info_dumpxml[] = {
5198 5199
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
5200
    {NULL, NULL}
5201 5202
};

5203
static const vshCmdOptDef opts_dumpxml[] = {
5204 5205 5206
    {"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")},
5207
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
5208
    {NULL, 0, 0, NULL}
5209 5210
};

E
Eric Blake 已提交
5211
static bool
5212
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
5213
{
5214
    virDomainPtr dom;
E
Eric Blake 已提交
5215
    bool ret = true;
5216
    char *dump;
E
Eric Blake 已提交
5217
    unsigned int flags = 0;
5218 5219
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
5220
    int update = vshCommandOptBool(cmd, "update-cpu");
5221 5222 5223 5224 5225

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
5226 5227
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
5228

5229
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5230
        return false;
5231

J
Jim Meyering 已提交
5232
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
5233
        return false;
5234

5235
    dump = virDomainGetXMLDesc(dom, flags);
5236
    if (dump != NULL) {
5237
        vshPrint(ctl, "%s", dump);
5238
        VIR_FREE(dump);
5239
    } else {
E
Eric Blake 已提交
5240
        ret = false;
5241
    }
5242

5243 5244 5245 5246
    virDomainFree(dom);
    return ret;
}

5247 5248 5249 5250
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
5251 5252
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
5253 5254 5255 5256
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
5257 5258
    {"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")},
5259 5260 5261
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5262
static bool
5263 5264
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5265
    bool ret = true;
5266 5267
    const char *format = NULL;
    const char *configFile = NULL;
5268 5269
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
5270
    unsigned int flags = 0;
5271

5272
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5273
        return false;
5274

5275 5276
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
5277
        return false;
5278

5279
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
5280
        return false;
5281 5282 5283

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
5284
        vshPrint(ctl, "%s", xmlData);
5285
        VIR_FREE(xmlData);
5286
    } else {
E
Eric Blake 已提交
5287
        ret = false;
5288 5289 5290 5291 5292 5293 5294 5295 5296
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
5297 5298
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
5299 5300 5301 5302
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
5303 5304
    {"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")},
5305 5306 5307
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5308
static bool
5309 5310
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5311
    bool ret = true;
5312 5313
    const char *format = NULL;
    const char *xmlFile = NULL;
5314 5315
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
5316
    unsigned int flags = 0;
5317

5318
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5319
        return false;
5320

5321 5322
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
5323
        return false;
5324

5325
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
5326
        return false;
5327 5328 5329

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
5330
        vshPrint(ctl, "%s", configData);
5331
        VIR_FREE(configData);
5332
    } else {
E
Eric Blake 已提交
5333
        ret = false;
5334 5335 5336 5337 5338
    }

    return ret;
}

K
Karel Zak 已提交
5339
/*
K
Karel Zak 已提交
5340
 * "domname" command
K
Karel Zak 已提交
5341
 */
5342
static const vshCmdInfo info_domname[] = {
5343
    {"help", N_("convert a domain id or UUID to domain name")},
5344
    {"desc", ""},
5345
    {NULL, NULL}
K
Karel Zak 已提交
5346 5347
};

5348
static const vshCmdOptDef opts_domname[] = {
5349
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
5350
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5351 5352
};

E
Eric Blake 已提交
5353
static bool
5354
cmdDomname(vshControl *ctl, const vshCmd *cmd)
5355
{
K
Karel Zak 已提交
5356 5357
    virDomainPtr dom;

5358
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5359
        return false;
J
Jim Meyering 已提交
5360
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5361
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
5362
        return false;
5363

K
Karel Zak 已提交
5364 5365
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
5366
    return true;
K
Karel Zak 已提交
5367 5368 5369
}

/*
K
Karel Zak 已提交
5370
 * "domid" command
K
Karel Zak 已提交
5371
 */
5372
static const vshCmdInfo info_domid[] = {
5373
    {"help", N_("convert a domain name or UUID to domain id")},
5374
    {"desc", ""},
5375
    {NULL, NULL}
K
Karel Zak 已提交
5376 5377
};

5378
static const vshCmdOptDef opts_domid[] = {
5379
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
5380
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5381 5382
};

E
Eric Blake 已提交
5383
static bool
5384
cmdDomid(vshControl *ctl, const vshCmd *cmd)
5385
{
5386
    virDomainPtr dom;
5387
    unsigned int id;
K
Karel Zak 已提交
5388

5389
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5390
        return false;
J
Jim Meyering 已提交
5391
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5392
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
5393
        return false;
5394

5395 5396
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
5397
        vshPrint(ctl, "%s\n", "-");
5398
    else
5399
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
5400
    virDomainFree(dom);
E
Eric Blake 已提交
5401
    return true;
K
Karel Zak 已提交
5402
}
5403

K
Karel Zak 已提交
5404 5405 5406
/*
 * "domuuid" command
 */
5407
static const vshCmdInfo info_domuuid[] = {
5408
    {"help", N_("convert a domain name or id to domain UUID")},
5409
    {"desc", ""},
K
Karel Zak 已提交
5410 5411 5412
    {NULL, NULL}
};

5413
static const vshCmdOptDef opts_domuuid[] = {
5414
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
5415 5416 5417
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5418
static bool
5419
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
5420 5421
{
    virDomainPtr dom;
5422
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
5423

5424
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5425
        return false;
J
Jim Meyering 已提交
5426
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5427
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
5428
        return false;
5429

K
Karel Zak 已提交
5430 5431 5432
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
5433
        vshError(ctl, "%s", _("failed to get domain UUID"));
5434

5435
    virDomainFree(dom);
E
Eric Blake 已提交
5436
    return true;
K
Karel Zak 已提交
5437 5438
}

5439 5440 5441
/*
 * "migrate" command
 */
5442
static const vshCmdInfo info_migrate[] = {
5443 5444
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
5445 5446 5447
    {NULL, NULL}
};

5448
static const vshCmdOptDef opts_migrate[] = {
5449 5450 5451 5452 5453 5454 5455
    {"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")},
5456 5457
    {"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)")},
5458 5459
    {"change-protection", VSH_OT_BOOL, 0,
     N_("prevent any configuration changes to domain until migration ends)")},
W
Wen Congyang 已提交
5460
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
5461
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
5462
    {"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)")},
5463 5464
    {"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 已提交
5465
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
5466
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
5467 5468 5469
    {NULL, 0, 0, NULL}
};

5470 5471 5472 5473 5474 5475 5476 5477
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
5478
{
5479
    char ret = '1';
5480
    virDomainPtr dom = NULL;
5481 5482 5483
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
E
Eric Blake 已提交
5484
    unsigned int flags = 0;
5485 5486 5487
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
5488 5489
    const char *xmlfile = NULL;
    char *xml = NULL;
5490
    sigset_t sigmask, oldsigmask;
5491 5492 5493 5494 5495

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

5497
    if (!vshConnectionUsability (ctl, ctl->conn))
5498
        goto out;
5499

J
Jim Meyering 已提交
5500
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
5501
        goto out;
5502

5503 5504
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
5505 5506
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
5507
        goto out;
5508
    }
5509

5510 5511 5512 5513 5514
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

5515 5516
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
5517 5518
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
5519
    if (vshCommandOptBool (cmd, "tunnelled"))
5520
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
5521

C
Chris Lalancette 已提交
5522 5523 5524 5525 5526
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

5527 5528 5529
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

5530 5531 5532 5533 5534 5535
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

5536 5537
    if (vshCommandOptBool (cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;
5538 5539 5540 5541 5542 5543

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


5544 5545 5546 5547
    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. */
5548

5549
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
5550
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
5551
            goto out;
5552
        }
5553

5554
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
5555
            ret = '0';
5556 5557 5558 5559 5560 5561
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
5562
        if (!dconn) goto out;
5563

5564
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
5565 5566
        if (ddom) {
            virDomainFree(ddom);
5567
            ret = '0';
5568 5569 5570
        }
        virConnectClose (dconn);
    }
5571

5572 5573 5574
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
5575
    if (dom) virDomainFree (dom);
5576
    VIR_FREE(xml);
5577 5578 5579
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
5580
static void
5581 5582
print_job_progress(const char *label, unsigned long long remaining,
                   unsigned long long total)
W
Wen Congyang 已提交
5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601
{
    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;
        }
    }

5602 5603
    /* see comments in vshError about why we must flush */
    fflush(stdout);
5604
    fprintf(stderr, "\r%s: [%3d %%]", label, progress);
5605
    fflush(stderr);
W
Wen Congyang 已提交
5606 5607
}

E
Eric Blake 已提交
5608
static bool
5609 5610 5611 5612 5613
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
5614
    bool functionReturn = false;
5615 5616 5617 5618 5619
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
5620 5621
    virDomainJobInfo jobinfo;
    bool verbose = false;
5622
    int timeout = 0;
W
Wen Congyang 已提交
5623 5624
    struct timeval start, curr;
    bool live_flag = false;
5625
    vshCtrlData data;
5626 5627 5628 5629
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
5630 5631

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

W
Wen Congyang 已提交
5634 5635 5636
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
5637
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
5638
        live_flag = true;
5639
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656
        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;
        }
    }

5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679
    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 已提交
5680
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
5681
    while (1) {
5682
repoll:
W
Wen Congyang 已提交
5683 5684 5685 5686
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
5687
                    functionReturn = true;
W
Wen Congyang 已提交
5688 5689
                    if (verbose) {
                        /* print [100 %] */
5690
                        print_job_progress("Migration", 0, 1);
W
Wen Congyang 已提交
5691 5692
                    }
                } else
W
Wen Congyang 已提交
5693
                    functionReturn = false;
5694
            } else
W
Wen Congyang 已提交
5695
                functionReturn = false;
W
Wen Congyang 已提交
5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
5707
            functionReturn = false;
W
Wen Congyang 已提交
5708 5709 5710
            break;
        }

W
Wen Congyang 已提交
5711 5712 5713 5714
        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. */
5715 5716
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "suspend the domain when migration timeouts\n");
W
Wen Congyang 已提交
5717 5718 5719 5720
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
5721 5722 5723 5724 5725
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
5726 5727
                print_job_progress("Migration", jobinfo.dataRemaining,
                                   jobinfo.dataTotal);
5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
5739
    return functionReturn;
5740 5741
}

5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752
/*
 * "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")},
5753
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
5754 5755 5756
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5757
static bool
5758 5759 5760
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
5761
    long long downtime = 0;
E
Eric Blake 已提交
5762
    bool ret = false;
5763

5764
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5765
        return false;
5766 5767

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

5770 5771
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
5772 5773 5774 5775 5776 5777 5778
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
5779
    ret = true;
5780 5781 5782 5783 5784 5785

done:
    virDomainFree(dom);
    return ret;
}

5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829
/*
 * "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;
}

5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868
/*
 * "migrate-getspeed" command
 */
static const vshCmdInfo info_migrate_getspeed[] = {
    {"help", N_("Get the maximum migration bandwidth")},
    {"desc", N_("Get the maximum migration bandwidth (in Mbps) for a domain.")},
    {NULL, NULL}
};

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

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

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

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

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

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

    ret = true;

done:
    virDomainFree(dom);
    return ret;
}

5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885
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))
5886
        goto cleanup;
5887 5888

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
5889
        goto cleanup;
5890 5891

    if (vshCommandOptString(cmd, "path", &path) < 0)
5892
        goto cleanup;
5893

5894 5895
    if (vshCommandOptUL(cmd, "bandwidth", &bandwidth) < 0) {
        vshError(ctl, "%s", _("bandwidth must be a number"));
5896
        goto cleanup;
5897
    }
5898 5899 5900 5901 5902 5903 5904 5905 5906 5907

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

5908
cleanup:
5909 5910
    if (dom)
        virDomainFree(dom);
5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994
    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;
}


5995 5996 5997
/*
 * "net-autostart" command
 */
5998
static const vshCmdInfo info_network_autostart[] = {
5999
    {"help", N_("autostart a network")},
6000
    {"desc",
6001
     N_("Configure a network to be automatically started at boot.")},
6002 6003 6004
    {NULL, NULL}
};

6005
static const vshCmdOptDef opts_network_autostart[] = {
6006 6007
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6008 6009 6010
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6011
static bool
6012
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
6013 6014
{
    virNetworkPtr network;
6015
    const char *name;
6016 6017
    int autostart;

6018
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6019
        return false;
6020

J
Jim Meyering 已提交
6021
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6022
        return false;
6023 6024 6025 6026

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
6027
        if (autostart)
6028
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
6029
        else
6030
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
6031
        virNetworkFree(network);
E
Eric Blake 已提交
6032
        return false;
6033 6034
    }

6035
    if (autostart)
6036
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
6037
    else
6038
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
6039

L
Laine Stump 已提交
6040
    virNetworkFree(network);
E
Eric Blake 已提交
6041
    return true;
6042
}
K
Karel Zak 已提交
6043

6044 6045 6046
/*
 * "net-create" command
 */
6047
static const vshCmdInfo info_network_create[] = {
6048 6049
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
6050 6051 6052
    {NULL, NULL}
};

6053
static const vshCmdOptDef opts_network_create[] = {
6054
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
6055 6056 6057
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6058
static bool
6059
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
6060 6061
{
    virNetworkPtr network;
6062
    const char *from = NULL;
E
Eric Blake 已提交
6063
    bool ret = true;
6064
    char *buffer;
6065

6066
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6067
        return false;
6068

6069
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6070
        return false;
6071

6072
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6073
        return false;
6074 6075

    network = virNetworkCreateXML(ctl->conn, buffer);
6076
    VIR_FREE(buffer);
6077

6078 6079 6080
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
6081
        virNetworkFree(network);
6082
    } else {
6083
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
6084
        ret = false;
6085 6086 6087 6088 6089 6090 6091 6092
    }
    return ret;
}


/*
 * "net-define" command
 */
6093
static const vshCmdInfo info_network_define[] = {
6094 6095
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
6096 6097 6098
    {NULL, NULL}
};

6099
static const vshCmdOptDef opts_network_define[] = {
6100
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
6101 6102 6103
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6104
static bool
6105
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
6106 6107
{
    virNetworkPtr network;
6108
    const char *from = NULL;
E
Eric Blake 已提交
6109
    bool ret = true;
6110
    char *buffer;
6111

6112
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6113
        return false;
6114

6115
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6116
        return false;
6117

6118
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6119
        return false;
6120 6121

    network = virNetworkDefineXML(ctl->conn, buffer);
6122
    VIR_FREE(buffer);
6123

6124 6125 6126
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
6127
        virNetworkFree(network);
6128
    } else {
6129
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
6130
        ret = false;
6131 6132 6133 6134 6135 6136 6137 6138
    }
    return ret;
}


/*
 * "net-destroy" command
 */
6139
static const vshCmdInfo info_network_destroy[] = {
6140 6141
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
6142 6143 6144
    {NULL, NULL}
};

6145
static const vshCmdOptDef opts_network_destroy[] = {
6146
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6147 6148 6149
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6150
static bool
6151
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
6152 6153
{
    virNetworkPtr network;
E
Eric Blake 已提交
6154
    bool ret = true;
6155
    const char *name;
6156

6157
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6158
        return false;
6159

J
Jim Meyering 已提交
6160
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6161
        return false;
6162 6163 6164 6165

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

6170
    virNetworkFree(network);
6171 6172 6173 6174 6175 6176 6177
    return ret;
}


/*
 * "net-dumpxml" command
 */
6178
static const vshCmdInfo info_network_dumpxml[] = {
6179 6180
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
6181 6182 6183
    {NULL, NULL}
};

6184
static const vshCmdOptDef opts_network_dumpxml[] = {
6185
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6186 6187 6188
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6189
static bool
6190
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
6191 6192
{
    virNetworkPtr network;
E
Eric Blake 已提交
6193
    bool ret = true;
6194 6195
    char *dump;

6196
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6197
        return false;
6198

J
Jim Meyering 已提交
6199
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
6200
        return false;
6201 6202 6203

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
6204
        vshPrint(ctl, "%s", dump);
6205
        VIR_FREE(dump);
6206
    } else {
E
Eric Blake 已提交
6207
        ret = false;
6208 6209 6210 6211 6212 6213
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227
/*
 * "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 已提交
6228
static bool
O
Osier Yang 已提交
6229 6230 6231 6232 6233 6234 6235 6236 6237 6238
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 已提交
6239
        return false;
O
Osier Yang 已提交
6240 6241 6242

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6243
        return false;
O
Osier Yang 已提交
6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268

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

6269
    VIR_FREE(bridge);
O
Osier Yang 已提交
6270
    virNetworkFree(network);
E
Eric Blake 已提交
6271
    return true;
O
Osier Yang 已提交
6272
}
6273

6274 6275 6276 6277
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
6278 6279
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
6280 6281 6282 6283
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
6284
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6285 6286 6287
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6288
static bool
6289 6290
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6291
    bool ret = false;
6292 6293 6294 6295 6296
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
6297
    unsigned int flags = VIR_INTERFACE_XML_INACTIVE;
6298

6299
    if (!vshConnectionUsability(ctl, ctl->conn))
6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325
        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 已提交
6326
        ret = true;
6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338
        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)) {
6339 6340
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352
        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 已提交
6353
    ret = true;
6354 6355 6356 6357 6358

cleanup:
    if (iface)
        virInterfaceFree (iface);

6359 6360 6361
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
6362 6363 6364

    if (tmp) {
        unlink (tmp);
6365
        VIR_FREE(tmp);
6366 6367 6368 6369 6370
    }

    return ret;
}

6371 6372 6373
/*
 * "net-list" command
 */
6374
static const vshCmdInfo info_network_list[] = {
6375 6376
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
6377 6378 6379
    {NULL, NULL}
};

6380
static const vshCmdOptDef opts_network_list[] = {
6381 6382
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
6383 6384 6385
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6386
static bool
6387
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6388 6389 6390 6391 6392
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
6393
    char **activeNames = NULL, **inactiveNames = NULL;
6394 6395
    inactive |= all;

6396
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6397
        return false;
6398 6399

    if (active) {
6400 6401
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
6402
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
6403
            return false;
6404
        }
6405
        if (maxactive) {
6406
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
6407

6408
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
6409
                                                    maxactive)) < 0) {
6410
                vshError(ctl, "%s", _("Failed to list active networks"));
6411
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6412
                return false;
6413
            }
6414

6415
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
6416
        }
6417 6418
    }
    if (inactive) {
6419 6420
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
6421
            vshError(ctl, "%s", _("Failed to list inactive networks"));
6422
            VIR_FREE(activeNames);
E
Eric Blake 已提交
6423
            return false;
6424
        }
6425 6426 6427
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

6428 6429 6430
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
6431
                vshError(ctl, "%s", _("Failed to list inactive networks"));
6432 6433
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6434
                return false;
6435
            }
6436

6437 6438
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
6439
    }
6440 6441
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
6442
    vshPrintExtra(ctl, "-----------------------------------------\n");
6443 6444

    for (i = 0; i < maxactive; i++) {
6445 6446
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
6447 6448
        const char *autostartStr;
        int autostart = 0;
6449 6450 6451

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6452
            VIR_FREE(activeNames[i]);
6453
            continue;
6454
        }
6455

6456 6457 6458
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6459
            autostartStr = autostart ? _("yes") : _("no");
6460 6461 6462 6463 6464

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
6465
        virNetworkFree(network);
6466
        VIR_FREE(activeNames[i]);
6467 6468 6469
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
6470 6471
        const char *autostartStr;
        int autostart = 0;
6472 6473 6474

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6475
            VIR_FREE(inactiveNames[i]);
6476
            continue;
6477
        }
6478

6479 6480 6481
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6482
            autostartStr = autostart ? _("yes") : _("no");
6483

6484
        vshPrint(ctl, "%-20s %-10s %-10s\n",
6485 6486 6487
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
6488 6489

        virNetworkFree(network);
6490
        VIR_FREE(inactiveNames[i]);
6491
    }
6492 6493
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6494
    return true;
6495 6496 6497 6498 6499 6500
}


/*
 * "net-name" command
 */
6501
static const vshCmdInfo info_network_name[] = {
6502
    {"help", N_("convert a network UUID to network name")},
6503
    {"desc", ""},
6504 6505 6506
    {NULL, NULL}
};

6507
static const vshCmdOptDef opts_network_name[] = {
6508
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
6509 6510 6511
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6512
static bool
6513
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
6514 6515 6516
{
    virNetworkPtr network;

6517
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6518
        return false;
J
Jim Meyering 已提交
6519
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
6520
                                           VSH_BYUUID)))
E
Eric Blake 已提交
6521
        return false;
6522 6523 6524

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
6525
    return true;
6526 6527 6528 6529 6530 6531
}


/*
 * "net-start" command
 */
6532
static const vshCmdInfo info_network_start[] = {
6533 6534
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
6535 6536 6537
    {NULL, NULL}
};

6538
static const vshCmdOptDef opts_network_start[] = {
6539
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
6540 6541 6542
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6543
static bool
6544
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
6545 6546
{
    virNetworkPtr network;
E
Eric Blake 已提交
6547
    bool ret = true;
6548

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

J
Jim Meyering 已提交
6552
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
6553
         return false;
6554 6555 6556

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
6557
                 virNetworkGetName(network));
6558
    } else {
6559
        vshError(ctl, _("Failed to start network %s"),
6560
                 virNetworkGetName(network));
E
Eric Blake 已提交
6561
        ret = false;
6562
    }
L
Laine Stump 已提交
6563
    virNetworkFree(network);
6564 6565 6566 6567 6568 6569 6570
    return ret;
}


/*
 * "net-undefine" command
 */
6571
static const vshCmdInfo info_network_undefine[] = {
6572 6573
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
6574 6575 6576
    {NULL, NULL}
};

6577
static const vshCmdOptDef opts_network_undefine[] = {
6578
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6579 6580 6581
    {NULL, 0, 0, NULL}
};

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

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

J
Jim Meyering 已提交
6592
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6593
        return false;
6594 6595 6596 6597

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

L
Laine Stump 已提交
6602
    virNetworkFree(network);
6603 6604 6605 6606 6607 6608 6609
    return ret;
}


/*
 * "net-uuid" command
 */
6610
static const vshCmdInfo info_network_uuid[] = {
6611
    {"help", N_("convert a network name to network UUID")},
6612
    {"desc", ""},
6613 6614 6615
    {NULL, NULL}
};

6616
static const vshCmdOptDef opts_network_uuid[] = {
6617
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
6618 6619 6620
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6621
static bool
6622
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
6623 6624 6625 6626
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

J
Jim Meyering 已提交
6630
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
6631
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6632
        return false;
6633 6634 6635 6636

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

L
Laine Stump 已提交
6639
    virNetworkFree(network);
E
Eric Blake 已提交
6640
    return true;
6641 6642 6643
}


6644 6645 6646 6647 6648
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
6649 6650
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
6651 6652 6653 6654
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
6655 6656
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
6657 6658
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
6659
static bool
6660 6661 6662 6663 6664 6665 6666 6667 6668
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;

6669
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6670
        return false;
6671 6672 6673 6674

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
6675
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
6676
            return false;
6677 6678 6679 6680 6681 6682
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
6683
                vshError(ctl, "%s", _("Failed to list active interfaces"));
6684
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6685
                return false;
6686 6687 6688 6689 6690 6691 6692 6693
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
6694
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6695
            VIR_FREE(activeNames);
E
Eric Blake 已提交
6696
            return false;
6697 6698 6699 6700
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

6701 6702 6703
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
6704
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6705 6706
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6707
                return false;
6708 6709 6710 6711 6712
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
6713 6714
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
6715 6716 6717
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
6718 6719
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
6720 6721 6722

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6723
            VIR_FREE(activeNames[i]);
6724 6725 6726 6727 6728 6729 6730 6731
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6732
        VIR_FREE(activeNames[i]);
6733 6734
    }
    for (i = 0; i < maxinactive; i++) {
6735 6736
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
6737 6738 6739

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6740
            VIR_FREE(inactiveNames[i]);
6741 6742 6743 6744 6745 6746 6747 6748
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6749
        VIR_FREE(inactiveNames[i]);
6750
    }
6751 6752
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6753
    return true;
6754 6755 6756 6757 6758 6759 6760

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
6761
    {"help", N_("convert an interface MAC address to interface name")},
6762 6763 6764 6765 6766
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
6767
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
6768 6769 6770
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6771
static bool
6772 6773 6774 6775
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6776
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6777
        return false;
6778 6779
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
6780
        return false;
6781 6782 6783

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6784
    return true;
6785 6786 6787 6788 6789 6790
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
6791
    {"help", N_("convert an interface name to interface MAC address")},
6792 6793 6794 6795 6796
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
6797
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
6798 6799 6800
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6801
static bool
6802 6803 6804 6805
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6806
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6807
        return false;
6808 6809
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6810
        return false;
6811 6812 6813

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6814
    return true;
6815 6816 6817 6818 6819 6820
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
6821 6822
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
6823 6824 6825 6826
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
6827 6828
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
6829 6830 6831
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6832
static bool
6833 6834 6835
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6836
    bool ret = true;
6837
    char *dump;
E
Eric Blake 已提交
6838
    unsigned int flags = 0;
6839 6840 6841 6842
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
6843

6844
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6845
        return false;
6846 6847

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

6850
    dump = virInterfaceGetXMLDesc(iface, flags);
6851
    if (dump != NULL) {
6852
        vshPrint(ctl, "%s", dump);
6853
        VIR_FREE(dump);
6854
    } else {
E
Eric Blake 已提交
6855
        ret = false;
6856 6857 6858 6859 6860 6861 6862 6863 6864 6865
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
6866 6867
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
6868 6869 6870 6871
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
6872
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
6873 6874 6875
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6876
static bool
6877 6878
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
6879
    virInterfacePtr iface;
6880
    const char *from = NULL;
E
Eric Blake 已提交
6881
    bool ret = true;
6882 6883
    char *buffer;

6884
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6885
        return false;
6886

6887
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6888
        return false;
6889 6890

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

6893
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
6894
    VIR_FREE(buffer);
6895

6896
    if (iface != NULL) {
6897
        vshPrint(ctl, _("Interface %s defined from %s\n"),
6898
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
6899
        virInterfaceFree (iface);
6900
    } else {
6901
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
6902
        ret = false;
6903 6904 6905 6906 6907 6908 6909 6910
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
6911 6912
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
6913 6914 6915 6916
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
6917
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6918 6919 6920
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6921
static bool
6922 6923 6924
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6925
    bool ret = true;
6926
    const char *name;
6927

6928
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6929
        return false;
6930 6931

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6932
        return false;
6933 6934 6935 6936

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
6937
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
6938
        ret = false;
6939 6940 6941 6942 6943 6944 6945 6946 6947 6948
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
6949 6950
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
6951 6952 6953 6954
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
6955
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6956 6957 6958
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6959
static bool
6960 6961 6962
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6963
    bool ret = true;
6964
    const char *name;
6965

6966
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6967
        return false;
6968 6969

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6970
        return false;
6971 6972 6973 6974

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
6975
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
6976
        ret = false;
6977 6978 6979 6980 6981 6982 6983 6984 6985 6986
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
6987
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
6988
    {"desc", N_("forcefully stop a physical host interface.")},
6989 6990 6991 6992
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
6993
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6994 6995 6996
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6997
static bool
6998 6999 7000
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
7001
    bool ret = true;
7002
    const char *name;
7003

7004
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7005
        return false;
7006 7007

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
7008
        return false;
7009 7010 7011 7012

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
7013
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
7014
        ret = false;
7015 7016 7017 7018 7019 7020
    }

    virInterfaceFree(iface);
    return ret;
}

7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105
/*
 * "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;
}
7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120

/*
 * "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 已提交
7121
static bool
7122 7123 7124
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
7125
    const char *from = NULL;
E
Eric Blake 已提交
7126
    bool ret = true;
7127 7128
    char *buffer;

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

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
7136
        return false;
7137 7138 7139 7140 7141 7142 7143 7144 7145 7146

    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 已提交
7147
        ret = false;
7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166
    }
    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 已提交
7167
static bool
7168 7169 7170
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
7171
    bool ret = true;
7172
    const char *name;
7173

7174
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7175
        return false;
7176 7177

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
7178
        return false;
7179 7180 7181 7182 7183

    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 已提交
7184
        ret = false;
7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205
    }

    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 已提交
7206
static bool
7207 7208 7209
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
7210
    bool ret = true;
7211 7212
    char *dump;

7213
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7214
        return false;
7215 7216

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
7217
        return false;
7218 7219 7220

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
7221
        vshPrint(ctl, "%s", dump);
7222 7223
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
7224
        ret = false;
7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243
    }

    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 已提交
7244
static bool
7245 7246 7247 7248 7249 7250
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

7251
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7252
        return false;
7253 7254 7255 7256

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
7257
        return false;
7258 7259 7260 7261 7262 7263 7264 7265
    }

    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 已提交
7266
        return false;
7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293
    }

    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 已提交
7294
    return true;
7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311
}


/*
 * "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 已提交
7312
static bool
7313 7314
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
7315
    bool ret = false;
7316 7317 7318 7319 7320 7321
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

7322
    if (!vshConnectionUsability(ctl, ctl->conn))
7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348
        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 已提交
7349
        ret = true;
7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375
        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 已提交
7376
    ret = true;
7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394

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


7395
/**************************************************************************/
7396
/*
7397
 * "pool-autostart" command
7398
 */
7399
static const vshCmdInfo info_pool_autostart[] = {
7400
    {"help", N_("autostart a pool")},
7401
    {"desc",
7402
     N_("Configure a pool to be automatically started at boot.")},
7403
    {NULL, NULL}
7404 7405
};

7406
static const vshCmdOptDef opts_pool_autostart[] = {
7407 7408
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
7409 7410
    {NULL, 0, 0, NULL}
};
7411

E
Eric Blake 已提交
7412
static bool
7413
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
7414
{
7415
    virStoragePoolPtr pool;
7416
    const char *name;
7417
    int autostart;
7418

7419
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7420
        return false;
7421

7422
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7423
        return false;
7424

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

7427 7428
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
7429
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
7430
        else
7431
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
7432
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7433
        return false;
7434 7435
    }

7436
    if (autostart)
7437
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
7438
    else
7439
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
7440

L
Laine Stump 已提交
7441
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7442
    return true;
7443 7444
}

7445
/*
7446
 * "pool-create" command
7447
 */
7448
static const vshCmdInfo info_pool_create[] = {
7449 7450
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
7451 7452 7453
    {NULL, NULL}
};

7454
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
7455
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
7456
     N_("file containing an XML pool description")},
7457 7458 7459
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7460
static bool
7461
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
7462
{
7463
    virStoragePoolPtr pool;
7464
    const char *from = NULL;
E
Eric Blake 已提交
7465
    bool ret = true;
7466
    char *buffer;
7467

7468
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7469
        return false;
7470

7471
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7472
        return false;
7473

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

7477
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
7478
    VIR_FREE(buffer);
7479 7480 7481 7482

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7483
        virStoragePoolFree(pool);
7484
    } else {
7485
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
7486
        ret = false;
7487 7488
    }
    return ret;
7489 7490
}

7491

7492 7493 7494 7495
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
7496
    {"help", N_("create a device defined "
7497
                          "by an XML file on the node")},
7498
    {"desc", N_("Create a device on the node.  Note that this "
7499 7500 7501 7502 7503 7504 7505
                          "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,
7506
     N_("file containing an XML description of the device")},
7507 7508 7509
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7510
static bool
7511 7512 7513
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
7514
    const char *from = NULL;
E
Eric Blake 已提交
7515
    bool ret = true;
7516 7517
    char *buffer;

7518
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7519
        return false;
7520

7521
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7522
        return false;
7523

7524
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
7525
        return false;
7526 7527

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
7528
    VIR_FREE(buffer);
7529 7530 7531 7532

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
7533
        virNodeDeviceFree(dev);
7534
    } else {
7535
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
7536
        ret = false;
7537 7538 7539 7540 7541 7542 7543 7544 7545 7546
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
7547
    {"help", N_("destroy (stop) a device on the node")},
7548
    {"desc", N_("Destroy a device on the node.  Note that this "
7549
                "command destroys devices on the physical host")},
7550 7551 7552 7553 7554
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
7555
     N_("name of the device to be destroyed")},
7556 7557 7558
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7559
static bool
7560 7561 7562
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
7563
    bool ret = true;
7564
    const char *name = NULL;
7565

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

7570
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
7571
        return false;
7572 7573 7574 7575 7576 7577

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
7578
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
7579
        ret = false;
7580 7581 7582 7583 7584 7585 7586
    }

    virNodeDeviceFree(dev);
    return ret;
}


7587
/*
7588
 * XML Building helper for pool-define-as and pool-create-as
7589
 */
7590
static const vshCmdOptDef opts_pool_X_as[] = {
7591 7592 7593 7594 7595 7596 7597 7598
    {"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")},
7599
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
7600 7601 7602
    {NULL, 0, 0, NULL}
};

7603
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
7604

7605 7606
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
7607
    virBuffer buf = VIR_BUFFER_INITIALIZER;
7608

7609
    if (vshCommandOptString(cmd, "name", &name) <= 0)
7610
        goto cleanup;
7611
    if (vshCommandOptString(cmd, "type", &type) <= 0)
7612 7613
        goto cleanup;

7614 7615 7616 7617 7618
    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 ||
7619 7620
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
7621
        goto cleanup;
7622
    }
7623

7624 7625
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
7626
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
7627
        virBufferAddLit(&buf, "  <source>\n");
7628

7629
        if (srcHost)
7630
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
7631
        if (srcPath)
7632
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
7633
        if (srcDev)
7634
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
7635
        if (srcFormat)
7636
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
7637
        if (srcName)
7638
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
7639 7640

        virBufferAddLit(&buf, "  </source>\n");
7641 7642
    }
    if (target) {
7643
        virBufferAddLit(&buf, "  <target>\n");
7644
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
7645
        virBufferAddLit(&buf, "  </target>\n");
7646
    }
7647 7648 7649 7650
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7651
        return false;
7652
    }
7653 7654 7655

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
7656
    return true;
7657 7658

cleanup:
7659
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7660
    return false;
7661 7662 7663 7664 7665 7666
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
7667 7668
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
7669 7670 7671
    {NULL, NULL}
};

E
Eric Blake 已提交
7672
static bool
7673 7674 7675
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
7676 7677
    const char *name;
    char *xml;
7678
    int printXML = vshCommandOptBool(cmd, "print-xml");
7679

7680
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7681
        return false;
7682 7683

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

7686
    if (printXML) {
7687
        vshPrint(ctl, "%s", xml);
7688
        VIR_FREE(xml);
7689
    } else {
7690
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
7691
        VIR_FREE(xml);
7692

7693 7694 7695 7696
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
7697
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
7698
            return false;
7699 7700
        }
    }
E
Eric Blake 已提交
7701
    return true;
7702 7703
}

7704

7705
/*
7706
 * "pool-define" command
7707
 */
7708
static const vshCmdInfo info_pool_define[] = {
7709 7710
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
7711 7712 7713
    {NULL, NULL}
};

7714
static const vshCmdOptDef opts_pool_define[] = {
7715
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
7716 7717 7718
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7719
static bool
7720
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
7721
{
7722
    virStoragePoolPtr pool;
7723
    const char *from = NULL;
E
Eric Blake 已提交
7724
    bool ret = true;
7725
    char *buffer;
7726

7727
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7728
        return false;
7729

7730
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7731
        return false;
7732

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

7736
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
7737
    VIR_FREE(buffer);
7738 7739 7740 7741

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7742
        virStoragePoolFree(pool);
7743
    } else {
7744
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
7745
        ret = false;
7746 7747
    }
    return ret;
7748 7749
}

7750

7751 7752 7753
/*
 * "pool-define-as" command
 */
7754
static const vshCmdInfo info_pool_define_as[] = {
7755 7756
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
7757 7758 7759
    {NULL, NULL}
};

E
Eric Blake 已提交
7760
static bool
7761
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
7762 7763
{
    virStoragePoolPtr pool;
7764 7765
    const char *name;
    char *xml;
7766
    int printXML = vshCommandOptBool(cmd, "print-xml");
7767

7768
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7769
        return false;
7770

7771
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
7772
        return false;
7773

7774
    if (printXML) {
7775
        vshPrint(ctl, "%s", xml);
7776
        VIR_FREE(xml);
7777
    } else {
7778
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
7779
        VIR_FREE(xml);
7780

7781 7782 7783 7784
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
7785
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
7786
            return false;
7787 7788
        }
    }
E
Eric Blake 已提交
7789
    return true;
7790 7791 7792
}


7793
/*
7794
 * "pool-build" command
7795
 */
7796
static const vshCmdInfo info_pool_build[] = {
7797 7798
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
7799 7800 7801
    {NULL, NULL}
};

7802
static const vshCmdOptDef opts_pool_build[] = {
7803
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7804 7805
    {"no-overwrite", VSH_OT_BOOL, 0, N_("do not overwrite an existing pool of this type")},
    {"overwrite", VSH_OT_BOOL, 0, N_("overwrite any existing data")},
7806 7807 7808
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7809
static bool
7810
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
7811
{
7812
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7813
    bool ret = true;
7814
    const char *name;
7815
    unsigned int flags = 0;
7816

7817
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7818
        return false;
7819

7820
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7821
        return false;
7822

7823 7824 7825 7826 7827 7828 7829 7830 7831
    if (vshCommandOptBool (cmd, "no-overwrite")) {
        flags |= VIR_STORAGE_POOL_BUILD_NO_OVERWRITE;
    }

    if (vshCommandOptBool (cmd, "overwrite")) {
        flags |= VIR_STORAGE_POOL_BUILD_OVERWRITE;
    }

    if (virStoragePoolBuild(pool, flags) == 0) {
7832
        vshPrint(ctl, _("Pool %s built\n"), name);
7833
    } else {
7834
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
7835
        ret = false;
7836 7837
    }

7838 7839
    virStoragePoolFree(pool);

7840 7841 7842
    return ret;
}

7843
/*
7844
 * "pool-destroy" command
7845
 */
7846
static const vshCmdInfo info_pool_destroy[] = {
7847 7848 7849
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
7850 7851 7852
    {NULL, NULL}
};

7853
static const vshCmdOptDef opts_pool_destroy[] = {
7854
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7855 7856 7857
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7858
static bool
7859
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
7860
{
7861
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7862
    bool ret = true;
7863
    const char *name;
7864

7865
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7866
        return false;
7867

7868
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7869
        return false;
7870

7871 7872 7873
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
7874
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
7875
        ret = false;
7876 7877
    }

7878
    virStoragePoolFree(pool);
7879 7880 7881
    return ret;
}

7882

7883
/*
7884 7885
 * "pool-delete" command
 */
7886
static const vshCmdInfo info_pool_delete[] = {
7887 7888
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
7889 7890 7891
    {NULL, NULL}
};

7892
static const vshCmdOptDef opts_pool_delete[] = {
7893
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7894 7895 7896
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7897
static bool
7898
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
7899 7900
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7901
    bool ret = true;
7902
    const char *name;
7903

7904
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7905
        return false;
7906 7907

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7908
        return false;
7909 7910

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
7911
        vshPrint(ctl, _("Pool %s deleted\n"), name);
7912
    } else {
7913
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
7914
        ret = false;
7915 7916
    }

L
Laine Stump 已提交
7917
    virStoragePoolFree(pool);
7918 7919 7920 7921 7922 7923 7924
    return ret;
}


/*
 * "pool-refresh" command
 */
7925
static const vshCmdInfo info_pool_refresh[] = {
7926 7927
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
7928 7929 7930
    {NULL, NULL}
};

7931
static const vshCmdOptDef opts_pool_refresh[] = {
7932
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7933 7934 7935
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7936
static bool
7937
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
7938 7939
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7940
    bool ret = true;
7941
    const char *name;
7942

7943
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7944
        return false;
7945 7946

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7947
        return false;
7948 7949 7950 7951

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
7952
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
7953
        ret = false;
7954 7955 7956 7957 7958 7959 7960 7961 7962 7963
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
7964
static const vshCmdInfo info_pool_dumpxml[] = {
7965 7966
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
7967 7968 7969
    {NULL, NULL}
};

7970
static const vshCmdOptDef opts_pool_dumpxml[] = {
7971
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7972 7973 7974
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7975
static bool
7976
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
7977 7978
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7979
    bool ret = true;
7980 7981
    char *dump;

7982
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7983
        return false;
7984 7985

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7986
        return false;
7987 7988 7989

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
7990
        vshPrint(ctl, "%s", dump);
7991
        VIR_FREE(dump);
7992
    } else {
E
Eric Blake 已提交
7993
        ret = false;
7994 7995 7996 7997 7998 7999 8000 8001 8002 8003
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
8004
static const vshCmdInfo info_pool_list[] = {
8005 8006
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
8007 8008 8009
    {NULL, NULL}
};

8010
static const vshCmdOptDef opts_pool_list[] = {
8011 8012
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
8013
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
8014 8015 8016
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8017
static bool
8018
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8019
{
8020 8021
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
8022 8023
    int i, ret;
    bool functionReturn;
8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039
    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 */
8040
    int all = vshCommandOptBool(cmd, "all");
8041 8042
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
8043 8044 8045
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

8046
    /* Check the connection to libvirtd daemon is still working */
8047
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8048
        return false;
8049

8050
    /* Retrieve the number of active storage pools */
8051
    if (active) {
8052 8053
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
8054
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
8055
            return false;
8056 8057
        }
    }
8058 8059

    /* Retrieve the number of inactive storage pools */
8060
    if (inactive) {
8061 8062
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
8063
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
8064
            return false;
8065
        }
8066
    }
8067

8068 8069
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
8070

8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082
    /* 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 已提交
8083
            return false;
8084 8085 8086
        }
    }

8087 8088 8089 8090 8091 8092 8093 8094
    /* 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 已提交
8095
            return false;
8096 8097
        }
    }
8098

8099 8100 8101 8102 8103 8104 8105 8106 8107 8108
    /* 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]);
8109
        if (!pool) {
8110
            VIR_FREE(poolNames[i]);
8111 8112 8113
            continue;
        }

8114
        /* Retrieve the autostart status of the pool */
8115
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
8116
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
8117
        else
8118 8119 8120 8121 8122 8123
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
8124 8125
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136
            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;
        }
8137

8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249
        /* 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 */
8250 8251 8252
        virStoragePoolFree(pool);
    }

8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270
    /* 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);
8271 8272
        }

8273
        /* Cleanup and return */
E
Eric Blake 已提交
8274
        functionReturn = true;
8275 8276
        goto cleanup;
    }
8277

8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315
    /* 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. */
8316
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
8317
             (unsigned long) nameStrLength);
8318
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
8319
             (unsigned long) stateStrLength);
8320
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
8321
             (unsigned long) autostartStrLength);
8322
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
8323
             (unsigned long) persistStrLength);
8324
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
8325
             (unsigned long) capStrLength);
8326
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
8327
             (unsigned long) allocStrLength);
8328
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371
             (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 已提交
8372
    functionReturn = true;
8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386
    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 已提交
8387
    functionReturn = false;
8388

8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400
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]);
8401
    }
8402 8403 8404 8405 8406 8407 8408

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

    /* Return the desired value */
    return functionReturn;
8409 8410
}

8411 8412 8413 8414
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
8415 8416
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
8417 8418 8419 8420 8421
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
8422 8423 8424
     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")},
8425
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
8426 8427 8428
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8429
static bool
8430 8431
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
8432
    const char *type = NULL, *host = NULL;
8433 8434
    char *srcSpec = NULL;
    char *srcList;
8435
    const char *initiator = NULL;
8436

8437 8438
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
8439 8440
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
8441
        return false;
8442
    }
8443

8444
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8445
        return false;
8446 8447

    if (host) {
8448
        const char *port = NULL;
8449
        virBuffer buf = VIR_BUFFER_INITIALIZER;
8450 8451 8452 8453

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
8454
            return false;
8455
        }
8456
        virBufferAddLit(&buf, "<source>\n");
8457
        virBufferAsprintf(&buf, "  <host name='%s'", host);
8458
        if (port)
8459
            virBufferAsprintf(&buf, " port='%s'", port);
8460
        virBufferAddLit(&buf, "/>\n");
8461 8462
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
8463
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
8464 8465
            virBufferAddLit(&buf, "  </initiator>\n");
        }
8466 8467 8468
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
8469
            return false;
8470
        }
8471
        srcSpec = virBufferContentAndReset(&buf);
8472 8473 8474
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
8475
    VIR_FREE(srcSpec);
8476
    if (srcList == NULL) {
8477
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
8478
        return false;
8479 8480
    }
    vshPrint(ctl, "%s", srcList);
8481
    VIR_FREE(srcList);
8482

E
Eric Blake 已提交
8483
    return true;
8484 8485 8486 8487 8488 8489 8490
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
8491 8492
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
8493 8494 8495 8496 8497
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
8498
     N_("type of storage pool sources to discover")},
8499
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
8500
     N_("optional file of source xml to query for pools")},
8501 8502 8503
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8504
static bool
8505 8506
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
8507
    const char *type = NULL, *srcSpecFile = NULL;
8508
    char *srcSpec = NULL, *srcList;
8509

8510
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
8511
        return false;
8512

8513 8514
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
8515
        return false;
8516
    }
8517

8518
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8519
        return false;
8520 8521

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
8522
        return false;
8523 8524

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
8525
    VIR_FREE(srcSpec);
8526
    if (srcList == NULL) {
8527
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
8528
        return false;
8529 8530
    }
    vshPrint(ctl, "%s", srcList);
8531
    VIR_FREE(srcList);
8532

E
Eric Blake 已提交
8533
    return true;
8534 8535 8536
}


8537 8538 8539
/*
 * "pool-info" command
 */
8540
static const vshCmdInfo info_pool_info[] = {
8541 8542
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
8543 8544 8545
    {NULL, NULL}
};

8546
static const vshCmdOptDef opts_pool_info[] = {
8547
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8548 8549 8550
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8551
static bool
8552
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
8553 8554 8555
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
8556 8557
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
8558
    bool ret = true;
8559 8560
    char uuid[VIR_UUID_STRING_BUFLEN];

8561
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8562
        return false;
8563 8564

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8565
        return false;
8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591

    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;
8592 8593 8594 8595
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
8596 8597
        }

8598 8599
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
8600 8601
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
8602 8603 8604 8605 8606 8607 8608
        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);
8609 8610
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
8611 8612 8613 8614 8615
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627
        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 已提交
8628
        ret = false;
8629 8630 8631 8632 8633 8634 8635 8636 8637 8638
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
8639
static const vshCmdInfo info_pool_name[] = {
8640
    {"help", N_("convert a pool UUID to pool name")},
8641
    {"desc", ""},
8642 8643 8644
    {NULL, NULL}
};

8645
static const vshCmdOptDef opts_pool_name[] = {
8646
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
8647 8648 8649
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8650
static bool
8651
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
8652 8653 8654
{
    virStoragePoolPtr pool;

8655
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8656
        return false;
8657
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8658
                                           VSH_BYUUID)))
E
Eric Blake 已提交
8659
        return false;
8660 8661 8662

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8663
    return true;
8664 8665 8666 8667 8668 8669
}


/*
 * "pool-start" command
 */
8670
static const vshCmdInfo info_pool_start[] = {
8671 8672
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
8673 8674 8675
    {NULL, NULL}
};

8676
static const vshCmdOptDef opts_pool_start[] = {
8677
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
8678 8679 8680
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8681
static bool
8682
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
8683 8684
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8685
    bool ret = true;
8686

8687
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8688
        return false;
8689

8690
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
8691
         return false;
8692 8693 8694 8695 8696

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
8697
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
8698
        ret = false;
8699
    }
L
Laine Stump 已提交
8700 8701

    virStoragePoolFree(pool);
8702 8703 8704 8705
    return ret;
}


8706 8707 8708
/*
 * "vol-create-as" command
 */
8709
static const vshCmdInfo info_vol_create_as[] = {
8710 8711
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
8712 8713 8714
    {NULL, NULL}
};

8715
static const vshCmdOptDef opts_vol_create_as[] = {
8716 8717 8718 8719 8720
    {"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")},
8721 8722
    {"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")},
8723 8724 8725 8726 8727 8728 8729 8730 8731 8732
    {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 已提交
8733
        /* Deliberate fallthrough cases here :-) */
8734 8735 8736
        switch (*end) {
        case 'T':
            *val *= 1024;
8737
            /* fallthrough */
8738 8739
        case 'G':
            *val *= 1024;
8740
            /* fallthrough */
8741 8742
        case 'M':
            *val *= 1024;
8743
            /* fallthrough */
8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
8757
static bool
8758
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
8759 8760 8761
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8762
    char *xml;
8763 8764
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
8765
    unsigned long long capacity, allocation = 0;
8766
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8767

8768
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8769
        return false;
8770 8771 8772

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

8775
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8776 8777
        goto cleanup;

8778
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
8779 8780
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
8781
        vshError(ctl, _("Malformed size %s"), capacityStr);
8782

8783 8784
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
8785
        vshError(ctl, _("Malformed size %s"), allocationStr);
8786

8787 8788 8789 8790 8791 8792 8793
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

8794

8795
    virBufferAddLit(&buf, "<volume>\n");
8796 8797
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
8798
    if (allocationStr)
8799
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
8800 8801

    if (format) {
8802
        virBufferAddLit(&buf, "  <target>\n");
8803
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
8804
        virBufferAddLit(&buf, "  </target>\n");
8805
    }
8806

8807 8808 8809 8810
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
8811 8812
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
8813 8814 8815
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
8816 8817
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
8818 8819 8820 8821 8822
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
8823 8824
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
8825 8826 8827
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
8828 8829
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
8830 8831 8832 8833 8834
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
8835 8836
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
8837 8838 8839
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
8840 8841
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
8842 8843 8844 8845
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
8846
            goto cleanup;
8847 8848 8849 8850 8851
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
8852
            goto cleanup;
8853 8854 8855 8856
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
8857
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
8858
        if (snapshotStrFormat)
8859
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
8860 8861 8862 8863 8864 8865 8866 8867
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

8869 8870
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
8871
        goto cleanup;
8872 8873 8874
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
8875
    VIR_FREE(xml);
8876 8877 8878 8879 8880
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
8881
        return true;
8882
    } else {
8883
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
8884
        return false;
8885 8886 8887
    }

 cleanup:
8888
    virBufferFreeAndReset(&buf);
8889
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8890
    return false;
8891 8892 8893
}


8894 8895 8896
/*
 * "pool-undefine" command
 */
8897
static const vshCmdInfo info_pool_undefine[] = {
8898 8899
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
8900 8901 8902
    {NULL, NULL}
};

8903
static const vshCmdOptDef opts_pool_undefine[] = {
8904
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8905 8906 8907
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8908
static bool
8909
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
8910 8911
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8912
    bool ret = true;
8913
    const char *name;
8914

8915
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8916
        return false;
8917 8918

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8919
        return false;
8920 8921 8922 8923

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

L
Laine Stump 已提交
8928
    virStoragePoolFree(pool);
8929 8930 8931 8932 8933 8934 8935
    return ret;
}


/*
 * "pool-uuid" command
 */
8936
static const vshCmdInfo info_pool_uuid[] = {
8937
    {"help", N_("convert a pool name to pool UUID")},
8938
    {"desc", ""},
8939 8940 8941
    {NULL, NULL}
};

8942
static const vshCmdOptDef opts_pool_uuid[] = {
8943
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
8944 8945 8946
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8947
static bool
8948
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
8949 8950 8951 8952
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

8953
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8954
        return false;
8955 8956

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8957
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8958
        return false;
8959 8960 8961 8962

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

L
Laine Stump 已提交
8965
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8966
    return true;
8967 8968 8969 8970 8971 8972
}


/*
 * "vol-create" command
 */
8973
static const vshCmdInfo info_vol_create[] = {
8974 8975
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
8976 8977 8978
    {NULL, NULL}
};

8979
static const vshCmdOptDef opts_vol_create[] = {
8980 8981
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
8982 8983 8984
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8985
static bool
8986
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
8987 8988 8989
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8990
    const char *from = NULL;
E
Eric Blake 已提交
8991
    bool ret = true;
8992 8993
    char *buffer;

8994
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8995
        return false;
8996 8997

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

9001
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9002
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9003
        return false;
9004 9005 9006
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9007
        virshReportError(ctl);
9008
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9009
        return false;
9010 9011 9012
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
9013
    VIR_FREE(buffer);
9014 9015 9016 9017 9018 9019 9020
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
9021
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
9022
        ret = false;
9023 9024 9025 9026
    }
    return ret;
}

9027 9028 9029 9030
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
9031 9032
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
9033 9034 9035 9036
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
9037 9038 9039
    {"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 已提交
9040
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
9041 9042 9043
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9044
static bool
9045 9046 9047 9048
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
9049
    const char *from = NULL;
E
Eric Blake 已提交
9050
    bool ret = false;
9051 9052
    char *buffer = NULL;

9053
    if (!vshConnectionUsability(ctl, ctl->conn))
9054 9055 9056 9057 9058
        goto cleanup;

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

9059
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9060 9061 9062 9063 9064 9065 9066
        goto cleanup;
    }

    if (!(inputvol = vshCommandOptVol(ctl, cmd, "vol", "inputpool", NULL)))
        goto cleanup;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9067
        virshReportError(ctl);
9068 9069 9070 9071 9072 9073 9074 9075 9076
        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 {
9077
        vshError(ctl, _("Failed to create vol from %s"), from);
9078 9079 9080
        goto cleanup;
    }

E
Eric Blake 已提交
9081
    ret = true;
9082
cleanup:
9083
    VIR_FREE(buffer);
9084 9085 9086 9087
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
9088 9089
    if (newvol)
        virStorageVolFree(newvol);
9090 9091 9092 9093
    return ret;
}

static xmlChar *
9094 9095
makeCloneXML(const char *origxml, const char *newname)
{
9096

9097 9098 9099
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
9100 9101 9102
    xmlChar *newxml = NULL;
    int size;

9103
    doc = virXMLParseStringCtxt(origxml, _("(volume_definition)"), &ctxt);
9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125
    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[] = {
9126 9127
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
9128 9129 9130 9131
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
9132 9133
    {"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 已提交
9134
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9135 9136 9137
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9138
static bool
9139 9140 9141 9142
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
9143
    const char *name = NULL;
9144
    char *origxml = NULL;
9145
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
9146
    bool ret = false;
9147

9148
    if (!vshConnectionUsability(ctl, ctl->conn))
9149 9150 9151 9152 9153 9154 9155
        goto cleanup;

    if (!(origvol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        goto cleanup;

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
9156
        vshError(ctl, "%s", _("failed to get parent pool"));
9157 9158 9159
        goto cleanup;
    }

9160
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178
        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 {
9179
        vshError(ctl, _("Failed to clone vol from %s"),
9180 9181 9182 9183
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
9184
    ret = true;
9185 9186

cleanup:
9187
    VIR_FREE(origxml);
9188 9189 9190
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
9191 9192
    if (newvol)
        virStorageVolFree(newvol);
9193 9194 9195 9196 9197
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210

/*
 * "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 已提交
9211
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225
    {"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 已提交
9226
static bool
9227 9228 9229 9230
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
9231
    bool ret = false;
9232 9233 9234 9235 9236 9237 9238 9239 9240 9241
    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 已提交
9242
        return false;
9243 9244 9245 9246
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
9247
        return false;
9248 9249 9250
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9251
        return false;
9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285
    }

    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 已提交
9286
    ret = true;
9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310

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 已提交
9311
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9312 9313 9314 9315 9316
    {"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 已提交
9317
static bool
9318 9319 9320 9321
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
9322
    bool ret = false;
9323 9324 9325 9326
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
9327
    bool created = false;
9328 9329

    if (!vshConnectionUsability(ctl, ctl->conn))
9330
        return false;
9331 9332 9333

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
9334
        return false;
9335 9336 9337 9338
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
9339
        return false;
9340 9341 9342
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
9343
        return false;
9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355

    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;
        }
9356 9357
    } else {
        created = true;
9358 9359 9360 9361 9362 9363 9364 9365
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

9366
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381
        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 已提交
9382
    ret = true;
9383 9384

cleanup:
9385
    VIR_FORCE_CLOSE(fd);
9386
    if (!ret && created)
9387 9388 9389 9390 9391 9392 9393 9394 9395
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


9396 9397 9398
/*
 * "vol-delete" command
 */
9399
static const vshCmdInfo info_vol_delete[] = {
9400 9401
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
9402 9403 9404
    {NULL, NULL}
};

9405
static const vshCmdOptDef opts_vol_delete[] = {
9406
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9407
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9408 9409 9410
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9411
static bool
9412
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
9413 9414
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9415
    bool ret = true;
9416
    const char *name;
9417

9418
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9419
        return false;
9420 9421

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9422
        return false;
9423 9424 9425
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
9426
        vshPrint(ctl, _("Vol %s deleted\n"), name);
9427
    } else {
9428
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
9429
        ret = false;
9430 9431
    }

L
Laine Stump 已提交
9432
    virStorageVolFree(vol);
9433 9434 9435 9436
    return ret;
}


D
David Allan 已提交
9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447
/*
 * "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 已提交
9448
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
9449 9450 9451
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9452
static bool
D
David Allan 已提交
9453 9454 9455
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9456
    bool ret = true;
9457
    const char *name;
D
David Allan 已提交
9458

9459
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9460
        return false;
D
David Allan 已提交
9461 9462

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9463
        return false;
D
David Allan 已提交
9464 9465 9466 9467 9468 9469
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
9470
        ret = false;
D
David Allan 已提交
9471 9472 9473 9474 9475 9476 9477
    }

    virStorageVolFree(vol);
    return ret;
}


9478 9479 9480
/*
 * "vol-info" command
 */
9481
static const vshCmdInfo info_vol_info[] = {
9482 9483
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
9484 9485 9486
    {NULL, NULL}
};

9487
static const vshCmdOptDef opts_vol_info[] = {
9488
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9489
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9490 9491 9492
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9493
static bool
9494
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
9495 9496 9497
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
9498
    bool ret = true;
9499

9500
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9501
        return false;
9502 9503

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9504
        return false;
9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520

    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 已提交
9521
        ret = false;
9522 9523 9524 9525 9526 9527 9528 9529 9530 9531
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
9532
static const vshCmdInfo info_vol_dumpxml[] = {
9533 9534
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
9535 9536 9537
    {NULL, NULL}
};

9538
static const vshCmdOptDef opts_vol_dumpxml[] = {
9539
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9540
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9541 9542 9543
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9544
static bool
9545
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
9546 9547
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9548
    bool ret = true;
9549 9550
    char *dump;

9551
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9552
        return false;
9553 9554

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9555
        return false;
9556 9557 9558

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
9559
        vshPrint(ctl, "%s", dump);
9560
        VIR_FREE(dump);
9561
    } else {
E
Eric Blake 已提交
9562
        ret = false;
9563 9564 9565 9566 9567 9568 9569 9570 9571 9572
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
9573
static const vshCmdInfo info_vol_list[] = {
9574 9575
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
9576 9577 9578
    {NULL, NULL}
};

9579
static const vshCmdOptDef opts_vol_list[] = {
9580
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9581
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
9582 9583 9584
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9585
static bool
9586
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9587
{
9588
    virStorageVolInfo volumeInfo;
9589 9590
    virStoragePoolPtr pool;
    char **activeNames = NULL;
9591 9592 9593 9594 9595
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
9596 9597
    int ret;
    bool functionReturn;
9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608
    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;
9609

9610
    /* Check the connection to libvirtd daemon is still working */
9611
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9612
        return false;
9613

9614
    /* Look up the pool information given to us by the user */
9615
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
9616
        return false;
9617

9618 9619
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
9620

9621 9622 9623
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9624
        return false;
9625 9626
    }

9627 9628 9629 9630 9631
    /* 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) {
9632
            vshError(ctl, "%s", _("Failed to list active vols"));
9633
            VIR_FREE(activeNames);
9634
            virStoragePoolFree(pool);
E
Eric Blake 已提交
9635
            return false;
9636 9637
        }

9638 9639 9640 9641 9642
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

        /* Set aside memory for volume information pointers */
        volInfoTexts = vshCalloc(ctl, numVolumes, sizeof(*volInfoTexts));
9643 9644
    }

9645 9646 9647 9648 9649
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
9650

9651 9652 9653 9654
        /* 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"));
9655 9656
        }

9657 9658 9659 9660 9661 9662 9663 9664 9665
        /* 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 */
9666

9667
                /* Volume type */
9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680
                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"));
                }
9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730

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

9732
        /* Cleanup memory allocation */
9733
        virStorageVolFree(vol);
9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751
    }

    /* 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 已提交
9752
        functionReturn = true;
9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783
        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 */
9784 9785 9786 9787 9788 9789 9790 9791 9792 9793
    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);
9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827

    /* 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 已提交
9828
    functionReturn = true;
9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842
    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 已提交
9843
    functionReturn = false;
9844 9845 9846 9847 9848 9849 9850 9851 9852 9853

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);
9854
        VIR_FREE(activeNames[i]);
9855
    }
9856 9857 9858 9859

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
9860
    VIR_FREE(activeNames);
9861
    virStoragePoolFree(pool);
9862 9863 9864

    /* Return the desired value */
    return functionReturn;
9865 9866 9867 9868 9869 9870
}


/*
 * "vol-name" command
 */
9871
static const vshCmdInfo info_vol_name[] = {
9872
    {"help", N_("returns the volume name for a given volume key or path")},
9873
    {"desc", ""},
9874 9875 9876
    {NULL, NULL}
};

9877
static const vshCmdOptDef opts_vol_name[] = {
9878
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
9879 9880 9881
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9882
static bool
9883
cmdVolName(vshControl *ctl, const vshCmd *cmd)
9884 9885 9886
{
    virStorageVolPtr vol;

9887
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9888
        return false;
9889

9890
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
9891
                                   VSH_BYUUID)))
E
Eric Blake 已提交
9892
        return false;
9893 9894 9895

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9896
    return true;
9897 9898 9899
}


J
Justin Clift 已提交
9900 9901 9902 9903 9904 9905 9906 9907 9908 9909
/*
 * "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[] = {
9910
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
9911 9912 9913 9914
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9915
static bool
J
Justin Clift 已提交
9916 9917 9918 9919
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9920
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
9921 9922

    /* Check the connection to libvirtd daemon is still working */
9923
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9924
        return false;
J
Justin Clift 已提交
9925 9926

    /* Use the supplied string to locate the volume */
9927
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
9928
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
9929
        return false;
J
Justin Clift 已提交
9930 9931 9932 9933 9934 9935 9936
    }

    /* 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 已提交
9937
        return false;
J
Justin Clift 已提交
9938 9939
    }

9940 9941 9942 9943 9944 9945 9946 9947 9948
    /* 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 已提交
9949 9950 9951 9952

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9953
    return true;
J
Justin Clift 已提交
9954 9955
}

9956 9957 9958 9959

/*
 * "vol-key" command
 */
9960
static const vshCmdInfo info_vol_key[] = {
9961
    {"help", N_("returns the volume key for a given volume name or path")},
9962
    {"desc", ""},
9963 9964 9965
    {NULL, NULL}
};

9966
static const vshCmdOptDef opts_vol_key[] = {
9967
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
9968
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9969 9970 9971
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9972
static bool
9973
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
9974 9975 9976
{
    virStorageVolPtr vol;

9977
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9978
        return false;
9979

9980
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9981
        return false;
9982 9983 9984

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9985
    return true;
9986 9987 9988 9989 9990 9991 9992
}



/*
 * "vol-path" command
 */
9993
static const vshCmdInfo info_vol_path[] = {
9994
    {"help", N_("returns the volume path for a given volume name or key")},
9995
    {"desc", ""},
9996 9997 9998
    {NULL, NULL}
};

9999
static const vshCmdOptDef opts_vol_path[] = {
10000
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
10001
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10002 10003 10004
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10005
static bool
10006
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
10007 10008
{
    virStorageVolPtr vol;
10009
    char * StorageVolPath;
10010

10011
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10012
        return false;
10013

10014
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL))) {
E
Eric Blake 已提交
10015
        return false;
10016
    }
10017

10018 10019 10020 10021 10022 10023 10024
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
10025
    virStorageVolFree(vol);
E
Eric Blake 已提交
10026
    return true;
10027 10028 10029
}


10030 10031 10032 10033
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
10034 10035
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
10036 10037
    {NULL, NULL}
};
10038

10039
static const vshCmdOptDef opts_secret_define[] = {
10040
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
10041 10042
    {NULL, 0, 0, NULL}
};
10043

E
Eric Blake 已提交
10044
static bool
10045 10046
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
10047
    const char *from = NULL;
10048
    char *buffer;
10049
    virSecretPtr res;
10050
    char uuid[VIR_UUID_STRING_BUFLEN];
10051

10052
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10053
        return false;
10054

10055
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10056
        return false;
10057 10058

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
10062
    VIR_FREE(buffer);
10063 10064

    if (res == NULL) {
10065
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
10066
        return false;
10067
    }
10068
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
10069
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
10070
        virSecretFree(res);
E
Eric Blake 已提交
10071
        return false;
10072 10073 10074
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
10075
    return true;
10076 10077 10078 10079 10080 10081
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
10082 10083
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
10084 10085 10086 10087
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
10088
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10089 10090 10091
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10092
static bool
10093 10094 10095
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
10096
    bool ret = false;
10097 10098
    char *xml;

10099
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10100
        return false;
10101 10102 10103

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
10104
        return false;
10105 10106 10107 10108

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
10109
    vshPrint(ctl, "%s", xml);
10110
    VIR_FREE(xml);
E
Eric Blake 已提交
10111
    ret = true;
10112 10113 10114 10115 10116 10117 10118 10119 10120 10121

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
10122 10123
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
10124 10125 10126 10127
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
10128 10129
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
10130 10131 10132
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10133
static bool
10134 10135 10136 10137
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
10138
    const char *base64 = NULL;
10139
    char *value;
E
Eric Blake 已提交
10140 10141
    int res;
    bool ret = false;
10142

10143
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10144
        return false;
10145 10146 10147

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
10148
        return false;
10149

10150
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
10151 10152 10153
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
10154
        vshError(ctl, "%s", _("Invalid base64 data"));
10155 10156 10157
        goto cleanup;
    }
    if (value == NULL) {
10158
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
10159
        return false;
10160 10161 10162 10163
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
10164
    VIR_FREE(value);
10165 10166

    if (res != 0) {
10167
        vshError(ctl, "%s", _("Failed to set secret value"));
10168 10169 10170
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
10171
    ret = true;
10172 10173 10174 10175 10176 10177 10178 10179 10180 10181

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
10182 10183
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
10184 10185 10186 10187
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
10188
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10189 10190 10191
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10192
static bool
10193 10194 10195 10196 10197 10198
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
10199
    bool ret = false;
10200

10201
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10202
        return false;
10203 10204 10205

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
10206
        return false;
10207 10208 10209 10210 10211 10212 10213

    value = virSecretGetValue(secret, &value_size, 0);
    if (value == NULL)
        goto cleanup;

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
10214
    VIR_FREE(value);
10215 10216

    if (base64 == NULL) {
10217
        vshError(ctl, "%s", _("Failed to allocate memory"));
10218 10219
        goto cleanup;
    }
10220
    vshPrint(ctl, "%s", base64);
10221
    memset(base64, 0, strlen(base64));
10222
    VIR_FREE(base64);
E
Eric Blake 已提交
10223
    ret = true;
10224 10225 10226 10227 10228 10229 10230 10231 10232 10233

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
10234 10235
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
10236 10237 10238 10239
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
10240
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10241 10242 10243
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10244
static bool
10245 10246 10247
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
10248
    bool ret = false;
10249
    const char *uuid;
10250

10251
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10252
        return false;
10253 10254 10255

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
10256
        return false;
10257 10258

    if (virSecretUndefine(secret) < 0) {
10259
        vshError(ctl, _("Failed to delete secret %s"), uuid);
10260 10261 10262
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
10263
    ret = true;
10264 10265 10266 10267 10268 10269 10270 10271 10272 10273

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
10274 10275
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
10276 10277 10278
    {NULL, NULL}
};

E
Eric Blake 已提交
10279
static bool
10280 10281 10282 10283 10284
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

10285
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10286
        return false;
10287 10288 10289

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
10290
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
10291
        return false;
10292 10293 10294 10295 10296
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
10297
        vshError(ctl, "%s", _("Failed to list secrets"));
10298
        VIR_FREE(uuids);
E
Eric Blake 已提交
10299
        return false;
10300 10301 10302 10303
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

10304 10305
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
10306 10307

    for (i = 0; i < maxuuids; i++) {
10308 10309 10310 10311
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
10312
            VIR_FREE(uuids[i]);
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330
            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);
10331
        VIR_FREE(uuids[i]);
10332
    }
10333
    VIR_FREE(uuids);
E
Eric Blake 已提交
10334
    return true;
10335
}
10336 10337 10338 10339 10340


/*
 * "version" command
 */
10341
static const vshCmdInfo info_version[] = {
10342 10343
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
10344 10345 10346
    {NULL, NULL}
};

10347 10348 10349 10350
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
10351

E
Eric Blake 已提交
10352
static bool
10353
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10354 10355 10356 10357 10358 10359
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
10360
    unsigned long daemonVersion;
10361 10362 10363 10364 10365
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

10366
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10367
        return false;
10368 10369 10370

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
10371
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
10372
        return false;
10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384
    }

    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) {
10385
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
10386
        return false;
10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403
    }
    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) {
10404
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
10405
        return false;
10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418
    }
    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);
    }
10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433

    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 已提交
10434
    return true;
10435 10436
}

10437 10438 10439 10440
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
10441
    {"help", N_("enumerate devices on this host")},
10442
    {"desc", ""},
10443 10444 10445 10446
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
10447 10448
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
10449 10450 10451
    {NULL, 0, 0, NULL}
};

10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473
#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] = '-';
10474 10475
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
10476 10477 10478
    }

    /* Print this device */
10479
    vshPrint(ctl, "%s", indentBuf);
10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502
    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) {
10503
        vshPrint(ctl, "%s", indentBuf);
10504
        vshPrint(ctl, " |\n");
10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526
    }

    /* 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) {
10527
        vshPrint(ctl, "%s", indentBuf);
10528 10529 10530 10531
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
10532
static bool
10533 10534
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
10535
    const char *cap = NULL;
10536
    char **devices;
10537
    int num_devices, i;
10538
    int tree = vshCommandOptBool(cmd, "tree");
10539

10540
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10541
        return false;
10542

10543
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
10544 10545 10546 10547
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
10548
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
10549
        return false;
10550
    } else if (num_devices == 0) {
E
Eric Blake 已提交
10551
        return true;
10552 10553 10554 10555 10556 10557
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
10558
        vshError(ctl, "%s", _("Failed to list node devices"));
10559
        VIR_FREE(devices);
E
Eric Blake 已提交
10560
        return false;
10561
    }
10562
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
10563 10564 10565 10566 10567 10568 10569
    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 已提交
10570
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589
            } 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++) {
10590 10591
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
10592
        }
10593
        VIR_FREE(parents);
10594 10595 10596
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
10597
            VIR_FREE(devices[i]);
10598
        }
10599
    }
10600
    VIR_FREE(devices);
E
Eric Blake 已提交
10601
    return true;
10602 10603 10604 10605 10606 10607
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
10608 10609
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
10610 10611 10612 10613 10614
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
10615
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10616 10617 10618
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10619
static bool
10620 10621
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
10622
    const char *name = NULL;
10623
    virNodeDevicePtr device;
L
Laine Stump 已提交
10624
    char *xml;
10625

10626
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10627
        return false;
10628
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10629
        return false;
10630
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10631
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10632
        return false;
10633 10634
    }

L
Laine Stump 已提交
10635 10636 10637
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
10638
        return false;
L
Laine Stump 已提交
10639 10640 10641
    }

    vshPrint(ctl, "%s\n", xml);
10642
    VIR_FREE(xml);
10643
    virNodeDeviceFree(device);
E
Eric Blake 已提交
10644
    return true;
10645 10646
}

10647 10648 10649 10650
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
10651 10652
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
10653 10654 10655 10656 10657
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
10658
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10659 10660 10661
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10662
static bool
10663 10664
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
10665
    const char *name = NULL;
10666
    virNodeDevicePtr device;
E
Eric Blake 已提交
10667
    bool ret = true;
10668

10669
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10670
        return false;
10671
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10672
        return false;
10673
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10674
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10675
        return false;
10676 10677 10678 10679 10680
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
10681
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
10682
        ret = false;
10683 10684 10685 10686 10687 10688 10689 10690 10691
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
10692 10693
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
10694 10695 10696 10697 10698
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
10699
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10700 10701 10702
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10703
static bool
10704 10705
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
10706
    const char *name = NULL;
10707
    virNodeDevicePtr device;
E
Eric Blake 已提交
10708
    bool ret = true;
10709

10710
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10711
        return false;
10712
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10713
        return false;
10714
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10715
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10716
        return false;
10717 10718 10719 10720 10721
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
10722
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
10723
        ret = false;
10724 10725 10726 10727 10728 10729 10730 10731 10732
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
10733 10734
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
10735 10736 10737 10738 10739
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
10740
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10741 10742 10743
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10744
static bool
10745 10746
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
10747
    const char *name = NULL;
10748
    virNodeDevicePtr device;
E
Eric Blake 已提交
10749
    bool ret = true;
10750

10751
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10752
        return false;
10753
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10754
        return false;
10755
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10756
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10757
        return false;
10758 10759 10760 10761 10762
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
10763
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
10764
        ret = false;
10765 10766 10767 10768 10769
    }
    virNodeDeviceFree(device);
    return ret;
}

10770
/*
E
Eric Blake 已提交
10771
 * "hostname" command
10772
 */
10773
static const vshCmdInfo info_hostname[] = {
10774
    {"help", N_("print the hypervisor hostname")},
10775
    {"desc", ""},
10776 10777 10778
    {NULL, NULL}
};

E
Eric Blake 已提交
10779
static bool
10780
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10781 10782 10783
{
    char *hostname;

10784
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10785
        return false;
10786 10787 10788

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
10789
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
10790
        return false;
10791 10792 10793
    }

    vshPrint (ctl, "%s\n", hostname);
10794
    VIR_FREE(hostname);
10795

E
Eric Blake 已提交
10796
    return true;
10797 10798 10799 10800 10801
}

/*
 * "uri" command
 */
10802
static const vshCmdInfo info_uri[] = {
10803
    {"help", N_("print the hypervisor canonical URI")},
10804
    {"desc", ""},
10805 10806 10807
    {NULL, NULL}
};

E
Eric Blake 已提交
10808
static bool
10809
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10810 10811 10812
{
    char *uri;

10813
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10814
        return false;
10815 10816 10817

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
10818
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
10819
        return false;
10820 10821 10822
    }

    vshPrint (ctl, "%s\n", uri);
10823
    VIR_FREE(uri);
10824

E
Eric Blake 已提交
10825
    return true;
10826 10827
}

E
Eric Blake 已提交
10828 10829 10830 10831 10832 10833 10834 10835 10836 10837
/*
 * "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 已提交
10838
static bool
E
Eric Blake 已提交
10839 10840 10841 10842 10843
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10844
        return false;
E
Eric Blake 已提交
10845 10846 10847 10848

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
10849
        return false;
E
Eric Blake 已提交
10850 10851 10852 10853 10854
    }

    vshPrint (ctl, "%s", sysinfo);
    VIR_FREE(sysinfo);

E
Eric Blake 已提交
10855
    return true;
E
Eric Blake 已提交
10856 10857
}

10858 10859 10860
/*
 * "vncdisplay" command
 */
10861
static const vshCmdInfo info_vncdisplay[] = {
10862 10863
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
10864 10865 10866
    {NULL, NULL}
};

10867
static const vshCmdOptDef opts_vncdisplay[] = {
10868
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10869 10870 10871
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10872
static bool
10873
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
10874 10875 10876 10877 10878
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10879
    bool ret = false;
10880 10881 10882
    int port = 0;
    char *doc;

10883
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10884
        return false;
10885

J
Jim Meyering 已提交
10886
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10887
        return false;
10888 10889 10890 10891 10892

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10893
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
10894
    VIR_FREE(doc);
10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909
    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) ||
10910
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
10911 10912 10913 10914 10915 10916
        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 已提交
10917
    ret = true;
10918 10919 10920 10921

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10922
    xmlFreeDoc(xml);
10923 10924 10925 10926 10927 10928 10929
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
10930
static const vshCmdInfo info_ttyconsole[] = {
10931 10932
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
10933 10934 10935
    {NULL, NULL}
};

10936
static const vshCmdOptDef opts_ttyconsole[] = {
10937
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10938 10939 10940
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10941
static bool
10942
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
10943 10944 10945 10946 10947
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10948
    bool ret = false;
10949 10950
    char *doc;

10951
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10952
        return false;
10953

J
Jim Meyering 已提交
10954
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10955
        return false;
10956 10957 10958 10959 10960

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10961
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
10962
    VIR_FREE(doc);
10963 10964 10965 10966 10967 10968 10969 10970 10971
    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 已提交
10972
    ret = true;
10973 10974 10975 10976

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10977
    xmlFreeDoc(xml);
10978 10979 10980 10981 10982 10983
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
10984
 */
10985
static const vshCmdInfo info_attach_device[] = {
10986 10987
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
10988 10989 10990
    {NULL, NULL}
};

10991
static const vshCmdOptDef opts_attach_device[] = {
10992 10993 10994
    {"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")},
10995 10996 10997
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10998
static bool
10999
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
11000 11001
{
    virDomainPtr dom;
11002
    const char *from = NULL;
11003
    char *buffer;
W
Wen Congyang 已提交
11004
    int ret;
J
Jim Fehlig 已提交
11005
    unsigned int flags;
11006

11007
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11008
        return false;
11009

J
Jim Meyering 已提交
11010
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
11011
        return false;
11012

11013
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11014
        virDomainFree(dom);
E
Eric Blake 已提交
11015
        return false;
11016 11017
    }

11018
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11019
        virshReportError(ctl);
11020
        virDomainFree(dom);
E
Eric Blake 已提交
11021
        return false;
11022
    }
11023

J
Jim Fehlig 已提交
11024
    if (vshCommandOptBool(cmd, "persistent")) {
11025
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11026
        if (virDomainIsActive(dom) == 1)
11027
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11028 11029 11030 11031
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
11032
    VIR_FREE(buffer);
11033 11034

    if (ret < 0) {
11035
        vshError(ctl, _("Failed to attach device from %s"), from);
11036
        virDomainFree(dom);
E
Eric Blake 已提交
11037
        return false;
11038
    } else {
J
Jim Meyering 已提交
11039
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
11040 11041 11042
    }

    virDomainFree(dom);
E
Eric Blake 已提交
11043
    return true;
11044 11045 11046 11047 11048 11049
}


/*
 * "detach-device" command
 */
11050
static const vshCmdInfo info_detach_device[] = {
11051 11052
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
11053 11054 11055
    {NULL, NULL}
};

11056
static const vshCmdOptDef opts_detach_device[] = {
11057 11058 11059
    {"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")},
11060 11061 11062
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11063
static bool
11064
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
11065 11066
{
    virDomainPtr dom;
11067
    const char *from = NULL;
11068
    char *buffer;
W
Wen Congyang 已提交
11069
    int ret;
J
Jim Fehlig 已提交
11070
    unsigned int flags;
11071

11072
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11073
        return false;
11074

J
Jim Meyering 已提交
11075
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
11076
        return false;
11077

11078
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11079
        virDomainFree(dom);
E
Eric Blake 已提交
11080
        return false;
11081 11082
    }

11083
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11084
        virshReportError(ctl);
11085
        virDomainFree(dom);
E
Eric Blake 已提交
11086
        return false;
11087
    }
11088

J
Jim Fehlig 已提交
11089
    if (vshCommandOptBool(cmd, "persistent")) {
11090
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11091
        if (virDomainIsActive(dom) == 1)
11092
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11093 11094 11095 11096
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
11097
    VIR_FREE(buffer);
11098 11099

    if (ret < 0) {
11100
        vshError(ctl, _("Failed to detach device from %s"), from);
11101
        virDomainFree(dom);
E
Eric Blake 已提交
11102
        return false;
11103
    } else {
J
Jim Meyering 已提交
11104
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
11105 11106 11107
    }

    virDomainFree(dom);
E
Eric Blake 已提交
11108
    return true;
11109 11110
}

11111

11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124
/*
 * "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")},
11125
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
11126 11127 11128
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11129
static bool
11130 11131 11132
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
11133
    const char *from = NULL;
11134
    char *buffer;
W
Wen Congyang 已提交
11135
    int ret;
11136 11137
    unsigned int flags;

11138
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11139
        return false;
11140 11141

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

11144
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11145
        virDomainFree(dom);
E
Eric Blake 已提交
11146
        return false;
11147 11148 11149
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11150
        virshReportError(ctl);
11151
        virDomainFree(dom);
E
Eric Blake 已提交
11152
        return false;
11153 11154 11155
    }

    if (vshCommandOptBool(cmd, "persistent")) {
11156
        flags = VIR_DOMAIN_AFFECT_CONFIG;
11157
        if (virDomainIsActive(dom) == 1)
11158
           flags |= VIR_DOMAIN_AFFECT_LIVE;
11159
    } else {
11160
        flags = VIR_DOMAIN_AFFECT_LIVE;
11161
    }
11162 11163 11164 11165

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

11166 11167 11168 11169 11170 11171
    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 已提交
11172
        return false;
11173 11174 11175 11176 11177
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
11178
    return true;
11179 11180 11181
}


11182 11183 11184
/*
 * "attach-interface" command
 */
11185
static const vshCmdInfo info_attach_interface[] = {
11186 11187
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
11188 11189 11190
    {NULL, NULL}
};

11191
static const vshCmdOptDef opts_attach_interface[] = {
11192 11193 11194 11195 11196 11197
    {"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")},
11198
    {"model", VSH_OT_DATA, 0, N_("model type")},
11199
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
11200 11201 11202
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11203
static bool
11204
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
11205 11206
{
    virDomainPtr dom = NULL;
11207 11208
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
11209
    int typ;
W
Wen Congyang 已提交
11210 11211
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11212
    unsigned int flags;
11213 11214
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
11215

11216
    if (!vshConnectionUsability(ctl, ctl->conn))
11217 11218
        goto cleanup;

J
Jim Meyering 已提交
11219
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11220 11221
        goto cleanup;

11222
    if (vshCommandOptString(cmd, "type", &type) <= 0)
11223 11224
        goto cleanup;

11225 11226 11227 11228
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
11229 11230
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
11231
        goto cleanup;
11232
    }
11233 11234

    /* check interface type */
11235
    if (STREQ(type, "network")) {
11236
        typ = 1;
11237
    } else if (STREQ(type, "bridge")) {
11238 11239
        typ = 2;
    } else {
E
Eric Blake 已提交
11240 11241
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
11242 11243 11244 11245
        goto cleanup;
    }

    /* Make XML of interface */
11246
    virBufferAsprintf(&buf, "<interface type='%s'>\n", type);
11247

11248
    if (typ == 1)
11249
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
11250
    else if (typ == 2)
11251
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
11252

11253
    if (target != NULL)
11254
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11255
    if (mac != NULL)
11256
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
11257
    if (script != NULL)
11258
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
11259
    if (model != NULL)
11260
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
11261

11262
    virBufferAddLit(&buf, "</interface>\n");
11263

11264 11265
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
11266
        goto cleanup;
11267 11268
    }

11269
    xml = virBufferContentAndReset(&buf);
11270

J
Jim Fehlig 已提交
11271
    if (vshCommandOptBool(cmd, "persistent")) {
11272
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11273
        if (virDomainIsActive(dom) == 1)
11274
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11275
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
11276
    } else {
11277
        ret = virDomainAttachDevice(dom, xml);
11278
    }
11279

11280 11281
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11282
    if (ret != 0) {
L
Laine Stump 已提交
11283
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
11284 11285
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
11286
        functionReturn = true;
J
Jim Fehlig 已提交
11287
    }
11288 11289 11290 11291

 cleanup:
    if (dom)
        virDomainFree(dom);
11292
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11293
    return functionReturn;
11294 11295 11296 11297 11298
}

/*
 * "detach-interface" command
 */
11299
static const vshCmdInfo info_detach_interface[] = {
11300 11301
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
11302 11303 11304
    {NULL, NULL}
};

11305
static const vshCmdOptDef opts_detach_interface[] = {
11306 11307 11308 11309
    {"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")},
11310 11311 11312
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11313
static bool
11314
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
11315 11316 11317 11318 11319 11320 11321
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
11322
    const char *mac =NULL, *type = NULL;
11323
    char *doc;
11324
    char buf[64];
E
Eric Blake 已提交
11325
    int i = 0, diff_mac;
W
Wen Congyang 已提交
11326 11327
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
11328
    unsigned int flags;
11329

11330
    if (!vshConnectionUsability(ctl, ctl->conn))
11331 11332
        goto cleanup;

J
Jim Meyering 已提交
11333
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11334 11335
        goto cleanup;

11336
    if (vshCommandOptString(cmd, "type", &type) <= 0)
11337 11338
        goto cleanup;

11339 11340
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
11341
        goto cleanup;
11342
    }
11343 11344 11345 11346 11347

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11348
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
11349
    VIR_FREE(doc);
11350
    if (!xml) {
11351
        vshError(ctl, "%s", _("Failed to get interface information"));
11352 11353 11354
        goto cleanup;
    }

E
Eric Blake 已提交
11355
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
11356 11357 11358
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11359
        vshError(ctl, _("No found interface whose type is %s"), type);
11360 11361 11362
        goto cleanup;
    }

11363 11364 11365 11366 11367 11368
    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;
    }

11369 11370 11371 11372 11373 11374 11375
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11376 11377 11378 11379 11380
            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);
11381 11382 11383 11384 11385 11386 11387
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11388
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
11389 11390 11391 11392 11393
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11394
        vshError(ctl, "%s", _("Failed to allocate memory"));
11395 11396 11397
        goto cleanup;
    }

11398
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
11399
        vshError(ctl, "%s", _("Failed to create XML"));
11400 11401 11402
        goto cleanup;
    }

J
Jim Fehlig 已提交
11403
    if (vshCommandOptBool(cmd, "persistent")) {
11404
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11405
        if (virDomainIsActive(dom) == 1)
11406
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11407 11408 11409 11410 11411 11412 11413 11414
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11415
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
11416
    } else {
J
Jim Meyering 已提交
11417
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
11418
        functionReturn = true;
11419
    }
11420 11421 11422 11423

 cleanup:
    if (dom)
        virDomainFree(dom);
11424
    xmlXPathFreeObject(obj);
11425
    xmlXPathFreeContext(ctxt);
11426 11427
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
11428
    return functionReturn;
11429 11430 11431 11432 11433
}

/*
 * "attach-disk" command
 */
11434
static const vshCmdInfo info_attach_disk[] = {
11435 11436
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
11437 11438 11439
    {NULL, NULL}
};

11440
static const vshCmdOptDef opts_attach_disk[] = {
11441 11442 11443 11444 11445
    {"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")},
11446
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
11447 11448 11449
    {"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")},
11450
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
11451 11452 11453
    {"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")},
11454 11455 11456
    {NULL, 0, 0, NULL}
};

11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603
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 已提交
11604
static bool
11605
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
11606 11607
{
    virDomainPtr dom = NULL;
11608
    const char *source = NULL, *target = NULL, *driver = NULL,
11609 11610 11611
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
11612 11613
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
11614
    unsigned int flags;
11615
    const char *stype = NULL;
11616 11617
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
11618

11619
    if (!vshConnectionUsability(ctl, ctl->conn))
11620 11621
        goto cleanup;

J
Jim Meyering 已提交
11622
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11623 11624
        goto cleanup;

11625
    if (vshCommandOptString(cmd, "source", &source) <= 0)
11626 11627
        goto cleanup;

11628
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11629 11630
        goto cleanup;

11631 11632 11633 11634
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
11635 11636 11637
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
11638
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
11639
        vshError(ctl, "%s", _("missing option"));
11640 11641
        goto cleanup;
    }
11642

11643 11644
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
11645
            isFile = true;
11646
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
11647
        isFile = true;
11648 11649 11650
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
11651 11652 11653
    }

    if (mode) {
11654
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
11655 11656
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
11657 11658 11659 11660 11661
            goto cleanup;
        }
    }

    /* Make XML of disk */
11662
    virBufferAsprintf(&buf, "<disk type='%s'",
11663 11664
                      (isFile) ? "file" : "block");
    if (type)
11665
        virBufferAsprintf(&buf, " device='%s'", type);
11666 11667
    virBufferAddLit(&buf, ">\n");

11668
    if (driver || subdriver)
11669
        virBufferAsprintf(&buf, "  <driver");
11670 11671

    if (driver)
11672
        virBufferAsprintf(&buf, " name='%s'", driver);
11673
    if (subdriver)
11674
        virBufferAsprintf(&buf, " type='%s'", subdriver);
11675 11676
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
11677

11678
    if (driver || subdriver || cache)
11679
        virBufferAddLit(&buf, "/>\n");
11680

11681
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
11682 11683
                      (isFile) ? "file" : "dev",
                      source);
11684
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11685
    if (mode)
11686
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
11687

11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735
    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;
            }
        }
    }

11736
    virBufferAddLit(&buf, "</disk>\n");
11737

11738 11739
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
11740
        return false;
11741 11742
    }

11743
    xml = virBufferContentAndReset(&buf);
11744

J
Jim Fehlig 已提交
11745
    if (vshCommandOptBool(cmd, "persistent")) {
11746
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11747
        if (virDomainIsActive(dom) == 1)
11748
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11749
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
11750
    } else {
11751
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
11752
    }
11753

11754 11755
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11756
    if (ret != 0) {
L
Laine Stump 已提交
11757
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
11758 11759
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
11760
        functionReturn = true;
J
Jim Fehlig 已提交
11761
    }
11762 11763 11764 11765

 cleanup:
    if (dom)
        virDomainFree(dom);
11766
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11767
    return functionReturn;
11768 11769 11770 11771 11772
}

/*
 * "detach-disk" command
 */
11773
static const vshCmdInfo info_detach_disk[] = {
11774 11775
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
11776 11777 11778
    {NULL, NULL}
};

11779
static const vshCmdOptDef opts_detach_disk[] = {
11780 11781 11782
    {"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")},
11783 11784 11785
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11786
static bool
11787
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
11788 11789 11790 11791 11792 11793 11794
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
11795
    const char *target = NULL;
11796
    char *doc;
E
Eric Blake 已提交
11797
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
11798 11799
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11800
    unsigned int flags;
11801

11802
    if (!vshConnectionUsability(ctl, ctl->conn))
11803 11804
        goto cleanup;

J
Jim Meyering 已提交
11805
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11806 11807
        goto cleanup;

11808
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11809 11810 11811 11812 11813 11814
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11815
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
11816
    VIR_FREE(doc);
11817
    if (!xml) {
11818
        vshError(ctl, "%s", _("Failed to get disk information"));
11819 11820 11821 11822 11823 11824
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11825
        vshError(ctl, "%s", _("Failed to get disk information"));
11826 11827 11828 11829 11830 11831 11832
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11833 11834 11835 11836 11837
            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);
11838 11839 11840 11841 11842 11843 11844
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11845
    vshError(ctl, _("No found disk whose target is %s"), target);
11846 11847 11848 11849 11850
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11851
        vshError(ctl, "%s", _("Failed to allocate memory"));
11852 11853 11854
        goto cleanup;
    }

11855
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
11856
        vshError(ctl, "%s", _("Failed to create XML"));
11857 11858 11859
        goto cleanup;
    }

J
Jim Fehlig 已提交
11860
    if (vshCommandOptBool(cmd, "persistent")) {
11861
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11862
        if (virDomainIsActive(dom) == 1)
11863
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11864 11865 11866 11867 11868 11869 11870 11871
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11872
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
11873
    } else {
J
Jim Meyering 已提交
11874
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
11875
        functionReturn = true;
11876
    }
11877 11878

 cleanup:
11879
    xmlXPathFreeObject(obj);
11880
    xmlXPathFreeContext(ctxt);
11881 11882
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
11883 11884
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
11885
    return functionReturn;
11886 11887
}

11888 11889 11890 11891
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
11892 11893
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
11894 11895 11896 11897
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
11898
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
11899 11900 11901
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11902
static bool
11903 11904
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
11905
    const char *from = NULL;
E
Eric Blake 已提交
11906
    bool ret = true;
11907 11908 11909
    char *buffer;
    int result;

11910
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11911
        return false;
11912

11913
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11914
        return false;
11915 11916

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
11920
    VIR_FREE(buffer);
11921 11922 11923 11924 11925

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
11926
        ret = false;
11927 11928 11929 11930 11931
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
11932
        ret = true;
11933 11934 11935 11936 11937
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
11938
        ret = true;
11939 11940 11941 11942 11943
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
11944
        ret = false;
11945 11946 11947 11948 11949
    }

    return ret;
}

11950 11951 11952 11953
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
11954 11955
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
11956 11957 11958 11959
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
11960
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
11961 11962 11963
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11964
static bool
11965 11966
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
11967
    const char *from = NULL;
E
Eric Blake 已提交
11968
    bool ret = true;
11969 11970 11971 11972 11973
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
11974
    xmlNodePtr node_list;
11975 11976 11977 11978 11979 11980
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

11981
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11982
        return false;
11983

11984
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11985
        return false;
11986 11987

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
11988
        return false;
11989 11990 11991 11992 11993

    doc = xmlNewDoc(NULL);
    if (doc == NULL)
        goto no_memory;

L
Laine Stump 已提交
11994 11995
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
11996 11997
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
11998
        ret = false;
11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034
        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 已提交
12035
        ret = false;
12036 12037 12038 12039 12040 12041 12042 12043
        goto cleanup;
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
12044
        ret = false;
12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061

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 已提交
12062
    ret = false;
12063
    goto cleanup;
12064 12065
}

12066 12067 12068 12069 12070 12071 12072 12073
/* 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;

12074
    ret = vshMalloc(ctl, PATH_MAX);
12075 12076 12077

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
12078 12079
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
12080
    if (fd == -1) {
12081
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
12082
                 strerror(errno));
12083
        VIR_FREE(ret);
12084 12085 12086 12087
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
12088 12089
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
12090
        VIR_FORCE_CLOSE(fd);
12091
        unlink (ret);
12092
        VIR_FREE(ret);
12093 12094
        return NULL;
    }
S
Stefan Berger 已提交
12095
    if (VIR_CLOSE(fd) < 0) {
12096 12097
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
12098
        unlink (ret);
12099
        VIR_FREE(ret);
12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114
        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 已提交
12115 12116 12117 12118
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
12119

12120
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
12121 12122 12123 12124
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
12125

12126 12127 12128 12129 12130
    /* 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 已提交
12131 12132
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
12133
     */
E
Eric Blake 已提交
12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145
    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);
12146 12147
    }

E
Eric Blake 已提交
12148 12149 12150 12151 12152 12153 12154
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
12155
    }
E
Eric Blake 已提交
12156
    ret = 0;
12157

E
Eric Blake 已提交
12158 12159 12160
cleanup:
    virCommandFree(cmd);
    return ret;
12161 12162 12163 12164 12165 12166 12167 12168
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
12169
        vshError(ctl,
12170
                 _("%s: failed to read temporary file: %s"),
12171
                 filename, strerror(errno));
12172 12173 12174 12175 12176
        return NULL;
    }
    return ret;
}

12177

P
Paolo Bonzini 已提交
12178 12179 12180 12181
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
12182 12183
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
12184 12185 12186 12187
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
12188
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
12189 12190 12191
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12192
static bool
12193
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
12194
{
12195
    const char *dir = NULL;
12196
    char *dir_malloced = NULL;
E
Eric Blake 已提交
12197
    bool ret = true;
P
Paolo Bonzini 已提交
12198 12199

    if (!ctl->imode) {
12200
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
12201
        return false;
P
Paolo Bonzini 已提交
12202 12203
    }

12204
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
12205
        uid_t uid = geteuid();
12206
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
12207 12208 12209 12210
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
12211
    if (chdir(dir) == -1) {
12212
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
12213
        ret = false;
P
Paolo Bonzini 已提交
12214 12215
    }

12216
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
12217
    return ret;
P
Paolo Bonzini 已提交
12218 12219 12220 12221 12222 12223
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
12224 12225
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
12226 12227 12228
    {NULL, NULL}
};

E
Eric Blake 已提交
12229
static bool
P
Paolo Bonzini 已提交
12230 12231 12232
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
12233
    bool ret = true;
P
Paolo Bonzini 已提交
12234

12235 12236
    cwd = getcwd(NULL, 0);
    if (!cwd) {
12237 12238
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
12239 12240
        ret = false;
    } else {
P
Paolo Bonzini 已提交
12241
        vshPrint (ctl, _("%s\n"), cwd);
12242 12243
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
12244

12245
    return ret;
P
Paolo Bonzini 已提交
12246 12247
}

E
Eric Blake 已提交
12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259
/*
 * "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")},
12260
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
12261 12262 12263 12264 12265 12266
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
12267
static bool
E
Eric Blake 已提交
12268 12269 12270 12271 12272
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
12273
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
12274 12275 12276 12277 12278 12279 12280 12281
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

12282
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
12283 12284 12285
        bool close_quote = false;
        char *q;

12286
        arg = opt->data;
E
Eric Blake 已提交
12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314
        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 已提交
12315
        return false;
E
Eric Blake 已提交
12316 12317 12318 12319 12320
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
12321
    return true;
E
Eric Blake 已提交
12322 12323
}

12324 12325 12326 12327
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
12328 12329
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
12330 12331 12332 12333
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
12334
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12335 12336 12337 12338 12339 12340
    {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 已提交
12341
static bool
12342 12343
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
12344
    bool ret = false;
12345 12346 12347 12348 12349
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
12350
    unsigned int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
12351

12352
    if (!vshConnectionUsability(ctl, ctl->conn))
12353 12354
        goto cleanup;

J
Jim Meyering 已提交
12355
    dom = vshCommandOptDomain (ctl, cmd, NULL);
12356 12357 12358 12359
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
12360
    doc = virDomainGetXMLDesc (dom, flags);
12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378
    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 已提交
12379
        ret = true;
12380 12381 12382 12383 12384 12385 12386
        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.
     */
12387
    doc_reread = virDomainGetXMLDesc (dom, flags);
12388 12389 12390 12391
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
12392 12393
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405
        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 已提交
12406
    ret = true;
12407 12408 12409 12410 12411

 cleanup:
    if (dom)
        virDomainFree (dom);

12412 12413 12414
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
12415 12416 12417

    if (tmp) {
        unlink (tmp);
12418
        VIR_FREE(tmp);
12419 12420 12421 12422 12423
    }

    return ret;
}

12424

12425 12426 12427 12428
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
12429 12430
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
12431 12432 12433 12434
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
12435
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
12436 12437 12438 12439 12440 12441 12442 12443 12444 12445
    {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[] = {
12446 12447
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
12448 12449 12450 12451
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
12452
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
12453 12454 12455 12456 12457 12458
    {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 已提交
12459 12460 12461
/*
 * "quit" command
 */
12462
static const vshCmdInfo info_quit[] = {
12463
    {"help", N_("quit this interactive terminal")},
12464
    {"desc", ""},
12465
    {NULL, NULL}
K
Karel Zak 已提交
12466 12467
};

E
Eric Blake 已提交
12468
static bool
12469
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
12470
{
E
Eric Blake 已提交
12471 12472
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
12473 12474
}

12475 12476 12477 12478 12479 12480 12481
/* Helper for snapshot-create and snapshot-create-as */
static bool
vshSnapshotCreate(vshControl *ctl, virDomainPtr dom, const char *buffer,
                  unsigned int flags, const char *from)
{
    bool ret = false;
    virDomainSnapshotPtr snapshot;
12482
    bool halt = false;
12483 12484 12485
    char *doc = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
E
Eric Blake 已提交
12486
    const char *name = NULL;
12487 12488

    snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512

    /* Emulate --halt on older servers.  */
    if (!snapshot && last_error->code == VIR_ERR_INVALID_ARG &&
        (flags & VIR_DOMAIN_SNAPSHOT_CREATE_HALT)) {
        int persistent;

        virFreeError(last_error);
        last_error = NULL;
        persistent = virDomainIsPersistent(dom);
        if (persistent < 0) {
            virshReportError(ctl);
            goto cleanup;
        }
        if (!persistent) {
            vshError(ctl, "%s",
                     _("cannot halt after snapshot of transient domain"));
            goto cleanup;
        }
        if (virDomainIsActive(dom) == 1)
            halt = true;
        flags &= ~VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
        snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
    }

12513 12514 12515
    if (snapshot == NULL)
        goto cleanup;

12516 12517 12518 12519 12520
    if (halt && virDomainDestroy(dom) < 0) {
        virshReportError(ctl);
        goto cleanup;
    }

E
Eric Blake 已提交
12521
    name = virDomainSnapshotGetName(snapshot);
12522
    if (!name) {
E
Eric Blake 已提交
12523
        vshError(ctl, "%s", _("Could not get snapshot name"));
12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542
        goto cleanup;
    }

    if (from)
        vshPrint(ctl, _("Domain snapshot %s created from '%s'"), name, from);
    else
        vshPrint(ctl, _("Domain snapshot %s created"), name);

    ret = true;

cleanup:
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    return ret;
}

12543 12544 12545 12546
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
12547 12548
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
12549 12550 12551 12552 12553 12554
    {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")},
12555 12556 12557
    {"redefine", VSH_OT_BOOL, 0, N_("redefine metadata for existing snapshot")},
    {"current", VSH_OT_BOOL, 0, N_("with redefine, set current snapshot")},
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
12558
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
12559
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
12560 12561 12562
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12563
static bool
12564 12565 12566
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12567
    bool ret = false;
12568
    const char *from = NULL;
12569
    char *buffer = NULL;
12570 12571 12572 12573 12574 12575 12576 12577
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "redefine"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE;
    if (vshCommandOptBool(cmd, "current"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT;
    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
12578 12579
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
12580 12581
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
12582

12583
    if (!vshConnectionUsability(ctl, ctl->conn))
12584 12585 12586 12587 12588 12589
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

12590
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
12591
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606
    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;
    }

12607
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, from);
12608 12609 12610 12611 12612 12613 12614 12615 12616

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12617 12618 12619
/*
 * "snapshot-create-as" command
 */
12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675
static int
vshParseSnapshotDiskspec(vshControl *ctl, virBufferPtr buf, const char *str)
{
    int ret = -1;
    char *name = NULL;
    char *snapshot = NULL;
    char *driver = NULL;
    char *file = NULL;
    char *spec = vshStrdup(ctl, str);
    char *tmp = spec;
    size_t len = strlen(str);

    if (*str == ',')
        goto cleanup;
    name = tmp;
    while ((tmp = strchr(tmp, ','))) {
        if (tmp[1] == ',') {
            /* Recognize ,, as an escape for a literal comma */
            memmove(&tmp[1], &tmp[2], len - (tmp - spec) + 2);
            len--;
            tmp++;
            continue;
        }
        /* Terminate previous string, look for next recognized one */
        *tmp++ = '\0';
        if (!snapshot && STRPREFIX(tmp, "snapshot="))
            snapshot = tmp + strlen("snapshot=");
        else if (!driver && STRPREFIX(tmp, "driver="))
            driver = tmp + strlen("driver=");
        else if (!file && STRPREFIX(tmp, "file="))
            file = tmp + strlen("file=");
        else
            goto cleanup;
    }

    virBufferEscapeString(buf, "    <disk name='%s'", name);
    if (snapshot)
        virBufferAsprintf(buf, " snapshot='%s'", snapshot);
    if (driver || file) {
        virBufferAddLit(buf, ">\n");
        if (driver)
            virBufferAsprintf(buf, "      <driver type='%s'/>\n", driver);
        if (file)
            virBufferEscapeString(buf, "      <source file='%s'/>\n", file);
        virBufferAddLit(buf, "    </disk>\n");
    } else {
        virBufferAddLit(buf, "/>\n");
    }
    ret = 0;
cleanup:
    if (ret < 0)
        vshError(ctl, _("unable to parse diskspec: %s"), str);
    VIR_FREE(spec);
    return ret;
}

12676 12677 12678 12679 12680 12681 12682 12683 12684 12685
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 已提交
12686
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
12687
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
12688
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
12689 12690 12691
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
    {"diskspec", VSH_OT_ARGV, 0,
     N_("disk attributes: disk[,snapshot=type][,driver=type][,file=name]")},
12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    char *buffer = NULL;
    const char *name = NULL;
    const char *desc = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
12704
    unsigned int flags = 0;
12705
    const vshCmdOpt *opt = NULL;
12706 12707 12708

    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
12709 12710
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
12711 12712
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728

    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)
12729
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
12730
    if (desc)
12731
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
12732 12733 12734 12735 12736 12737 12738 12739 12740 12741
    if (vshCommandOptBool(cmd, "diskspec")) {
        virBufferAddLit(&buf, "  <disks>\n");
        while ((opt = vshCommandOptArgv(cmd, opt))) {
            if (vshParseSnapshotDiskspec(ctl, &buf, opt->data) < 0) {
                virBufferFreeAndReset(&buf);
                goto cleanup;
            }
        }
        virBufferAddLit(&buf, "  </disks>\n");
    }
12742 12743 12744 12745 12746 12747 12748 12749
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
12750 12751 12752 12753 12754 12755
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

12756
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, NULL);
12757 12758 12759 12760 12761 12762 12763 12764 12765

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866
/*
 * "snapshot-edit" command
 */
static const vshCmdInfo info_snapshot_edit[] = {
    {"help", N_("edit XML for a snapshot")},
    {"desc", N_("Edit the domain snapshot XML for a named snapshot")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_edit[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("also set edited snapshot as current")},
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotEdit(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    const char *name;
    bool ret = false;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    unsigned int getxml_flags = VIR_DOMAIN_XML_SECURE;
    unsigned int define_flags = VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE;

    if (vshCommandOptBool(cmd, "current"))
        define_flags |= VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT;

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

    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    /* Get the XML configuration of the snapshot.  */
    doc = virDomainSnapshotGetXMLDesc(snapshot, getxml_flags);
    if (!doc)
        goto cleanup;
    virDomainSnapshotFree(snapshot);
    snapshot = NULL;

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

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

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

    /* Compare original XML with edited.  Short-circuit if it did not
     * change, and we do not have any flags.  */
    if (STREQ(doc, doc_edited) &&
        !(define_flags & VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT)) {
        vshPrint(ctl, _("Snapshot %s XML configuration not changed.\n"),
                 name);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
    snapshot = virDomainSnapshotCreateXML(dom, doc_edited, define_flags);
    if (!snapshot) {
        vshError(ctl, _("Failed to update %s"), name);
        goto cleanup;
    }

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

cleanup:
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);
    return ret;
}

12867 12868 12869 12870
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
12871 12872
    {"help", N_("Get or set the current snapshot")},
    {"desc", N_("Get or set the current snapshot")},
12873 12874 12875 12876 12877
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12878
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
12879 12880
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
12881 12882
    {"snapshotname", VSH_OT_DATA, 0,
     N_("name of existing snapshot to make current")},
12883 12884 12885
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12886
static bool
12887 12888 12889
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12890
    bool ret = false;
12891 12892
    int current;
    virDomainSnapshotPtr snapshot = NULL;
12893
    char *xml = NULL;
12894
    const char *snapshotname = NULL;
12895 12896 12897 12898
    unsigned int flags = 0;

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

12900
    if (!vshConnectionUsability(ctl, ctl->conn))
12901 12902 12903 12904 12905 12906
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935
    if (vshCommandOptString(cmd, "snapshotname", &snapshotname) < 0) {
        vshError(ctl, _("invalid snapshotname argument '%s'"), snapshotname);
        goto cleanup;
    }
    if (snapshotname) {
        virDomainSnapshotPtr snapshot2 = NULL;
        flags = (VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE |
                 VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT);

        if (vshCommandOptBool(cmd, "name")) {
            vshError(ctl, "%s",
                     _("--name and snapshotname are mutually exclusive"));
            goto cleanup;
        }
        snapshot = virDomainSnapshotLookupByName(dom, snapshotname, 0);
        if (snapshot == NULL)
            goto cleanup;
        xml = virDomainSnapshotGetXMLDesc(snapshot, VIR_DOMAIN_XML_SECURE);
        if (!xml)
            goto cleanup;
        snapshot2 = virDomainSnapshotCreateXML(dom, xml, flags);
        if (snapshot2 == NULL)
            goto cleanup;
        virDomainSnapshotFree(snapshot2);
        vshPrint(ctl, _("Snapshot %s set as current"), snapshotname);
        ret = true;
        goto cleanup;
    }

12936 12937 12938 12939
    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
E
Eric Blake 已提交
12940
        const char *name = NULL;
12941 12942 12943 12944

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

12945
        if (vshCommandOptBool(cmd, "name")) {
E
Eric Blake 已提交
12946
            name = virDomainSnapshotGetName(snapshot);
12947 12948
            if (!name)
                goto cleanup;
E
Eric Blake 已提交
12949 12950 12951 12952
        } else {
            xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
            if (!xml)
                goto cleanup;
12953 12954 12955
        }

        vshPrint(ctl, "%s", name ? name : xml);
12956 12957
    }

E
Eric Blake 已提交
12958
    ret = true;
12959 12960

cleanup:
12961
    VIR_FREE(xml);
12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980
    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")},
12981
    {"parent", VSH_OT_BOOL, 0, N_("add a column showing parent snapshot")},
12982 12983 12984
    {"roots", VSH_OT_BOOL, 0, N_("list only snapshots without parents")},
    {"metadata", VSH_OT_BOOL, 0,
     N_("list only snapshots that have metadata that would prevent undefine")},
12985 12986 12987
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12988
static bool
12989 12990 12991
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12992
    bool ret = false;
12993
    unsigned int flags = 0;
12994 12995
    int parent_filter = 0; /* -1 for roots filtering, 0 for no parent
                              information needed, 1 for parent column */
12996 12997
    int numsnaps;
    char **names = NULL;
12998
    int actual = 0;
12999 13000 13001 13002 13003 13004
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
13005
    char *parent = NULL;
13006 13007
    long long creation_longlong;
    time_t creation_time_t;
13008 13009 13010
    char timestr[100];
    struct tm time_info;

13011
    if (vshCommandOptBool(cmd, "parent")) {
13012 13013 13014 13015 13016
        if (vshCommandOptBool(cmd, "roots")) {
            vshError(ctl, "%s",
                     _("--parent and --roots are mutually exlusive"));
            return false;
        }
13017
        parent_filter = 1;
13018 13019 13020 13021 13022 13023
    } else if (vshCommandOptBool(cmd, "roots")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
    }

    if (vshCommandOptBool(cmd, "metadata")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_METADATA;
13024 13025
    }

13026
    if (!vshConnectionUsability(ctl, ctl->conn))
13027 13028 13029 13030 13031 13032
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

13033
    numsnaps = virDomainSnapshotNum(dom, flags);
13034

13035 13036 13037 13038 13039 13040 13041 13042 13043 13044
    /* Fall back to simulation if --roots was unsupported.  */
    if (numsnaps < 0 && last_error->code == VIR_ERR_INVALID_ARG &&
        (flags & VIR_DOMAIN_SNAPSHOT_LIST_ROOTS)) {
        virFreeError(last_error);
        last_error = NULL;
        parent_filter = -1;
        flags &= ~VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
        numsnaps = virDomainSnapshotNum(dom, flags);
    }

13045 13046 13047
    if (numsnaps < 0)
        goto cleanup;

13048 13049 13050 13051 13052 13053 13054 13055
    if (parent_filter > 0)
        vshPrintExtra(ctl, " %-20s %-25s %-15s %s",
                      _("Name"), _("Creation Time"), _("State"), _("Parent"));
    else
        vshPrintExtra(ctl, " %-20s %-25s %s",
                      _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "\n\
------------------------------------------------------------\n");
13056 13057 13058 13059 13060

    if (numsnaps) {
        if (VIR_ALLOC_N(names, numsnaps) < 0)
            goto cleanup;

13061
        actual = virDomainSnapshotListNames(dom, names, numsnaps, flags);
13062 13063 13064 13065 13066 13067 13068
        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 */
13069
            VIR_FREE(parent);
13070 13071 13072 13073
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
13074
            xmlFreeDoc(xml);
13075 13076 13077 13078 13079 13080 13081 13082 13083 13084
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

13085
            xml = virXMLParseStringCtxt(doc, _("(domain_snapshot)"), &ctxt);
13086 13087 13088
            if (!xml)
                continue;

13089 13090 13091
            if (parent_filter) {
                parent = virXPathString("string(/domainsnapshot/parent/name)",
                                        ctxt);
13092 13093
                if (!parent && parent_filter < 0)
                    continue;
13094 13095
            }

13096 13097 13098
            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
13099 13100
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
13101
                continue;
13102 13103 13104 13105 13106 13107
            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);
13108 13109
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z",
                     &time_info);
13110

13111 13112 13113 13114 13115
            if (parent)
                vshPrint(ctl, " %-20s %-25s %-15s %s\n",
                         names[i], timestr, state, parent);
            else
                vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
13116 13117 13118
        }
    }

E
Eric Blake 已提交
13119
    ret = true;
13120 13121 13122

cleanup:
    /* this frees up memory from the last iteration of the loop */
13123
    VIR_FREE(parent);
13124 13125 13126 13127
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    xmlXPathFreeContext(ctxt);
13128
    xmlFreeDoc(xml);
13129
    VIR_FREE(doc);
13130 13131
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150
    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")},
13151 13152
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
13153 13154 13155
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13156
static bool
13157 13158 13159
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13160
    bool ret = false;
13161
    const char *name = NULL;
13162 13163
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
13164 13165 13166 13167
    unsigned int flags = 0;

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

13169
    if (!vshConnectionUsability(ctl, ctl->conn))
13170 13171 13172 13173 13174 13175
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

13176
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13177 13178 13179 13180 13181 13182
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

13183
    xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
13184 13185 13186
    if (!xml)
        goto cleanup;

13187
    vshPrint(ctl, "%s", xml);
13188

E
Eric Blake 已提交
13189
    ret = true;
13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

E
Eric Blake 已提交
13201 13202 13203 13204
/*
 * "snapshot-parent" command
 */
static const vshCmdInfo info_snapshot_parent[] = {
E
Eric Blake 已提交
13205
    {"help", N_("Get the name of the parent of a snapshot")},
E
Eric Blake 已提交
13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244 13245
    {"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;

13246
    xmldoc = virXMLParseStringCtxt(xml, _("(domain_snapshot)"), &ctxt);
E
Eric Blake 已提交
13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260
    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);
13261
    xmlFreeDoc(xmldoc);
E
Eric Blake 已提交
13262 13263 13264 13265 13266 13267 13268 13269 13270
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

13271
/*
13272
 * "snapshot-revert" command
13273
 */
13274
static const vshCmdInfo info_snapshot_revert[] = {
13275 13276 13277 13278 13279
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

13280
static const vshCmdOptDef opts_snapshot_revert[] = {
13281 13282
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
13283 13284
    {"running", VSH_OT_BOOL, 0, N_("after reverting, change state to running")},
    {"paused", VSH_OT_BOOL, 0, N_("after reverting, change state to paused")},
13285 13286 13287
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13288
static bool
13289
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
13290 13291
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13292
    bool ret = false;
13293
    const char *name = NULL;
13294
    virDomainSnapshotPtr snapshot = NULL;
13295 13296 13297 13298 13299 13300
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED;
13301

13302
    if (!vshConnectionUsability(ctl, ctl->conn))
13303 13304 13305 13306 13307 13308
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

13309
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13310 13311 13312 13313 13314 13315
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

13316
    if (virDomainRevertToSnapshot(snapshot, flags) < 0)
13317 13318
        goto cleanup;

E
Eric Blake 已提交
13319
    ret = true;
13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342

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")},
13343 13344 13345
    {"children-only", VSH_OT_BOOL, 0, N_("delete children but not snapshot")},
    {"metadata", VSH_OT_BOOL, 0,
     N_("delete only libvirt metadata, leaving snapshot contents behind")},
13346 13347 13348
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13349
static bool
13350 13351 13352
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13353
    bool ret = false;
13354
    const char *name = NULL;
13355 13356 13357
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

13358
    if (!vshConnectionUsability(ctl, ctl->conn))
13359 13360 13361 13362 13363 13364
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

13365
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13366 13367 13368 13369
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;
13370 13371 13372 13373
    if (vshCommandOptBool(cmd, "children-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY;
    if (vshCommandOptBool(cmd, "metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY;
13374 13375 13376 13377 13378

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

13379 13380 13381
    /* XXX If we wanted, we could emulate DELETE_CHILDREN_ONLY even on
     * older servers that reject the flag, by manually computing the
     * list of descendants.  But that's a lot of code to maintain.  */
13382
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
13383 13384 13385 13386
        if (flags & VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY)
            vshPrint(ctl, _("Domain snapshot %s children deleted\n"), name);
        else
            vshPrint(ctl, _("Domain snapshot %s deleted\n"), name);
13387 13388
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
13389
        goto cleanup;
13390
    }
13391

E
Eric Blake 已提交
13392
    ret = true;
13393 13394 13395 13396 13397 13398 13399 13400 13401 13402

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

13403 13404 13405 13406
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
13407 13408
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
13409 13410 13411 13412 13413
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
13414
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
13415
    {"cmd", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("command")},
13416 13417 13418
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13419
static bool
13420 13421 13422
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13423
    bool ret = false;
13424
    char *monitor_cmd = NULL;
13425
    char *result = NULL;
13426
    unsigned int flags = 0;
13427 13428 13429
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
13430 13431 13432 13433 13434 13435 13436 13437

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

13438 13439 13440 13441 13442 13443 13444 13445
    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"));
13446 13447
        goto cleanup;
    }
13448
    monitor_cmd = virBufferContentAndReset(&buf);
13449

13450 13451 13452 13453
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
13454 13455 13456 13457
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
13458
    ret = true;
13459 13460 13461

cleanup:
    VIR_FREE(result);
13462
    VIR_FREE(monitor_cmd);
13463 13464 13465 13466 13467 13468
    if (dom)
        virDomainFree(dom);

    return ret;
}

13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514
/*
 * "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;
}

13515
static const vshCmdDef domManagementCmds[] = {
13516 13517 13518 13519 13520 13521 13522 13523
    {"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},
13524 13525
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
13526
#ifndef WIN32
13527
    {"console", cmdConsole, opts_console, info_console, 0},
13528
#endif
13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539
    {"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},
13540
    {"domif-setlink", cmdDomIfSetLink, opts_domif_setlink, info_domif_setlink, 0},
13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551 13552
    {"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},
13553
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
13554 13555 13556 13557 13558 13559 13560 13561
    {"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},
13562 13563
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
13564 13565
    {"migrate-getspeed", cmdMigrateGetMaxSpeed,
     opts_migrate_getspeed, info_migrate_getspeed, 0},
13566 13567 13568 13569
    {"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},
13570 13571 13572 13573 13574 13575
    {"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},
13576
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
13577
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589
    {"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 已提交
13590
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
13591
    {"version", cmdVersion, opts_version, info_version, 0},
13592 13593
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
13594 13595 13596
};

static const vshCmdDef domMonitoringCmds[] = {
13597
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
13598
    {"domblklist", cmdDomblklist, opts_domblklist, info_domblklist, 0},
13599
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
13600
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
13601
    {"domif-getlink", cmdDomIfGetLink, opts_domif_getlink, info_domif_getlink, 0},
13602 13603 13604 13605 13606 13607
    {"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}
13608 13609 13610
};

static const vshCmdDef storagePoolCmds[] = {
13611
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
13612
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
13613
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
13614 13615 13616 13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633 13634
     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}
13635 13636 13637
};

static const vshCmdDef storageVolCmds[] = {
13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654 13655
    {"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}
13656
};
13657

13658
static const vshCmdDef networkCmds[] = {
13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677
    {"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}
13678
};
13679

13680
static const vshCmdDef nodedevCmds[] = {
13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694 13695
    {"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}
13696 13697 13698
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
13699 13700 13701 13702
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716
    {"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 已提交
13717 13718
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
13719 13720 13721 13722 13723
    {"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}
13724
};
13725

13726
static const vshCmdDef nwfilterCmds[] = {
13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737
    {"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}
13738
};
13739

13740
static const vshCmdDef secretCmds[] = {
13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752
    {"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}
13753
};
13754

13755
static const vshCmdDef virshCmds[] = {
13756 13757 13758 13759 13760 13761 13762
    {"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}
13763
};
13764

13765
static const vshCmdDef snapshotCmds[] = {
13766 13767
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
13768 13769
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
13770 13771 13772 13773 13774 13775
    {"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},
13776 13777
    {"snapshot-edit", cmdSnapshotEdit, opts_snapshot_edit,
     info_snapshot_edit, 0},
13778 13779
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
E
Eric Blake 已提交
13780 13781
    {"snapshot-parent", cmdSnapshotParent, opts_snapshot_parent,
     info_snapshot_parent, 0},
13782 13783 13784
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
13785
};
13786

13787
static const vshCmdDef hostAndHypervisorCmds[] = {
13788 13789 13790 13791 13792
    {"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},
13793
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
13794
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
13795
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
13796
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
13797 13798 13799 13800 13801
    {"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 已提交
13802 13803
};

13804 13805 13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816 13817 13818 13819 13820
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 已提交
13821 13822 13823 13824
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
13825
static const char *
13826
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
13827
{
13828
    const vshCmdInfo *info;
13829

K
Karel Zak 已提交
13830
    for (info = cmd->info; info && info->name; info++) {
13831
        if (STREQ(info->name, name))
K
Karel Zak 已提交
13832 13833 13834 13835 13836
            return info->data;
    }
    return NULL;
}

13837
/* Validate that the options associated with cmd can be parsed.  */
13838
static int
E
Eric Blake 已提交
13839
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
13840 13841 13842 13843 13844
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
13845 13846 13847
    *opts_need_arg = 0;
    *opts_required = 0;

13848 13849 13850 13851 13852 13853 13854 13855 13856
    if (!cmd->opts)
        return 0;

    for (i = 0; cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];

        if (i > 31)
            return -1; /* too many options */
        if (opt->type == VSH_OT_BOOL) {
E
Eric Blake 已提交
13857
            if (opt->flags & VSH_OFLAG_REQ)
13858 13859 13860
                return -1; /* bool options can't be mandatory */
            continue;
        }
E
Eric Blake 已提交
13861 13862
        if (opt->flags & VSH_OFLAG_REQ_OPT) {
            if (opt->flags & VSH_OFLAG_REQ)
L
Lai Jiangshan 已提交
13863 13864 13865 13866
                *opts_required |= 1 << i;
            continue;
        }

13867
        *opts_need_arg |= 1 << i;
E
Eric Blake 已提交
13868
        if (opt->flags & VSH_OFLAG_REQ) {
13869 13870 13871 13872 13873 13874
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
13875 13876 13877

        if (opt->type == VSH_OT_ARGV && cmd->opts[i + 1].name)
            return -1; /* argv option must be listed last */
13878 13879 13880 13881
    }
    return 0;
}

13882
static const vshCmdOptDef *
13883
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
13884
                   uint32_t *opts_seen, int *opt_index)
13885
{
13886 13887 13888 13889
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
13890

13891
        if (STREQ(opt->name, name)) {
13892
            if ((*opts_seen & (1 << i)) && opt->type != VSH_OT_ARGV) {
13893 13894 13895
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
13896 13897
            *opts_seen |= 1 << i;
            *opt_index = i;
K
Karel Zak 已提交
13898
            return opt;
13899 13900 13901 13902 13903
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
13904 13905 13906
    return NULL;
}

13907
static const vshCmdOptDef *
13908 13909
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
13910
{
13911
    int i;
13912
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
13913

13914 13915 13916 13917
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
13918
    i = ffs(*opts_need_arg) - 1;
13919
    opt = &cmd->opts[i];
13920
    if (opt->type != VSH_OT_ARGV)
13921
        *opts_need_arg &= ~(1 << i);
13922
    *opts_seen |= 1 << i;
13923
    return opt;
K
Karel Zak 已提交
13924 13925
}

13926 13927 13928
/*
 * Checks for required options
 */
13929
static int
13930 13931
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
13932
{
13933
    const vshCmdDef *def = cmd->def;
13934 13935 13936 13937 13938 13939 13940 13941 13942
    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];
13943

13944
            vshError(ctl,
13945
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
13946 13947 13948
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
13949 13950
        }
    }
13951
    return -1;
13952 13953
}

13954
static const vshCmdDef *
13955 13956
vshCmddefSearch(const char *cmdname)
{
13957
    const vshCmdGrp *g;
13958
    const vshCmdDef *c;
13959

13960 13961
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
13962
            if (STREQ(c->name, cmdname))
13963 13964 13965 13966
                return c;
        }
    }

K
Karel Zak 已提交
13967 13968 13969
    return NULL;
}

13970 13971 13972 13973 13974 13975
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
13976
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
13977 13978 13979 13980 13981 13982
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
13983
static bool
13984 13985 13986 13987 13988 13989 13990
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 已提交
13991
        return false;
13992 13993 13994 13995 13996 13997 13998 13999 14000 14001
    } 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 已提交
14002
    return true;
14003 14004
}

E
Eric Blake 已提交
14005
static bool
14006
vshCmddefHelp(vshControl *ctl, const char *cmdname)
14007
{
14008
    const vshCmdDef *def = vshCmddefSearch(cmdname);
14009

K
Karel Zak 已提交
14010
    if (!def) {
14011
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
14012
        return false;
14013
    } else {
E
Eric Blake 已提交
14014 14015
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
14016
        const char *help = _(vshCmddefGetInfo(def, "help"));
14017
        char buf[256];
14018 14019
        uint32_t opts_need_arg;
        uint32_t opts_required;
14020
        bool shortopt = false; /* true if 'arg' works instead of '--opt arg' */
14021 14022 14023 14024

        if (vshCmddefOptParse(def, &opts_need_arg, &opts_required)) {
            vshError(ctl, _("internal error: bad options in command: '%s'"),
                     def->name);
E
Eric Blake 已提交
14025
            return false;
14026
        }
K
Karel Zak 已提交
14027

14028
        fputs(_("  NAME\n"), stdout);
14029 14030
        fprintf(stdout, "    %s - %s\n", def->name, help);

14031 14032 14033 14034 14035
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
14036
                const char *fmt = "%s";
14037 14038
                switch (opt->type) {
                case VSH_OT_BOOL:
14039
                    fmt = "[--%s]";
14040 14041
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
14042
                    /* xgettext:c-format */
E
Eric Blake 已提交
14043
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>"
14044
                           : _("[--%s <number>]"));
14045 14046
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
14047 14048
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
14049 14050
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
14051 14052
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
14053 14054
                    break;
                case VSH_OT_DATA:
E
Eric Blake 已提交
14055
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
14056 14057
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
14058 14059 14060
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
14061 14062 14063 14064 14065 14066 14067 14068
                    if (shortopt) {
                        fmt = (opt->flags & VSH_OFLAG_REQ)
                            ? _("{[--%s] <string>}...")
                            : _("[[--%s] <string>]...");
                    } else {
                        fmt = (opt->flags & VSH_OFLAG_REQ) ? _("<%s>...")
                            : _("[<%s>]...");
                    }
14069 14070
                    break;
                default:
14071
                    assert(0);
14072
                }
14073
                fputc(' ', stdout);
E
Eric Blake 已提交
14074
                fprintf(stdout, fmt, opt->name);
14075
            }
K
Karel Zak 已提交
14076
        }
14077 14078 14079
        fputc('\n', stdout);

        if (desc[0]) {
14080
            /* Print the description only if it's not empty.  */
14081
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
14082
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
14083
        }
14084

K
Karel Zak 已提交
14085
        if (def->opts) {
14086
            const vshCmdOptDef *opt;
14087
            fputs(_("\n  OPTIONS\n"), stdout);
14088
            for (opt = def->opts; opt->name; opt++) {
14089 14090
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
14091
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
14092 14093
                    break;
                case VSH_OT_INT:
14094
                    snprintf(buf, sizeof(buf),
E
Eric Blake 已提交
14095
                             (opt->flags & VSH_OFLAG_REQ) ? _("[--%s] <number>")
14096
                             : _("--%s <number>"), opt->name);
14097 14098
                    break;
                case VSH_OT_STRING:
14099
                    /* OT_STRING should never be VSH_OFLAG_REQ */
14100
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
14101 14102
                    break;
                case VSH_OT_DATA:
14103 14104
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
14105 14106
                    break;
                case VSH_OT_ARGV:
14107 14108 14109
                    snprintf(buf, sizeof(buf),
                             shortopt ? _("[--%s] <string>") : _("<%s>"),
                             opt->name);
14110
                    break;
14111 14112 14113
                default:
                    assert(0);
                }
14114

E
Eric Blake 已提交
14115
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
14116
            }
K
Karel Zak 已提交
14117 14118 14119
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
14120
    return true;
K
Karel Zak 已提交
14121 14122 14123 14124 14125 14126
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
14127 14128 14129
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
14130 14131
    vshCmdOpt *a = arg;

14132
    while (a) {
K
Karel Zak 已提交
14133
        vshCmdOpt *tmp = a;
14134

K
Karel Zak 已提交
14135 14136
        a = a->next;

14137 14138
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
14139 14140 14141 14142
    }
}

static void
14143
vshCommandFree(vshCmd *cmd)
14144
{
K
Karel Zak 已提交
14145 14146
    vshCmd *c = cmd;

14147
    while (c) {
K
Karel Zak 已提交
14148
        vshCmd *tmp = c;
14149

K
Karel Zak 已提交
14150 14151 14152 14153
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
14154
        VIR_FREE(tmp);
K
Karel Zak 已提交
14155 14156 14157
    }
}

E
Eric Blake 已提交
14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168
/**
 * 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 已提交
14169
 */
E
Eric Blake 已提交
14170 14171
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
14172
{
E
Eric Blake 已提交
14173 14174
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
14175

E
Eric Blake 已提交
14176 14177 14178 14179 14180 14181 14182
    /* 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 已提交
14183
    }
E
Eric Blake 已提交
14184 14185 14186 14187 14188 14189 14190

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
E
Eric Blake 已提交
14191
            return (valid->flags & VSH_OFLAG_REQ) == 0 ? 0 : -1;
E
Eric Blake 已提交
14192 14193 14194 14195
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
14196 14197
}

E
Eric Blake 已提交
14198 14199
/**
 * vshCommandOptInt:
14200 14201 14202 14203 14204 14205 14206
 * @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 已提交
14207
 * 0 if option not found and not required (@value untouched)
14208
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
14209 14210
 */
static int
14211
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
14212
{
E
Eric Blake 已提交
14213 14214 14215
    vshCmdOpt *arg;
    int ret;
    int num;
14216
    char *end_p = NULL;
14217

E
Eric Blake 已提交
14218 14219 14220 14221 14222 14223 14224
    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;
14225
    }
E
Eric Blake 已提交
14226 14227 14228 14229 14230 14231 14232

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
14233 14234
}

14235

E
Eric Blake 已提交
14236 14237 14238 14239 14240 14241
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
14242 14243 14244 14245 14246 14247
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
14248 14249 14250
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
14251 14252
    char *end_p = NULL;

E
Eric Blake 已提交
14253 14254 14255 14256 14257 14258 14259
    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;
14260
    }
E
Eric Blake 已提交
14261 14262 14263 14264 14265 14266 14267

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14268 14269 14270
}


14271
/*
E
Eric Blake 已提交
14272 14273 14274 14275 14276
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
14277 14278 14279 14280 14281
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
14282
{
E
Eric Blake 已提交
14283 14284
    vshCmdOpt *arg;
    int ret;
14285
    unsigned long num;
14286 14287
    char *end_p = NULL;

E
Eric Blake 已提交
14288 14289 14290 14291 14292 14293 14294
    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;
14295
    }
E
Eric Blake 已提交
14296 14297 14298 14299 14300 14301 14302

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14303 14304
}

E
Eric Blake 已提交
14305 14306 14307 14308 14309 14310
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
14311
 * Returns option as STRING
E
Eric Blake 已提交
14312 14313 14314 14315
 * 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 已提交
14316
 */
14317 14318
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
14319
{
E
Eric Blake 已提交
14320 14321 14322 14323 14324 14325 14326 14327 14328 14329
    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;
14330
    }
14331

E
Eric Blake 已提交
14332
    if (!*arg->data && !(arg->def->flags & VSH_OFLAG_EMPTY_OK)) {
E
Eric Blake 已提交
14333 14334 14335 14336
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
14337 14338
}

E
Eric Blake 已提交
14339 14340 14341 14342 14343 14344
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
14345
 * Returns option as long long
14346
 * See vshCommandOptInt()
14347
 */
14348 14349 14350
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
14351
{
E
Eric Blake 已提交
14352 14353
    vshCmdOpt *arg;
    int ret;
14354
    long long num;
14355 14356
    char *end_p = NULL;

E
Eric Blake 已提交
14357 14358 14359 14360 14361 14362 14363
    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;
14364
    }
E
Eric Blake 已提交
14365 14366 14367 14368 14369 14370 14371

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14372 14373
}

E
Eric Blake 已提交
14374 14375 14376 14377 14378 14379 14380 14381 14382
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
14383 14384 14385 14386
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
14387 14388
    vshCmdOpt *arg;
    int ret;
14389 14390 14391
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
14392 14393 14394 14395 14396 14397 14398
    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;
14399
    }
E
Eric Blake 已提交
14400 14401 14402 14403 14404 14405 14406

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14407 14408 14409
}


E
Eric Blake 已提交
14410 14411 14412 14413 14414 14415 14416 14417 14418
/**
 * 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 已提交
14419
 */
E
Eric Blake 已提交
14420
static bool
14421
vshCommandOptBool(const vshCmd *cmd, const char *name)
14422
{
E
Eric Blake 已提交
14423 14424 14425
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
14426 14427
}

E
Eric Blake 已提交
14428 14429 14430 14431 14432
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
14433 14434
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
14435
 *
14436
 * Requires that a VSH_OT_ARGV option be last in the
14437 14438
 * list of supported options in CMD->def->opts.
 */
14439 14440
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
14441
{
14442
    opt = opt ? opt->next : cmd->opts;
14443 14444

    while (opt) {
E
Eric Blake 已提交
14445
        if (opt->def->type == VSH_OT_ARGV) {
14446
            return opt;
14447 14448 14449 14450 14451 14452
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470
/* 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)
14471
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
14472 14473 14474
                 cmd->def->name, optname);
    return found;
}
14475

K
Karel Zak 已提交
14476
static virDomainPtr
J
Jim Meyering 已提交
14477
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
14478
                      const char **name, int flag)
14479
{
K
Karel Zak 已提交
14480
    virDomainPtr dom = NULL;
14481
    const char *n = NULL;
K
Karel Zak 已提交
14482
    int id;
J
Jim Meyering 已提交
14483 14484 14485
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
14486

14487
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14488 14489
        return NULL;

14490
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14491 14492
             cmd->def->name, optname, n);

K
Karel Zak 已提交
14493 14494
    if (name)
        *name = n;
14495

K
Karel Zak 已提交
14496
    /* try it by ID */
14497
    if (flag & VSH_BYID) {
14498
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
14499 14500
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
14501 14502 14503
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
14504
    }
K
Karel Zak 已提交
14505
    /* try it by UUID */
14506
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
14507
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
14508
                 cmd->def->name, optname);
K
Karel Zak 已提交
14509
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
14510
    }
K
Karel Zak 已提交
14511
    /* try it by NAME */
14512
    if (dom==NULL && (flag & VSH_BYNAME)) {
14513
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
14514
                 cmd->def->name, optname);
K
Karel Zak 已提交
14515
        dom = virDomainLookupByName(ctl->conn, n);
14516
    }
K
Karel Zak 已提交
14517

14518
    if (!dom)
14519
        vshError(ctl, _("failed to get domain '%s'"), n);
14520

K
Karel Zak 已提交
14521 14522 14523
    return dom;
}

14524
static virNetworkPtr
J
Jim Meyering 已提交
14525
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
14526
                       const char **name, int flag)
14527 14528
{
    virNetworkPtr network = NULL;
14529
    const char *n = NULL;
J
Jim Meyering 已提交
14530 14531 14532
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
14533

14534
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14535 14536
        return NULL;

14537
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14538 14539 14540 14541 14542 14543
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
14544
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14545
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
14546
                 cmd->def->name, optname);
14547 14548 14549 14550
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
14551
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
14552 14553 14554 14555 14556
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
14557
        vshError(ctl, _("failed to get network '%s'"), n);
14558 14559 14560 14561

    return network;
}

14562 14563 14564

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
14565
                        const char **name, int flag)
14566 14567
{
    virNWFilterPtr nwfilter = NULL;
14568
    const char *n = NULL;
14569 14570 14571 14572
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14573
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14574 14575
        return NULL;

14576
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14577 14578 14579 14580 14581 14582 14583
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14584
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
14585 14586 14587 14588 14589
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
14590
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
14591 14592 14593 14594 14595 14596 14597 14598 14599 14600
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

14601 14602
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
14603
                         const char **name, int flag)
14604 14605
{
    virInterfacePtr iface = NULL;
14606
    const char *n = NULL;
14607 14608 14609 14610
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14611
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14612 14613
        return NULL;

14614
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14615 14616 14617 14618 14619 14620
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
14621
    if ((flag & VSH_BYNAME)) {
14622
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
14623 14624 14625 14626 14627
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
14628
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
14629 14630 14631 14632 14633
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
14634
        vshError(ctl, _("failed to get interface '%s'"), n);
14635 14636 14637 14638

    return iface;
}

14639
static virStoragePoolPtr
14640
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
14641
                    const char **name, int flag)
14642 14643
{
    virStoragePoolPtr pool = NULL;
14644
    const char *n = NULL;
14645

14646
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14647 14648
        return NULL;

14649
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14650 14651 14652 14653 14654 14655
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
14656
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14657
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
14658
                 cmd->def->name, optname);
14659 14660 14661
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
14662
    if (pool == NULL && (flag & VSH_BYNAME)) {
14663
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
14664 14665 14666 14667 14668
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
14669
        vshError(ctl, _("failed to get pool '%s'"), n);
14670 14671 14672 14673 14674

    return pool;
}

static virStorageVolPtr
14675
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
14676 14677
                   const char *optname,
                   const char *pooloptname,
14678
                   const char **name, int flag)
14679 14680 14681
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
14682
    const char *n = NULL, *p = NULL;
14683

14684
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14685 14686
        return NULL;

14687
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
14688
        vshError(ctl, "%s", _("missing option"));
14689
        return NULL;
14690
    }
14691 14692 14693 14694

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

14695
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
14696 14697 14698 14699 14700
             cmd->def->name, optname, n);

    if (name)
        *name = n;

14701
    /* try it by name */
14702
    if (pool && (flag & VSH_BYNAME)) {
14703
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
14704 14705 14706
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
14707
    /* try it by key */
14708
    if (vol == NULL && (flag & VSH_BYUUID)) {
14709
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
14710 14711 14712
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
14713
    /* try it by path */
14714
    if (vol == NULL && (flag & VSH_BYUUID)) {
14715
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
14716 14717 14718 14719
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

14720 14721 14722 14723 14724 14725 14726
    if (!vol) {
        if (pool)
            vshError(ctl, _("failed to get vol '%s'"), n);
        else
            vshError(ctl, _("failed to get vol '%s', specifying --pool "
                            "might help"), n);
    }
14727 14728 14729 14730 14731 14732 14733

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

14734
static virSecretPtr
14735
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
14736 14737
{
    virSecretPtr secret = NULL;
14738
    const char *n = NULL;
14739 14740 14741 14742 14743
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14744
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14745 14746
        return NULL;

14747 14748
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
14749 14750 14751 14752 14753 14754 14755

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
14756
        vshError(ctl, _("failed to get secret '%s'"), n);
14757 14758 14759 14760

    return secret;
}

K
Karel Zak 已提交
14761 14762 14763
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
14764
static bool
14765
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
14766
{
E
Eric Blake 已提交
14767
    bool ret = true;
14768 14769

    while (cmd) {
K
Karel Zak 已提交
14770
        struct timeval before, after;
14771
        bool enable_timing = ctl->timing;
14772

14773 14774
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
14775 14776
            vshReconnect(ctl);

14777
        if (enable_timing)
K
Karel Zak 已提交
14778
            GETTIMEOFDAY(&before);
14779

K
Karel Zak 已提交
14780 14781
        ret = cmd->def->handler(ctl, cmd);

14782
        if (enable_timing)
K
Karel Zak 已提交
14783
            GETTIMEOFDAY(&after);
14784

14785
        if (!ret)
J
John Levon 已提交
14786 14787
            virshReportError(ctl);

14788
        /* try to automatically catch disconnections */
14789
        if (!ret &&
14790 14791 14792 14793 14794 14795 14796 14797 14798
            ((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);

14799
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
14800 14801
            return ret;

14802
        if (enable_timing)
14803
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
14804 14805
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
14806
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
14807 14808 14809 14810 14811 14812
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
14813
 * Command parsing
K
Karel Zak 已提交
14814 14815 14816
 * ---------------
 */

14817 14818 14819 14820 14821 14822 14823 14824 14825 14826
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 已提交
14827
    /* vshCommandStringGetArg() */
14828
    char *pos;
L
Lai Jiangshan 已提交
14829 14830 14831
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
14832 14833
} vshCommandParser;

E
Eric Blake 已提交
14834
static bool
14835
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
14836
{
K
Karel Zak 已提交
14837 14838 14839
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
14840

K
Karel Zak 已提交
14841 14842 14843 14844
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
14845

14846
    while (1) {
K
Karel Zak 已提交
14847
        vshCmdOpt *last = NULL;
14848
        const vshCmdDef *cmd = NULL;
14849
        vshCommandToken tk;
L
Lai Jiangshan 已提交
14850
        bool data_only = false;
14851 14852 14853
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
14854

K
Karel Zak 已提交
14855
        first = NULL;
14856

14857
        while (1) {
14858
            const vshCmdOptDef *opt = NULL;
14859

K
Karel Zak 已提交
14860
            tkdata = NULL;
14861
            tk = parser->getNextArg(ctl, parser, &tkdata);
14862 14863

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14864
                goto syntaxError;
H
Hu Tao 已提交
14865 14866
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
14867
                break;
H
Hu Tao 已提交
14868
            }
14869 14870

            if (cmd == NULL) {
K
Karel Zak 已提交
14871 14872
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
14873
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
14874
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
14875
                }
14876 14877 14878 14879 14880 14881 14882
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
14883
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
14884 14885 14886 14887
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
14888
                char *optstr = strchr(tkdata + 2, '=');
14889 14890
                int opt_index;

14891 14892 14893 14894
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
14895
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
14896
                                               &opts_seen, &opt_index))) {
14897
                    VIR_FREE(optstr);
K
Karel Zak 已提交
14898 14899
                    goto syntaxError;
                }
14900
                VIR_FREE(tkdata);
K
Karel Zak 已提交
14901 14902 14903

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
14904 14905 14906
                    if (optstr)
                        tkdata = optstr;
                    else
14907
                        tk = parser->getNextArg(ctl, parser, &tkdata);
14908
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14909
                        goto syntaxError;
14910
                    if (tk != VSH_TK_ARG) {
14911
                        vshError(ctl,
14912
                                 _("expected syntax: --%s <%s>"),
14913 14914
                                 opt->name,
                                 opt->type ==
14915
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
14916 14917
                        goto syntaxError;
                    }
14918 14919
                    if (opt->type != VSH_OT_ARGV)
                        opts_need_arg &= ~(1 << opt_index);
14920 14921 14922 14923 14924 14925 14926 14927
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
14928
                }
L
Lai Jiangshan 已提交
14929 14930 14931 14932
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
14933
            } else {
L
Lai Jiangshan 已提交
14934
get_data:
14935 14936
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
14937
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
14938 14939 14940 14941 14942
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
14943
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
14944

K
Karel Zak 已提交
14945 14946 14947 14948
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
14949

K
Karel Zak 已提交
14950 14951 14952 14953 14954
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
14955

14956
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
14957 14958
                         cmd->name,
                         opt->name,
14959 14960
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
14961 14962
            }
        }
14963

D
Daniel Veillard 已提交
14964
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
14965
        if (cmd) {
14966
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
14967

K
Karel Zak 已提交
14968 14969 14970 14971
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

14972
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
14973
                VIR_FREE(c);
14974
                goto syntaxError;
14975
            }
14976

K
Karel Zak 已提交
14977 14978 14979 14980 14981 14982
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
14983 14984 14985

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
14986
    }
14987

E
Eric Blake 已提交
14988
    return true;
K
Karel Zak 已提交
14989

14990
 syntaxError:
14991
    if (ctl->cmd) {
K
Karel Zak 已提交
14992
        vshCommandFree(ctl->cmd);
14993 14994
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
14995 14996
    if (first)
        vshCommandOptFree(first);
14997
    VIR_FREE(tkdata);
E
Eric Blake 已提交
14998
    return false;
K
Karel Zak 已提交
14999 15000
}

15001 15002 15003 15004 15005 15006 15007 15008 15009 15010 15011 15012 15013 15014 15015 15016 15017 15018
/* --------------------
 * 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 已提交
15019 15020
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
15021 15022 15023 15024
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
15025
        return false;
15026 15027 15028 15029 15030 15031 15032 15033 15034 15035 15036 15037 15038 15039 15040 15041 15042 15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088 15089 15090 15091 15092 15093 15094 15095 15096 15097

    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 已提交
15098 15099
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
15100 15101 15102 15103
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
15104
        return false;
15105 15106 15107 15108 15109 15110

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
15111
/* ---------------
15112
 * Misc utils
K
Karel Zak 已提交
15113 15114
 * ---------------
 */
15115 15116 15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140 15141 15142
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 已提交
15143
static const char *
15144 15145
vshDomainStateToString(int state)
{
15146 15147
    /* Can't use virDomainStateTypeToString, because we want to mark
     * strings for translation.  */
15148
    switch ((virDomainState) state) {
15149
    case VIR_DOMAIN_RUNNING:
15150
        return N_("running");
15151
    case VIR_DOMAIN_BLOCKED:
15152
        return N_("idle");
15153
    case VIR_DOMAIN_PAUSED:
15154
        return N_("paused");
15155
    case VIR_DOMAIN_SHUTDOWN:
15156
        return N_("in shutdown");
15157
    case VIR_DOMAIN_SHUTOFF:
15158
        return N_("shut off");
15159
    case VIR_DOMAIN_CRASHED:
15160
        return N_("crashed");
15161
    case VIR_DOMAIN_NOSTATE:
15162
    default:
15163
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
15164
    }
15165
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
15166 15167
}

15168 15169 15170 15171 15172 15173 15174 15175 15176 15177 15178 15179 15180 15181 15182 15183 15184 15185 15186 15187 15188 15189 15190 15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205 15206 15207 15208 15209 15210 15211 15212 15213 15214 15215 15216 15217 15218 15219 15220 15221 15222
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");
15223 15224
        case VIR_DOMAIN_PAUSED_SHUTTING_DOWN:
            return N_("shutting down");
15225 15226 15227 15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239 15240 15241 15242 15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254 15255 15256 15257 15258 15259 15260 15261 15262 15263 15264 15265
        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;
15266 15267 15268

    default:
        ;
15269 15270 15271 15272 15273
    }

    return N_("unknown");
}

15274 15275 15276 15277 15278 15279 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290 15291 15292 15293 15294 15295 15296 15297 15298 15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 15312 15313 15314 15315 15316 15317 15318 15319 15320 15321 15322 15323 15324 15325 15326 15327 15328 15329 15330 15331 15332 15333 15334 15335 15336
static char *
vshGetTypedParamValue(vshControl *ctl, virTypedParameterPtr item)
{
    int ret = 0;
    char *str = NULL;

    if (!ctl || !item)
        return NULL;

    switch(item->type) {
    case VIR_TYPED_PARAM_INT:
        ret = virAsprintf(&str, "%d", item->value.i);
        break;

    case VIR_TYPED_PARAM_UINT:
        ret = virAsprintf(&str, "%u", item->value.ui);
        break;

    case VIR_TYPED_PARAM_LLONG:
        ret = virAsprintf(&str, "%lld", item->value.l);
        break;

    case VIR_TYPED_PARAM_ULLONG:
        ret = virAsprintf(&str, "%llu", item->value.ul);
        break;

    case VIR_TYPED_PARAM_DOUBLE:
        ret = virAsprintf(&str, "%f", item->value.d);
        break;

    case VIR_TYPED_PARAM_BOOLEAN:
        ret = virAsprintf(&str, "%s", item->value.b ? _("yes") : _("no"));
        break;

    default:
        vshError(ctl, _("unimplemented block statistics parameter type"));
    }

    if (ret < 0)
        vshError(ctl, "%s", _("Out of memory"));
    return str;
}

static virTypedParameterPtr
vshFindTypedParamByName(const char *name, virTypedParameterPtr list, int count)
{
    int i = count;
    virTypedParameterPtr found = list;

    if (!list || !name)
        return NULL;

    while (i-- > 0) {
        if (STREQ(name, found->field))
            return found;

        found++; /* go to next struct in array */
    }

    /* not found */
    return NULL;
}

15337 15338 15339 15340 15341 15342 15343 15344 15345 15346 15347 15348 15349 15350 15351 15352 15353
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");
}

15354 15355 15356 15357
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
15358
    case VIR_VCPU_OFFLINE:
15359
        return N_("offline");
15360
    case VIR_VCPU_BLOCKED:
15361
        return N_("idle");
15362
    case VIR_VCPU_RUNNING:
15363
        return N_("running");
15364
    default:
15365
        ;/*FALLTHROUGH*/
15366
    }
15367
    return N_("no state");
15368 15369
}

E
Eric Blake 已提交
15370
static bool
15371
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
15372
{
15373 15374
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
15375 15376
     */
    if (!conn) {
15377
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
15378
        return false;
K
Karel Zak 已提交
15379
    }
E
Eric Blake 已提交
15380
    return true;
K
Karel Zak 已提交
15381 15382
}

K
Karel Zak 已提交
15383
static void
15384
vshDebug(vshControl *ctl, int level, const char *format, ...)
15385
{
K
Karel Zak 已提交
15386
    va_list ap;
15387
    char *str;
K
Karel Zak 已提交
15388

15389 15390 15391 15392 15393 15394 15395
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

15396
    va_start(ap, format);
15397
    vshOutputLogFile(ctl, level, format, ap);
15398 15399
    va_end(ap);

K
Karel Zak 已提交
15400
    va_start(ap, format);
15401 15402 15403 15404 15405
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
15406
    va_end(ap);
15407 15408
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
15409 15410 15411
}

static void
15412
vshPrintExtra(vshControl *ctl, const char *format, ...)
15413
{
K
Karel Zak 已提交
15414
    va_list ap;
15415
    char *str;
15416

15417
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
15418
        return;
15419

K
Karel Zak 已提交
15420
    va_start(ap, format);
15421 15422 15423 15424 15425
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
15426
    va_end(ap);
15427
    fputs(str, stdout);
15428
    VIR_FREE(str);
K
Karel Zak 已提交
15429 15430
}

K
Karel Zak 已提交
15431

K
Karel Zak 已提交
15432
static void
15433
vshError(vshControl *ctl, const char *format, ...)
15434
{
K
Karel Zak 已提交
15435
    va_list ap;
15436
    char *str;
15437

15438 15439 15440 15441 15442
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
15443

15444 15445 15446 15447
    /* 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);
15448
    fputs(_("error: "), stderr);
15449

K
Karel Zak 已提交
15450
    va_start(ap, format);
15451 15452 15453
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
15454 15455
    va_end(ap);

15456
    fprintf(stderr, "%s\n", NULLSTR(str));
15457
    fflush(stderr);
15458
    VIR_FREE(str);
K
Karel Zak 已提交
15459 15460
}

15461

K
Karel Zak 已提交
15462
/*
15463
 * Initialize connection.
K
Karel Zak 已提交
15464
 */
E
Eric Blake 已提交
15465
static bool
15466
vshInit(vshControl *ctl)
15467
{
15468 15469
    char *debugEnv;

K
Karel Zak 已提交
15470
    if (ctl->conn)
E
Eric Blake 已提交
15471
        return false;
K
Karel Zak 已提交
15472

J
Jiri Denemark 已提交
15473
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
15474 15475 15476
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
15477 15478 15479
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
15480 15481
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
15482 15483
            } else {
                ctl->debug = debug;
15484 15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

15496 15497
    vshOpenLogFile(ctl);

15498 15499
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
15500

15501 15502 15503
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

15504
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
15505
        return false;
15506

15507 15508 15509 15510
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
15511

15512 15513 15514 15515 15516 15517 15518 15519 15520 15521 15522
        /* 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;
        }
15523
    }
K
Karel Zak 已提交
15524

E
Eric Blake 已提交
15525
    return true;
K
Karel Zak 已提交
15526 15527
}

15528 15529
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

15530 15531 15532 15533 15534 15535 15536 15537 15538 15539 15540 15541 15542 15543 15544 15545 15546 15547 15548
/**
 * 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:
15549
                vshError(ctl, "%s",
J
Jim Meyering 已提交
15550
                         _("failed to get the log file information"));
15551
                exit(EXIT_FAILURE);
15552 15553 15554
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
15555 15556
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
15557 15558 15559 15560
        }
    }

    /* log file open */
15561
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
15562
        vshError(ctl, "%s",
J
Jim Meyering 已提交
15563
                 _("failed to open the log file. check the log file path"));
15564
        exit(EXIT_FAILURE);
15565 15566 15567 15568 15569 15570 15571 15572 15573
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
15574 15575
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
15576
{
15577 15578 15579
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
15580 15581 15582 15583 15584 15585 15586 15587 15588 15589 15590 15591 15592 15593
    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);
15594
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
15595 15596 15597 15598 15599 15600
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
15601 15602
                      SIGN_NAME,
                      (int) getpid());
15603 15604 15605 15606 15607 15608 15609 15610 15611 15612 15613 15614 15615 15616 15617 15618 15619 15620 15621 15622
    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;
    }
15623 15624 15625
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
15626

15627 15628
    if (virBufferError(&buf))
        goto error;
15629

15630 15631 15632 15633 15634
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
15635
    }
15636

15637 15638 15639 15640 15641 15642 15643 15644 15645 15646 15647
    /* 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);
15648 15649 15650 15651 15652 15653 15654 15655 15656 15657 15658
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
15659 15660 15661
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
15662 15663 15664
    }

    if (ctl->logfile) {
15665
        VIR_FREE(ctl->logfile);
15666 15667 15668 15669
        ctl->logfile = NULL;
    }
}

15670
#ifdef USE_READLINE
15671

K
Karel Zak 已提交
15672 15673 15674 15675 15676
/* -----------------
 * Readline stuff
 * -----------------
 */

15677
/*
K
Karel Zak 已提交
15678 15679
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
15680
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
15681 15682
 */
static char *
15683 15684
vshReadlineCommandGenerator(const char *text, int state)
{
15685
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
15686
    const char *name;
15687 15688
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
15689 15690

    if (!state) {
15691 15692
        grp_list_index = 0;
        cmd_list_index = 0;
15693
        len = strlen(text);
K
Karel Zak 已提交
15694 15695
    }

15696 15697
    grp = cmdGroups;

K
Karel Zak 已提交
15698
    /* Return the next name which partially matches from the
15699
     * command list.
K
Karel Zak 已提交
15700
     */
15701 15702 15703 15704 15705 15706 15707 15708 15709 15710 15711 15712 15713 15714
    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 已提交
15715 15716 15717 15718 15719 15720 15721
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
15722 15723
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
15724
    static int list_index, len;
15725
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
15726
    const char *name;
K
Karel Zak 已提交
15727 15728 15729 15730 15731 15732 15733 15734 15735

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

15736
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
15737
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
15738 15739 15740

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
15741
        len = strlen(text);
15742
        VIR_FREE(cmdname);
K
Karel Zak 已提交
15743 15744 15745 15746
    }

    if (!cmd)
        return NULL;
15747

15748 15749 15750
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
15751
    while ((name = cmd->opts[list_index].name)) {
15752
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
15753
        char *res;
15754

K
Karel Zak 已提交
15755
        list_index++;
15756

15757
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
15758 15759
            /* ignore non --option */
            continue;
15760

K
Karel Zak 已提交
15761
        if (len > 2) {
15762
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
15763 15764
                continue;
        }
15765
        res = vshMalloc(NULL, strlen(name) + 3);
15766
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
15767 15768 15769 15770 15771 15772 15773 15774
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
15775 15776 15777
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
15778 15779
    char **matches = (char **) NULL;

15780
    if (start == 0)
K
Karel Zak 已提交
15781
        /* command name generator */
15782
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
15783 15784
    else
        /* commands options */
15785
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
15786 15787 15788 15789
    return matches;
}


15790 15791
static int
vshReadlineInit(vshControl *ctl)
15792
{
15793 15794
    char *userdir = NULL;

K
Karel Zak 已提交
15795 15796 15797 15798 15799
    /* 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;
15800 15801 15802

    /* Limit the total size of the history buffer */
    stifle_history(500);
15803 15804

    /* Prepare to read/write history from/to the ~/.virsh/history file */
15805
    userdir = virGetUserDirectory(getuid());
15806

15807 15808
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
15809
        return -1;
15810
    }
15811 15812 15813

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15814
        VIR_FREE(userdir);
15815 15816 15817 15818 15819
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15820
        VIR_FREE(userdir);
15821 15822 15823
        return -1;
    }

15824
    VIR_FREE(userdir);
15825 15826 15827 15828 15829 15830 15831 15832 15833 15834 15835 15836 15837 15838 15839 15840 15841 15842

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

15843 15844
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
15845 15846
}

15847 15848 15849 15850 15851 15852
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

15853
#else /* !USE_READLINE */
15854

15855 15856 15857 15858 15859 15860 15861
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

15862
static void
15863
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
15864 15865 15866 15867 15868 15869 15870 15871 15872 15873 15874 15875 15876 15877 15878 15879 15880 15881 15882 15883 15884 15885 15886
{
    /* 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);
}

15887
#endif /* !USE_READLINE */
15888

K
Karel Zak 已提交
15889
/*
J
Jim Meyering 已提交
15890
 * Deinitialize virsh
K
Karel Zak 已提交
15891
 */
E
Eric Blake 已提交
15892
static bool
15893
vshDeinit(vshControl *ctl)
15894
{
15895
    vshReadlineDeinit(ctl);
15896
    vshCloseLogFile(ctl);
15897
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
15898
    if (ctl->conn) {
15899 15900 15901
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
15902 15903
        }
    }
D
Daniel P. Berrange 已提交
15904 15905
    virResetLastError();

E
Eric Blake 已提交
15906
    return true;
K
Karel Zak 已提交
15907
}
15908

K
Karel Zak 已提交
15909 15910 15911 15912
/*
 * Print usage
 */
static void
15913
vshUsage(void)
15914
{
15915
    const vshCmdGrp *grp;
15916
    const vshCmdDef *cmd;
15917

L
Lai Jiangshan 已提交
15918 15919
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
15920 15921 15922
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
15923
                      "    -d | --debug <num>      debug level [0-4]\n"
15924 15925 15926 15927
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
15928
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
15929
                      "    -V | --version=long     version and full options\n\n"
15930
                      "  commands (non interactive mode):\n\n"), progname, progname);
15931

15932 15933
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
15934

15935 15936 15937 15938 15939 15940 15941 15942 15943
        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"));
15944 15945 15946
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
15947 15948
}

15949 15950 15951 15952 15953 15954 15955 15956 15957 15958
/*
 * 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 已提交
15959 15960
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
15961 15962 15963 15964 15965 15966 15967 15968 15969 15970 15971 15972 15973 15974 15975 15976 15977 15978 15979 15980 15981 15982 15983 15984 15985 15986 15987 15988 15989 15990 15991 15992 15993 15994 15995
#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 已提交
15996
    vshPrint(ctl, "%s", _(" Networking:"));
15997 15998 15999 16000 16001 16002 16003 16004 16005 16006 16007 16008 16009 16010 16011 16012 16013 16014 16015 16016 16017 16018 16019 16020 16021 16022
#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 已提交
16023
    vshPrint(ctl, "%s", _(" Storage:"));
16024 16025 16026 16027 16028 16029 16030 16031 16032 16033 16034 16035 16036 16037 16038 16039 16040 16041 16042 16043 16044 16045 16046
#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 已提交
16047
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
16048
#ifdef WITH_SECDRIVER_APPARMOR
16049 16050 16051 16052 16053 16054 16055 16056 16057 16058 16059 16060 16061 16062 16063 16064 16065 16066 16067 16068 16069 16070 16071
    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 已提交
16072 16073 16074 16075
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
16076
static bool
16077
vshParseArgv(vshControl *ctl, int argc, char **argv)
16078
{
16079 16080
    bool help = false;
    int arg;
K
Karel Zak 已提交
16081
    struct option opt[] = {
E
Eric Blake 已提交
16082 16083 16084 16085 16086 16087 16088 16089 16090
        {"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}
16091 16092
    };

16093 16094 16095
    /* 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. */
16096
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
16097
        switch (arg) {
16098
        case 'd':
D
Daniel Veillard 已提交
16099
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
16100
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
16101 16102
                exit(EXIT_FAILURE);
            }
16103 16104
            break;
        case 'h':
16105
            help = true;
16106 16107
            break;
        case 'q':
E
Eric Blake 已提交
16108
            ctl->quiet = true;
16109 16110
            break;
        case 't':
E
Eric Blake 已提交
16111
            ctl->timing = true;
16112 16113 16114 16115
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
16116 16117 16118 16119 16120 16121
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
16122 16123 16124
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
16125
        case 'r':
E
Eric Blake 已提交
16126
            ctl->readonly = true;
16127
            break;
16128 16129 16130
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
16131
        default:
16132 16133
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
16134 16135 16136 16137
        }
    }

    if (help) {
16138 16139
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
16140 16141
            exit(EXIT_FAILURE);
        }
16142 16143 16144

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
16145
        exit(EXIT_SUCCESS);
16146 16147
    }

16148
    if (argc > optind) {
K
Karel Zak 已提交
16149
        /* parse command */
E
Eric Blake 已提交
16150
        ctl->imode = false;
16151
        if (argc - optind == 1) {
16152
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
16153
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
16154
        } else {
16155
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
16156 16157
        }
    }
E
Eric Blake 已提交
16158
    return true;
K
Karel Zak 已提交
16159 16160
}

16161 16162 16163 16164
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
16165
    char *defaultConn;
E
Eric Blake 已提交
16166
    bool ret = true;
K
Karel Zak 已提交
16167

16168 16169 16170
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
16171
    ctl->debug = VSH_DEBUG_DEFAULT;
16172

16173 16174
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
16175
        /* failure to setup locale is not fatal */
16176
    }
16177
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
16178
        perror("bindtextdomain");
E
Eric Blake 已提交
16179
        return EXIT_FAILURE;
16180
    }
16181
    if (!textdomain(PACKAGE)) {
16182
        perror("textdomain");
E
Eric Blake 已提交
16183
        return EXIT_FAILURE;
16184 16185
    }

16186 16187 16188 16189 16190
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

16191
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
16192 16193 16194
        progname = argv[0];
    else
        progname++;
16195

16196
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
16197
        ctl->name = vshStrdup(ctl, defaultConn);
16198 16199
    }

D
Daniel P. Berrange 已提交
16200 16201
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
16202
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
16203
    }
16204

D
Daniel P. Berrange 已提交
16205 16206
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
16207
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
16208
    }
16209

K
Karel Zak 已提交
16210
    if (!ctl->imode) {
16211
        ret = vshCommandRun(ctl, ctl->cmd);
16212
    } else {
K
Karel Zak 已提交
16213 16214
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
16215
            vshPrint(ctl,
16216
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
16217
                     progname);
J
Jim Meyering 已提交
16218
            vshPrint(ctl, "%s",
16219
                     _("Type:  'help' for help with commands\n"
16220
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
16221
        }
16222 16223 16224 16225 16226 16227

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
16228
        do {
16229
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
16230
            ctl->cmdstr =
16231
                vshReadline(ctl, prompt);
16232 16233
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
16234
            if (*ctl->cmdstr) {
16235
#if USE_READLINE
K
Karel Zak 已提交
16236
                add_history(ctl->cmdstr);
16237
#endif
16238
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
16239 16240
                    vshCommandRun(ctl, ctl->cmd);
            }
16241
            VIR_FREE(ctl->cmdstr);
16242
        } while (ctl->imode);
K
Karel Zak 已提交
16243

16244 16245
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
16246
    }
16247

K
Karel Zak 已提交
16248 16249
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
16250
}