virsh.c 461.8 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 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
    {"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",
      N_("number of read operations:     ") }, /* 0 */
    { VIR_DOMAIN_BLOCK_STATS_READ_BYTES,        "rd_bytes",
      N_("number of read bytes:          ") }, /* 1 */
    { VIR_DOMAIN_BLOCK_STATS_WRITE_REQ,         "wr_req",
      N_("number of write operations:    ") }, /* 2 */
    { VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES,       "wr_bytes",
      N_("number of bytes written:       ") }, /* 3 */
    { VIR_DOMAIN_BLOCK_STATS_ERRS,              "errs",
      N_("error count:                   ") }, /* 4 */
    { VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ,         NULL,
      N_("number of flush operations:    ") }, /* 5 */
    { VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES,  NULL,
      N_("total duration of reads (ns):  ") }, /* 6 */
    { VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES, NULL,
      N_("total duration of writes (ns): ") }, /* 7 */
    { 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)                                     \
        vshPrint(ctl, "%s %s %lld\n", device,           \
                 human ? _(domblkstat_output[ID].human) \
                 : domblkstat_output[ID].legacy,        \
                 VALUE);
1109

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

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

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

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

1134 1135 1136 1137 1138 1139 1140
    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) {
1141 1142
        /* try older API if newer is not supported */
        if (last_error->code != VIR_ERR_NO_SUPPORT)
1143 1144
            goto cleanup;

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

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

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

        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);
1166
    } else {
1167
        params = vshCalloc(ctl, nparams, sizeof(*params));
1168

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

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 1205 1206 1207 1208 1209
        /* 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;

            vshPrint(ctl, "%s %s %s\n", device, field, value);

            VIR_FREE(value);
        }

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

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

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

    ret = true;

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

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

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

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

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

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

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

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

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

1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
/* "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;
1317
    const char *iface;
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
    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;

1337
    if (vshCommandOptString(cmd, "interface", &iface) <= 0)
1338 1339 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
        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 */
1366
    xml = virXMLParseStringCtxt(desc, _("(domain_definition)"), &ctxt);
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
    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");

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

1399
    vshError(ctl, _("interface with address '%s' not found"), iface);
1400 1401 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
    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;
1481
    const char *iface = NULL;
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
    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;

1499
    if (vshCommandOptString (cmd, "interface", &iface) <= 0) {
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
        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;
    }

1513
    xml = virXMLParseStringCtxt(desc, _("(domain_definition)"), &ctxt);
1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536
    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");

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

1546
    vshError(ctl, _("Interface with address '%s' not found."), iface);
1547 1548 1549 1550 1551 1552 1553 1554 1555
    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");
1556
            vshPrint(ctl, "%s %s", iface, state);
1557 1558 1559 1560 1561 1562 1563 1564
            VIR_FREE(state);

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

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

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

    return ret;
}

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

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

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

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

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

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

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

    virDomainFree(dom);
E
Eric Blake 已提交
1630
    return true;
1631 1632
}

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

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

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

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

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

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

1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
/*
 * "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;

1722
    xmldoc = virXMLParseStringCtxt(xml, _("(domain_definition)"), &ctxt);
1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
    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;
}

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

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

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

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

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

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

1794 1795 1796 1797
    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1844
    VIR_FREE(buffer);
1845

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

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

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

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

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

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

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

    dom = virDomainDefineXML(ctl->conn, buffer);
1893
    VIR_FREE(buffer);
1894

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

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

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

E
Eric Blake 已提交
1923
static bool
1924
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1925 1926
{
    virDomainPtr dom;
1927
    bool ret = false;
1928
    const char *name = NULL;
1929
    /* Flags to attempt.  */
E
Eric Blake 已提交
1930
    unsigned int flags = 0;
1931 1932 1933 1934
    /* User-requested actions.  */
    bool managed_save = vshCommandOptBool(cmd, "managed-save");
    bool snapshots_metadata = vshCommandOptBool(cmd, "snapshots-metadata");
    /* Positive if these items exist.  */
1935
    int has_managed_save = 0;
1936 1937 1938 1939 1940
    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;
1941
    int rc = -1;
1942
    int running;
1943

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

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

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

1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
    /* 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;
            }
1978 1979
            virFreeError(last_error);
            last_error = NULL;
1980
            has_managed_save = 0;
1981 1982
        }

1983 1984
        has_snapshots = virDomainSnapshotNum(dom, 0);
        if (has_snapshots < 0) {
1985 1986
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998
                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.  */
1999 2000
                virFreeError(last_error);
                last_error = NULL;
2001 2002 2003 2004 2005
                has_snapshots_metadata = has_snapshots;
            } else {
                /* The server knew the new flag, all aspects of
                 * undefineFlags are safe.  */
                managed_save_safe = snapshots_safe = true;
2006
            }
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019
        }
    }
    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;
    }
2020

2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034
    /* 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;
    }
2035

2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047
    /* 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;
2048 2049 2050
        }
    }

2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064
    /* 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:
2065
    if (rc == 0) {
2066
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
2067
        ret = true;
2068
    } else {
2069
        vshError(ctl, _("Failed to undefine domain %s"), name);
2070 2071
    }

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


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

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

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

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

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

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

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

2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161
    /* 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 已提交
2162 2163
    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
2164
         : virDomainCreate(dom)) < 0) {
2165
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
2166
        goto cleanup;
2167
    }
2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179

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

    ret = true;

cleanup:
2180
    virDomainFree(dom);
2181 2182 2183
    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276
/*
 * "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 已提交
2277
    unsigned int flags = 0;
2278 2279 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
    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")},
2314 2315
    {"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")},
2316 2317 2318 2319 2320 2321 2322 2323 2324 2325
    {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;
2326 2327 2328 2329 2330 2331
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370

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

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

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

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

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

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

cleanup:
    VIR_FREE(xml);
    return ret;
}

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

static const vshCmdOptDef opts_save_image_edit[] = {
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("saved state file to edit")},
2371 2372
    {"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")},
2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383
    {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;
2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399
    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;
    }
2400 2401 2402 2403 2404 2405 2406 2407

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

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

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

2426 2427 2428
    /* 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) {
2429 2430 2431 2432 2433 2434 2435
        vshPrint(ctl, _("Saved image %s XML configuration not changed.\n"),
                 file);
        ret = true;
        goto cleanup;
    }

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

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

static const vshCmdOptDef opts_managedsave[] = {
2468
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2469
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2470 2471
    {"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")},
2472 2473 2474
    {NULL, 0, 0, NULL}
};

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

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

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

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

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

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

cleanup:
2505 2506 2507 2508
    virDomainFree(dom);
    return ret;
}

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

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

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

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

cleanup:
    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

        if (!match)
            return 0;

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

2673 2674
    return 0;
}
2675

2676

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

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

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

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

2722
    if (nparams) {
2723
        params = vshMalloc(ctl, sizeof(*params) * nparams);
2724

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cleanup:
2882
    VIR_FREE(xml);
2883 2884 2885
    return ret;
}

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

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

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

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

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

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

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

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

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

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

2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 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
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;
}

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

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

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

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

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

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

3124 3125 3126 3127
    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

3162 3163 3164 3165
    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        if (info.cpuTime != 0) {
3299
            double cpuUsed = info.cpuTime;
3300

3301
            cpuUsed /= 1000000000.0;
3302

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

3529

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

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

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

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

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

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

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

E
Eric Blake 已提交
3613
    func_ret = true;
3614

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            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;
3966
        }
3967 3968
    }

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

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

3984
static const vshCmdOptDef opts_vcpupin[] = {
3985
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3986 3987 3988
    {"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")},
3989 3990 3991
    {"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")},
3992 3993 3994
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3995
static bool
E
Eric Blake 已提交
3996
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
3997 3998 3999 4000
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
4001
    int vcpu = -1;
4002
    const char *cpulist = NULL;
E
Eric Blake 已提交
4003
    bool ret = true;
4004 4005
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
4006
    size_t cpumaplen;
4007 4008
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
4009
    bool unuse = false;
4010
    const char *cur;
4011 4012 4013
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
4014
    bool query = false; /* Query mode if no cpulist */
E
Eric Blake 已提交
4015
    unsigned int flags = 0;
4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031

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

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

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

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

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

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

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

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

4071 4072
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
4073

4074 4075 4076 4077 4078 4079 4080 4081
    /* 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 已提交
4082
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
4083 4084 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
                                             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);
4128 4129
    /* Parse cpulist */
    cur = cpulist;
4130
    if (*cur == 0) {
4131
        goto parse_error;
4132 4133 4134
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
4135
        cur = "";
4136
    }
4137 4138 4139 4140 4141 4142 4143

    while (*cur != 0) {

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

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

4159 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
        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);
        }
4186

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

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

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

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

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

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

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

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

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

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

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

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

4287 4288
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

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

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

4308
  cleanup:
4309 4310 4311 4312
    virDomainFree(dom);
    return ret;
}

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

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

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4358 4359
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT,
     N_("the codeset of keycodes, default:linux")},
4360
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
A
Alex Jia 已提交
4361
     N_("the time (in milliseconds) how long the keys will be held")},
4362 4363 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
    {"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;
}

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

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

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

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

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

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

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

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

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

4597 4598 4599 4600
    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

4822 4823 4824 4825 4826 4827 4828 4829 4830
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

4831 4832 4833
    if (min_guarantee)
        nparams++;

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

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

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

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

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

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

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

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

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

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

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

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

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

4975 4976 4977 4978 4979
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
4980
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
4981 4982 4983 4984 4985 4986 4987 4988 4989 4990
    {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
4991
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
4992 4993 4994 4995
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
4996 4997
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
4998 4999 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
    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;

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

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122
/*
 * "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;
5123 5124
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
5125 5126 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
    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;
}

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

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

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

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

E
Eric Blake 已提交
5189
    return true;
5190 5191
}

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

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

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

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
5224 5225
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
5226

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

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

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

5241 5242 5243 5244
    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

    return ret;
}

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

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

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

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

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

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

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

    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

5495
    if (!vshConnectionUsability (ctl, ctl->conn))
5496
        goto out;
5497

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

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

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

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

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

5525 5526 5527
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

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

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

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

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


5542 5543 5544 5545
    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. */
5546

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

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

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
5560
        if (!dconn) goto out;
5561

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

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

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

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

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

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
5628 5629

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

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

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

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

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

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

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

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

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

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

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

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

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

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

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

E
Eric Blake 已提交
5777
    ret = true;
5778 5779 5780 5781 5782 5783

done:
    virDomainFree(dom);
    return ret;
}

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

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

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

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

    if (vshCommandOptString(cmd, "path", &path) < 0)
5890
        goto cleanup;
5891

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

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

5906
cleanup:
5907 5908
    if (dom)
        virDomainFree(dom);
5909 5910 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
    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;
}


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    network = virNetworkCreateXML(ctl->conn, buffer);
6074
    VIR_FREE(buffer);
6075

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


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

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

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

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

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

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

    network = virNetworkDefineXML(ctl->conn, buffer);
6120
    VIR_FREE(buffer);
6121

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


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

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

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

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

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

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

6168
    virNetworkFree(network);
6169 6170 6171 6172 6173 6174 6175
    return ret;
}


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

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

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

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

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

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

    virNetworkFree(network);
    return ret;
}

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

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

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

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

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

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

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

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

cleanup:
    if (iface)
        virInterfaceFree (iface);

6357 6358 6359
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
6360 6361 6362

    if (tmp) {
        unlink (tmp);
6363
        VIR_FREE(tmp);
6364 6365 6366 6367 6368
    }

    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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


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

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

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

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

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

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


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

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

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

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

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

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

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


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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

}

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

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

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

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

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

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

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

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

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

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

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

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

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

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
6841

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

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

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

    virInterfaceFree(iface);
    return ret;
}

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

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

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

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

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

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

6891
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
6892
    VIR_FREE(buffer);
6893

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

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

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

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

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

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

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

    virInterfaceFree(iface);
    return ret;
}

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

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

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

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

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

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

    virInterfaceFree(iface);
    return ret;
}

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

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

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

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

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

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

    virInterfaceFree(iface);
    return ret;
}

7019 7020 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
/*
 * "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;
}
7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118

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

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

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

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

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

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

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

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

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

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

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

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

    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 已提交
7242
static bool
7243 7244 7245 7246 7247 7248
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

7249
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7250
        return false;
7251 7252 7253 7254

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
7255
        return false;
7256 7257 7258 7259 7260 7261 7262 7263
    }

    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 已提交
7264
        return false;
7265 7266 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
    }

    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 已提交
7292
    return true;
7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309
}


/*
 * "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 已提交
7310
static bool
7311 7312
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
7313
    bool ret = false;
7314 7315 7316 7317 7318 7319
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

7320
    if (!vshConnectionUsability(ctl, ctl->conn))
7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346
        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 已提交
7347
        ret = true;
7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373
        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 已提交
7374
    ret = true;
7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392

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


7393
/**************************************************************************/
7394
/*
7395
 * "pool-autostart" command
7396
 */
7397
static const vshCmdInfo info_pool_autostart[] = {
7398
    {"help", N_("autostart a pool")},
7399
    {"desc",
7400
     N_("Configure a pool to be automatically started at boot.")},
7401
    {NULL, NULL}
7402 7403
};

7404
static const vshCmdOptDef opts_pool_autostart[] = {
7405 7406
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
7407 7408
    {NULL, 0, 0, NULL}
};
7409

E
Eric Blake 已提交
7410
static bool
7411
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
7412
{
7413
    virStoragePoolPtr pool;
7414
    const char *name;
7415
    int autostart;
7416

7417
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7418
        return false;
7419

7420
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7421
        return false;
7422

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

7425 7426
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
7427
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
7428
        else
7429
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
7430
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7431
        return false;
7432 7433
    }

7434
    if (autostart)
7435
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
7436
    else
7437
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
7438

L
Laine Stump 已提交
7439
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7440
    return true;
7441 7442
}

7443
/*
7444
 * "pool-create" command
7445
 */
7446
static const vshCmdInfo info_pool_create[] = {
7447 7448
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
7449 7450 7451
    {NULL, NULL}
};

7452
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
7453
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
7454
     N_("file containing an XML pool description")},
7455 7456 7457
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7458
static bool
7459
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
7460
{
7461
    virStoragePoolPtr pool;
7462
    const char *from = NULL;
E
Eric Blake 已提交
7463
    bool ret = true;
7464
    char *buffer;
7465

7466
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7467
        return false;
7468

7469
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7470
        return false;
7471

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

7475
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
7476
    VIR_FREE(buffer);
7477 7478 7479 7480

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7481
        virStoragePoolFree(pool);
7482
    } else {
7483
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
7484
        ret = false;
7485 7486
    }
    return ret;
7487 7488
}

7489

7490 7491 7492 7493
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
7494
    {"help", N_("create a device defined "
7495
                          "by an XML file on the node")},
7496
    {"desc", N_("Create a device on the node.  Note that this "
7497 7498 7499 7500 7501 7502 7503
                          "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,
7504
     N_("file containing an XML description of the device")},
7505 7506 7507
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7508
static bool
7509 7510 7511
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
7512
    const char *from = NULL;
E
Eric Blake 已提交
7513
    bool ret = true;
7514 7515
    char *buffer;

7516
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7517
        return false;
7518

7519
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7520
        return false;
7521

7522
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
7523
        return false;
7524 7525

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
7526
    VIR_FREE(buffer);
7527 7528 7529 7530

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
7531
        virNodeDeviceFree(dev);
7532
    } else {
7533
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
7534
        ret = false;
7535 7536 7537 7538 7539 7540 7541 7542 7543 7544
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
7545
    {"help", N_("destroy (stop) a device on the node")},
7546
    {"desc", N_("Destroy a device on the node.  Note that this "
7547
                "command destroys devices on the physical host")},
7548 7549 7550 7551 7552
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
7553
     N_("name of the device to be destroyed")},
7554 7555 7556
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7557
static bool
7558 7559 7560
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
7561
    bool ret = true;
7562
    const char *name = NULL;
7563

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

7568
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
7569
        return false;
7570 7571 7572 7573 7574 7575

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
7576
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
7577
        ret = false;
7578 7579 7580 7581 7582 7583 7584
    }

    virNodeDeviceFree(dev);
    return ret;
}


7585
/*
7586
 * XML Building helper for pool-define-as and pool-create-as
7587
 */
7588
static const vshCmdOptDef opts_pool_X_as[] = {
7589 7590 7591 7592 7593 7594 7595 7596
    {"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")},
7597
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
7598 7599 7600
    {NULL, 0, 0, NULL}
};

7601
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
7602

7603 7604
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
7605
    virBuffer buf = VIR_BUFFER_INITIALIZER;
7606

7607
    if (vshCommandOptString(cmd, "name", &name) <= 0)
7608
        goto cleanup;
7609
    if (vshCommandOptString(cmd, "type", &type) <= 0)
7610 7611
        goto cleanup;

7612 7613 7614 7615 7616
    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 ||
7617 7618
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
7619
        goto cleanup;
7620
    }
7621

7622 7623
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
7624
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
7625
        virBufferAddLit(&buf, "  <source>\n");
7626

7627
        if (srcHost)
7628
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
7629
        if (srcPath)
7630
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
7631
        if (srcDev)
7632
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
7633
        if (srcFormat)
7634
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
7635
        if (srcName)
7636
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
7637 7638

        virBufferAddLit(&buf, "  </source>\n");
7639 7640
    }
    if (target) {
7641
        virBufferAddLit(&buf, "  <target>\n");
7642
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
7643
        virBufferAddLit(&buf, "  </target>\n");
7644
    }
7645 7646 7647 7648
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7649
        return false;
7650
    }
7651 7652 7653

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
7654
    return true;
7655 7656

cleanup:
7657
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7658
    return false;
7659 7660 7661 7662 7663 7664
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
7665 7666
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
7667 7668 7669
    {NULL, NULL}
};

E
Eric Blake 已提交
7670
static bool
7671 7672 7673
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
7674 7675
    const char *name;
    char *xml;
7676
    int printXML = vshCommandOptBool(cmd, "print-xml");
7677

7678
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7679
        return false;
7680 7681

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

7684
    if (printXML) {
7685
        vshPrint(ctl, "%s", xml);
7686
        VIR_FREE(xml);
7687
    } else {
7688
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
7689
        VIR_FREE(xml);
7690

7691 7692 7693 7694
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
7695
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
7696
            return false;
7697 7698
        }
    }
E
Eric Blake 已提交
7699
    return true;
7700 7701
}

7702

7703
/*
7704
 * "pool-define" command
7705
 */
7706
static const vshCmdInfo info_pool_define[] = {
7707 7708
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
7709 7710 7711
    {NULL, NULL}
};

7712
static const vshCmdOptDef opts_pool_define[] = {
7713
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
7714 7715 7716
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7717
static bool
7718
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
7719
{
7720
    virStoragePoolPtr pool;
7721
    const char *from = NULL;
E
Eric Blake 已提交
7722
    bool ret = true;
7723
    char *buffer;
7724

7725
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7726
        return false;
7727

7728
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7729
        return false;
7730

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

7734
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
7735
    VIR_FREE(buffer);
7736 7737 7738 7739

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7740
        virStoragePoolFree(pool);
7741
    } else {
7742
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
7743
        ret = false;
7744 7745
    }
    return ret;
7746 7747
}

7748

7749 7750 7751
/*
 * "pool-define-as" command
 */
7752
static const vshCmdInfo info_pool_define_as[] = {
7753 7754
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
7755 7756 7757
    {NULL, NULL}
};

E
Eric Blake 已提交
7758
static bool
7759
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
7760 7761
{
    virStoragePoolPtr pool;
7762 7763
    const char *name;
    char *xml;
7764
    int printXML = vshCommandOptBool(cmd, "print-xml");
7765

7766
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7767
        return false;
7768

7769
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
7770
        return false;
7771

7772
    if (printXML) {
7773
        vshPrint(ctl, "%s", xml);
7774
        VIR_FREE(xml);
7775
    } else {
7776
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
7777
        VIR_FREE(xml);
7778

7779 7780 7781 7782
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
7783
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
7784
            return false;
7785 7786
        }
    }
E
Eric Blake 已提交
7787
    return true;
7788 7789 7790
}


7791
/*
7792
 * "pool-build" command
7793
 */
7794
static const vshCmdInfo info_pool_build[] = {
7795 7796
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
7797 7798 7799
    {NULL, NULL}
};

7800
static const vshCmdOptDef opts_pool_build[] = {
7801
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7802 7803
    {"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")},
7804 7805 7806
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7807
static bool
7808
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
7809
{
7810
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7811
    bool ret = true;
7812
    const char *name;
7813
    unsigned int flags = 0;
7814

7815
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7816
        return false;
7817

7818
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7819
        return false;
7820

7821 7822 7823 7824 7825 7826 7827 7828 7829
    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) {
7830
        vshPrint(ctl, _("Pool %s built\n"), name);
7831
    } else {
7832
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
7833
        ret = false;
7834 7835
    }

7836 7837
    virStoragePoolFree(pool);

7838 7839 7840
    return ret;
}

7841
/*
7842
 * "pool-destroy" command
7843
 */
7844
static const vshCmdInfo info_pool_destroy[] = {
7845 7846 7847
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
7848 7849 7850
    {NULL, NULL}
};

7851
static const vshCmdOptDef opts_pool_destroy[] = {
7852
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7853 7854 7855
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7856
static bool
7857
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
7858
{
7859
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7860
    bool ret = true;
7861
    const char *name;
7862

7863
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7864
        return false;
7865

7866
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7867
        return false;
7868

7869 7870 7871
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
7872
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
7873
        ret = false;
7874 7875
    }

7876
    virStoragePoolFree(pool);
7877 7878 7879
    return ret;
}

7880

7881
/*
7882 7883
 * "pool-delete" command
 */
7884
static const vshCmdInfo info_pool_delete[] = {
7885 7886
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
7887 7888 7889
    {NULL, NULL}
};

7890
static const vshCmdOptDef opts_pool_delete[] = {
7891
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7892 7893 7894
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7895
static bool
7896
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
7897 7898
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7899
    bool ret = true;
7900
    const char *name;
7901

7902
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7903
        return false;
7904 7905

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7906
        return false;
7907 7908

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
7909
        vshPrint(ctl, _("Pool %s deleted\n"), name);
7910
    } else {
7911
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
7912
        ret = false;
7913 7914
    }

L
Laine Stump 已提交
7915
    virStoragePoolFree(pool);
7916 7917 7918 7919 7920 7921 7922
    return ret;
}


/*
 * "pool-refresh" command
 */
7923
static const vshCmdInfo info_pool_refresh[] = {
7924 7925
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
7926 7927 7928
    {NULL, NULL}
};

7929
static const vshCmdOptDef opts_pool_refresh[] = {
7930
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7931 7932 7933
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7934
static bool
7935
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
7936 7937
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7938
    bool ret = true;
7939
    const char *name;
7940

7941
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7942
        return false;
7943 7944

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7945
        return false;
7946 7947 7948 7949

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
7950
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
7951
        ret = false;
7952 7953 7954 7955 7956 7957 7958 7959 7960 7961
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
7962
static const vshCmdInfo info_pool_dumpxml[] = {
7963 7964
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
7965 7966 7967
    {NULL, NULL}
};

7968
static const vshCmdOptDef opts_pool_dumpxml[] = {
7969
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7970 7971 7972
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7973
static bool
7974
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
7975 7976
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7977
    bool ret = true;
7978 7979
    char *dump;

7980
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7981
        return false;
7982 7983

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7984
        return false;
7985 7986 7987

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
7988
        vshPrint(ctl, "%s", dump);
7989
        VIR_FREE(dump);
7990
    } else {
E
Eric Blake 已提交
7991
        ret = false;
7992 7993 7994 7995 7996 7997 7998 7999 8000 8001
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
8002
static const vshCmdInfo info_pool_list[] = {
8003 8004
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
8005 8006 8007
    {NULL, NULL}
};

8008
static const vshCmdOptDef opts_pool_list[] = {
8009 8010
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
8011
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
8012 8013 8014
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8015
static bool
8016
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8017
{
8018 8019
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
8020 8021
    int i, ret;
    bool functionReturn;
8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037
    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 */
8038
    int all = vshCommandOptBool(cmd, "all");
8039 8040
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
8041 8042 8043
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

8044
    /* Check the connection to libvirtd daemon is still working */
8045
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8046
        return false;
8047

8048
    /* Retrieve the number of active storage pools */
8049
    if (active) {
8050 8051
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
8052
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
8053
            return false;
8054 8055
        }
    }
8056 8057

    /* Retrieve the number of inactive storage pools */
8058
    if (inactive) {
8059 8060
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
8061
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
8062
            return false;
8063
        }
8064
    }
8065

8066 8067
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
8068

8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080
    /* 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 已提交
8081
            return false;
8082 8083 8084
        }
    }

8085 8086 8087 8088 8089 8090 8091 8092
    /* 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 已提交
8093
            return false;
8094 8095
        }
    }
8096

8097 8098 8099 8100 8101 8102 8103 8104 8105 8106
    /* 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]);
8107
        if (!pool) {
8108
            VIR_FREE(poolNames[i]);
8109 8110 8111
            continue;
        }

8112
        /* Retrieve the autostart status of the pool */
8113
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
8114
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
8115
        else
8116 8117 8118 8119 8120 8121
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
8122 8123
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134
            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;
        }
8135

8136 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
        /* 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 */
8248 8249 8250
        virStoragePoolFree(pool);
    }

8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268
    /* 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);
8269 8270
        }

8271
        /* Cleanup and return */
E
Eric Blake 已提交
8272
        functionReturn = true;
8273 8274
        goto cleanup;
    }
8275

8276 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
    /* 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. */
8314
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
8315
             (unsigned long) nameStrLength);
8316
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
8317
             (unsigned long) stateStrLength);
8318
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
8319
             (unsigned long) autostartStrLength);
8320
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
8321
             (unsigned long) persistStrLength);
8322
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
8323
             (unsigned long) capStrLength);
8324
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
8325
             (unsigned long) allocStrLength);
8326
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
8327 8328 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
             (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 已提交
8370
    functionReturn = true;
8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384
    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 已提交
8385
    functionReturn = false;
8386

8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398
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]);
8399
    }
8400 8401 8402 8403 8404 8405 8406

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

    /* Return the desired value */
    return functionReturn;
8407 8408
}

8409 8410 8411 8412
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
8413 8414
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
8415 8416 8417 8418 8419
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
8420 8421 8422
     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")},
8423
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
8424 8425 8426
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8427
static bool
8428 8429
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
8430
    const char *type = NULL, *host = NULL;
8431 8432
    char *srcSpec = NULL;
    char *srcList;
8433
    const char *initiator = NULL;
8434

8435 8436
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
8437 8438
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
8439
        return false;
8440
    }
8441

8442
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8443
        return false;
8444 8445

    if (host) {
8446
        const char *port = NULL;
8447
        virBuffer buf = VIR_BUFFER_INITIALIZER;
8448 8449 8450 8451

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
8452
            return false;
8453
        }
8454
        virBufferAddLit(&buf, "<source>\n");
8455
        virBufferAsprintf(&buf, "  <host name='%s'", host);
8456
        if (port)
8457
            virBufferAsprintf(&buf, " port='%s'", port);
8458
        virBufferAddLit(&buf, "/>\n");
8459 8460
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
8461
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
8462 8463
            virBufferAddLit(&buf, "  </initiator>\n");
        }
8464 8465 8466
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
8467
            return false;
8468
        }
8469
        srcSpec = virBufferContentAndReset(&buf);
8470 8471 8472
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
8473
    VIR_FREE(srcSpec);
8474
    if (srcList == NULL) {
8475
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
8476
        return false;
8477 8478
    }
    vshPrint(ctl, "%s", srcList);
8479
    VIR_FREE(srcList);
8480

E
Eric Blake 已提交
8481
    return true;
8482 8483 8484 8485 8486 8487 8488
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
8489 8490
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
8491 8492 8493 8494 8495
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
8496
     N_("type of storage pool sources to discover")},
8497
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
8498
     N_("optional file of source xml to query for pools")},
8499 8500 8501
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8502
static bool
8503 8504
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
8505
    const char *type = NULL, *srcSpecFile = NULL;
8506
    char *srcSpec = NULL, *srcList;
8507

8508
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
8509
        return false;
8510

8511 8512
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
8513
        return false;
8514
    }
8515

8516
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8517
        return false;
8518 8519

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
8520
        return false;
8521 8522

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
8523
    VIR_FREE(srcSpec);
8524
    if (srcList == NULL) {
8525
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
8526
        return false;
8527 8528
    }
    vshPrint(ctl, "%s", srcList);
8529
    VIR_FREE(srcList);
8530

E
Eric Blake 已提交
8531
    return true;
8532 8533 8534
}


8535 8536 8537
/*
 * "pool-info" command
 */
8538
static const vshCmdInfo info_pool_info[] = {
8539 8540
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
8541 8542 8543
    {NULL, NULL}
};

8544
static const vshCmdOptDef opts_pool_info[] = {
8545
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8546 8547 8548
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8549
static bool
8550
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
8551 8552 8553
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
8554 8555
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
8556
    bool ret = true;
8557 8558
    char uuid[VIR_UUID_STRING_BUFLEN];

8559
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8560
        return false;
8561 8562

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8563
        return false;
8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589

    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;
8590 8591 8592 8593
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
8594 8595
        }

8596 8597
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
8598 8599
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
8600 8601 8602 8603 8604 8605 8606
        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);
8607 8608
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
8609 8610 8611 8612 8613
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625
        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 已提交
8626
        ret = false;
8627 8628 8629 8630 8631 8632 8633 8634 8635 8636
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
8637
static const vshCmdInfo info_pool_name[] = {
8638
    {"help", N_("convert a pool UUID to pool name")},
8639
    {"desc", ""},
8640 8641 8642
    {NULL, NULL}
};

8643
static const vshCmdOptDef opts_pool_name[] = {
8644
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
8645 8646 8647
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8648
static bool
8649
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
8650 8651 8652
{
    virStoragePoolPtr pool;

8653
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8654
        return false;
8655
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8656
                                           VSH_BYUUID)))
E
Eric Blake 已提交
8657
        return false;
8658 8659 8660

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8661
    return true;
8662 8663 8664 8665 8666 8667
}


/*
 * "pool-start" command
 */
8668
static const vshCmdInfo info_pool_start[] = {
8669 8670
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
8671 8672 8673
    {NULL, NULL}
};

8674
static const vshCmdOptDef opts_pool_start[] = {
8675
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
8676 8677 8678
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8679
static bool
8680
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
8681 8682
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8683
    bool ret = true;
8684

8685
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8686
        return false;
8687

8688
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
8689
         return false;
8690 8691 8692 8693 8694

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
8695
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
8696
        ret = false;
8697
    }
L
Laine Stump 已提交
8698 8699

    virStoragePoolFree(pool);
8700 8701 8702 8703
    return ret;
}


8704 8705 8706
/*
 * "vol-create-as" command
 */
8707
static const vshCmdInfo info_vol_create_as[] = {
8708 8709
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
8710 8711 8712
    {NULL, NULL}
};

8713
static const vshCmdOptDef opts_vol_create_as[] = {
8714 8715 8716 8717 8718
    {"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")},
8719 8720
    {"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")},
8721 8722 8723 8724 8725 8726 8727 8728 8729 8730
    {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 已提交
8731
        /* Deliberate fallthrough cases here :-) */
8732 8733 8734
        switch (*end) {
        case 'T':
            *val *= 1024;
8735
            /* fallthrough */
8736 8737
        case 'G':
            *val *= 1024;
8738
            /* fallthrough */
8739 8740
        case 'M':
            *val *= 1024;
8741
            /* fallthrough */
8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
8755
static bool
8756
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
8757 8758 8759
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8760
    char *xml;
8761 8762
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
8763
    unsigned long long capacity, allocation = 0;
8764
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8765

8766
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8767
        return false;
8768 8769 8770

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

8773
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8774 8775
        goto cleanup;

8776
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
8777 8778
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
8779
        vshError(ctl, _("Malformed size %s"), capacityStr);
8780

8781 8782
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
8783
        vshError(ctl, _("Malformed size %s"), allocationStr);
8784

8785 8786 8787 8788 8789 8790 8791
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

8792

8793
    virBufferAddLit(&buf, "<volume>\n");
8794 8795
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
8796
    if (allocationStr)
8797
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
8798 8799

    if (format) {
8800
        virBufferAddLit(&buf, "  <target>\n");
8801
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
8802
        virBufferAddLit(&buf, "  </target>\n");
8803
    }
8804

8805 8806 8807 8808
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
8809 8810
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
8811 8812 8813
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
8814 8815
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
8816 8817 8818 8819 8820
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
8821 8822
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
8823 8824 8825
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
8826 8827
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
8828 8829 8830 8831 8832
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
8833 8834
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
8835 8836 8837
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
8838 8839
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
8840 8841 8842 8843
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
8844
            goto cleanup;
8845 8846 8847 8848 8849
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
8850
            goto cleanup;
8851 8852 8853 8854
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
8855
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
8856
        if (snapshotStrFormat)
8857
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
8858 8859 8860 8861 8862 8863 8864 8865
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

8867 8868
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
8869
        goto cleanup;
8870 8871 8872
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
8873
    VIR_FREE(xml);
8874 8875 8876 8877 8878
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
8879
        return true;
8880
    } else {
8881
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
8882
        return false;
8883 8884 8885
    }

 cleanup:
8886
    virBufferFreeAndReset(&buf);
8887
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8888
    return false;
8889 8890 8891
}


8892 8893 8894
/*
 * "pool-undefine" command
 */
8895
static const vshCmdInfo info_pool_undefine[] = {
8896 8897
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
8898 8899 8900
    {NULL, NULL}
};

8901
static const vshCmdOptDef opts_pool_undefine[] = {
8902
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8903 8904 8905
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8906
static bool
8907
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
8908 8909
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8910
    bool ret = true;
8911
    const char *name;
8912

8913
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8914
        return false;
8915 8916

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8917
        return false;
8918 8919 8920 8921

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

L
Laine Stump 已提交
8926
    virStoragePoolFree(pool);
8927 8928 8929 8930 8931 8932 8933
    return ret;
}


/*
 * "pool-uuid" command
 */
8934
static const vshCmdInfo info_pool_uuid[] = {
8935
    {"help", N_("convert a pool name to pool UUID")},
8936
    {"desc", ""},
8937 8938 8939
    {NULL, NULL}
};

8940
static const vshCmdOptDef opts_pool_uuid[] = {
8941
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
8942 8943 8944
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8945
static bool
8946
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
8947 8948 8949 8950
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

8951
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8952
        return false;
8953 8954

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8955
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8956
        return false;
8957 8958 8959 8960

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

L
Laine Stump 已提交
8963
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8964
    return true;
8965 8966 8967 8968 8969 8970
}


/*
 * "vol-create" command
 */
8971
static const vshCmdInfo info_vol_create[] = {
8972 8973
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
8974 8975 8976
    {NULL, NULL}
};

8977
static const vshCmdOptDef opts_vol_create[] = {
8978 8979
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
8980 8981 8982
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8983
static bool
8984
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
8985 8986 8987
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8988
    const char *from = NULL;
E
Eric Blake 已提交
8989
    bool ret = true;
8990 8991
    char *buffer;

8992
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8993
        return false;
8994 8995

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

8999
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9000
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9001
        return false;
9002 9003 9004
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9005
        virshReportError(ctl);
9006
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9007
        return false;
9008 9009 9010
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
9011
    VIR_FREE(buffer);
9012 9013 9014 9015 9016 9017 9018
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
9019
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
9020
        ret = false;
9021 9022 9023 9024
    }
    return ret;
}

9025 9026 9027 9028
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
9029 9030
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
9031 9032 9033 9034
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
9035 9036 9037
    {"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 已提交
9038
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
9039 9040 9041
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9042
static bool
9043 9044 9045 9046
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
9047
    const char *from = NULL;
E
Eric Blake 已提交
9048
    bool ret = false;
9049 9050
    char *buffer = NULL;

9051
    if (!vshConnectionUsability(ctl, ctl->conn))
9052 9053 9054 9055 9056
        goto cleanup;

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

9057
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9058 9059 9060 9061 9062 9063 9064
        goto cleanup;
    }

    if (!(inputvol = vshCommandOptVol(ctl, cmd, "vol", "inputpool", NULL)))
        goto cleanup;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9065
        virshReportError(ctl);
9066 9067 9068 9069 9070 9071 9072 9073 9074
        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 {
9075
        vshError(ctl, _("Failed to create vol from %s"), from);
9076 9077 9078
        goto cleanup;
    }

E
Eric Blake 已提交
9079
    ret = true;
9080
cleanup:
9081
    VIR_FREE(buffer);
9082 9083 9084 9085
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
9086 9087
    if (newvol)
        virStorageVolFree(newvol);
9088 9089 9090 9091
    return ret;
}

static xmlChar *
9092 9093
makeCloneXML(const char *origxml, const char *newname)
{
9094

9095 9096 9097
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
9098 9099 9100
    xmlChar *newxml = NULL;
    int size;

9101
    doc = virXMLParseStringCtxt(origxml, _("(volume_definition)"), &ctxt);
9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123
    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[] = {
9124 9125
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
9126 9127 9128 9129
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
9130 9131
    {"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 已提交
9132
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9133 9134 9135
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9136
static bool
9137 9138 9139 9140
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
9141
    const char *name = NULL;
9142
    char *origxml = NULL;
9143
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
9144
    bool ret = false;
9145

9146
    if (!vshConnectionUsability(ctl, ctl->conn))
9147 9148 9149 9150 9151 9152 9153
        goto cleanup;

    if (!(origvol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        goto cleanup;

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
9154
        vshError(ctl, "%s", _("failed to get parent pool"));
9155 9156 9157
        goto cleanup;
    }

9158
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176
        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 {
9177
        vshError(ctl, _("Failed to clone vol from %s"),
9178 9179 9180 9181
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
9182
    ret = true;
9183 9184

cleanup:
9185
    VIR_FREE(origxml);
9186 9187 9188
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
9189 9190
    if (newvol)
        virStorageVolFree(newvol);
9191 9192 9193 9194 9195
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208

/*
 * "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 已提交
9209
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223
    {"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 已提交
9224
static bool
9225 9226 9227 9228
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
9229
    bool ret = false;
9230 9231 9232 9233 9234 9235 9236 9237 9238 9239
    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 已提交
9240
        return false;
9241 9242 9243 9244
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
9245
        return false;
9246 9247 9248
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9249
        return false;
9250 9251 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
    }

    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 已提交
9284
    ret = true;
9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308

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 已提交
9309
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9310 9311 9312 9313 9314
    {"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 已提交
9315
static bool
9316 9317 9318 9319
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
9320
    bool ret = false;
9321 9322 9323 9324
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
9325
    bool created = false;
9326 9327

    if (!vshConnectionUsability(ctl, ctl->conn))
9328
        return false;
9329 9330 9331

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
9332
        return false;
9333 9334 9335 9336
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
9337
        return false;
9338 9339 9340
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
9341
        return false;
9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353

    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;
        }
9354 9355
    } else {
        created = true;
9356 9357 9358 9359 9360 9361 9362 9363
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

9364
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379
        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 已提交
9380
    ret = true;
9381 9382

cleanup:
9383
    VIR_FORCE_CLOSE(fd);
9384
    if (!ret && created)
9385 9386 9387 9388 9389 9390 9391 9392 9393
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


9394 9395 9396
/*
 * "vol-delete" command
 */
9397
static const vshCmdInfo info_vol_delete[] = {
9398 9399
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
9400 9401 9402
    {NULL, NULL}
};

9403
static const vshCmdOptDef opts_vol_delete[] = {
9404
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9405
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9406 9407 9408
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9409
static bool
9410
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
9411 9412
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9413
    bool ret = true;
9414
    const char *name;
9415

9416
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9417
        return false;
9418 9419

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9420
        return false;
9421 9422 9423
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
9424
        vshPrint(ctl, _("Vol %s deleted\n"), name);
9425
    } else {
9426
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
9427
        ret = false;
9428 9429
    }

L
Laine Stump 已提交
9430
    virStorageVolFree(vol);
9431 9432 9433 9434
    return ret;
}


D
David Allan 已提交
9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445
/*
 * "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 已提交
9446
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
9447 9448 9449
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9450
static bool
D
David Allan 已提交
9451 9452 9453
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9454
    bool ret = true;
9455
    const char *name;
D
David Allan 已提交
9456

9457
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9458
        return false;
D
David Allan 已提交
9459 9460

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9461
        return false;
D
David Allan 已提交
9462 9463 9464 9465 9466 9467
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
9468
        ret = false;
D
David Allan 已提交
9469 9470 9471 9472 9473 9474 9475
    }

    virStorageVolFree(vol);
    return ret;
}


9476 9477 9478
/*
 * "vol-info" command
 */
9479
static const vshCmdInfo info_vol_info[] = {
9480 9481
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
9482 9483 9484
    {NULL, NULL}
};

9485
static const vshCmdOptDef opts_vol_info[] = {
9486
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9487
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9488 9489 9490
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9491
static bool
9492
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
9493 9494 9495
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
9496
    bool ret = true;
9497

9498
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9499
        return false;
9500 9501

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9502
        return false;
9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518

    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 已提交
9519
        ret = false;
9520 9521 9522 9523 9524 9525 9526 9527 9528 9529
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
9530
static const vshCmdInfo info_vol_dumpxml[] = {
9531 9532
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
9533 9534 9535
    {NULL, NULL}
};

9536
static const vshCmdOptDef opts_vol_dumpxml[] = {
9537
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9538
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9539 9540 9541
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9542
static bool
9543
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
9544 9545
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9546
    bool ret = true;
9547 9548
    char *dump;

9549
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9550
        return false;
9551 9552

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9553
        return false;
9554 9555 9556

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
9557
        vshPrint(ctl, "%s", dump);
9558
        VIR_FREE(dump);
9559
    } else {
E
Eric Blake 已提交
9560
        ret = false;
9561 9562 9563 9564 9565 9566 9567 9568 9569 9570
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
9571
static const vshCmdInfo info_vol_list[] = {
9572 9573
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
9574 9575 9576
    {NULL, NULL}
};

9577
static const vshCmdOptDef opts_vol_list[] = {
9578
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9579
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
9580 9581 9582
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9583
static bool
9584
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9585
{
9586
    virStorageVolInfo volumeInfo;
9587 9588
    virStoragePoolPtr pool;
    char **activeNames = NULL;
9589 9590 9591 9592 9593
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
9594 9595
    int ret;
    bool functionReturn;
9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606
    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;
9607

9608
    /* Check the connection to libvirtd daemon is still working */
9609
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9610
        return false;
9611

9612
    /* Look up the pool information given to us by the user */
9613
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
9614
        return false;
9615

9616 9617
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
9618

9619 9620 9621
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9622
        return false;
9623 9624
    }

9625 9626 9627 9628 9629
    /* 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) {
9630
            vshError(ctl, "%s", _("Failed to list active vols"));
9631
            VIR_FREE(activeNames);
9632
            virStoragePoolFree(pool);
E
Eric Blake 已提交
9633
            return false;
9634 9635
        }

9636 9637 9638 9639 9640
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

        /* Set aside memory for volume information pointers */
        volInfoTexts = vshCalloc(ctl, numVolumes, sizeof(*volInfoTexts));
9641 9642
    }

9643 9644 9645 9646 9647
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
9648

9649 9650 9651 9652
        /* 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"));
9653 9654
        }

9655 9656 9657 9658 9659 9660 9661 9662 9663
        /* 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 */
9664

9665
                /* Volume type */
9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678
                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"));
                }
9679 9680 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

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

9730
        /* Cleanup memory allocation */
9731
        virStorageVolFree(vol);
9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749
    }

    /* 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 已提交
9750
        functionReturn = true;
9751 9752 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
        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 */
9782 9783 9784 9785 9786 9787 9788 9789 9790 9791
    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);
9792 9793 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

    /* 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 已提交
9826
    functionReturn = true;
9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840
    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 已提交
9841
    functionReturn = false;
9842 9843 9844 9845 9846 9847 9848 9849 9850 9851

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);
9852
        VIR_FREE(activeNames[i]);
9853
    }
9854 9855 9856 9857

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
9858
    VIR_FREE(activeNames);
9859
    virStoragePoolFree(pool);
9860 9861 9862

    /* Return the desired value */
    return functionReturn;
9863 9864 9865 9866 9867 9868
}


/*
 * "vol-name" command
 */
9869
static const vshCmdInfo info_vol_name[] = {
9870
    {"help", N_("returns the volume name for a given volume key or path")},
9871
    {"desc", ""},
9872 9873 9874
    {NULL, NULL}
};

9875
static const vshCmdOptDef opts_vol_name[] = {
9876
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
9877 9878 9879
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9880
static bool
9881
cmdVolName(vshControl *ctl, const vshCmd *cmd)
9882 9883 9884
{
    virStorageVolPtr vol;

9885
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9886
        return false;
9887

9888
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
9889
                                   VSH_BYUUID)))
E
Eric Blake 已提交
9890
        return false;
9891 9892 9893

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9894
    return true;
9895 9896 9897
}


J
Justin Clift 已提交
9898 9899 9900 9901 9902 9903 9904 9905 9906 9907
/*
 * "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[] = {
9908
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
9909 9910 9911 9912
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9913
static bool
J
Justin Clift 已提交
9914 9915 9916 9917
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9918
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
9919 9920

    /* Check the connection to libvirtd daemon is still working */
9921
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9922
        return false;
J
Justin Clift 已提交
9923 9924

    /* Use the supplied string to locate the volume */
9925
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
9926
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
9927
        return false;
J
Justin Clift 已提交
9928 9929 9930 9931 9932 9933 9934
    }

    /* 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 已提交
9935
        return false;
J
Justin Clift 已提交
9936 9937
    }

9938 9939 9940 9941 9942 9943 9944 9945 9946
    /* 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 已提交
9947 9948 9949 9950

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9951
    return true;
J
Justin Clift 已提交
9952 9953
}

9954 9955 9956 9957

/*
 * "vol-key" command
 */
9958
static const vshCmdInfo info_vol_key[] = {
9959
    {"help", N_("returns the volume key for a given volume name or path")},
9960
    {"desc", ""},
9961 9962 9963
    {NULL, NULL}
};

9964
static const vshCmdOptDef opts_vol_key[] = {
9965
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
9966
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9967 9968 9969
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9970
static bool
9971
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
9972 9973 9974
{
    virStorageVolPtr vol;

9975
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9976
        return false;
9977

9978
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9979
        return false;
9980 9981 9982

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9983
    return true;
9984 9985 9986 9987 9988 9989 9990
}



/*
 * "vol-path" command
 */
9991
static const vshCmdInfo info_vol_path[] = {
9992
    {"help", N_("returns the volume path for a given volume name or key")},
9993
    {"desc", ""},
9994 9995 9996
    {NULL, NULL}
};

9997
static const vshCmdOptDef opts_vol_path[] = {
9998
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
9999
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10000 10001 10002
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10003
static bool
10004
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
10005 10006
{
    virStorageVolPtr vol;
10007
    const char *name = NULL;
10008
    char * StorageVolPath;
10009

10010
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10011
        return false;
10012 10013

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
10014
        return false;
10015
    }
10016

10017 10018 10019 10020 10021 10022 10023
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
10024
    virStorageVolFree(vol);
E
Eric Blake 已提交
10025
    return true;
10026 10027 10028
}


10029 10030 10031 10032
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
10033 10034
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
10035 10036
    {NULL, NULL}
};
10037

10038
static const vshCmdOptDef opts_secret_define[] = {
10039
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
10040 10041
    {NULL, 0, 0, NULL}
};
10042

E
Eric Blake 已提交
10043
static bool
10044 10045
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
10046
    const char *from = NULL;
10047
    char *buffer;
10048
    virSecretPtr res;
10049
    char uuid[VIR_UUID_STRING_BUFLEN];
10050

10051
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10052
        return false;
10053

10054
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10055
        return false;
10056 10057

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
10061
    VIR_FREE(buffer);
10062 10063

    if (res == NULL) {
10064
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
10065
        return false;
10066
    }
10067
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
10068
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
10069
        virSecretFree(res);
E
Eric Blake 已提交
10070
        return false;
10071 10072 10073
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
10074
    return true;
10075 10076 10077 10078 10079 10080
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
10081 10082
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
10083 10084 10085 10086
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
10087
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10088 10089 10090
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10091
static bool
10092 10093 10094
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
10095
    bool ret = false;
10096 10097
    char *xml;

10098
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10099
        return false;
10100 10101 10102

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
10103
        return false;
10104 10105 10106 10107

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
10108
    vshPrint(ctl, "%s", xml);
10109
    VIR_FREE(xml);
E
Eric Blake 已提交
10110
    ret = true;
10111 10112 10113 10114 10115 10116 10117 10118 10119 10120

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
10121 10122
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
10123 10124 10125 10126
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
10127 10128
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
10129 10130 10131
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10132
static bool
10133 10134 10135 10136
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
10137
    const char *base64 = NULL;
10138
    char *value;
E
Eric Blake 已提交
10139 10140
    int res;
    bool ret = false;
10141

10142
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10143
        return false;
10144 10145 10146

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
10147
        return false;
10148

10149
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
10150 10151 10152
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
10153
        vshError(ctl, "%s", _("Invalid base64 data"));
10154 10155 10156
        goto cleanup;
    }
    if (value == NULL) {
10157
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
10158
        return false;
10159 10160 10161 10162
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
10163
    VIR_FREE(value);
10164 10165

    if (res != 0) {
10166
        vshError(ctl, "%s", _("Failed to set secret value"));
10167 10168 10169
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
10170
    ret = true;
10171 10172 10173 10174 10175 10176 10177 10178 10179 10180

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
10181 10182
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
10183 10184 10185 10186
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
10187
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10188 10189 10190
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10191
static bool
10192 10193 10194 10195 10196 10197
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
10198
    bool ret = false;
10199

10200
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10201
        return false;
10202 10203 10204

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
10205
        return false;
10206 10207 10208 10209 10210 10211 10212

    value = virSecretGetValue(secret, &value_size, 0);
    if (value == NULL)
        goto cleanup;

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
10213
    VIR_FREE(value);
10214 10215

    if (base64 == NULL) {
10216
        vshError(ctl, "%s", _("Failed to allocate memory"));
10217 10218
        goto cleanup;
    }
10219
    vshPrint(ctl, "%s", base64);
10220
    memset(base64, 0, strlen(base64));
10221
    VIR_FREE(base64);
E
Eric Blake 已提交
10222
    ret = true;
10223 10224 10225 10226 10227 10228 10229 10230 10231 10232

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
10233 10234
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
10235 10236 10237 10238
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
10239
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10240 10241 10242
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10243
static bool
10244 10245 10246
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
10247
    bool ret = false;
10248
    const char *uuid;
10249

10250
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10251
        return false;
10252 10253 10254

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
10255
        return false;
10256 10257

    if (virSecretUndefine(secret) < 0) {
10258
        vshError(ctl, _("Failed to delete secret %s"), uuid);
10259 10260 10261
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
10262
    ret = true;
10263 10264 10265 10266 10267 10268 10269 10270 10271 10272

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
10273 10274
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
10275 10276 10277
    {NULL, NULL}
};

E
Eric Blake 已提交
10278
static bool
10279 10280 10281 10282 10283
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

10284
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10285
        return false;
10286 10287 10288

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
10289
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
10290
        return false;
10291 10292 10293 10294 10295
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
10296
        vshError(ctl, "%s", _("Failed to list secrets"));
10297
        VIR_FREE(uuids);
E
Eric Blake 已提交
10298
        return false;
10299 10300 10301 10302
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

10303 10304
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
10305 10306

    for (i = 0; i < maxuuids; i++) {
10307 10308 10309 10310
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
10311
            VIR_FREE(uuids[i]);
10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329
            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);
10330
        VIR_FREE(uuids[i]);
10331
    }
10332
    VIR_FREE(uuids);
E
Eric Blake 已提交
10333
    return true;
10334
}
10335 10336 10337 10338 10339


/*
 * "version" command
 */
10340
static const vshCmdInfo info_version[] = {
10341 10342
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
10343 10344 10345
    {NULL, NULL}
};

10346 10347 10348 10349
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
10350

E
Eric Blake 已提交
10351
static bool
10352
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10353 10354 10355 10356 10357 10358
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
10359
    unsigned long daemonVersion;
10360 10361 10362 10363 10364
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

10365
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10366
        return false;
10367 10368 10369

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
10370
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
10371
        return false;
10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383
    }

    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) {
10384
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
10385
        return false;
10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402
    }
    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) {
10403
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
10404
        return false;
10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417
    }
    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);
    }
10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432

    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 已提交
10433
    return true;
10434 10435
}

10436 10437 10438 10439
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
10440
    {"help", N_("enumerate devices on this host")},
10441
    {"desc", ""},
10442 10443 10444 10445
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
10446 10447
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
10448 10449 10450
    {NULL, 0, 0, NULL}
};

10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472
#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] = '-';
10473 10474
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
10475 10476 10477
    }

    /* Print this device */
10478
    vshPrint(ctl, "%s", indentBuf);
10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501
    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) {
10502
        vshPrint(ctl, "%s", indentBuf);
10503
        vshPrint(ctl, " |\n");
10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525
    }

    /* 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) {
10526
        vshPrint(ctl, "%s", indentBuf);
10527 10528 10529 10530
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
10531
static bool
10532 10533
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
10534
    const char *cap = NULL;
10535
    char **devices;
10536
    int num_devices, i;
10537
    int tree = vshCommandOptBool(cmd, "tree");
10538

10539
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10540
        return false;
10541

10542
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
10543 10544 10545 10546
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
10547
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
10548
        return false;
10549
    } else if (num_devices == 0) {
E
Eric Blake 已提交
10550
        return true;
10551 10552 10553 10554 10555 10556
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
10557
        vshError(ctl, "%s", _("Failed to list node devices"));
10558
        VIR_FREE(devices);
E
Eric Blake 已提交
10559
        return false;
10560
    }
10561
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
10562 10563 10564 10565 10566 10567 10568
    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 已提交
10569
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588
            } 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++) {
10589 10590
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
10591
        }
10592
        VIR_FREE(parents);
10593 10594 10595
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
10596
            VIR_FREE(devices[i]);
10597
        }
10598
    }
10599
    VIR_FREE(devices);
E
Eric Blake 已提交
10600
    return true;
10601 10602 10603 10604 10605 10606
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
10607 10608
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
10609 10610 10611 10612 10613
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
10614
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10615 10616 10617
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10618
static bool
10619 10620
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
10621
    const char *name = NULL;
10622
    virNodeDevicePtr device;
L
Laine Stump 已提交
10623
    char *xml;
10624

10625
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10626
        return false;
10627
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10628
        return false;
10629
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10630
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10631
        return false;
10632 10633
    }

L
Laine Stump 已提交
10634 10635 10636
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
10637
        return false;
L
Laine Stump 已提交
10638 10639 10640
    }

    vshPrint(ctl, "%s\n", xml);
10641
    VIR_FREE(xml);
10642
    virNodeDeviceFree(device);
E
Eric Blake 已提交
10643
    return true;
10644 10645
}

10646 10647 10648 10649
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
10650 10651
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
10652 10653 10654 10655 10656
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
10657
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10658 10659 10660
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10661
static bool
10662 10663
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
10664
    const char *name = NULL;
10665
    virNodeDevicePtr device;
E
Eric Blake 已提交
10666
    bool ret = true;
10667

10668
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10669
        return false;
10670
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10671
        return false;
10672
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10673
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10674
        return false;
10675 10676 10677 10678 10679
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
10680
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
10681
        ret = false;
10682 10683 10684 10685 10686 10687 10688 10689 10690
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
10691 10692
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
10693 10694 10695 10696 10697
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
10698
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10699 10700 10701
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10702
static bool
10703 10704
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
10705
    const char *name = NULL;
10706
    virNodeDevicePtr device;
E
Eric Blake 已提交
10707
    bool ret = true;
10708

10709
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10710
        return false;
10711
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10712
        return false;
10713
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10714
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10715
        return false;
10716 10717 10718 10719 10720
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
10721
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
10722
        ret = false;
10723 10724 10725 10726 10727 10728 10729 10730 10731
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
10732 10733
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
10734 10735 10736 10737 10738
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
10739
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10740 10741 10742
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10743
static bool
10744 10745
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
10746
    const char *name = NULL;
10747
    virNodeDevicePtr device;
E
Eric Blake 已提交
10748
    bool ret = true;
10749

10750
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10751
        return false;
10752
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10753
        return false;
10754
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10755
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10756
        return false;
10757 10758 10759 10760 10761
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
10762
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
10763
        ret = false;
10764 10765 10766 10767 10768
    }
    virNodeDeviceFree(device);
    return ret;
}

10769
/*
E
Eric Blake 已提交
10770
 * "hostname" command
10771
 */
10772
static const vshCmdInfo info_hostname[] = {
10773
    {"help", N_("print the hypervisor hostname")},
10774
    {"desc", ""},
10775 10776 10777
    {NULL, NULL}
};

E
Eric Blake 已提交
10778
static bool
10779
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10780 10781 10782
{
    char *hostname;

10783
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10784
        return false;
10785 10786 10787

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
10788
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
10789
        return false;
10790 10791 10792
    }

    vshPrint (ctl, "%s\n", hostname);
10793
    VIR_FREE(hostname);
10794

E
Eric Blake 已提交
10795
    return true;
10796 10797 10798 10799 10800
}

/*
 * "uri" command
 */
10801
static const vshCmdInfo info_uri[] = {
10802
    {"help", N_("print the hypervisor canonical URI")},
10803
    {"desc", ""},
10804 10805 10806
    {NULL, NULL}
};

E
Eric Blake 已提交
10807
static bool
10808
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10809 10810 10811
{
    char *uri;

10812
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10813
        return false;
10814 10815 10816

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
10817
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
10818
        return false;
10819 10820 10821
    }

    vshPrint (ctl, "%s\n", uri);
10822
    VIR_FREE(uri);
10823

E
Eric Blake 已提交
10824
    return true;
10825 10826
}

E
Eric Blake 已提交
10827 10828 10829 10830 10831 10832 10833 10834 10835 10836
/*
 * "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 已提交
10837
static bool
E
Eric Blake 已提交
10838 10839 10840 10841 10842
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10843
        return false;
E
Eric Blake 已提交
10844 10845 10846 10847

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
10848
        return false;
E
Eric Blake 已提交
10849 10850 10851 10852 10853
    }

    vshPrint (ctl, "%s", sysinfo);
    VIR_FREE(sysinfo);

E
Eric Blake 已提交
10854
    return true;
E
Eric Blake 已提交
10855 10856
}

10857 10858 10859
/*
 * "vncdisplay" command
 */
10860
static const vshCmdInfo info_vncdisplay[] = {
10861 10862
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
10863 10864 10865
    {NULL, NULL}
};

10866
static const vshCmdOptDef opts_vncdisplay[] = {
10867
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10868 10869 10870
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10871
static bool
10872
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
10873 10874 10875 10876 10877
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10878
    bool ret = false;
10879 10880 10881
    int port = 0;
    char *doc;

10882
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10883
        return false;
10884

J
Jim Meyering 已提交
10885
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10886
        return false;
10887 10888 10889 10890 10891

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10892
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
10893
    VIR_FREE(doc);
10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908
    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) ||
10909
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
10910 10911 10912 10913 10914 10915
        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 已提交
10916
    ret = true;
10917 10918 10919 10920

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10921
    xmlFreeDoc(xml);
10922 10923 10924 10925 10926 10927 10928
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
10929
static const vshCmdInfo info_ttyconsole[] = {
10930 10931
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
10932 10933 10934
    {NULL, NULL}
};

10935
static const vshCmdOptDef opts_ttyconsole[] = {
10936
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10937 10938 10939
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10940
static bool
10941
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
10942 10943 10944 10945 10946
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10947
    bool ret = false;
10948 10949
    char *doc;

10950
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10951
        return false;
10952

J
Jim Meyering 已提交
10953
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10954
        return false;
10955 10956 10957 10958 10959

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10960
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
10961
    VIR_FREE(doc);
10962 10963 10964 10965 10966 10967 10968 10969 10970
    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 已提交
10971
    ret = true;
10972 10973 10974 10975

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10976
    xmlFreeDoc(xml);
10977 10978 10979 10980 10981 10982
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
10983
 */
10984
static const vshCmdInfo info_attach_device[] = {
10985 10986
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
10987 10988 10989
    {NULL, NULL}
};

10990
static const vshCmdOptDef opts_attach_device[] = {
10991 10992 10993
    {"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")},
10994 10995 10996
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10997
static bool
10998
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
10999 11000
{
    virDomainPtr dom;
11001
    const char *from = NULL;
11002
    char *buffer;
W
Wen Congyang 已提交
11003
    int ret;
J
Jim Fehlig 已提交
11004
    unsigned int flags;
11005

11006
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11007
        return false;
11008

J
Jim Meyering 已提交
11009
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
11010
        return false;
11011

11012
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11013
        virDomainFree(dom);
E
Eric Blake 已提交
11014
        return false;
11015 11016
    }

11017
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11018
        virshReportError(ctl);
11019
        virDomainFree(dom);
E
Eric Blake 已提交
11020
        return false;
11021
    }
11022

J
Jim Fehlig 已提交
11023
    if (vshCommandOptBool(cmd, "persistent")) {
11024
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11025
        if (virDomainIsActive(dom) == 1)
11026
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11027 11028 11029 11030
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
11031
    VIR_FREE(buffer);
11032 11033

    if (ret < 0) {
11034
        vshError(ctl, _("Failed to attach device from %s"), from);
11035
        virDomainFree(dom);
E
Eric Blake 已提交
11036
        return false;
11037
    } else {
J
Jim Meyering 已提交
11038
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
11039 11040 11041
    }

    virDomainFree(dom);
E
Eric Blake 已提交
11042
    return true;
11043 11044 11045 11046 11047 11048
}


/*
 * "detach-device" command
 */
11049
static const vshCmdInfo info_detach_device[] = {
11050 11051
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
11052 11053 11054
    {NULL, NULL}
};

11055
static const vshCmdOptDef opts_detach_device[] = {
11056 11057 11058
    {"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")},
11059 11060 11061
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11062
static bool
11063
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
11064 11065
{
    virDomainPtr dom;
11066
    const char *from = NULL;
11067
    char *buffer;
W
Wen Congyang 已提交
11068
    int ret;
J
Jim Fehlig 已提交
11069
    unsigned int flags;
11070

11071
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11072
        return false;
11073

J
Jim Meyering 已提交
11074
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
11075
        return false;
11076

11077
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11078
        virDomainFree(dom);
E
Eric Blake 已提交
11079
        return false;
11080 11081
    }

11082
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11083
        virshReportError(ctl);
11084
        virDomainFree(dom);
E
Eric Blake 已提交
11085
        return false;
11086
    }
11087

J
Jim Fehlig 已提交
11088
    if (vshCommandOptBool(cmd, "persistent")) {
11089
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11090
        if (virDomainIsActive(dom) == 1)
11091
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11092 11093 11094 11095
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
11096
    VIR_FREE(buffer);
11097 11098

    if (ret < 0) {
11099
        vshError(ctl, _("Failed to detach device from %s"), from);
11100
        virDomainFree(dom);
E
Eric Blake 已提交
11101
        return false;
11102
    } else {
J
Jim Meyering 已提交
11103
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
11104 11105 11106
    }

    virDomainFree(dom);
E
Eric Blake 已提交
11107
    return true;
11108 11109
}

11110

11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123
/*
 * "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")},
11124
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
11125 11126 11127
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11128
static bool
11129 11130 11131
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
11132
    const char *from = NULL;
11133
    char *buffer;
W
Wen Congyang 已提交
11134
    int ret;
11135 11136
    unsigned int flags;

11137
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11138
        return false;
11139 11140

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

11143
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11144
        virDomainFree(dom);
E
Eric Blake 已提交
11145
        return false;
11146 11147 11148
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11149
        virshReportError(ctl);
11150
        virDomainFree(dom);
E
Eric Blake 已提交
11151
        return false;
11152 11153 11154
    }

    if (vshCommandOptBool(cmd, "persistent")) {
11155
        flags = VIR_DOMAIN_AFFECT_CONFIG;
11156
        if (virDomainIsActive(dom) == 1)
11157
           flags |= VIR_DOMAIN_AFFECT_LIVE;
11158
    } else {
11159
        flags = VIR_DOMAIN_AFFECT_LIVE;
11160
    }
11161 11162 11163 11164

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

11165 11166 11167 11168 11169 11170
    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 已提交
11171
        return false;
11172 11173 11174 11175 11176
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
11177
    return true;
11178 11179 11180
}


11181 11182 11183
/*
 * "attach-interface" command
 */
11184
static const vshCmdInfo info_attach_interface[] = {
11185 11186
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
11187 11188 11189
    {NULL, NULL}
};

11190
static const vshCmdOptDef opts_attach_interface[] = {
11191 11192 11193 11194 11195 11196
    {"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")},
11197
    {"model", VSH_OT_DATA, 0, N_("model type")},
11198
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
11199 11200 11201
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11202
static bool
11203
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
11204 11205
{
    virDomainPtr dom = NULL;
11206 11207
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
11208
    int typ;
W
Wen Congyang 已提交
11209 11210
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11211
    unsigned int flags;
11212 11213
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
11214

11215
    if (!vshConnectionUsability(ctl, ctl->conn))
11216 11217
        goto cleanup;

J
Jim Meyering 已提交
11218
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11219 11220
        goto cleanup;

11221
    if (vshCommandOptString(cmd, "type", &type) <= 0)
11222 11223
        goto cleanup;

11224 11225 11226 11227
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
11228 11229
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
11230
        goto cleanup;
11231
    }
11232 11233

    /* check interface type */
11234
    if (STREQ(type, "network")) {
11235
        typ = 1;
11236
    } else if (STREQ(type, "bridge")) {
11237 11238
        typ = 2;
    } else {
E
Eric Blake 已提交
11239 11240
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
11241 11242 11243 11244
        goto cleanup;
    }

    /* Make XML of interface */
11245
    virBufferAsprintf(&buf, "<interface type='%s'>\n", type);
11246

11247
    if (typ == 1)
11248
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
11249
    else if (typ == 2)
11250
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
11251

11252
    if (target != NULL)
11253
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11254
    if (mac != NULL)
11255
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
11256
    if (script != NULL)
11257
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
11258
    if (model != NULL)
11259
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
11260

11261
    virBufferAddLit(&buf, "</interface>\n");
11262

11263 11264
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
11265
        goto cleanup;
11266 11267
    }

11268
    xml = virBufferContentAndReset(&buf);
11269

J
Jim Fehlig 已提交
11270
    if (vshCommandOptBool(cmd, "persistent")) {
11271
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11272
        if (virDomainIsActive(dom) == 1)
11273
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11274
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
11275
    } else {
11276
        ret = virDomainAttachDevice(dom, xml);
11277
    }
11278

11279 11280
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11281
    if (ret != 0) {
L
Laine Stump 已提交
11282
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
11283 11284
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
11285
        functionReturn = true;
J
Jim Fehlig 已提交
11286
    }
11287 11288 11289 11290

 cleanup:
    if (dom)
        virDomainFree(dom);
11291
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11292
    return functionReturn;
11293 11294 11295 11296 11297
}

/*
 * "detach-interface" command
 */
11298
static const vshCmdInfo info_detach_interface[] = {
11299 11300
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
11301 11302 11303
    {NULL, NULL}
};

11304
static const vshCmdOptDef opts_detach_interface[] = {
11305 11306 11307 11308
    {"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")},
11309 11310 11311
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11312
static bool
11313
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
11314 11315 11316 11317 11318 11319 11320
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
11321
    const char *mac =NULL, *type = NULL;
11322
    char *doc;
11323
    char buf[64];
E
Eric Blake 已提交
11324
    int i = 0, diff_mac;
W
Wen Congyang 已提交
11325 11326
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
11327
    unsigned int flags;
11328

11329
    if (!vshConnectionUsability(ctl, ctl->conn))
11330 11331
        goto cleanup;

J
Jim Meyering 已提交
11332
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11333 11334
        goto cleanup;

11335
    if (vshCommandOptString(cmd, "type", &type) <= 0)
11336 11337
        goto cleanup;

11338 11339
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
11340
        goto cleanup;
11341
    }
11342 11343 11344 11345 11346

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11347
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
11348
    VIR_FREE(doc);
11349
    if (!xml) {
11350
        vshError(ctl, "%s", _("Failed to get interface information"));
11351 11352 11353
        goto cleanup;
    }

E
Eric Blake 已提交
11354
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
11355 11356 11357
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11358
        vshError(ctl, _("No found interface whose type is %s"), type);
11359 11360 11361
        goto cleanup;
    }

11362 11363 11364 11365 11366 11367
    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;
    }

11368 11369 11370 11371 11372 11373 11374
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11375 11376 11377 11378 11379
            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);
11380 11381 11382 11383 11384 11385 11386
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11387
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
11388 11389 11390 11391 11392
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11393
        vshError(ctl, "%s", _("Failed to allocate memory"));
11394 11395 11396
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
11402
    if (vshCommandOptBool(cmd, "persistent")) {
11403
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11404
        if (virDomainIsActive(dom) == 1)
11405
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11406 11407 11408 11409 11410 11411 11412 11413
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11414
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
11415
    } else {
J
Jim Meyering 已提交
11416
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
11417
        functionReturn = true;
11418
    }
11419 11420 11421 11422

 cleanup:
    if (dom)
        virDomainFree(dom);
11423
    xmlXPathFreeObject(obj);
11424
    xmlXPathFreeContext(ctxt);
11425 11426
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
11427
    return functionReturn;
11428 11429 11430 11431 11432
}

/*
 * "attach-disk" command
 */
11433
static const vshCmdInfo info_attach_disk[] = {
11434 11435
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
11436 11437 11438
    {NULL, NULL}
};

11439
static const vshCmdOptDef opts_attach_disk[] = {
11440 11441 11442 11443 11444
    {"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")},
11445
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
11446 11447 11448
    {"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")},
11449
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
11450 11451 11452
    {"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")},
11453 11454 11455
    {NULL, 0, 0, NULL}
};

11456 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
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 已提交
11603
static bool
11604
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
11605 11606
{
    virDomainPtr dom = NULL;
11607
    const char *source = NULL, *target = NULL, *driver = NULL,
11608 11609 11610
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
11611 11612
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
11613
    unsigned int flags;
11614
    const char *stype = NULL;
11615 11616
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
11617

11618
    if (!vshConnectionUsability(ctl, ctl->conn))
11619 11620
        goto cleanup;

J
Jim Meyering 已提交
11621
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11622 11623
        goto cleanup;

11624
    if (vshCommandOptString(cmd, "source", &source) <= 0)
11625 11626
        goto cleanup;

11627
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11628 11629
        goto cleanup;

11630 11631 11632 11633
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
11634 11635 11636
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
11637
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
11638
        vshError(ctl, "%s", _("missing option"));
11639 11640
        goto cleanup;
    }
11641

11642 11643
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
11644
            isFile = true;
11645
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
11646
        isFile = true;
11647 11648 11649
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
11650 11651 11652
    }

    if (mode) {
11653
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
11654 11655
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
11656 11657 11658 11659 11660
            goto cleanup;
        }
    }

    /* Make XML of disk */
11661
    virBufferAsprintf(&buf, "<disk type='%s'",
11662 11663
                      (isFile) ? "file" : "block");
    if (type)
11664
        virBufferAsprintf(&buf, " device='%s'", type);
11665 11666
    virBufferAddLit(&buf, ">\n");

11667
    if (driver || subdriver)
11668
        virBufferAsprintf(&buf, "  <driver");
11669 11670

    if (driver)
11671
        virBufferAsprintf(&buf, " name='%s'", driver);
11672
    if (subdriver)
11673
        virBufferAsprintf(&buf, " type='%s'", subdriver);
11674 11675
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
11676

11677
    if (driver || subdriver || cache)
11678
        virBufferAddLit(&buf, "/>\n");
11679

11680
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
11681 11682
                      (isFile) ? "file" : "dev",
                      source);
11683
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11684
    if (mode)
11685
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
11686

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

11735
    virBufferAddLit(&buf, "</disk>\n");
11736

11737 11738
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
11739
        return false;
11740 11741
    }

11742
    xml = virBufferContentAndReset(&buf);
11743

J
Jim Fehlig 已提交
11744
    if (vshCommandOptBool(cmd, "persistent")) {
11745
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11746
        if (virDomainIsActive(dom) == 1)
11747
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11748
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
11749
    } else {
11750
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
11751
    }
11752

11753 11754
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11755
    if (ret != 0) {
L
Laine Stump 已提交
11756
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
11757 11758
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
11759
        functionReturn = true;
J
Jim Fehlig 已提交
11760
    }
11761 11762 11763 11764

 cleanup:
    if (dom)
        virDomainFree(dom);
11765
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11766
    return functionReturn;
11767 11768 11769 11770 11771
}

/*
 * "detach-disk" command
 */
11772
static const vshCmdInfo info_detach_disk[] = {
11773 11774
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
11775 11776 11777
    {NULL, NULL}
};

11778
static const vshCmdOptDef opts_detach_disk[] = {
11779 11780 11781
    {"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")},
11782 11783 11784
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11785
static bool
11786
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
11787 11788 11789 11790 11791 11792 11793
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
11794
    const char *target = NULL;
11795
    char *doc;
E
Eric Blake 已提交
11796
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
11797 11798
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11799
    unsigned int flags;
11800

11801
    if (!vshConnectionUsability(ctl, ctl->conn))
11802 11803
        goto cleanup;

J
Jim Meyering 已提交
11804
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11805 11806
        goto cleanup;

11807
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11808 11809 11810 11811 11812 11813
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11814
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
11815
    VIR_FREE(doc);
11816
    if (!xml) {
11817
        vshError(ctl, "%s", _("Failed to get disk information"));
11818 11819 11820 11821 11822 11823
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11824
        vshError(ctl, "%s", _("Failed to get disk information"));
11825 11826 11827 11828 11829 11830 11831
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11832 11833 11834 11835 11836
            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);
11837 11838 11839 11840 11841 11842 11843
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11844
    vshError(ctl, _("No found disk whose target is %s"), target);
11845 11846 11847 11848 11849
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11850
        vshError(ctl, "%s", _("Failed to allocate memory"));
11851 11852 11853
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
11859
    if (vshCommandOptBool(cmd, "persistent")) {
11860
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11861
        if (virDomainIsActive(dom) == 1)
11862
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11863 11864 11865 11866 11867 11868 11869 11870
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11871
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
11872
    } else {
J
Jim Meyering 已提交
11873
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
11874
        functionReturn = true;
11875
    }
11876 11877

 cleanup:
11878
    xmlXPathFreeObject(obj);
11879
    xmlXPathFreeContext(ctxt);
11880 11881
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
11882 11883
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
11884
    return functionReturn;
11885 11886
}

11887 11888 11889 11890
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
11891 11892
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
11893 11894 11895 11896
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
11897
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
11898 11899 11900
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11901
static bool
11902 11903
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
11904
    const char *from = NULL;
E
Eric Blake 已提交
11905
    bool ret = true;
11906 11907 11908
    char *buffer;
    int result;

11909
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11910
        return false;
11911

11912
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11913
        return false;
11914 11915

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
11919
    VIR_FREE(buffer);
11920 11921 11922 11923 11924

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
11925
        ret = false;
11926 11927 11928 11929 11930
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
11931
        ret = true;
11932 11933 11934 11935 11936
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
11937
        ret = true;
11938 11939 11940 11941 11942
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
11943
        ret = false;
11944 11945 11946 11947 11948
    }

    return ret;
}

11949 11950 11951 11952
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
11953 11954
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
11955 11956 11957 11958
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
11959
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
11960 11961 11962
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11963
static bool
11964 11965
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
11966
    const char *from = NULL;
E
Eric Blake 已提交
11967
    bool ret = true;
11968 11969 11970 11971 11972
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
11973
    xmlNodePtr node_list;
11974 11975 11976 11977 11978 11979
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

11980
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11981
        return false;
11982

11983
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11984
        return false;
11985 11986

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
11987
        return false;
11988 11989 11990 11991 11992

    doc = xmlNewDoc(NULL);
    if (doc == NULL)
        goto no_memory;

L
Laine Stump 已提交
11993 11994
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
11995 11996
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
11997
        ret = false;
11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033
        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 已提交
12034
        ret = false;
12035 12036 12037 12038 12039 12040 12041 12042
        goto cleanup;
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
12043
        ret = false;
12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060

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 已提交
12061
    ret = false;
12062
    goto cleanup;
12063 12064
}

12065 12066 12067 12068 12069 12070 12071 12072
/* 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;

12073
    ret = vshMalloc(ctl, PATH_MAX);
12074 12075 12076

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
12077 12078
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
12079
    if (fd == -1) {
12080
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
12081
                 strerror(errno));
12082
        VIR_FREE(ret);
12083 12084 12085 12086
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
12087 12088
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
12089
        VIR_FORCE_CLOSE(fd);
12090
        unlink (ret);
12091
        VIR_FREE(ret);
12092 12093
        return NULL;
    }
S
Stefan Berger 已提交
12094
    if (VIR_CLOSE(fd) < 0) {
12095 12096
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
12097
        unlink (ret);
12098
        VIR_FREE(ret);
12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113
        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 已提交
12114 12115 12116 12117
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
12118

12119
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
12120 12121 12122 12123
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
12124

12125 12126 12127 12128 12129
    /* 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 已提交
12130 12131
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
12132
     */
E
Eric Blake 已提交
12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144
    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);
12145 12146
    }

E
Eric Blake 已提交
12147 12148 12149 12150 12151 12152 12153
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
12154
    }
E
Eric Blake 已提交
12155
    ret = 0;
12156

E
Eric Blake 已提交
12157 12158 12159
cleanup:
    virCommandFree(cmd);
    return ret;
12160 12161 12162 12163 12164 12165 12166 12167
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
12168
        vshError(ctl,
12169
                 _("%s: failed to read temporary file: %s"),
12170
                 filename, strerror(errno));
12171 12172 12173 12174 12175
        return NULL;
    }
    return ret;
}

12176

P
Paolo Bonzini 已提交
12177 12178 12179 12180
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
12181 12182
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
12183 12184 12185 12186
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
12187
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
12188 12189 12190
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12191
static bool
12192
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
12193
{
12194
    const char *dir = NULL;
12195
    char *dir_malloced = NULL;
E
Eric Blake 已提交
12196
    bool ret = true;
P
Paolo Bonzini 已提交
12197 12198

    if (!ctl->imode) {
12199
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
12200
        return false;
P
Paolo Bonzini 已提交
12201 12202
    }

12203
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
12204
        uid_t uid = geteuid();
12205
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
12206 12207 12208 12209
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
12210
    if (chdir(dir) == -1) {
12211
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
12212
        ret = false;
P
Paolo Bonzini 已提交
12213 12214
    }

12215
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
12216
    return ret;
P
Paolo Bonzini 已提交
12217 12218 12219 12220 12221 12222
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
12223 12224
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
12225 12226 12227
    {NULL, NULL}
};

E
Eric Blake 已提交
12228
static bool
P
Paolo Bonzini 已提交
12229 12230 12231
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
12232
    bool ret = true;
P
Paolo Bonzini 已提交
12233

12234 12235
    cwd = getcwd(NULL, 0);
    if (!cwd) {
12236 12237
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
12238 12239
        ret = false;
    } else {
P
Paolo Bonzini 已提交
12240
        vshPrint (ctl, _("%s\n"), cwd);
12241 12242
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
12243

12244
    return ret;
P
Paolo Bonzini 已提交
12245 12246
}

E
Eric Blake 已提交
12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258
/*
 * "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")},
12259
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
12260 12261 12262 12263 12264 12265
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
12266
static bool
E
Eric Blake 已提交
12267 12268 12269 12270 12271
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
12272
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
12273 12274 12275 12276 12277 12278 12279 12280
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

12281
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
12282 12283 12284
        bool close_quote = false;
        char *q;

12285
        arg = opt->data;
E
Eric Blake 已提交
12286 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
        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 已提交
12314
        return false;
E
Eric Blake 已提交
12315 12316 12317 12318 12319
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
12320
    return true;
E
Eric Blake 已提交
12321 12322
}

12323 12324 12325 12326
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
12327 12328
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
12329 12330 12331 12332
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
12333
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12334 12335 12336 12337 12338 12339
    {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 已提交
12340
static bool
12341 12342
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
12343
    bool ret = false;
12344 12345 12346 12347 12348
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
12349
    unsigned int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
12350

12351
    if (!vshConnectionUsability(ctl, ctl->conn))
12352 12353
        goto cleanup;

J
Jim Meyering 已提交
12354
    dom = vshCommandOptDomain (ctl, cmd, NULL);
12355 12356 12357 12358
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
12359
    doc = virDomainGetXMLDesc (dom, flags);
12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377
    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 已提交
12378
        ret = true;
12379 12380 12381 12382 12383 12384 12385
        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.
     */
12386
    doc_reread = virDomainGetXMLDesc (dom, flags);
12387 12388 12389 12390
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
12391 12392
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404
        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 已提交
12405
    ret = true;
12406 12407 12408 12409 12410

 cleanup:
    if (dom)
        virDomainFree (dom);

12411 12412 12413
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
12414 12415 12416

    if (tmp) {
        unlink (tmp);
12417
        VIR_FREE(tmp);
12418 12419 12420 12421 12422
    }

    return ret;
}

12423

12424 12425 12426 12427
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
12428 12429
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
12430 12431 12432 12433
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
12434
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
12435 12436 12437 12438 12439 12440 12441 12442 12443 12444
    {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[] = {
12445 12446
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
12447 12448 12449 12450
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
12451
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
12452 12453 12454 12455 12456 12457
    {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 已提交
12458 12459 12460
/*
 * "quit" command
 */
12461
static const vshCmdInfo info_quit[] = {
12462
    {"help", N_("quit this interactive terminal")},
12463
    {"desc", ""},
12464
    {NULL, NULL}
K
Karel Zak 已提交
12465 12466
};

E
Eric Blake 已提交
12467
static bool
12468
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
12469
{
E
Eric Blake 已提交
12470 12471
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
12472 12473
}

12474 12475 12476 12477 12478 12479 12480
/* 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;
12481
    bool halt = false;
12482 12483 12484
    char *doc = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
E
Eric Blake 已提交
12485
    const char *name = NULL;
12486 12487

    snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511

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

12512 12513 12514
    if (snapshot == NULL)
        goto cleanup;

12515 12516 12517 12518 12519
    if (halt && virDomainDestroy(dom) < 0) {
        virshReportError(ctl);
        goto cleanup;
    }

E
Eric Blake 已提交
12520
    name = virDomainSnapshotGetName(snapshot);
12521
    if (!name) {
E
Eric Blake 已提交
12522
        vshError(ctl, "%s", _("Could not get snapshot name"));
12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541
        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;
}

12542 12543 12544 12545
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
12546 12547
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
12548 12549 12550 12551 12552 12553
    {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")},
12554 12555 12556
    {"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")},
12557
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
12558
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
12559 12560 12561
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12562
static bool
12563 12564 12565
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12566
    bool ret = false;
12567
    const char *from = NULL;
12568
    char *buffer = NULL;
12569 12570 12571 12572 12573 12574 12575 12576
    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;
12577 12578
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
12579 12580
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
12581

12582
    if (!vshConnectionUsability(ctl, ctl->conn))
12583 12584 12585 12586 12587 12588
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

12589
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
12590
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605
    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;
    }

12606
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, from);
12607 12608 12609 12610 12611 12612 12613 12614 12615

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12616 12617 12618
/*
 * "snapshot-create-as" command
 */
12619 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
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;
}

12675 12676 12677 12678 12679 12680 12681 12682 12683 12684
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 已提交
12685
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
12686
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
12687
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
12688 12689 12690
    {"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]")},
12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702
    {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;
12703
    unsigned int flags = 0;
12704
    const vshCmdOpt *opt = NULL;
12705 12706 12707

    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
12708 12709
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
12710 12711
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727

    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)
12728
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
12729
    if (desc)
12730
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
12731 12732 12733 12734 12735 12736 12737 12738 12739 12740
    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");
    }
12741 12742 12743 12744 12745 12746 12747 12748
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
12749 12750 12751 12752 12753 12754
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

12755
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, NULL);
12756 12757 12758 12759 12760 12761 12762 12763 12764

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 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
/*
 * "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;
}

12866 12867 12868 12869
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
12870 12871
    {"help", N_("Get or set the current snapshot")},
    {"desc", N_("Get or set the current snapshot")},
12872 12873 12874 12875 12876
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12877
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
12878 12879
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
12880 12881
    {"snapshotname", VSH_OT_DATA, 0,
     N_("name of existing snapshot to make current")},
12882 12883 12884
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12885
static bool
12886 12887 12888
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12889
    bool ret = false;
12890 12891
    int current;
    virDomainSnapshotPtr snapshot = NULL;
12892
    char *xml = NULL;
12893
    const char *snapshotname = NULL;
12894 12895 12896 12897
    unsigned int flags = 0;

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

12899
    if (!vshConnectionUsability(ctl, ctl->conn))
12900 12901 12902 12903 12904 12905
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

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

12935 12936 12937 12938
    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
E
Eric Blake 已提交
12939
        const char *name = NULL;
12940 12941 12942 12943

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

12944
        if (vshCommandOptBool(cmd, "name")) {
E
Eric Blake 已提交
12945
            name = virDomainSnapshotGetName(snapshot);
12946 12947
            if (!name)
                goto cleanup;
E
Eric Blake 已提交
12948 12949 12950 12951
        } else {
            xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
            if (!xml)
                goto cleanup;
12952 12953 12954
        }

        vshPrint(ctl, "%s", name ? name : xml);
12955 12956
    }

E
Eric Blake 已提交
12957
    ret = true;
12958 12959

cleanup:
12960
    VIR_FREE(xml);
12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979
    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")},
12980
    {"parent", VSH_OT_BOOL, 0, N_("add a column showing parent snapshot")},
12981 12982 12983
    {"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")},
12984 12985 12986
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12987
static bool
12988 12989 12990
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12991
    bool ret = false;
12992
    unsigned int flags = 0;
12993 12994
    int parent_filter = 0; /* -1 for roots filtering, 0 for no parent
                              information needed, 1 for parent column */
12995 12996
    int numsnaps;
    char **names = NULL;
12997
    int actual = 0;
12998 12999 13000 13001 13002 13003
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
13004
    char *parent = NULL;
13005 13006
    long long creation_longlong;
    time_t creation_time_t;
13007 13008 13009
    char timestr[100];
    struct tm time_info;

13010
    if (vshCommandOptBool(cmd, "parent")) {
13011 13012 13013 13014 13015
        if (vshCommandOptBool(cmd, "roots")) {
            vshError(ctl, "%s",
                     _("--parent and --roots are mutually exlusive"));
            return false;
        }
13016
        parent_filter = 1;
13017 13018 13019 13020 13021 13022
    } else if (vshCommandOptBool(cmd, "roots")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
    }

    if (vshCommandOptBool(cmd, "metadata")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_METADATA;
13023 13024
    }

13025
    if (!vshConnectionUsability(ctl, ctl->conn))
13026 13027 13028 13029 13030 13031
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

13032
    numsnaps = virDomainSnapshotNum(dom, flags);
13033

13034 13035 13036 13037 13038 13039 13040 13041 13042 13043
    /* 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);
    }

13044 13045 13046
    if (numsnaps < 0)
        goto cleanup;

13047 13048 13049 13050 13051 13052 13053 13054
    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");
13055 13056 13057 13058 13059

    if (numsnaps) {
        if (VIR_ALLOC_N(names, numsnaps) < 0)
            goto cleanup;

13060
        actual = virDomainSnapshotListNames(dom, names, numsnaps, flags);
13061 13062 13063 13064 13065 13066 13067
        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 */
13068
            VIR_FREE(parent);
13069 13070 13071 13072
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
13073
            xmlFreeDoc(xml);
13074 13075 13076 13077 13078 13079 13080 13081 13082 13083
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

13084
            xml = virXMLParseStringCtxt(doc, _("(domain_snapshot)"), &ctxt);
13085 13086 13087
            if (!xml)
                continue;

13088 13089 13090
            if (parent_filter) {
                parent = virXPathString("string(/domainsnapshot/parent/name)",
                                        ctxt);
13091 13092
                if (!parent && parent_filter < 0)
                    continue;
13093 13094
            }

13095 13096 13097
            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
13098 13099
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
13100
                continue;
13101 13102 13103 13104 13105 13106
            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);
13107 13108
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z",
                     &time_info);
13109

13110 13111 13112 13113 13114
            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);
13115 13116 13117
        }
    }

E
Eric Blake 已提交
13118
    ret = true;
13119 13120 13121

cleanup:
    /* this frees up memory from the last iteration of the loop */
13122
    VIR_FREE(parent);
13123 13124 13125 13126
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    xmlXPathFreeContext(ctxt);
13127
    xmlFreeDoc(xml);
13128
    VIR_FREE(doc);
13129 13130
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149
    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")},
13150 13151
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
13152 13153 13154
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13155
static bool
13156 13157 13158
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13159
    bool ret = false;
13160
    const char *name = NULL;
13161 13162
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
13163 13164 13165 13166
    unsigned int flags = 0;

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

13168
    if (!vshConnectionUsability(ctl, ctl->conn))
13169 13170 13171 13172 13173 13174
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

13175
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13176 13177 13178 13179 13180 13181
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

13182
    xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
13183 13184 13185
    if (!xml)
        goto cleanup;

13186
    vshPrint(ctl, "%s", xml);
13187

E
Eric Blake 已提交
13188
    ret = true;
13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

E
Eric Blake 已提交
13200 13201 13202 13203
/*
 * "snapshot-parent" command
 */
static const vshCmdInfo info_snapshot_parent[] = {
E
Eric Blake 已提交
13204
    {"help", N_("Get the name of the parent of a snapshot")},
E
Eric Blake 已提交
13205 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
    {"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;

13245
    xmldoc = virXMLParseStringCtxt(xml, _("(domain_snapshot)"), &ctxt);
E
Eric Blake 已提交
13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259
    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);
13260
    xmlFreeDoc(xmldoc);
E
Eric Blake 已提交
13261 13262 13263 13264 13265 13266 13267 13268 13269
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

13270
/*
13271
 * "snapshot-revert" command
13272
 */
13273
static const vshCmdInfo info_snapshot_revert[] = {
13274 13275 13276 13277 13278
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

13279
static const vshCmdOptDef opts_snapshot_revert[] = {
13280 13281
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
13282 13283
    {"running", VSH_OT_BOOL, 0, N_("after reverting, change state to running")},
    {"paused", VSH_OT_BOOL, 0, N_("after reverting, change state to paused")},
13284 13285 13286
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13287
static bool
13288
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
13289 13290
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13291
    bool ret = false;
13292
    const char *name = NULL;
13293
    virDomainSnapshotPtr snapshot = NULL;
13294 13295 13296 13297 13298 13299
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED;
13300

13301
    if (!vshConnectionUsability(ctl, ctl->conn))
13302 13303 13304 13305 13306 13307
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

13308
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13309 13310 13311 13312 13313 13314
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

13315
    if (virDomainRevertToSnapshot(snapshot, flags) < 0)
13316 13317
        goto cleanup;

E
Eric Blake 已提交
13318
    ret = true;
13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341

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")},
13342 13343 13344
    {"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")},
13345 13346 13347
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13348
static bool
13349 13350 13351
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13352
    bool ret = false;
13353
    const char *name = NULL;
13354 13355 13356
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

13357
    if (!vshConnectionUsability(ctl, ctl->conn))
13358 13359 13360 13361 13362 13363
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

13364
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13365 13366 13367 13368
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;
13369 13370 13371 13372
    if (vshCommandOptBool(cmd, "children-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY;
    if (vshCommandOptBool(cmd, "metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY;
13373 13374 13375 13376 13377

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

13378 13379 13380
    /* 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.  */
13381
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
13382 13383 13384 13385
        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);
13386 13387
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
13388
        goto cleanup;
13389
    }
13390

E
Eric Blake 已提交
13391
    ret = true;
13392 13393 13394 13395 13396 13397 13398 13399 13400 13401

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

13402 13403 13404 13405
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
13406 13407
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
13408 13409 13410 13411 13412
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
13413
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
13414
    {"cmd", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("command")},
13415 13416 13417
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13418
static bool
13419 13420 13421
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13422
    bool ret = false;
13423
    char *monitor_cmd = NULL;
13424
    char *result = NULL;
13425
    unsigned int flags = 0;
13426 13427 13428
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
13429 13430 13431 13432 13433 13434 13435 13436

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

13437 13438 13439 13440 13441 13442 13443 13444
    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"));
13445 13446
        goto cleanup;
    }
13447
    monitor_cmd = virBufferContentAndReset(&buf);
13448

13449 13450 13451 13452
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
13453 13454 13455 13456
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
13457
    ret = true;
13458 13459 13460

cleanup:
    VIR_FREE(result);
13461
    VIR_FREE(monitor_cmd);
13462 13463 13464 13465 13466 13467
    if (dom)
        virDomainFree(dom);

    return ret;
}

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

13514
static const vshCmdDef domManagementCmds[] = {
13515 13516 13517 13518 13519 13520 13521 13522
    {"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},
13523 13524
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
13525
#ifndef WIN32
13526
    {"console", cmdConsole, opts_console, info_console, 0},
13527
#endif
13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538
    {"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},
13539
    {"domif-setlink", cmdDomIfSetLink, opts_domif_setlink, info_domif_setlink, 0},
13540 13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551
    {"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},
13552
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
13553 13554 13555 13556 13557 13558 13559 13560
    {"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},
13561 13562
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
13563 13564
    {"migrate-getspeed", cmdMigrateGetMaxSpeed,
     opts_migrate_getspeed, info_migrate_getspeed, 0},
13565 13566 13567 13568
    {"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},
13569 13570 13571 13572 13573 13574
    {"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},
13575
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
13576
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588
    {"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 已提交
13589
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
13590
    {"version", cmdVersion, opts_version, info_version, 0},
13591 13592
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
13593 13594 13595
};

static const vshCmdDef domMonitoringCmds[] = {
13596
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
13597
    {"domblklist", cmdDomblklist, opts_domblklist, info_domblklist, 0},
13598
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
13599
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
13600
    {"domif-getlink", cmdDomIfGetLink, opts_domif_getlink, info_domif_getlink, 0},
13601 13602 13603 13604 13605 13606
    {"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}
13607 13608 13609
};

static const vshCmdDef storagePoolCmds[] = {
13610
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
13611
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
13612
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
13613 13614 13615 13616 13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633
     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}
13634 13635 13636
};

static const vshCmdDef storageVolCmds[] = {
13637 13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654
    {"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}
13655
};
13656

13657
static const vshCmdDef networkCmds[] = {
13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676
    {"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}
13677
};
13678

13679
static const vshCmdDef nodedevCmds[] = {
13680 13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694
    {"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}
13695 13696 13697
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
13698 13699 13700 13701
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715
    {"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 已提交
13716 13717
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
13718 13719 13720 13721 13722
    {"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}
13723
};
13724

13725
static const vshCmdDef nwfilterCmds[] = {
13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736
    {"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}
13737
};
13738

13739
static const vshCmdDef secretCmds[] = {
13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751
    {"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}
13752
};
13753

13754
static const vshCmdDef virshCmds[] = {
13755 13756 13757 13758 13759 13760 13761
    {"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}
13762
};
13763

13764
static const vshCmdDef snapshotCmds[] = {
13765 13766
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
13767 13768
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
13769 13770 13771 13772 13773 13774
    {"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},
13775 13776
    {"snapshot-edit", cmdSnapshotEdit, opts_snapshot_edit,
     info_snapshot_edit, 0},
13777 13778
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
E
Eric Blake 已提交
13779 13780
    {"snapshot-parent", cmdSnapshotParent, opts_snapshot_parent,
     info_snapshot_parent, 0},
13781 13782 13783
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
13784
};
13785

13786
static const vshCmdDef hostAndHypervisorCmds[] = {
13787 13788 13789 13790 13791
    {"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},
13792
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
13793
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
13794
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
13795
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
13796 13797 13798 13799 13800
    {"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 已提交
13801 13802
};

13803 13804 13805 13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816 13817 13818 13819
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 已提交
13820 13821 13822 13823
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
13824
static const char *
13825
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
13826
{
13827
    const vshCmdInfo *info;
13828

K
Karel Zak 已提交
13829
    for (info = cmd->info; info && info->name; info++) {
13830
        if (STREQ(info->name, name))
K
Karel Zak 已提交
13831 13832 13833 13834 13835
            return info->data;
    }
    return NULL;
}

13836
static int
E
Eric Blake 已提交
13837
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
13838 13839 13840 13841 13842
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
13843 13844 13845
    *opts_need_arg = 0;
    *opts_required = 0;

13846 13847 13848 13849 13850 13851 13852 13853 13854
    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 已提交
13855
            if (opt->flags & VSH_OFLAG_REQ)
13856 13857 13858
                return -1; /* bool options can't be mandatory */
            continue;
        }
E
Eric Blake 已提交
13859 13860
        if (opt->flags & VSH_OFLAG_REQ_OPT) {
            if (opt->flags & VSH_OFLAG_REQ)
L
Lai Jiangshan 已提交
13861 13862 13863 13864
                *opts_required |= 1 << i;
            continue;
        }

13865
        *opts_need_arg |= 1 << i;
E
Eric Blake 已提交
13866
        if (opt->flags & VSH_OFLAG_REQ) {
13867 13868 13869 13870 13871 13872 13873 13874 13875 13876
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
    }
    return 0;
}

13877
static const vshCmdOptDef *
13878 13879
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
13880
{
13881 13882 13883 13884
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
13885

13886 13887 13888 13889 13890
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
13891 13892
            if (opt->type != VSH_OT_ARGV)
                *opts_seen |= 1 << i;
K
Karel Zak 已提交
13893
            return opt;
13894 13895 13896 13897 13898
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
13899 13900 13901
    return NULL;
}

13902
static const vshCmdOptDef *
13903 13904
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
13905
{
13906
    int i;
13907
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
13908

13909 13910 13911 13912
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
13913
    i = ffs(*opts_need_arg) - 1;
13914
    opt = &cmd->opts[i];
13915
    if (opt->type != VSH_OT_ARGV) {
13916
        *opts_need_arg &= ~(1 << i);
13917 13918
        *opts_seen |= 1 << i;
    }
13919
    return opt;
K
Karel Zak 已提交
13920 13921
}

13922 13923 13924
/*
 * Checks for required options
 */
13925
static int
13926 13927
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
13928
{
13929
    const vshCmdDef *def = cmd->def;
13930 13931 13932 13933 13934 13935 13936 13937 13938
    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];
13939

13940
            vshError(ctl,
13941
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
13942 13943 13944
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
13945 13946
        }
    }
13947
    return -1;
13948 13949
}

13950
static const vshCmdDef *
13951 13952
vshCmddefSearch(const char *cmdname)
{
13953
    const vshCmdGrp *g;
13954
    const vshCmdDef *c;
13955

13956 13957
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
13958
            if (STREQ(c->name, cmdname))
13959 13960 13961 13962
                return c;
        }
    }

K
Karel Zak 已提交
13963 13964 13965
    return NULL;
}

13966 13967 13968 13969 13970 13971
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
13972
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
13973 13974 13975 13976 13977 13978
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
13979
static bool
13980 13981 13982 13983 13984 13985 13986
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 已提交
13987
        return false;
13988 13989 13990 13991 13992 13993 13994 13995 13996 13997
    } 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 已提交
13998
    return true;
13999 14000
}

E
Eric Blake 已提交
14001
static bool
14002
vshCmddefHelp(vshControl *ctl, const char *cmdname)
14003
{
14004
    const vshCmdDef *def = vshCmddefSearch(cmdname);
14005

K
Karel Zak 已提交
14006
    if (!def) {
14007
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
14008
        return false;
14009
    } else {
E
Eric Blake 已提交
14010 14011
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
14012
        const char *help = _(vshCmddefGetInfo(def, "help"));
14013
        char buf[256];
14014 14015
        uint32_t opts_need_arg;
        uint32_t opts_required;
14016
        bool shortopt = false; /* true if 'arg' works instead of '--opt arg' */
14017 14018 14019 14020

        if (vshCmddefOptParse(def, &opts_need_arg, &opts_required)) {
            vshError(ctl, _("internal error: bad options in command: '%s'"),
                     def->name);
E
Eric Blake 已提交
14021
            return false;
14022
        }
K
Karel Zak 已提交
14023

14024
        fputs(_("  NAME\n"), stdout);
14025 14026
        fprintf(stdout, "    %s - %s\n", def->name, help);

14027 14028 14029 14030 14031
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
14032
                const char *fmt = "%s";
14033 14034
                switch (opt->type) {
                case VSH_OT_BOOL:
14035
                    fmt = "[--%s]";
14036 14037
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
14038
                    /* xgettext:c-format */
E
Eric Blake 已提交
14039
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>"
14040
                           : _("[--%s <number>]"));
14041 14042
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
14043 14044
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
14045 14046
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
14047 14048
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
14049 14050
                    break;
                case VSH_OT_DATA:
E
Eric Blake 已提交
14051
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
14052 14053
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
14054 14055 14056
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
14057 14058 14059 14060 14061 14062 14063 14064
                    if (shortopt) {
                        fmt = (opt->flags & VSH_OFLAG_REQ)
                            ? _("{[--%s] <string>}...")
                            : _("[[--%s] <string>]...");
                    } else {
                        fmt = (opt->flags & VSH_OFLAG_REQ) ? _("<%s>...")
                            : _("[<%s>]...");
                    }
14065 14066
                    break;
                default:
14067
                    assert(0);
14068
                }
14069
                fputc(' ', stdout);
E
Eric Blake 已提交
14070
                fprintf(stdout, fmt, opt->name);
14071
            }
K
Karel Zak 已提交
14072
        }
14073 14074 14075
        fputc('\n', stdout);

        if (desc[0]) {
14076
            /* Print the description only if it's not empty.  */
14077
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
14078
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
14079
        }
14080

K
Karel Zak 已提交
14081
        if (def->opts) {
14082
            const vshCmdOptDef *opt;
14083
            fputs(_("\n  OPTIONS\n"), stdout);
14084
            for (opt = def->opts; opt->name; opt++) {
14085 14086
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
14087
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
14088 14089
                    break;
                case VSH_OT_INT:
14090
                    snprintf(buf, sizeof(buf),
E
Eric Blake 已提交
14091
                             (opt->flags & VSH_OFLAG_REQ) ? _("[--%s] <number>")
14092
                             : _("--%s <number>"), opt->name);
14093 14094
                    break;
                case VSH_OT_STRING:
14095
                    /* OT_STRING should never be VSH_OFLAG_REQ */
14096
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
14097 14098
                    break;
                case VSH_OT_DATA:
14099 14100
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
14101 14102
                    break;
                case VSH_OT_ARGV:
14103 14104 14105
                    snprintf(buf, sizeof(buf),
                             shortopt ? _("[--%s] <string>") : _("<%s>"),
                             opt->name);
14106
                    break;
14107 14108 14109
                default:
                    assert(0);
                }
14110

E
Eric Blake 已提交
14111
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
14112
            }
K
Karel Zak 已提交
14113 14114 14115
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
14116
    return true;
K
Karel Zak 已提交
14117 14118 14119 14120 14121 14122
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
14123 14124 14125
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
14126 14127
    vshCmdOpt *a = arg;

14128
    while (a) {
K
Karel Zak 已提交
14129
        vshCmdOpt *tmp = a;
14130

K
Karel Zak 已提交
14131 14132
        a = a->next;

14133 14134
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
14135 14136 14137 14138
    }
}

static void
14139
vshCommandFree(vshCmd *cmd)
14140
{
K
Karel Zak 已提交
14141 14142
    vshCmd *c = cmd;

14143
    while (c) {
K
Karel Zak 已提交
14144
        vshCmd *tmp = c;
14145

K
Karel Zak 已提交
14146 14147 14148 14149
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
14150
        VIR_FREE(tmp);
K
Karel Zak 已提交
14151 14152 14153
    }
}

E
Eric Blake 已提交
14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164
/**
 * 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 已提交
14165
 */
E
Eric Blake 已提交
14166 14167
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
14168
{
E
Eric Blake 已提交
14169 14170
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
14171

E
Eric Blake 已提交
14172 14173 14174 14175 14176 14177 14178
    /* 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 已提交
14179
    }
E
Eric Blake 已提交
14180 14181 14182 14183 14184 14185 14186

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
E
Eric Blake 已提交
14187
            return (valid->flags & VSH_OFLAG_REQ) == 0 ? 0 : -1;
E
Eric Blake 已提交
14188 14189 14190 14191
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
14192 14193
}

E
Eric Blake 已提交
14194 14195
/**
 * vshCommandOptInt:
14196 14197 14198 14199 14200 14201 14202
 * @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 已提交
14203
 * 0 if option not found and not required (@value untouched)
14204
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
14205 14206
 */
static int
14207
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
14208
{
E
Eric Blake 已提交
14209 14210 14211
    vshCmdOpt *arg;
    int ret;
    int num;
14212
    char *end_p = NULL;
14213

E
Eric Blake 已提交
14214 14215 14216 14217 14218 14219 14220
    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;
14221
    }
E
Eric Blake 已提交
14222 14223 14224 14225 14226 14227 14228

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
14229 14230
}

14231

E
Eric Blake 已提交
14232 14233 14234 14235 14236 14237
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
14238 14239 14240 14241 14242 14243
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
14244 14245 14246
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
14247 14248
    char *end_p = NULL;

E
Eric Blake 已提交
14249 14250 14251 14252 14253 14254 14255
    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;
14256
    }
E
Eric Blake 已提交
14257 14258 14259 14260 14261 14262 14263

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14264 14265 14266
}


14267
/*
E
Eric Blake 已提交
14268 14269 14270 14271 14272
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
14273 14274 14275 14276 14277
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
14278
{
E
Eric Blake 已提交
14279 14280
    vshCmdOpt *arg;
    int ret;
14281
    unsigned long num;
14282 14283
    char *end_p = NULL;

E
Eric Blake 已提交
14284 14285 14286 14287 14288 14289 14290
    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;
14291
    }
E
Eric Blake 已提交
14292 14293 14294 14295 14296 14297 14298

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14299 14300
}

E
Eric Blake 已提交
14301 14302 14303 14304 14305 14306
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
14307
 * Returns option as STRING
E
Eric Blake 已提交
14308 14309 14310 14311
 * 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 已提交
14312
 */
14313 14314
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
14315
{
E
Eric Blake 已提交
14316 14317 14318 14319 14320 14321 14322 14323 14324 14325
    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;
14326
    }
14327

E
Eric Blake 已提交
14328
    if (!*arg->data && !(arg->def->flags & VSH_OFLAG_EMPTY_OK)) {
E
Eric Blake 已提交
14329 14330 14331 14332
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
14333 14334
}

E
Eric Blake 已提交
14335 14336 14337 14338 14339 14340
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
14341
 * Returns option as long long
14342
 * See vshCommandOptInt()
14343
 */
14344 14345 14346
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
14347
{
E
Eric Blake 已提交
14348 14349
    vshCmdOpt *arg;
    int ret;
14350
    long long num;
14351 14352
    char *end_p = NULL;

E
Eric Blake 已提交
14353 14354 14355 14356 14357 14358 14359
    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;
14360
    }
E
Eric Blake 已提交
14361 14362 14363 14364 14365 14366 14367

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14368 14369
}

E
Eric Blake 已提交
14370 14371 14372 14373 14374 14375 14376 14377 14378
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
14379 14380 14381 14382
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
14383 14384
    vshCmdOpt *arg;
    int ret;
14385 14386 14387
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
14388 14389 14390 14391 14392 14393 14394
    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;
14395
    }
E
Eric Blake 已提交
14396 14397 14398 14399 14400 14401 14402

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14403 14404 14405
}


E
Eric Blake 已提交
14406 14407 14408 14409 14410 14411 14412 14413 14414
/**
 * 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 已提交
14415
 */
E
Eric Blake 已提交
14416
static bool
14417
vshCommandOptBool(const vshCmd *cmd, const char *name)
14418
{
E
Eric Blake 已提交
14419 14420 14421
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
14422 14423
}

E
Eric Blake 已提交
14424 14425 14426 14427 14428
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
14429 14430
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
14431
 *
14432
 * Requires that a VSH_OT_ARGV option be last in the
14433 14434
 * list of supported options in CMD->def->opts.
 */
14435 14436
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
14437
{
14438
    opt = opt ? opt->next : cmd->opts;
14439 14440

    while (opt) {
E
Eric Blake 已提交
14441
        if (opt->def->type == VSH_OT_ARGV) {
14442
            return opt;
14443 14444 14445 14446 14447 14448
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466
/* 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)
14467
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
14468 14469 14470
                 cmd->def->name, optname);
    return found;
}
14471

K
Karel Zak 已提交
14472
static virDomainPtr
J
Jim Meyering 已提交
14473
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
14474
                      const char **name, int flag)
14475
{
K
Karel Zak 已提交
14476
    virDomainPtr dom = NULL;
14477
    const char *n = NULL;
K
Karel Zak 已提交
14478
    int id;
J
Jim Meyering 已提交
14479 14480 14481
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
14482

14483
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14484 14485
        return NULL;

14486
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14487 14488
             cmd->def->name, optname, n);

K
Karel Zak 已提交
14489 14490
    if (name)
        *name = n;
14491

K
Karel Zak 已提交
14492
    /* try it by ID */
14493
    if (flag & VSH_BYID) {
14494
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
14495 14496
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
14497 14498 14499
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
14500
    }
K
Karel Zak 已提交
14501
    /* try it by UUID */
14502
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
14503
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
14504
                 cmd->def->name, optname);
K
Karel Zak 已提交
14505
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
14506
    }
K
Karel Zak 已提交
14507
    /* try it by NAME */
14508
    if (dom==NULL && (flag & VSH_BYNAME)) {
14509
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
14510
                 cmd->def->name, optname);
K
Karel Zak 已提交
14511
        dom = virDomainLookupByName(ctl->conn, n);
14512
    }
K
Karel Zak 已提交
14513

14514
    if (!dom)
14515
        vshError(ctl, _("failed to get domain '%s'"), n);
14516

K
Karel Zak 已提交
14517 14518 14519
    return dom;
}

14520
static virNetworkPtr
J
Jim Meyering 已提交
14521
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
14522
                       const char **name, int flag)
14523 14524
{
    virNetworkPtr network = NULL;
14525
    const char *n = NULL;
J
Jim Meyering 已提交
14526 14527 14528
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
14529

14530
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14531 14532
        return NULL;

14533
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14534 14535 14536 14537 14538 14539
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
14540
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14541
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
14542
                 cmd->def->name, optname);
14543 14544 14545 14546
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
14547
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
14548 14549 14550 14551 14552
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
14553
        vshError(ctl, _("failed to get network '%s'"), n);
14554 14555 14556 14557

    return network;
}

14558 14559 14560

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
14561
                        const char **name, int flag)
14562 14563
{
    virNWFilterPtr nwfilter = NULL;
14564
    const char *n = NULL;
14565 14566 14567 14568
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14569
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14570 14571
        return NULL;

14572
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14573 14574 14575 14576 14577 14578 14579
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14580
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
14581 14582 14583 14584 14585
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
14586
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
14587 14588 14589 14590 14591 14592 14593 14594 14595 14596
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

14597 14598
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
14599
                         const char **name, int flag)
14600 14601
{
    virInterfacePtr iface = NULL;
14602
    const char *n = NULL;
14603 14604 14605 14606
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14607
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14608 14609
        return NULL;

14610
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14611 14612 14613 14614 14615 14616
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
14617
    if ((flag & VSH_BYNAME)) {
14618
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
14619 14620 14621 14622 14623
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
14624
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
14625 14626 14627 14628 14629
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
14630
        vshError(ctl, _("failed to get interface '%s'"), n);
14631 14632 14633 14634

    return iface;
}

14635
static virStoragePoolPtr
14636
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
14637
                    const char **name, int flag)
14638 14639
{
    virStoragePoolPtr pool = NULL;
14640
    const char *n = NULL;
14641

14642
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14643 14644
        return NULL;

14645
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14646 14647 14648 14649 14650 14651
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
14652
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14653
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
14654
                 cmd->def->name, optname);
14655 14656 14657
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
14658
    if (pool == NULL && (flag & VSH_BYNAME)) {
14659
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
14660 14661 14662 14663 14664
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
14665
        vshError(ctl, _("failed to get pool '%s'"), n);
14666 14667 14668 14669 14670

    return pool;
}

static virStorageVolPtr
14671
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
14672 14673
                   const char *optname,
                   const char *pooloptname,
14674
                   const char **name, int flag)
14675 14676 14677
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
14678
    const char *n = NULL, *p = NULL;
14679

14680
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14681 14682
        return NULL;

14683
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
14684
        vshError(ctl, "%s", _("missing option"));
14685
        return NULL;
14686
    }
14687 14688 14689 14690

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

14691
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
14692 14693 14694 14695 14696
             cmd->def->name, optname, n);

    if (name)
        *name = n;

14697
    /* try it by name */
14698
    if (pool && (flag & VSH_BYNAME)) {
14699
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
14700 14701 14702
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
14703
    /* try it by key */
14704
    if (vol == NULL && (flag & VSH_BYUUID)) {
14705
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
14706 14707 14708
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
14709
    /* try it by path */
14710
    if (vol == NULL && (flag & VSH_BYUUID)) {
14711
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
14712 14713 14714 14715 14716
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
14717
        vshError(ctl, _("failed to get vol '%s'"), n);
14718 14719 14720 14721 14722 14723 14724

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

14725
static virSecretPtr
14726
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
14727 14728
{
    virSecretPtr secret = NULL;
14729
    const char *n = NULL;
14730 14731 14732 14733 14734
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14735
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14736 14737
        return NULL;

14738 14739
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
14740 14741 14742 14743 14744 14745 14746

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
14747
        vshError(ctl, _("failed to get secret '%s'"), n);
14748 14749 14750 14751

    return secret;
}

K
Karel Zak 已提交
14752 14753 14754
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
14755
static bool
14756
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
14757
{
E
Eric Blake 已提交
14758
    bool ret = true;
14759 14760

    while (cmd) {
K
Karel Zak 已提交
14761
        struct timeval before, after;
14762
        bool enable_timing = ctl->timing;
14763

14764 14765
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
14766 14767
            vshReconnect(ctl);

14768
        if (enable_timing)
K
Karel Zak 已提交
14769
            GETTIMEOFDAY(&before);
14770

K
Karel Zak 已提交
14771 14772
        ret = cmd->def->handler(ctl, cmd);

14773
        if (enable_timing)
K
Karel Zak 已提交
14774
            GETTIMEOFDAY(&after);
14775

14776
        if (!ret)
J
John Levon 已提交
14777 14778
            virshReportError(ctl);

14779
        /* try to automatically catch disconnections */
14780
        if (!ret &&
14781 14782 14783 14784 14785 14786 14787 14788 14789
            ((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);

14790
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
14791 14792
            return ret;

14793
        if (enable_timing)
14794
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
14795 14796
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
14797
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
14798 14799 14800 14801 14802 14803
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
14804
 * Command parsing
K
Karel Zak 已提交
14805 14806 14807
 * ---------------
 */

14808 14809 14810 14811 14812 14813 14814 14815 14816 14817
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 已提交
14818
    /* vshCommandStringGetArg() */
14819
    char *pos;
L
Lai Jiangshan 已提交
14820 14821 14822
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
14823 14824
} vshCommandParser;

E
Eric Blake 已提交
14825
static bool
14826
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
14827
{
K
Karel Zak 已提交
14828 14829 14830
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
14831

K
Karel Zak 已提交
14832 14833 14834 14835
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
14836

14837
    while (1) {
K
Karel Zak 已提交
14838
        vshCmdOpt *last = NULL;
14839
        const vshCmdDef *cmd = NULL;
14840
        vshCommandToken tk;
L
Lai Jiangshan 已提交
14841
        bool data_only = false;
14842 14843 14844
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
14845

K
Karel Zak 已提交
14846
        first = NULL;
14847

14848
        while (1) {
14849
            const vshCmdOptDef *opt = NULL;
14850

K
Karel Zak 已提交
14851
            tkdata = NULL;
14852
            tk = parser->getNextArg(ctl, parser, &tkdata);
14853 14854

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14855
                goto syntaxError;
H
Hu Tao 已提交
14856 14857
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
14858
                break;
H
Hu Tao 已提交
14859
            }
14860 14861

            if (cmd == NULL) {
K
Karel Zak 已提交
14862 14863
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
14864
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
14865
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
14866
                }
14867 14868 14869 14870 14871 14872 14873
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
14874
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
14875 14876 14877 14878
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
14879 14880 14881 14882 14883
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
14884 14885
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
14886
                    VIR_FREE(optstr);
K
Karel Zak 已提交
14887 14888
                    goto syntaxError;
                }
14889
                VIR_FREE(tkdata);
K
Karel Zak 已提交
14890 14891 14892

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
14893 14894 14895
                    if (optstr)
                        tkdata = optstr;
                    else
14896
                        tk = parser->getNextArg(ctl, parser, &tkdata);
14897
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14898
                        goto syntaxError;
14899
                    if (tk != VSH_TK_ARG) {
14900
                        vshError(ctl,
14901
                                 _("expected syntax: --%s <%s>"),
14902 14903
                                 opt->name,
                                 opt->type ==
14904
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
14905 14906
                        goto syntaxError;
                    }
14907
                    opts_need_arg &= ~opts_seen;
14908 14909 14910 14911 14912 14913 14914 14915
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
14916
                }
L
Lai Jiangshan 已提交
14917 14918 14919 14920
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
14921
            } else {
L
Lai Jiangshan 已提交
14922
get_data:
14923 14924
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
14925
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
14926 14927 14928 14929 14930
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
14931
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
14932

K
Karel Zak 已提交
14933 14934 14935 14936
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
14937

K
Karel Zak 已提交
14938 14939 14940 14941 14942
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
14943

14944
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
14945 14946
                         cmd->name,
                         opt->name,
14947 14948
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
14949 14950
            }
        }
14951

D
Daniel Veillard 已提交
14952
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
14953
        if (cmd) {
14954
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
14955

K
Karel Zak 已提交
14956 14957 14958 14959
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

14960
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
14961
                VIR_FREE(c);
14962
                goto syntaxError;
14963
            }
14964

K
Karel Zak 已提交
14965 14966 14967 14968 14969 14970
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
14971 14972 14973

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
14974
    }
14975

E
Eric Blake 已提交
14976
    return true;
K
Karel Zak 已提交
14977

14978
 syntaxError:
14979
    if (ctl->cmd) {
K
Karel Zak 已提交
14980
        vshCommandFree(ctl->cmd);
14981 14982
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
14983 14984
    if (first)
        vshCommandOptFree(first);
14985
    VIR_FREE(tkdata);
E
Eric Blake 已提交
14986
    return false;
K
Karel Zak 已提交
14987 14988
}

14989 14990 14991 14992 14993 14994 14995 14996 14997 14998 14999 15000 15001 15002 15003 15004 15005 15006
/* --------------------
 * 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 已提交
15007 15008
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
15009 15010 15011 15012
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
15013
        return false;
15014 15015 15016 15017 15018 15019 15020 15021 15022 15023 15024 15025 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

    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 已提交
15086 15087
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
15088 15089 15090 15091
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
15092
        return false;
15093 15094 15095 15096 15097 15098

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
15099
/* ---------------
15100
 * Misc utils
K
Karel Zak 已提交
15101 15102
 * ---------------
 */
15103 15104 15105 15106 15107 15108 15109 15110 15111 15112 15113 15114 15115 15116 15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128 15129 15130
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 已提交
15131
static const char *
15132 15133
vshDomainStateToString(int state)
{
15134 15135
    /* Can't use virDomainStateTypeToString, because we want to mark
     * strings for translation.  */
15136
    switch ((virDomainState) state) {
15137
    case VIR_DOMAIN_RUNNING:
15138
        return N_("running");
15139
    case VIR_DOMAIN_BLOCKED:
15140
        return N_("idle");
15141
    case VIR_DOMAIN_PAUSED:
15142
        return N_("paused");
15143
    case VIR_DOMAIN_SHUTDOWN:
15144
        return N_("in shutdown");
15145
    case VIR_DOMAIN_SHUTOFF:
15146
        return N_("shut off");
15147
    case VIR_DOMAIN_CRASHED:
15148
        return N_("crashed");
15149
    case VIR_DOMAIN_NOSTATE:
15150
    default:
15151
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
15152
    }
15153
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
15154 15155
}

15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 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
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");
15211 15212
        case VIR_DOMAIN_PAUSED_SHUTTING_DOWN:
            return N_("shutting down");
15213 15214 15215 15216 15217 15218 15219 15220 15221 15222 15223 15224 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
        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;
15254 15255 15256

    default:
        ;
15257 15258 15259 15260 15261
    }

    return N_("unknown");
}

15262 15263 15264 15265 15266 15267 15268 15269 15270 15271 15272 15273 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
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;
}

15325 15326 15327 15328 15329 15330 15331 15332 15333 15334 15335 15336 15337 15338 15339 15340 15341
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");
}

15342 15343 15344 15345
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
15346
    case VIR_VCPU_OFFLINE:
15347
        return N_("offline");
15348
    case VIR_VCPU_BLOCKED:
15349
        return N_("idle");
15350
    case VIR_VCPU_RUNNING:
15351
        return N_("running");
15352
    default:
15353
        ;/*FALLTHROUGH*/
15354
    }
15355
    return N_("no state");
15356 15357
}

E
Eric Blake 已提交
15358
static bool
15359
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
15360
{
15361 15362
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
15363 15364
     */
    if (!conn) {
15365
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
15366
        return false;
K
Karel Zak 已提交
15367
    }
E
Eric Blake 已提交
15368
    return true;
K
Karel Zak 已提交
15369 15370
}

K
Karel Zak 已提交
15371
static void
15372
vshDebug(vshControl *ctl, int level, const char *format, ...)
15373
{
K
Karel Zak 已提交
15374
    va_list ap;
15375
    char *str;
K
Karel Zak 已提交
15376

15377 15378 15379 15380 15381 15382 15383
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

15384
    va_start(ap, format);
15385
    vshOutputLogFile(ctl, level, format, ap);
15386 15387
    va_end(ap);

K
Karel Zak 已提交
15388
    va_start(ap, format);
15389 15390 15391 15392 15393
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
15394
    va_end(ap);
15395 15396
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
15397 15398 15399
}

static void
15400
vshPrintExtra(vshControl *ctl, const char *format, ...)
15401
{
K
Karel Zak 已提交
15402
    va_list ap;
15403
    char *str;
15404

15405
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
15406
        return;
15407

K
Karel Zak 已提交
15408
    va_start(ap, format);
15409 15410 15411 15412 15413
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
15414
    va_end(ap);
15415
    fputs(str, stdout);
15416
    VIR_FREE(str);
K
Karel Zak 已提交
15417 15418
}

K
Karel Zak 已提交
15419

K
Karel Zak 已提交
15420
static void
15421
vshError(vshControl *ctl, const char *format, ...)
15422
{
K
Karel Zak 已提交
15423
    va_list ap;
15424
    char *str;
15425

15426 15427 15428 15429 15430
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
15431

15432 15433 15434 15435
    /* 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);
15436
    fputs(_("error: "), stderr);
15437

K
Karel Zak 已提交
15438
    va_start(ap, format);
15439 15440 15441
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
15442 15443
    va_end(ap);

15444
    fprintf(stderr, "%s\n", NULLSTR(str));
15445
    fflush(stderr);
15446
    VIR_FREE(str);
K
Karel Zak 已提交
15447 15448
}

15449

K
Karel Zak 已提交
15450
/*
15451
 * Initialize connection.
K
Karel Zak 已提交
15452
 */
E
Eric Blake 已提交
15453
static bool
15454
vshInit(vshControl *ctl)
15455
{
15456 15457
    char *debugEnv;

K
Karel Zak 已提交
15458
    if (ctl->conn)
E
Eric Blake 已提交
15459
        return false;
K
Karel Zak 已提交
15460

J
Jiri Denemark 已提交
15461
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
15462 15463 15464
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
15465 15466 15467
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
15468 15469
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
15470 15471
            } else {
                ctl->debug = debug;
15472 15473 15474 15475 15476 15477 15478 15479 15480 15481 15482 15483
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

15484 15485
    vshOpenLogFile(ctl);

15486 15487
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
15488

15489 15490 15491
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

15492
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
15493
        return false;
15494

15495 15496 15497 15498
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
15499

15500 15501 15502 15503 15504 15505 15506 15507 15508 15509 15510
        /* 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;
        }
15511
    }
K
Karel Zak 已提交
15512

E
Eric Blake 已提交
15513
    return true;
K
Karel Zak 已提交
15514 15515
}

15516 15517
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

15518 15519 15520 15521 15522 15523 15524 15525 15526 15527 15528 15529 15530 15531 15532 15533 15534 15535 15536
/**
 * 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:
15537
                vshError(ctl, "%s",
J
Jim Meyering 已提交
15538
                         _("failed to get the log file information"));
15539
                exit(EXIT_FAILURE);
15540 15541 15542
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
15543 15544
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
15545 15546 15547 15548
        }
    }

    /* log file open */
15549
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
15550
        vshError(ctl, "%s",
J
Jim Meyering 已提交
15551
                 _("failed to open the log file. check the log file path"));
15552
        exit(EXIT_FAILURE);
15553 15554 15555 15556 15557 15558 15559 15560 15561
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
15562 15563
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
15564
{
15565 15566 15567
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
15568 15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581
    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);
15582
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
15583 15584 15585 15586 15587 15588
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
15589 15590
                      SIGN_NAME,
                      (int) getpid());
15591 15592 15593 15594 15595 15596 15597 15598 15599 15600 15601 15602 15603 15604 15605 15606 15607 15608 15609 15610
    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;
    }
15611 15612 15613
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
15614

15615 15616
    if (virBufferError(&buf))
        goto error;
15617

15618 15619 15620 15621 15622
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
15623
    }
15624

15625 15626 15627 15628 15629 15630 15631 15632 15633 15634 15635
    /* 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);
15636 15637 15638 15639 15640 15641 15642 15643 15644 15645 15646
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
15647 15648 15649
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
15650 15651 15652
    }

    if (ctl->logfile) {
15653
        VIR_FREE(ctl->logfile);
15654 15655 15656 15657
        ctl->logfile = NULL;
    }
}

15658
#ifdef USE_READLINE
15659

K
Karel Zak 已提交
15660 15661 15662 15663 15664
/* -----------------
 * Readline stuff
 * -----------------
 */

15665
/*
K
Karel Zak 已提交
15666 15667
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
15668
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
15669 15670
 */
static char *
15671 15672
vshReadlineCommandGenerator(const char *text, int state)
{
15673
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
15674
    const char *name;
15675 15676
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
15677 15678

    if (!state) {
15679 15680
        grp_list_index = 0;
        cmd_list_index = 0;
15681
        len = strlen(text);
K
Karel Zak 已提交
15682 15683
    }

15684 15685
    grp = cmdGroups;

K
Karel Zak 已提交
15686
    /* Return the next name which partially matches from the
15687
     * command list.
K
Karel Zak 已提交
15688
     */
15689 15690 15691 15692 15693 15694 15695 15696 15697 15698 15699 15700 15701 15702
    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 已提交
15703 15704 15705 15706 15707 15708 15709
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
15710 15711
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
15712
    static int list_index, len;
15713
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
15714
    const char *name;
K
Karel Zak 已提交
15715 15716 15717 15718 15719 15720 15721 15722 15723

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

15724
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
15725
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
15726 15727 15728

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
15729
        len = strlen(text);
15730
        VIR_FREE(cmdname);
K
Karel Zak 已提交
15731 15732 15733 15734
    }

    if (!cmd)
        return NULL;
15735

15736 15737 15738
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
15739
    while ((name = cmd->opts[list_index].name)) {
15740
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
15741
        char *res;
15742

K
Karel Zak 已提交
15743
        list_index++;
15744

15745
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
15746 15747
            /* ignore non --option */
            continue;
15748

K
Karel Zak 已提交
15749
        if (len > 2) {
15750
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
15751 15752
                continue;
        }
15753
        res = vshMalloc(NULL, strlen(name) + 3);
15754
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
15755 15756 15757 15758 15759 15760 15761 15762
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
15763 15764 15765
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
15766 15767
    char **matches = (char **) NULL;

15768
    if (start == 0)
K
Karel Zak 已提交
15769
        /* command name generator */
15770
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
15771 15772
    else
        /* commands options */
15773
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
15774 15775 15776 15777
    return matches;
}


15778 15779
static int
vshReadlineInit(vshControl *ctl)
15780
{
15781 15782
    char *userdir = NULL;

K
Karel Zak 已提交
15783 15784 15785 15786 15787
    /* 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;
15788 15789 15790

    /* Limit the total size of the history buffer */
    stifle_history(500);
15791 15792

    /* Prepare to read/write history from/to the ~/.virsh/history file */
15793
    userdir = virGetUserDirectory(getuid());
15794

15795 15796
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
15797
        return -1;
15798
    }
15799 15800 15801

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15802
        VIR_FREE(userdir);
15803 15804 15805 15806 15807
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15808
        VIR_FREE(userdir);
15809 15810 15811
        return -1;
    }

15812
    VIR_FREE(userdir);
15813 15814 15815 15816 15817 15818 15819 15820 15821 15822 15823 15824 15825 15826 15827 15828 15829 15830

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

15831 15832
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
15833 15834
}

15835 15836 15837 15838 15839 15840
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

15841
#else /* !USE_READLINE */
15842

15843 15844 15845 15846 15847 15848 15849
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

15850
static void
15851
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
15852 15853 15854 15855 15856 15857 15858 15859 15860 15861 15862 15863 15864 15865 15866 15867 15868 15869 15870 15871 15872 15873 15874
{
    /* 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);
}

15875
#endif /* !USE_READLINE */
15876

K
Karel Zak 已提交
15877
/*
J
Jim Meyering 已提交
15878
 * Deinitialize virsh
K
Karel Zak 已提交
15879
 */
E
Eric Blake 已提交
15880
static bool
15881
vshDeinit(vshControl *ctl)
15882
{
15883
    vshReadlineDeinit(ctl);
15884
    vshCloseLogFile(ctl);
15885
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
15886
    if (ctl->conn) {
15887 15888 15889
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
15890 15891
        }
    }
D
Daniel P. Berrange 已提交
15892 15893
    virResetLastError();

E
Eric Blake 已提交
15894
    return true;
K
Karel Zak 已提交
15895
}
15896

K
Karel Zak 已提交
15897 15898 15899 15900
/*
 * Print usage
 */
static void
15901
vshUsage(void)
15902
{
15903
    const vshCmdGrp *grp;
15904
    const vshCmdDef *cmd;
15905

L
Lai Jiangshan 已提交
15906 15907
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
15908 15909 15910
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
15911
                      "    -d | --debug <num>      debug level [0-4]\n"
15912 15913 15914 15915
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
15916
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
15917
                      "    -V | --version=long     version and full options\n\n"
15918
                      "  commands (non interactive mode):\n\n"), progname, progname);
15919

15920 15921
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
15922

15923 15924 15925 15926 15927 15928 15929 15930 15931
        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"));
15932 15933 15934
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
15935 15936
}

15937 15938 15939 15940 15941 15942 15943 15944 15945 15946
/*
 * 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 已提交
15947 15948
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
15949 15950 15951 15952 15953 15954 15955 15956 15957 15958 15959 15960 15961 15962 15963 15964 15965 15966 15967 15968 15969 15970 15971 15972 15973 15974 15975 15976 15977 15978 15979 15980 15981 15982 15983
#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 已提交
15984
    vshPrint(ctl, "%s", _(" Networking:"));
15985 15986 15987 15988 15989 15990 15991 15992 15993 15994 15995 15996 15997 15998 15999 16000 16001 16002 16003 16004 16005 16006 16007 16008 16009 16010
#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 已提交
16011
    vshPrint(ctl, "%s", _(" Storage:"));
16012 16013 16014 16015 16016 16017 16018 16019 16020 16021 16022 16023 16024 16025 16026 16027 16028 16029 16030 16031 16032 16033 16034
#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 已提交
16035
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
16036
#ifdef WITH_SECDRIVER_APPARMOR
16037 16038 16039 16040 16041 16042 16043 16044 16045 16046 16047 16048 16049 16050 16051 16052 16053 16054 16055 16056 16057 16058 16059
    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 已提交
16060 16061 16062 16063
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
16064
static bool
16065
vshParseArgv(vshControl *ctl, int argc, char **argv)
16066
{
16067 16068
    bool help = false;
    int arg;
K
Karel Zak 已提交
16069
    struct option opt[] = {
E
Eric Blake 已提交
16070 16071 16072 16073 16074 16075 16076 16077 16078
        {"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}
16079 16080
    };

16081 16082 16083
    /* 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. */
16084
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
16085
        switch (arg) {
16086
        case 'd':
D
Daniel Veillard 已提交
16087
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
16088
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
16089 16090
                exit(EXIT_FAILURE);
            }
16091 16092
            break;
        case 'h':
16093
            help = true;
16094 16095
            break;
        case 'q':
E
Eric Blake 已提交
16096
            ctl->quiet = true;
16097 16098
            break;
        case 't':
E
Eric Blake 已提交
16099
            ctl->timing = true;
16100 16101 16102 16103
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
16104 16105 16106 16107 16108 16109
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
16110 16111 16112
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
16113
        case 'r':
E
Eric Blake 已提交
16114
            ctl->readonly = true;
16115
            break;
16116 16117 16118
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
16119
        default:
16120 16121
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
16122 16123 16124 16125
        }
    }

    if (help) {
16126 16127
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
16128 16129
            exit(EXIT_FAILURE);
        }
16130 16131 16132

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
16133
        exit(EXIT_SUCCESS);
16134 16135
    }

16136
    if (argc > optind) {
K
Karel Zak 已提交
16137
        /* parse command */
E
Eric Blake 已提交
16138
        ctl->imode = false;
16139
        if (argc - optind == 1) {
16140
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
16141
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
16142
        } else {
16143
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
16144 16145
        }
    }
E
Eric Blake 已提交
16146
    return true;
K
Karel Zak 已提交
16147 16148
}

16149 16150 16151 16152
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
16153
    char *defaultConn;
E
Eric Blake 已提交
16154
    bool ret = true;
K
Karel Zak 已提交
16155

16156 16157 16158
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
16159
    ctl->debug = VSH_DEBUG_DEFAULT;
16160

16161 16162
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
16163
        /* failure to setup locale is not fatal */
16164
    }
16165
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
16166
        perror("bindtextdomain");
E
Eric Blake 已提交
16167
        return EXIT_FAILURE;
16168
    }
16169
    if (!textdomain(PACKAGE)) {
16170
        perror("textdomain");
E
Eric Blake 已提交
16171
        return EXIT_FAILURE;
16172 16173
    }

16174 16175 16176 16177 16178
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

16179
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
16180 16181 16182
        progname = argv[0];
    else
        progname++;
16183

16184
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
16185
        ctl->name = vshStrdup(ctl, defaultConn);
16186 16187
    }

D
Daniel P. Berrange 已提交
16188 16189
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
16190
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
16191
    }
16192

D
Daniel P. Berrange 已提交
16193 16194
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
16195
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
16196
    }
16197

K
Karel Zak 已提交
16198
    if (!ctl->imode) {
16199
        ret = vshCommandRun(ctl, ctl->cmd);
16200
    } else {
K
Karel Zak 已提交
16201 16202
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
16203
            vshPrint(ctl,
16204
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
16205
                     progname);
J
Jim Meyering 已提交
16206
            vshPrint(ctl, "%s",
16207
                     _("Type:  'help' for help with commands\n"
16208
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
16209
        }
16210 16211 16212 16213 16214 16215

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
16216
        do {
16217
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
16218
            ctl->cmdstr =
16219
                vshReadline(ctl, prompt);
16220 16221
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
16222
            if (*ctl->cmdstr) {
16223
#if USE_READLINE
K
Karel Zak 已提交
16224
                add_history(ctl->cmdstr);
16225
#endif
16226
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
16227 16228
                    vshCommandRun(ctl, ctl->cmd);
            }
16229
            VIR_FREE(ctl->cmdstr);
16230
        } while (ctl->imode);
K
Karel Zak 已提交
16231

16232 16233
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
16234
    }
16235

K
Karel Zak 已提交
16236 16237
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
16238
}