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

13
#include <config.h>
14

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

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

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

46
#include "internal.h"
47
#include "virterror_internal.h"
48
#include "base64.h"
49
#include "buf.h"
50
#include "console.h"
51
#include "util.h"
52
#include "memory.h"
53
#include "xml.h"
54
#include "libvirt/libvirt-qemu.h"
E
Eric Blake 已提交
55
#include "virfile.h"
56
#include "event_poll.h"
57
#include "configmake.h"
58
#include "threads.h"
E
Eric Blake 已提交
59
#include "command.h"
60
#include "count-one-bits.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 70 71 72 73 74
#define VSH_PROMPT_RW    "virsh # "
#define VSH_PROMPT_RO    "virsh > "

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

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

J
Jiri Denemark 已提交
102 103
#define VSH_DEBUG_DEFAULT VSH_ERR_ERROR

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

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

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
/*
 * 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 已提交
151 152 153
/*
 * Command Option Flags
 */
E
Eric Blake 已提交
154 155 156 157
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 已提交
158
    VSH_OFLAG_REQ_OPT  = (1 << 2), /* --optionname required */
E
Eric Blake 已提交
159
};
K
Karel Zak 已提交
160 161 162 163 164 165

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

/*
E
Eric Blake 已提交
166 167 168 169 170
 * 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 已提交
171
 */
172
typedef struct {
E
Eric Blake 已提交
173 174
    const char *name;           /* name of information, or NULL for list end */
    const char *data;           /* non-NULL information */
K
Karel Zak 已提交
175 176 177 178 179
} vshCmdInfo;

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

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

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

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

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

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

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

255
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
256

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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;

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

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

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

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

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

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

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

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

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

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

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

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

K
Karel Zak 已提交
612 613 614 615 616 617
/* ---------------
 * Commands
 * ---------------
 */

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

625
    {NULL, NULL}
K
Karel Zak 已提交
626 627
};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

768 769
#ifndef WIN32

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

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

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

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

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

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

 cleanup:
808

809 810 811
    return ret;
}

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

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

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

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

830
    ret = cmdRunConsole(ctl, dom, name);
831

832
cleanup:
833 834 835 836
    virDomainFree(dom);
    return ret;
}

837 838 839
#endif /* WIN32 */


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

849
static const vshCmdOptDef opts_list[] = {
850 851
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
852 853 854
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
855

E
Eric Blake 已提交
856
static bool
857
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
858
{
859 860 861 862
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
863
    char **names = NULL;
864 865
    int maxname = 0;
    inactive |= all;
K
Karel Zak 已提交
866

867
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
868
        return false;
869

870
    if (active) {
871 872
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
873
            vshError(ctl, "%s", _("Failed to list active domains"));
E
Eric Blake 已提交
874
            return false;
875 876 877 878 879
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
880
                vshError(ctl, "%s", _("Failed to list active domains"));
881
                VIR_FREE(ids);
E
Eric Blake 已提交
882
                return false;
883 884
            }

885
            qsort(&ids[0], maxid, sizeof(int), idsorter);
886
        }
887 888
    }
    if (inactive) {
889 890
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
891
            vshError(ctl, "%s", _("Failed to list inactive domains"));
892
            VIR_FREE(ids);
E
Eric Blake 已提交
893
            return false;
894
        }
895 896 897 898
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
899
                vshError(ctl, "%s", _("Failed to list inactive domains"));
900 901
                VIR_FREE(ids);
                VIR_FREE(names);
E
Eric Blake 已提交
902
                return false;
903
            }
904

905
            qsort(&names[0], maxname, sizeof(char*), namesorter);
906
        }
907
    }
908
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
909
    vshPrintExtra(ctl, "----------------------------------\n");
910 911

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

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

K
Karel Zak 已提交
918
        vshPrint(ctl, "%3d %-20s %s\n",
919 920
                 virDomainGetID(dom),
                 virDomainGetName(dom),
921
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
922
        virDomainFree(dom);
K
Karel Zak 已提交
923
    }
924 925 926 927
    for (i = 0; i < maxname; i++) {
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);

        /* this kind of work with domains is not atomic operation */
928
        if (!dom) {
929
            VIR_FREE(names[i]);
930
            continue;
931
        }
932

933 934 935 936
        vshPrint(ctl, "%3s %-20s %s\n",
                 "-",
                 names[i],
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
937

938
        virDomainFree(dom);
939
        VIR_FREE(names[i]);
940
    }
941 942
    VIR_FREE(ids);
    VIR_FREE(names);
E
Eric Blake 已提交
943
    return true;
K
Karel Zak 已提交
944 945 946
}

/*
K
Karel Zak 已提交
947
 * "domstate" command
K
Karel Zak 已提交
948
 */
949
static const vshCmdInfo info_domstate[] = {
950 951
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
952
    {NULL, NULL}
K
Karel Zak 已提交
953 954
};

955
static const vshCmdOptDef opts_domstate[] = {
956
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
957
    {"reason", VSH_OT_BOOL, 0, N_("also print reason for the state")},
958
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
959 960
};

E
Eric Blake 已提交
961
static bool
962
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
963
{
K
Karel Zak 已提交
964
    virDomainPtr dom;
E
Eric Blake 已提交
965
    bool ret = true;
966 967
    int showReason = vshCommandOptBool(cmd, "reason");
    int state, reason;
968

969
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
970
        return false;
971

J
Jim Meyering 已提交
972
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
973
        return false;
974

975
    if ((state = vshDomainState(ctl, dom, &reason)) < 0) {
E
Eric Blake 已提交
976
        ret = false;
977 978 979 980 981 982 983 984 985 986 987
        goto cleanup;
    }

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

989
cleanup:
990 991 992 993
    virDomainFree(dom);
    return ret;
}

994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
/*
 * "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;
}

1041 1042
/* "domblkstat" command
 */
1043
static const vshCmdInfo info_domblkstat[] = {
1044 1045
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
1046 1047 1048
    {NULL,NULL}
};

1049
static const vshCmdOptDef opts_domblkstat[] = {
1050 1051
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
1052 1053 1054
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1055
static bool
1056
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
1057 1058
{
    virDomainPtr dom;
1059
    const char *name = NULL, *device = NULL;
1060 1061
    struct _virDomainBlockStats stats;

1062
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1063
        return false;
1064

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

1068
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
L
Laine Stump 已提交
1069
        virDomainFree(dom);
E
Eric Blake 已提交
1070
        return false;
L
Laine Stump 已提交
1071
    }
1072 1073

    if (virDomainBlockStats (dom, device, &stats, sizeof stats) == -1) {
1074
        vshError(ctl, _("Failed to get block stats %s %s"), name, device);
1075
        virDomainFree(dom);
E
Eric Blake 已提交
1076
        return false;
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
    }

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

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

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

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

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

    virDomainFree(dom);
E
Eric Blake 已提交
1095
    return true;
1096 1097 1098 1099
}

/* "domifstat" command
 */
1100
static const vshCmdInfo info_domifstat[] = {
1101 1102
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1103 1104 1105
    {NULL,NULL}
};

1106
static const vshCmdOptDef opts_domifstat[] = {
1107 1108
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1109 1110 1111
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1112
static bool
1113
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1114 1115
{
    virDomainPtr dom;
1116
    const char *name = NULL, *device = NULL;
1117 1118
    struct _virDomainInterfaceStats stats;

1119
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1120
        return false;
1121

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

1125
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1126
        virDomainFree(dom);
E
Eric Blake 已提交
1127
        return false;
L
Laine Stump 已提交
1128
    }
1129 1130

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1131
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1132
        virDomainFree(dom);
E
Eric Blake 已提交
1133
        return false;
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
    }

    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 已提交
1161
    return true;
1162 1163
}

1164 1165 1166
/*
 * "dommemstats" command
 */
1167
static const vshCmdInfo info_dommemstat[] = {
1168 1169
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1170 1171 1172
    {NULL,NULL}
};

1173
static const vshCmdOptDef opts_dommemstat[] = {
1174
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1175 1176 1177
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1178
static bool
1179
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1180 1181
{
    virDomainPtr dom;
1182
    const char *name;
1183 1184 1185
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1186
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1187
        return false;
1188 1189

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1190
        return false;
1191 1192 1193 1194 1195

    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 已提交
1196
        return false;
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
    }

    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);
1212 1213
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON)
            vshPrint (ctl, "actual %llu\n", stats[i].val);
1214 1215 1216
    }

    virDomainFree(dom);
E
Eric Blake 已提交
1217
    return true;
1218 1219
}

1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
/*
 * "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 已提交
1235
static bool
1236 1237 1238 1239
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1240
    bool ret = true;
1241
    const char *device = NULL;
1242

1243
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1244
        return false;
1245 1246

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

1249
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1250
        virDomainFree(dom);
E
Eric Blake 已提交
1251
        return false;
1252 1253 1254 1255
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1256
        return false;
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
    }

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

1267 1268 1269
/*
 * "suspend" command
 */
1270
static const vshCmdInfo info_suspend[] = {
1271 1272
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1273
    {NULL, NULL}
1274 1275
};

1276
static const vshCmdOptDef opts_suspend[] = {
1277
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1278
    {NULL, 0, 0, NULL}
1279 1280
};

E
Eric Blake 已提交
1281
static bool
1282
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1283
{
1284
    virDomainPtr dom;
1285
    const char *name;
E
Eric Blake 已提交
1286
    bool ret = true;
1287

1288
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1289
        return false;
1290

J
Jim Meyering 已提交
1291
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1292
        return false;
1293 1294

    if (virDomainSuspend(dom) == 0) {
1295
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1296
    } else {
1297
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1298
        ret = false;
1299
    }
1300

1301 1302 1303 1304
    virDomainFree(dom);
    return ret;
}

1305 1306 1307
/*
 * "create" command
 */
1308
static const vshCmdInfo info_create[] = {
1309 1310
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1311 1312 1313
    {NULL, NULL}
};

1314
static const vshCmdOptDef opts_create[] = {
1315
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1316
#ifndef WIN32
1317
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1318
#endif
1319
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1320
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1321 1322 1323
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1324
static bool
1325
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1326 1327
{
    virDomainPtr dom;
1328
    const char *from = NULL;
E
Eric Blake 已提交
1329
    bool ret = true;
1330
    char *buffer;
1331
#ifndef WIN32
1332
    int console = vshCommandOptBool(cmd, "console");
1333
#endif
1334
    unsigned int flags = VIR_DOMAIN_NONE;
1335

1336
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1337
        return false;
1338

1339
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1340
        return false;
1341

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

1345 1346
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1347 1348
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1349 1350

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1351
    VIR_FREE(buffer);
1352

1353
    if (dom != NULL) {
1354
        vshPrint(ctl, _("Domain %s created from %s\n"),
1355
                 virDomainGetName(dom), from);
1356
#ifndef WIN32
1357
        if (console)
1358
            cmdRunConsole(ctl, dom, NULL);
1359
#endif
1360
        virDomainFree(dom);
1361
    } else {
1362
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1363
        ret = false;
1364 1365 1366 1367
    }
    return ret;
}

1368 1369 1370
/*
 * "define" command
 */
1371
static const vshCmdInfo info_define[] = {
1372 1373
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1374 1375 1376
    {NULL, NULL}
};

1377
static const vshCmdOptDef opts_define[] = {
1378
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1379 1380 1381
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1382
static bool
1383
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1384 1385
{
    virDomainPtr dom;
1386
    const char *from = NULL;
E
Eric Blake 已提交
1387
    bool ret = true;
1388
    char *buffer;
1389

1390
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1391
        return false;
1392

1393
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1394
        return false;
1395

1396
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1397
        return false;
1398 1399

    dom = virDomainDefineXML(ctl->conn, buffer);
1400
    VIR_FREE(buffer);
1401

1402
    if (dom != NULL) {
1403
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1404
                 virDomainGetName(dom), from);
1405
        virDomainFree(dom);
1406
    } else {
1407
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1408
        ret = false;
1409 1410 1411 1412 1413 1414 1415
    }
    return ret;
}

/*
 * "undefine" command
 */
1416
static const vshCmdInfo info_undefine[] = {
1417 1418
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1419 1420 1421
    {NULL, NULL}
};

1422
static const vshCmdOptDef opts_undefine[] = {
1423
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1424
    {"managed-save", VSH_OT_BOOL, 0, N_("remove domain managed state file")},
1425 1426 1427
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1428
static bool
1429
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1430 1431
{
    virDomainPtr dom;
E
Eric Blake 已提交
1432
    bool ret = true;
1433
    const char *name = NULL;
1434
    int id;
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
    int flags = 0;
    int managed_save = vshCommandOptBool(cmd, "managed-save");
    int has_managed_save = 0;
    int rc = -1;

    if (managed_save)
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;

    if (!managed_save)
        flags = -1;
1445

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

1449
    if (vshCommandOptString(cmd, "domain", &name) <= 0)
E
Eric Blake 已提交
1450
        return false;
1451 1452 1453

    if (name && virStrToLong_i(name, NULL, 10, &id) == 0
        && id >= 0 && (dom = virDomainLookupByID(ctl->conn, id))) {
1454 1455 1456 1457 1458
        vshError(ctl,
                 _("a running domain like %s cannot be undefined;\n"
                   "to undefine, first shutdown then undefine"
                   " using its name or UUID"),
                 name);
1459
        virDomainFree(dom);
E
Eric Blake 已提交
1460
        return false;
1461
    }
J
Jim Meyering 已提交
1462
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
1463
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
1464
        return false;
1465

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

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

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

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

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

            rc = virDomainUndefine(dom);
        }
    }

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

1521
    virDomainFree(dom);
1522 1523 1524 1525 1526 1527 1528
    return ret;
}


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

1537
static const vshCmdOptDef opts_start[] = {
1538
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1539
#ifndef WIN32
1540
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1541
#endif
E
Eric Blake 已提交
1542
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1543
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1544 1545 1546
    {NULL, 0, 0, NULL}
};

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

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

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

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

E
Eric Blake 已提交
1570 1571
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1572 1573
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
E
Eric Blake 已提交
1574 1575 1576 1577

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

1592 1593 1594
/*
 * "save" command
 */
1595
static const vshCmdInfo info_save[] = {
1596
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
1597
    {"desc", N_("Save the RAM state of a running domain.")},
1598
    {NULL, NULL}
1599 1600
};

1601
static const vshCmdOptDef opts_save[] = {
1602 1603
    {"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")},
1604
    {NULL, 0, 0, NULL}
1605 1606
};

E
Eric Blake 已提交
1607
static bool
1608
cmdSave(vshControl *ctl, const vshCmd *cmd)
1609
{
1610
    virDomainPtr dom;
1611 1612
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1613
    bool ret = true;
1614

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

1618
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1619
        return false;
1620

J
Jim Meyering 已提交
1621
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1622
        return false;
1623 1624

    if (virDomainSave(dom, to) == 0) {
1625
        vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
1626
    } else {
1627
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
E
Eric Blake 已提交
1628
        ret = false;
1629
    }
1630

1631 1632 1633 1634
    virDomainFree(dom);
    return ret;
}

1635 1636 1637 1638 1639
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1640 1641 1642 1643
    {"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.")},
1644 1645 1646 1647 1648 1649 1650 1651
    {NULL, NULL}
};

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

E
Eric Blake 已提交
1652
static bool
1653 1654 1655
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1656
    const char *name;
E
Eric Blake 已提交
1657
    bool ret = true;
1658

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1663
        return false;
1664 1665 1666 1667 1668

    if (virDomainManagedSave(dom, 0) == 0) {
        vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    } else {
        vshError(ctl, _("Failed to save domain %s state"), name);
E
Eric Blake 已提交
1669
        ret = false;
1670 1671 1672 1673 1674 1675
    }

    virDomainFree(dom);
    return ret;
}

1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689
/*
 * "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 已提交
1690
static bool
1691 1692 1693
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1694
    const char *name;
E
Eric Blake 已提交
1695
    bool ret = false;
1696 1697
    int hassave;

1698
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1699
        return false;
1700 1701

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1702
        return false;
1703 1704 1705

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1706
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722
        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 已提交
1723
    ret = true;
1724 1725 1726 1727 1728 1729

cleanup:
    virDomainFree(dom);
    return ret;
}

1730 1731 1732
/*
 * "schedinfo" command
 */
1733
static const vshCmdInfo info_schedinfo[] = {
1734 1735
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1736 1737 1738
    {NULL, NULL}
};

1739
static const vshCmdOptDef opts_schedinfo[] = {
1740 1741 1742 1743
    {"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")},
1744 1745 1746
    {"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")},
1747 1748 1749
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
1750
static int
1751
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
1752
                   virTypedParameterPtr param)
1753
{
1754
    const char *data = NULL;
1755 1756 1757

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
1758
        param->type == VIR_TYPED_PARAM_UINT &&
1759 1760
        vshCommandOptBool(cmd, "weight")) {
        int val;
1761
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
1762
            vshError(ctl, "%s", _("Invalid value of weight"));
1763
            return -1;
1764
        } else {
1765
            param->value.ui = val;
1766
        }
1767
        return 1;
1768 1769
    }

1770 1771
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
1772
        param->type == VIR_TYPED_PARAM_UINT &&
1773 1774
        vshCommandOptBool(cmd, "cap")) {
        int val;
1775
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
1776
            vshError(ctl, "%s", _("Invalid value of cap"));
1777
            return -1;
1778
        } else {
1779
            param->value.ui = val;
1780
        }
1781
        return 1;
1782
    }
1783

1784
    if (vshCommandOptString(cmd, "set", &data) > 0) {
1785 1786 1787
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
1788
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
1789
            return -1;
1790
        }
1791 1792 1793 1794 1795 1796 1797 1798 1799
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
1800
        case VIR_TYPED_PARAM_INT:
1801
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
1802
                vshError(ctl, "%s",
1803 1804 1805 1806
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
1807
        case VIR_TYPED_PARAM_UINT:
1808
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
1809
                vshError(ctl, "%s",
1810 1811 1812 1813
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
1814
        case VIR_TYPED_PARAM_LLONG:
1815
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
1816
                vshError(ctl, "%s",
J
Jim Meyering 已提交
1817
                         _("Invalid value for parameter, expecting a long long"));
1818 1819 1820
                return -1;
            }
            break;
1821
        case VIR_TYPED_PARAM_ULLONG:
1822
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
1823
                vshError(ctl, "%s",
1824 1825 1826 1827
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
1828
        case VIR_TYPED_PARAM_DOUBLE:
1829
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
1830
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
1831 1832 1833
                return -1;
            }
            break;
1834
        case VIR_TYPED_PARAM_BOOLEAN:
1835
            param->value.b = STREQ(val, "0") ? 0 : 1;
1836
        }
1837
        return 1;
1838
    }
1839

1840 1841
    return 0;
}
1842

1843

E
Eric Blake 已提交
1844
static bool
1845 1846 1847 1848
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
1849
    virTypedParameterPtr params = NULL;
1850 1851 1852
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
1853
    bool ret_val = false;
1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
    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;
        }
1864
        flags = VIR_DOMAIN_AFFECT_CURRENT;
1865 1866
    } else {
        if (config)
1867
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
1868
        if (live)
1869
            flags |= VIR_DOMAIN_AFFECT_LIVE;
1870
    }
1871

1872
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1873
        return false;
1874

1875
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
1876
        return false;
1877 1878 1879

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
1880
    if (schedulertype != NULL) {
1881
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
1882
             schedulertype);
1883
        VIR_FREE(schedulertype);
1884
    } else {
1885
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
1886
        goto cleanup;
1887 1888
    }

1889
    if (nparams) {
1890
        params = vshMalloc(ctl, sizeof(*params) * nparams);
1891

1892
        memset(params, 0, sizeof(*params) * nparams);
1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903
        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);
        }
1904 1905 1906 1907
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
1908
        for (i = 0; i < nparams; i++) {
1909 1910 1911 1912 1913 1914 1915 1916 1917 1918
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
1919 1920 1921 1922 1923
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
1924 1925 1926
            if (ret == -1)
                goto cleanup;

1927 1928 1929 1930 1931 1932 1933
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
1934 1935
            if (ret == -1)
                goto cleanup;
1936 1937 1938 1939
        } 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.  */
1940 1941
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
1942 1943 1944 1945
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
1946 1947 1948 1949 1950 1951
            /* 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;
            }
1952 1953
        }

E
Eric Blake 已提交
1954
        ret_val = true;
1955
        for (i = 0; i < nparams; i++) {
1956
            switch (params[i].type) {
1957
            case VIR_TYPED_PARAM_INT:
1958
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1959
                 break;
1960
            case VIR_TYPED_PARAM_UINT:
1961
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1962
                 break;
1963
            case VIR_TYPED_PARAM_LLONG:
1964
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1965
                 break;
1966
            case VIR_TYPED_PARAM_ULLONG:
1967
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1968
                 break;
1969
            case VIR_TYPED_PARAM_DOUBLE:
1970
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1971
                 break;
1972
            case VIR_TYPED_PARAM_BOOLEAN:
1973
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
1974 1975
                 break;
            default:
1976
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
1977 1978 1979
            }
        }
    }
1980

1981
 cleanup:
1982
    VIR_FREE(params);
1983
    virDomainFree(dom);
1984
    return ret_val;
1985 1986
}

1987 1988 1989
/*
 * "restore" command
 */
1990
static const vshCmdInfo info_restore[] = {
1991 1992
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
1993
    {NULL, NULL}
1994 1995
};

1996
static const vshCmdOptDef opts_restore[] = {
1997
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
1998
    {NULL, 0, 0, NULL}
1999 2000
};

E
Eric Blake 已提交
2001
static bool
2002
cmdRestore(vshControl *ctl, const vshCmd *cmd)
2003
{
2004
    const char *from = NULL;
E
Eric Blake 已提交
2005
    bool ret = true;
2006

2007
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2008
        return false;
2009

2010
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2011
        return false;
2012 2013

    if (virDomainRestore(ctl->conn, from) == 0) {
2014
        vshPrint(ctl, _("Domain restored from %s\n"), from);
2015
    } else {
2016
        vshError(ctl, _("Failed to restore domain from %s"), from);
E
Eric Blake 已提交
2017
        ret = false;
2018 2019 2020 2021
    }
    return ret;
}

D
Daniel Veillard 已提交
2022 2023 2024
/*
 * "dump" command
 */
2025
static const vshCmdInfo info_dump[] = {
2026 2027
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
2028 2029 2030
    {NULL, NULL}
};

2031
static const vshCmdOptDef opts_dump[] = {
2032 2033 2034 2035
    {"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")},
    {"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 已提交
2036 2037 2038
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2039
static bool
2040
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
2041 2042
{
    virDomainPtr dom;
2043 2044
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
2045
    bool ret = true;
2046
    int flags = 0;
D
Daniel Veillard 已提交
2047

2048
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2049
        return false;
D
Daniel Veillard 已提交
2050

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

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

P
Paolo Bonzini 已提交
2057 2058
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
2059 2060 2061 2062
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;

    if (virDomainCoreDump(dom, to, flags) == 0) {
2063
        vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
D
Daniel Veillard 已提交
2064
    } else {
2065
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
E
Eric Blake 已提交
2066
        ret = false;
D
Daniel Veillard 已提交
2067 2068 2069 2070 2071 2072
    }

    virDomainFree(dom);
    return ret;
}

2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 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 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219
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;
}

2220 2221 2222
/*
 * "resume" command
 */
2223
static const vshCmdInfo info_resume[] = {
2224 2225
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
2226
    {NULL, NULL}
2227 2228
};

2229
static const vshCmdOptDef opts_resume[] = {
2230
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2231
    {NULL, 0, 0, NULL}
2232 2233
};

E
Eric Blake 已提交
2234
static bool
2235
cmdResume(vshControl *ctl, const vshCmd *cmd)
2236
{
2237
    virDomainPtr dom;
E
Eric Blake 已提交
2238
    bool ret = true;
2239
    const char *name;
2240

2241
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2242
        return false;
2243

J
Jim Meyering 已提交
2244
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2245
        return false;
2246 2247

    if (virDomainResume(dom) == 0) {
2248
        vshPrint(ctl, _("Domain %s resumed\n"), name);
2249
    } else {
2250
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
2251
        ret = false;
2252
    }
2253

2254 2255 2256 2257
    virDomainFree(dom);
    return ret;
}

2258 2259 2260
/*
 * "shutdown" command
 */
2261
static const vshCmdInfo info_shutdown[] = {
2262 2263
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
2264
    {NULL, NULL}
2265 2266
};

2267
static const vshCmdOptDef opts_shutdown[] = {
2268
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2269
    {NULL, 0, 0, NULL}
2270 2271
};

E
Eric Blake 已提交
2272
static bool
2273
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
2274
{
2275
    virDomainPtr dom;
E
Eric Blake 已提交
2276
    bool ret = true;
2277
    const char *name;
2278

2279
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2280
        return false;
2281

J
Jim Meyering 已提交
2282
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2283
        return false;
2284 2285

    if (virDomainShutdown(dom) == 0) {
2286
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
2287
    } else {
2288
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
2289
        ret = false;
2290
    }
2291

2292 2293 2294 2295
    virDomainFree(dom);
    return ret;
}

2296 2297 2298
/*
 * "reboot" command
 */
2299
static const vshCmdInfo info_reboot[] = {
2300 2301
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
2302 2303 2304
    {NULL, NULL}
};

2305
static const vshCmdOptDef opts_reboot[] = {
2306
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2307 2308 2309
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2310
static bool
2311
cmdReboot(vshControl *ctl, const vshCmd *cmd)
2312 2313
{
    virDomainPtr dom;
E
Eric Blake 已提交
2314
    bool ret = true;
2315
    const char *name;
2316

2317
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2318
        return false;
2319

J
Jim Meyering 已提交
2320
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2321
        return false;
2322 2323

    if (virDomainReboot(dom, 0) == 0) {
2324
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
2325
    } else {
2326
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
2327
        ret = false;
2328 2329 2330 2331 2332 2333
    }

    virDomainFree(dom);
    return ret;
}

2334 2335 2336
/*
 * "destroy" command
 */
2337
static const vshCmdInfo info_destroy[] = {
2338 2339 2340
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
2341
    {NULL, NULL}
2342 2343
};

2344
static const vshCmdOptDef opts_destroy[] = {
2345
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2346
    {NULL, 0, 0, NULL}
2347 2348
};

E
Eric Blake 已提交
2349
static bool
2350
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2351
{
2352
    virDomainPtr dom;
E
Eric Blake 已提交
2353
    bool ret = true;
2354
    const char *name;
2355

2356
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2357
        return false;
2358

J
Jim Meyering 已提交
2359
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2360
        return false;
2361 2362

    if (virDomainDestroy(dom) == 0) {
2363
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2364
    } else {
2365
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
2366
        ret = false;
2367
    }
2368

2369
    virDomainFree(dom);
K
Karel Zak 已提交
2370 2371 2372 2373
    return ret;
}

/*
2374
 * "dominfo" command
K
Karel Zak 已提交
2375
 */
2376
static const vshCmdInfo info_dominfo[] = {
2377 2378
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2379
    {NULL, NULL}
K
Karel Zak 已提交
2380 2381
};

2382
static const vshCmdOptDef opts_dominfo[] = {
2383
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2384
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2385 2386
};

E
Eric Blake 已提交
2387
static bool
2388
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2389
{
K
Karel Zak 已提交
2390 2391
    virDomainInfo info;
    virDomainPtr dom;
2392
    virSecurityModel secmodel;
2393
    virSecurityLabelPtr seclabel;
2394
    int persistent = 0;
E
Eric Blake 已提交
2395 2396
    bool ret = true;
    int autostart;
2397
    unsigned int id;
2398
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2399
    int has_managed_save = 0;
2400

2401
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2402
        return false;
K
Karel Zak 已提交
2403

J
Jim Meyering 已提交
2404
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2405
        return false;
2406

2407 2408
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2409
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2410
    else
2411
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2412 2413
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2414
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2415
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2416 2417

    if ((str = virDomainGetOSType(dom))) {
2418
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2419
        VIR_FREE(str);
2420 2421 2422
    }

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

2426
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2427 2428

        if (info.cpuTime != 0) {
2429
            double cpuUsed = info.cpuTime;
2430

2431
            cpuUsed /= 1000000000.0;
2432

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

2436 2437
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2438
                 info.maxMem);
2439
        else
2440
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2441 2442
                 _("no limit"));

2443
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2444 2445
                 info.memory);

K
Karel Zak 已提交
2446
    } else {
E
Eric Blake 已提交
2447
        ret = false;
K
Karel Zak 已提交
2448
    }
2449

2450 2451
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
2452 2453
    vshDebug(ctl, VSH_ERR_DEBUG, "Domain persistent flag value: %d\n",
             persistent);
2454 2455 2456 2457 2458 2459
    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 */
2460
    if (!virDomainGetAutostart(dom, &autostart)) {
2461
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2462 2463 2464
                 autostart ? _("enable") : _("disable") );
    }

2465 2466 2467 2468 2469 2470 2471
    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"));

2472 2473 2474
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2475 2476
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
2477
            return false;
2478 2479 2480
        } else {
            virFreeError(last_error);
            last_error = NULL;
2481
        }
2482 2483 2484 2485 2486 2487 2488
    } 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 */
2489
            if (VIR_ALLOC(seclabel) < 0) {
2490
                virDomainFree(dom);
E
Eric Blake 已提交
2491
                return false;
2492 2493 2494 2495 2496
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
2497
                return false;
2498
            } else {
2499
                if (seclabel->label[0] != '\0')
2500
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
2501
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
2502
            }
2503 2504

            VIR_FREE(seclabel);
2505 2506
        }
    }
2507
    virDomainFree(dom);
K
Karel Zak 已提交
2508 2509 2510
    return ret;
}

2511 2512 2513 2514
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2515 2516
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2517 2518 2519 2520
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2521
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2522 2523 2524 2525
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
2526
static bool
2527 2528 2529 2530
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
2531
    bool ret = true;
2532

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2537
        return false;
2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563

    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 已提交
2564
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2565
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2566
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2567
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2568
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2569 2570 2571
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2572
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2573
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2574
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2575
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2576
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2577 2578 2579
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2580
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2581
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2582
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2583
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2584
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2585 2586
        }
    } else {
E
Eric Blake 已提交
2587
        ret = false;
2588 2589 2590 2591 2592 2593
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2594 2595 2596 2597
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2598 2599
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2600 2601 2602 2603
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2604
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2605 2606 2607
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2608
static bool
2609 2610 2611
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2612
    bool ret = true;
2613

2614
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2615
        return false;
2616 2617

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
2621
        ret = false;
2622 2623 2624 2625 2626

    virDomainFree(dom);
    return ret;
}

2627 2628 2629
/*
 * "freecell" command
 */
2630
static const vshCmdInfo info_freecell[] = {
2631 2632
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2633 2634 2635
    {NULL, NULL}
};

2636
static const vshCmdOptDef opts_freecell[] = {
2637
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2638
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
2639 2640 2641
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2642
static bool
2643
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2644
{
W
Wen Congyang 已提交
2645
    bool func_ret = false;
2646
    int ret;
2647
    int cell = -1, cell_given;
2648
    unsigned long long memory;
2649 2650 2651 2652
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
2653
    int all_given;
2654 2655 2656 2657
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
2658

2659

2660
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2661
        return false;
2662

2663 2664 2665 2666
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
2667 2668 2669 2670 2671 2672 2673 2674 2675
    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) {
2676 2677 2678
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2679 2680 2681
            goto cleanup;
        }

2682 2683 2684
        xml = xmlReadDoc((const xmlChar *) cap_xml, "node.xml", NULL,
                          XML_PARSE_NOENT | XML_PARSE_NONET |
                          XML_PARSE_NOWARNING);
2685

2686 2687
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2688 2689 2690
            goto cleanup;
        }

2691 2692 2693 2694 2695
        ctxt = xmlXPathNewContext(xml);
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
2696
            vshError(ctl, "%s", _("could not get information about "
2697
                                  "NUMA topology"));
2698 2699 2700
            goto cleanup;
        }

2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721
        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;
            }
        }

2722
        memory = 0;
2723 2724 2725 2726
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
2727 2728 2729 2730
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
2731
    } else {
2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745
        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));
2746 2747
    }

E
Eric Blake 已提交
2748
    func_ret = true;
2749

2750
cleanup:
2751 2752 2753
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
2754
    VIR_FREE(nodes);
2755 2756 2757
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
2758
    return func_ret;
2759 2760
}

E
Eric Blake 已提交
2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774
/*
 * "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 已提交
2775
static bool
E
Eric Blake 已提交
2776 2777
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
2778
    const char *type = NULL;
E
Eric Blake 已提交
2779 2780
    int vcpus;

2781 2782
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
2783
        return false;
2784
    }
E
Eric Blake 已提交
2785 2786

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

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

E
Eric Blake 已提交
2794
    return true;
E
Eric Blake 已提交
2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814
}

/*
 * "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")},
    {"current", VSH_OT_BOOL, 0, N_("get current vcpu usage")},
    {"config", VSH_OT_BOOL, 0, N_("get value to be used on next boot")},
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2815
static bool
E
Eric Blake 已提交
2816 2817 2818
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2819
    bool ret = true;
E
Eric Blake 已提交
2820 2821 2822 2823 2824 2825 2826 2827 2828 2829
    int maximum = vshCommandOptBool(cmd, "maximum");
    int current = vshCommandOptBool(cmd, "current");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    bool all = maximum + current + config + live == 0;
    int count;

    if (maximum && current) {
        vshError(ctl, "%s",
                 _("--maximum and --current cannot both be specified"));
E
Eric Blake 已提交
2830
        return false;
E
Eric Blake 已提交
2831 2832 2833 2834
    }
    if (config && live) {
        vshError(ctl, "%s",
                 _("--config and --live cannot both be specified"));
E
Eric Blake 已提交
2835
        return false;
E
Eric Blake 已提交
2836 2837 2838 2839 2840 2841 2842 2843 2844 2845
    }
    /* We want one of each pair of mutually exclusive options; that
     * is, use of flags requires exactly two options.  */
    if (maximum + current + config + live == 1) {
        vshError(ctl,
                 _("when using --%s, either --%s or --%s must be specified"),
                 (maximum ? "maximum" : current ? "current"
                  : config ? "config" : "live"),
                 maximum + current ? "config" : "maximum",
                 maximum + current ? "live" : "current");
E
Eric Blake 已提交
2846
        return false;
E
Eric Blake 已提交
2847 2848 2849
    }

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

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

    /* In all cases, try the new API first; if it fails because we are
     * talking to an older client, try a fallback API before giving
     * up.  */
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
2860
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
2861 2862 2863 2864 2865 2866 2867 2868 2869
        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;
            }
2870 2871
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
2872 2873 2874 2875 2876
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2877
            ret = false;
E
Eric Blake 已提交
2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889
        } 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 |
2890
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
2891 2892 2893 2894 2895 2896 2897
        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 已提交
2898
            ret = false;
E
Eric Blake 已提交
2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    if (all || (current && config)) {
2910
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934
        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 已提交
2935
            ret = false;
E
Eric Blake 已提交
2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    if (all || (current && live)) {
2947
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
2948 2949 2950 2951 2952 2953 2954 2955 2956
        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 已提交
2957
            ret = false;
E
Eric Blake 已提交
2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971
        } 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;
}

2972 2973 2974
/*
 * "vcpuinfo" command
 */
2975
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
2976
    {"help", N_("detailed domain vcpu information")},
2977
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
2978 2979 2980
    {NULL, NULL}
};

2981
static const vshCmdOptDef opts_vcpuinfo[] = {
2982
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2983 2984 2985
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2986
static bool
2987
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
2988 2989 2990 2991 2992
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
2993 2994
    unsigned char *cpumaps;
    int ncpus, maxcpu;
2995
    size_t cpumaplen;
E
Eric Blake 已提交
2996
    bool ret = true;
2997
    int n, m;
2998

2999
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3000
        return false;
3001

J
Jim Meyering 已提交
3002
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3003
        return false;
3004 3005 3006

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3007
        return false;
3008 3009 3010 3011
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3012
        return false;
3013 3014
    }

3015
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
3016 3017 3018
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
3019

3020 3021
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
3022
                                   cpumaps, cpumaplen)) >= 0) {
3023 3024 3025 3026
        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 已提交
3027
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
3028 3029 3030 3031 3032 3033 3034 3035
            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:"));
3036 3037
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
3038 3039 3040 3041 3042 3043
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
3044
    } else {
3045
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
3046
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3047 3048 3049
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
3050
            /* fallback plan to use virDomainGetVcpuPinInfo */
3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068

            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;
3069
        }
3070 3071
    }

3072
    VIR_FREE(cpumaps);
3073
    VIR_FREE(cpuinfo);
3074 3075 3076 3077 3078 3079 3080
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
3081
static const vshCmdInfo info_vcpupin[] = {
3082
    {"help", N_("control or query domain vcpu affinity")},
3083
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
3084 3085 3086
    {NULL, NULL}
};

3087
static const vshCmdOptDef opts_vcpupin[] = {
3088
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3089 3090 3091
    {"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")},
3092 3093 3094
    {"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")},
3095 3096 3097
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3098
static bool
E
Eric Blake 已提交
3099
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
3100 3101 3102 3103
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
3104
    int vcpu = -1;
3105
    const char *cpulist = NULL;
E
Eric Blake 已提交
3106
    bool ret = true;
3107 3108
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
3109
    size_t cpumaplen;
3110 3111
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
3112
    bool unuse = false;
3113
    const char *cur;
3114 3115 3116
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
3117
    bool query = false; /* Query mode if no cpulist */
3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134
    int flags = 0;

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

3136
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3137
        return false;
3138

J
Jim Meyering 已提交
3139
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3140
        return false;
3141

3142 3143
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
3144
        virDomainFree(dom);
E
Eric Blake 已提交
3145
        return false;
3146
    }
3147
    query = !cpulist;
3148

3149 3150 3151 3152
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
3153
        virDomainFree(dom);
E
Eric Blake 已提交
3154
        return false;
3155
    }
3156

3157 3158
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3159
        return false;
3160 3161 3162
    }

    if (virDomainGetInfo(dom, &info) != 0) {
3163
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
3164
        virDomainFree(dom);
E
Eric Blake 已提交
3165
        return false;
3166 3167 3168
    }

    if (vcpu >= info.nrVirtCpu) {
3169
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
3170
        virDomainFree(dom);
E
Eric Blake 已提交
3171
        return false;
3172 3173
    }

3174 3175
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
3176

3177 3178 3179 3180 3181 3182 3183 3184
    /* 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 已提交
3185
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230
                                             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);
3231 3232
    /* Parse cpulist */
    cur = cpulist;
3233
    if (*cur == 0) {
3234
        goto parse_error;
3235 3236 3237
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
3238
        cur = "";
3239
    }
3240 3241 3242 3243 3244 3245 3246

    while (*cur != 0) {

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

3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260
        /* 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);
3261

3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288
        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);
        }
3289

3290 3291 3292 3293 3294 3295
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
3296
        } else {
3297
            goto parse_error;
3298
        }
3299
    }
3300

3301 3302 3303 3304 3305 3306 3307 3308
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
3309 3310
    }

3311
cleanup:
3312
    VIR_FREE(cpumap);
3313 3314
    virDomainFree(dom);
    return ret;
3315 3316 3317 3318 3319

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

3322 3323 3324
/*
 * "setvcpus" command
 */
3325
static const vshCmdInfo info_setvcpus[] = {
3326 3327
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
3328 3329 3330
    {NULL, NULL}
};

3331
static const vshCmdOptDef opts_setvcpus[] = {
3332
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3333
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
3334 3335 3336
    {"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")},
3337
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3338 3339 3340
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3341
static bool
3342
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
3343 3344
{
    virDomainPtr dom;
3345
    int count = 0;
E
Eric Blake 已提交
3346
    bool ret = true;
E
Eric Blake 已提交
3347 3348 3349
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367
    int current = vshCommandOptBool(cmd, "current");
    int flags = 0;

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

3369
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3370
        return false;
3371

J
Jim Meyering 已提交
3372
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3373
        return false;
3374

3375 3376 3377 3378
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
3379

3380
    if (flags == -1) {
E
Eric Blake 已提交
3381
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
3382
            ret = false;
E
Eric Blake 已提交
3383 3384
        }
    } else {
3385 3386 3387
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
3388
            vshDebug(ctl, VSH_ERR_DEBUG, "--maximum flag was given\n");
3389

3390 3391
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

3392 3393 3394 3395 3396 3397 3398 3399
            /* 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 已提交
3400
                ret = false;
3401 3402 3403 3404 3405
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
3406
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
3407
            ret = false;
E
Eric Blake 已提交
3408
        }
3409 3410
    }

3411
  cleanup:
3412 3413 3414 3415
    virDomainFree(dom);
    return ret;
}

3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449
/*
 * "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;
}

3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541
/*
 * "send-key" command
 */
static const vshCmdInfo info_send_key[] = {
    {"help", N_("Send keycodes to the guest")},
    {"desc", N_("Send keycodes to the guest, the keycodes must be integers\n"
                "    Examples:\n\n"
                "        virsh # send-key <domain> 37 18 21\n"
                "        virsh # send-key <domain> KEY_RIGHTCTRL KEY_C\n"
                "        virsh # send-key <domain> --codeset xt 37 18 21\n"
                "        virsh # send-key <domain> --holdtime 1000 0x15 18 0xf\n"
                )},
    {NULL, NULL}
};

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT, N_("the codeset of keycodes, default:linux")},
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
                 N_("the time (in millsecond) how long the keys will be held")},
    {"keycode", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("the key code")},
    {NULL, 0, 0, NULL}
};

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

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

    return val;
}

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

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

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

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

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

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

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

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

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

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

cleanup:
    virDomainFree(dom);
    return ret;
}

3542 3543 3544
/*
 * "setmemory" command
 */
3545
static const vshCmdInfo info_setmem[] = {
3546 3547
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
3548 3549 3550
    {NULL, NULL}
};

3551
static const vshCmdOptDef opts_setmem[] = {
3552
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3553
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
3554 3555
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
3556
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3557 3558 3559
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3560
static bool
3561
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
3562 3563
{
    virDomainPtr dom;
3564
    virDomainInfo info;
3565
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
3566
    bool ret = true;
3567 3568
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3569
    int current = vshCommandOptBool(cmd, "current");
3570 3571
    int flags = 0;

3572 3573 3574
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3575
            return false;
3576
        }
3577
        flags = VIR_DOMAIN_AFFECT_CURRENT;
3578 3579
    } else {
        if (config)
3580
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3581
        if (live)
3582
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3583 3584 3585
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
3586
    }
3587

3588
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3589
        return false;
3590

J
Jim Meyering 已提交
3591
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3592
        return false;
3593

3594 3595
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3596
        return false;
3597 3598
    }

3599
    if (kilobytes <= 0) {
3600
        virDomainFree(dom);
3601
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
3602
        return false;
3603 3604
    }

3605 3606
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
3607
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
3608
        return false;
3609 3610 3611 3612
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
3613
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
3614
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
3615
        return false;
3616 3617
    }

3618
    if (flags == -1) {
3619
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
3620
            ret = false;
3621 3622 3623
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
3624
            ret = false;
3625
        }
3626 3627 3628 3629 3630 3631 3632 3633 3634
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
3635
static const vshCmdInfo info_setmaxmem[] = {
3636 3637
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
3638 3639 3640
    {NULL, NULL}
};

3641
static const vshCmdOptDef opts_setmaxmem[] = {
3642
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3643
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
3644 3645 3646
    {"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")},
3647 3648 3649
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3650
static bool
3651
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
3652 3653
{
    virDomainPtr dom;
3654
    int kilobytes = 0;
E
Eric Blake 已提交
3655
    bool ret = true;
3656 3657 3658 3659 3660 3661 3662 3663
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
    int flags = VIR_DOMAIN_MEM_MAXIMUM;

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3664
            return false;
3665 3666 3667
        }
    } else {
        if (config)
3668
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3669
        if (live)
3670
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3671 3672 3673 3674
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
3675

3676
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3677
        return false;
3678

J
Jim Meyering 已提交
3679
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3680
        return false;
3681

3682 3683
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3684
        return false;
3685 3686
    }

3687
    if (kilobytes <= 0) {
3688
        virDomainFree(dom);
3689
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
3690
        return false;
3691 3692
    }

3693 3694 3695
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3696
            ret = false;
3697 3698 3699 3700
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3701
            ret = false;
3702
        }
3703 3704
    }

3705 3706 3707 3708
    virDomainFree(dom);
    return ret;
}

3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724
/*
 * "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 已提交
3725 3726 3727
    {"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")},
3728 3729 3730
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3731
static bool
3732 3733 3734 3735 3736 3737
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
    unsigned int i = 0;
3738
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3739
    bool ret = false;
H
Hu Tao 已提交
3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756
    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;
    }
3757 3758

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3759
        return false;
3760 3761

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3762
        return false;
3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779

    if (vshCommandOptInt(cmd, "weight", &weight) < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

    if (weight) {
        nparams++;
        if (weight < 0) {
            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 已提交
3780
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
3781 3782 3783 3784 3785 3786 3787
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3788
            ret = true;
3789 3790 3791 3792 3793
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
3794
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
3795 3796 3797 3798 3799 3800
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
3801
                case VIR_TYPED_PARAM_INT:
3802 3803 3804
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
3805
                case VIR_TYPED_PARAM_UINT:
3806 3807 3808
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
3809
                case VIR_TYPED_PARAM_LLONG:
3810 3811 3812
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
3813
                case VIR_TYPED_PARAM_ULLONG:
3814 3815 3816
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
3817
                case VIR_TYPED_PARAM_DOUBLE:
3818 3819 3820
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
3821
                case VIR_TYPED_PARAM_BOOLEAN:
3822 3823 3824 3825 3826 3827 3828 3829
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
3830
        ret = true;
3831 3832 3833 3834 3835 3836
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
3837
            temp->type = VIR_TYPED_PARAM_UINT;
3838 3839 3840 3841 3842 3843 3844 3845

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
H
Hu Tao 已提交
3846
        if (virDomainSetBlkioParameters(dom, params, nparams, flags) != 0)
3847 3848
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
3849
            ret = true;
3850 3851 3852 3853 3854 3855 3856 3857
    }

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

3858 3859 3860 3861
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
3862 3863 3864
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
3865 3866 3867 3868 3869 3870 3871
                "    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")},
3872
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3873
     N_("Max memory in kilobytes")},
3874
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3875
     N_("Memory during contention in kilobytes")},
3876
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3877
     N_("Max memory plus swap in kilobytes")},
3878
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
3879
     N_("Min guaranteed memory in kilobytes")},
3880 3881 3882
    {"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")},
3883 3884 3885
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3886
static bool
3887 3888 3889
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
3890 3891
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
3892 3893
    int nparams = 0;
    unsigned int i = 0;
3894
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3895
    bool ret = false;
3896 3897 3898 3899 3900 3901 3902 3903 3904 3905
    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;
        }
3906
        flags = VIR_DOMAIN_AFFECT_CURRENT;
3907 3908
    } else {
        if (config)
3909
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3910
        if (live)
3911
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3912
    }
3913 3914

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3915
        return false;
3916 3917

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

3920 3921 3922 3923 3924 3925 3926 3927 3928
    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;
    }

3929 3930 3931 3932 3933 3934 3935 3936 3937
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

3938 3939 3940
    if (min_guarantee)
        nparams++;

3941 3942
    if (nparams == 0) {
        /* get the number of memory parameters */
3943
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
3944 3945 3946 3947 3948
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

3949 3950
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3951
            ret = true;
3952 3953 3954
            goto cleanup;
        }

3955
        /* now go get all the memory parameters */
E
Eric Blake 已提交
3956
        params = vshCalloc(ctl, nparams, sizeof(*params));
3957
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
3958 3959 3960 3961 3962 3963
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
3964
                case VIR_TYPED_PARAM_INT:
3965 3966 3967
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
3968
                case VIR_TYPED_PARAM_UINT:
3969 3970 3971
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
3972
                case VIR_TYPED_PARAM_LLONG:
3973 3974 3975
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
3976
                case VIR_TYPED_PARAM_ULLONG:
3977 3978 3979 3980 3981
                    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);
3982
                    break;
3983
                case VIR_TYPED_PARAM_DOUBLE:
3984 3985 3986
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
3987
                case VIR_TYPED_PARAM_BOOLEAN:
3988 3989 3990 3991
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
3992
                    vshPrint(ctl, "unimplemented memory parameter type\n");
3993 3994 3995
            }
        }

E
Eric Blake 已提交
3996
        ret = true;
3997 3998
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
3999
        params = vshCalloc(ctl, nparams, sizeof(*params));
4000 4001 4002

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4003
            temp->type = VIR_TYPED_PARAM_ULLONG;
4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022

            /*
             * 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;
4023
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
4024 4025
                        sizeof(temp->field));
                swap_hard_limit = 0;
4026 4027 4028 4029 4030
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
4031
            }
4032 4033 4034 4035

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
4036
        }
4037
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
4038
            vshError(ctl, "%s", _("Unable to change memory parameters"));
4039
        else
E
Eric Blake 已提交
4040
            ret = true;
4041 4042 4043
    }

  cleanup:
E
Eric Blake 已提交
4044
    VIR_FREE(params);
4045 4046 4047 4048
    virDomainFree(dom);
    return ret;
}

4049 4050 4051
/*
 * "nodeinfo" command
 */
4052
static const vshCmdInfo info_nodeinfo[] = {
4053 4054
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
4055 4056 4057
    {NULL, NULL}
};

E
Eric Blake 已提交
4058
static bool
4059
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4060 4061
{
    virNodeInfo info;
4062

4063
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4064
        return false;
4065 4066

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
4067
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
4068
        return false;
4069 4070 4071 4072 4073 4074 4075 4076 4077 4078
    }
    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 已提交
4079
    return true;
4080 4081
}

4082 4083 4084 4085 4086
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
4087
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
4088 4089 4090 4091 4092 4093 4094 4095 4096 4097
    {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
4098
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
4099 4100 4101 4102
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
4103 4104
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147
    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;

4148
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
4149
                cpu_stats[i].sys = value;
4150
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
4151
                cpu_stats[i].user = value;
4152
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
4153
                cpu_stats[i].idle = value;
4154
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
4155
                cpu_stats[i].iowait = value;
4156
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
4157 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 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210
                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) {
            vshPrint(ctl, "%-15s %20llu\n", _("user  :"), cpu_stats[0].user);
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
            vshPrint(ctl, "%-15s %20llu\n", _("idle  :"), cpu_stats[0].idle);
            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);
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle :"), 100 - usage);
        } 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",
                     _("    user  :"), user_time / total_time * 100);
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("    system:"), sys_time  / total_time * 100);
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("idle  :"), idle_time     / total_time * 100);
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229
/*
 * "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;
4230 4231
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271
    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;
}

4272 4273 4274
/*
 * "capabilities" command
 */
4275
static const vshCmdInfo info_capabilities[] = {
4276 4277
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
4278 4279 4280
    {NULL, NULL}
};

E
Eric Blake 已提交
4281
static bool
4282
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4283 4284 4285
{
    char *caps;

4286
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4287
        return false;
4288 4289

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
4290
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
4291
        return false;
4292 4293
    }
    vshPrint (ctl, "%s\n", caps);
4294
    VIR_FREE(caps);
4295

E
Eric Blake 已提交
4296
    return true;
4297 4298
}

4299 4300 4301
/*
 * "dumpxml" command
 */
4302
static const vshCmdInfo info_dumpxml[] = {
4303 4304
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
4305
    {NULL, NULL}
4306 4307
};

4308
static const vshCmdOptDef opts_dumpxml[] = {
4309 4310 4311
    {"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")},
4312
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
4313
    {NULL, 0, 0, NULL}
4314 4315
};

E
Eric Blake 已提交
4316
static bool
4317
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
4318
{
4319
    virDomainPtr dom;
E
Eric Blake 已提交
4320
    bool ret = true;
4321
    char *dump;
4322 4323 4324
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
4325
    int update = vshCommandOptBool(cmd, "update-cpu");
4326 4327 4328 4329 4330

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
4331 4332
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
4333

4334
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4335
        return false;
4336

J
Jim Meyering 已提交
4337
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4338
        return false;
4339

4340
    dump = virDomainGetXMLDesc(dom, flags);
4341
    if (dump != NULL) {
4342
        vshPrint(ctl, "%s", dump);
4343
        VIR_FREE(dump);
4344
    } else {
E
Eric Blake 已提交
4345
        ret = false;
4346
    }
4347

4348 4349 4350 4351
    virDomainFree(dom);
    return ret;
}

4352 4353 4354 4355
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
4356 4357
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
4358 4359 4360 4361
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
4362 4363
    {"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")},
4364 4365 4366
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4367
static bool
4368 4369
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4370
    bool ret = true;
4371 4372
    const char *format = NULL;
    const char *configFile = NULL;
4373 4374 4375 4376
    char *configData;
    char *xmlData;
    int flags = 0;

4377
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4378
        return false;
4379

4380 4381
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
4382
        return false;
4383

4384
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
4385
        return false;
4386 4387 4388

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
4389
        vshPrint(ctl, "%s", xmlData);
4390
        VIR_FREE(xmlData);
4391
    } else {
E
Eric Blake 已提交
4392
        ret = false;
4393 4394 4395 4396 4397 4398 4399 4400 4401
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
4402 4403
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
4404 4405 4406 4407
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
4408 4409
    {"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")},
4410 4411 4412
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4413
static bool
4414 4415
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4416
    bool ret = true;
4417 4418
    const char *format = NULL;
    const char *xmlFile = NULL;
4419 4420 4421 4422
    char *configData;
    char *xmlData;
    int flags = 0;

4423
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4424
        return false;
4425

4426 4427
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
4428
        return false;
4429

4430
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
4431
        return false;
4432 4433 4434

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
4435
        vshPrint(ctl, "%s", configData);
4436
        VIR_FREE(configData);
4437
    } else {
E
Eric Blake 已提交
4438
        ret = false;
4439 4440 4441 4442 4443
    }

    return ret;
}

K
Karel Zak 已提交
4444
/*
K
Karel Zak 已提交
4445
 * "domname" command
K
Karel Zak 已提交
4446
 */
4447
static const vshCmdInfo info_domname[] = {
4448
    {"help", N_("convert a domain id or UUID to domain name")},
4449
    {"desc", ""},
4450
    {NULL, NULL}
K
Karel Zak 已提交
4451 4452
};

4453
static const vshCmdOptDef opts_domname[] = {
4454
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
4455
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4456 4457
};

E
Eric Blake 已提交
4458
static bool
4459
cmdDomname(vshControl *ctl, const vshCmd *cmd)
4460
{
K
Karel Zak 已提交
4461 4462
    virDomainPtr dom;

4463
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4464
        return false;
J
Jim Meyering 已提交
4465
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4466
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
4467
        return false;
4468

K
Karel Zak 已提交
4469 4470
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
4471
    return true;
K
Karel Zak 已提交
4472 4473 4474
}

/*
K
Karel Zak 已提交
4475
 * "domid" command
K
Karel Zak 已提交
4476
 */
4477
static const vshCmdInfo info_domid[] = {
4478
    {"help", N_("convert a domain name or UUID to domain id")},
4479
    {"desc", ""},
4480
    {NULL, NULL}
K
Karel Zak 已提交
4481 4482
};

4483
static const vshCmdOptDef opts_domid[] = {
4484
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
4485
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4486 4487
};

E
Eric Blake 已提交
4488
static bool
4489
cmdDomid(vshControl *ctl, const vshCmd *cmd)
4490
{
4491
    virDomainPtr dom;
4492
    unsigned int id;
K
Karel Zak 已提交
4493

4494
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4495
        return false;
J
Jim Meyering 已提交
4496
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4497
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
4498
        return false;
4499

4500 4501
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
4502
        vshPrint(ctl, "%s\n", "-");
4503
    else
4504
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
4505
    virDomainFree(dom);
E
Eric Blake 已提交
4506
    return true;
K
Karel Zak 已提交
4507
}
4508

K
Karel Zak 已提交
4509 4510 4511
/*
 * "domuuid" command
 */
4512
static const vshCmdInfo info_domuuid[] = {
4513
    {"help", N_("convert a domain name or id to domain UUID")},
4514
    {"desc", ""},
K
Karel Zak 已提交
4515 4516 4517
    {NULL, NULL}
};

4518
static const vshCmdOptDef opts_domuuid[] = {
4519
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
4520 4521 4522
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4523
static bool
4524
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
4525 4526
{
    virDomainPtr dom;
4527
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
4528

4529
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4530
        return false;
J
Jim Meyering 已提交
4531
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4532
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
4533
        return false;
4534

K
Karel Zak 已提交
4535 4536 4537
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
4538
        vshError(ctl, "%s", _("failed to get domain UUID"));
4539

4540
    virDomainFree(dom);
E
Eric Blake 已提交
4541
    return true;
K
Karel Zak 已提交
4542 4543
}

4544 4545 4546
/*
 * "migrate" command
 */
4547
static const vshCmdInfo info_migrate[] = {
4548 4549
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
4550 4551 4552
    {NULL, NULL}
};

4553
static const vshCmdOptDef opts_migrate[] = {
4554 4555 4556 4557 4558 4559 4560
    {"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")},
4561 4562
    {"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)")},
W
Wen Congyang 已提交
4563
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
4564
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4565
    {"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)")},
4566 4567
    {"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 已提交
4568
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
4569
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
4570 4571 4572
    {NULL, 0, 0, NULL}
};

4573 4574 4575 4576 4577 4578 4579 4580
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
4581
{
4582
    char ret = '1';
4583
    virDomainPtr dom = NULL;
4584 4585 4586 4587
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
    int flags = 0;
4588 4589 4590
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
4591 4592
    const char *xmlfile = NULL;
    char *xml = NULL;
4593
    sigset_t sigmask, oldsigmask;
4594 4595 4596 4597 4598

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

4600
    if (!vshConnectionUsability (ctl, ctl->conn))
4601
        goto out;
4602

J
Jim Meyering 已提交
4603
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
4604
        goto out;
4605

4606 4607
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
4608 4609
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
4610
        goto out;
4611
    }
4612

4613 4614 4615 4616 4617
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

4618 4619
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
4620 4621
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
4622
    if (vshCommandOptBool (cmd, "tunnelled"))
4623
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
4624

C
Chris Lalancette 已提交
4625 4626 4627 4628 4629
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

4630 4631 4632
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

4633 4634 4635 4636 4637 4638
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

4639 4640 4641 4642 4643 4644

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


4645 4646 4647 4648
    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. */
4649

4650
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
4651
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
4652
            goto out;
4653
        }
4654

4655
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
4656
            ret = '0';
4657 4658 4659 4660 4661 4662
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
4663
        if (!dconn) goto out;
4664

4665
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
4666 4667
        if (ddom) {
            virDomainFree(ddom);
4668
            ret = '0';
4669 4670 4671
        }
        virConnectClose (dconn);
    }
4672

4673 4674 4675
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
4676
    if (dom) virDomainFree (dom);
4677
    VIR_FREE(xml);
4678 4679 4680
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
4681
static void
4682
print_job_progress(unsigned long long remaining, unsigned long long total)
W
Wen Congyang 已提交
4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701
{
    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;
        }
    }

4702
    fprintf(stderr, "\rMigration: [%3d %%]", progress);
W
Wen Congyang 已提交
4703 4704
}

E
Eric Blake 已提交
4705
static bool
4706 4707 4708 4709 4710
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
4711
    bool functionReturn = false;
4712 4713 4714 4715 4716
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
4717 4718
    virDomainJobInfo jobinfo;
    bool verbose = false;
4719
    int timeout = 0;
W
Wen Congyang 已提交
4720 4721
    struct timeval start, curr;
    bool live_flag = false;
4722
    vshCtrlData data;
4723 4724 4725 4726
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
4727 4728

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

W
Wen Congyang 已提交
4731 4732 4733
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
4734
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
4735
        live_flag = true;
4736
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753
        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;
        }
    }

4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776
    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 已提交
4777
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
4778
    while (1) {
4779
repoll:
W
Wen Congyang 已提交
4780 4781 4782 4783
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
4784
                    functionReturn = true;
W
Wen Congyang 已提交
4785 4786
                    if (verbose) {
                        /* print [100 %] */
4787
                        print_job_progress(0, 1);
W
Wen Congyang 已提交
4788 4789
                    }
                } else
W
Wen Congyang 已提交
4790
                    functionReturn = false;
4791
            } else
W
Wen Congyang 已提交
4792
                functionReturn = false;
W
Wen Congyang 已提交
4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
4804
            functionReturn = false;
W
Wen Congyang 已提交
4805 4806 4807
            break;
        }

W
Wen Congyang 已提交
4808 4809 4810 4811
        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. */
4812 4813
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "suspend the domain when migration timeouts\n");
W
Wen Congyang 已提交
4814 4815 4816 4817
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
4818 4819 4820 4821 4822
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
4823
                print_job_progress(jobinfo.dataRemaining, jobinfo.dataTotal);
4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
4835
    return functionReturn;
4836 4837
}

4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848
/*
 * "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")},
4849
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
4850 4851 4852
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4853
static bool
4854 4855 4856
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
4857
    long long downtime = 0;
E
Eric Blake 已提交
4858
    bool ret = false;
4859

4860
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4861
        return false;
4862 4863

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

4866 4867
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
4868 4869 4870 4871 4872 4873 4874
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
4875
    ret = true;
4876 4877 4878 4879 4880 4881

done:
    virDomainFree(dom);
    return ret;
}

4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925
/*
 * "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;
}

4926 4927 4928
/*
 * "net-autostart" command
 */
4929
static const vshCmdInfo info_network_autostart[] = {
4930
    {"help", N_("autostart a network")},
4931
    {"desc",
4932
     N_("Configure a network to be automatically started at boot.")},
4933 4934 4935
    {NULL, NULL}
};

4936
static const vshCmdOptDef opts_network_autostart[] = {
4937 4938
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4939 4940 4941
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4942
static bool
4943
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
4944 4945
{
    virNetworkPtr network;
4946
    const char *name;
4947 4948
    int autostart;

4949
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4950
        return false;
4951

J
Jim Meyering 已提交
4952
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4953
        return false;
4954 4955 4956 4957

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
4958
        if (autostart)
4959
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
4960
        else
4961
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
4962
        virNetworkFree(network);
E
Eric Blake 已提交
4963
        return false;
4964 4965
    }

4966
    if (autostart)
4967
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
4968
    else
4969
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
4970

L
Laine Stump 已提交
4971
    virNetworkFree(network);
E
Eric Blake 已提交
4972
    return true;
4973
}
K
Karel Zak 已提交
4974

4975 4976 4977
/*
 * "net-create" command
 */
4978
static const vshCmdInfo info_network_create[] = {
4979 4980
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
4981 4982 4983
    {NULL, NULL}
};

4984
static const vshCmdOptDef opts_network_create[] = {
4985
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4986 4987 4988
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4989
static bool
4990
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
4991 4992
{
    virNetworkPtr network;
4993
    const char *from = NULL;
E
Eric Blake 已提交
4994
    bool ret = true;
4995
    char *buffer;
4996

4997
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4998
        return false;
4999

5000
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5001
        return false;
5002

5003
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5004
        return false;
5005 5006

    network = virNetworkCreateXML(ctl->conn, buffer);
5007
    VIR_FREE(buffer);
5008

5009 5010 5011
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
5012
        virNetworkFree(network);
5013
    } else {
5014
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
5015
        ret = false;
5016 5017 5018 5019 5020 5021 5022 5023
    }
    return ret;
}


/*
 * "net-define" command
 */
5024
static const vshCmdInfo info_network_define[] = {
5025 5026
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
5027 5028 5029
    {NULL, NULL}
};

5030
static const vshCmdOptDef opts_network_define[] = {
5031
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5032 5033 5034
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5035
static bool
5036
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
5037 5038
{
    virNetworkPtr network;
5039
    const char *from = NULL;
E
Eric Blake 已提交
5040
    bool ret = true;
5041
    char *buffer;
5042

5043
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5044
        return false;
5045

5046
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5047
        return false;
5048

5049
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5050
        return false;
5051 5052

    network = virNetworkDefineXML(ctl->conn, buffer);
5053
    VIR_FREE(buffer);
5054

5055 5056 5057
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
5058
        virNetworkFree(network);
5059
    } else {
5060
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
5061
        ret = false;
5062 5063 5064 5065 5066 5067 5068 5069
    }
    return ret;
}


/*
 * "net-destroy" command
 */
5070
static const vshCmdInfo info_network_destroy[] = {
5071 5072
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
5073 5074 5075
    {NULL, NULL}
};

5076
static const vshCmdOptDef opts_network_destroy[] = {
5077
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5078 5079 5080
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5081
static bool
5082
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
5083 5084
{
    virNetworkPtr network;
E
Eric Blake 已提交
5085
    bool ret = true;
5086
    const char *name;
5087

5088
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5089
        return false;
5090

J
Jim Meyering 已提交
5091
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5092
        return false;
5093 5094 5095 5096

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

5101
    virNetworkFree(network);
5102 5103 5104 5105 5106 5107 5108
    return ret;
}


/*
 * "net-dumpxml" command
 */
5109
static const vshCmdInfo info_network_dumpxml[] = {
5110 5111
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
5112 5113 5114
    {NULL, NULL}
};

5115
static const vshCmdOptDef opts_network_dumpxml[] = {
5116
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5117 5118 5119
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5120
static bool
5121
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
5122 5123
{
    virNetworkPtr network;
E
Eric Blake 已提交
5124
    bool ret = true;
5125 5126
    char *dump;

5127
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5128
        return false;
5129

J
Jim Meyering 已提交
5130
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
5131
        return false;
5132 5133 5134

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
5135
        vshPrint(ctl, "%s", dump);
5136
        VIR_FREE(dump);
5137
    } else {
E
Eric Blake 已提交
5138
        ret = false;
5139 5140 5141 5142 5143 5144
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158
/*
 * "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 已提交
5159
static bool
O
Osier Yang 已提交
5160 5161 5162 5163 5164 5165 5166 5167 5168 5169
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 已提交
5170
        return false;
O
Osier Yang 已提交
5171 5172 5173

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5174
        return false;
O
Osier Yang 已提交
5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200

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

    virNetworkFree(network);
E
Eric Blake 已提交
5201
    return true;
O
Osier Yang 已提交
5202
}
5203

5204 5205 5206 5207
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
5208 5209
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
5210 5211 5212 5213
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
5214
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5215 5216 5217
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5218
static bool
5219 5220
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5221
    bool ret = false;
5222 5223 5224 5225 5226
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
5227
    int flags = VIR_INTERFACE_XML_INACTIVE;
5228

5229
    if (!vshConnectionUsability(ctl, ctl->conn))
5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255
        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 已提交
5256
        ret = true;
5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268
        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)) {
5269 5270
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282
        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 已提交
5283
    ret = true;
5284 5285 5286 5287 5288

cleanup:
    if (iface)
        virInterfaceFree (iface);

5289 5290 5291
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
5292 5293 5294

    if (tmp) {
        unlink (tmp);
5295
        VIR_FREE(tmp);
5296 5297 5298 5299 5300
    }

    return ret;
}

5301 5302 5303
/*
 * "net-list" command
 */
5304
static const vshCmdInfo info_network_list[] = {
5305 5306
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
5307 5308 5309
    {NULL, NULL}
};

5310
static const vshCmdOptDef opts_network_list[] = {
5311 5312
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
5313 5314 5315
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5316
static bool
5317
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5318 5319 5320 5321 5322
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
5323
    char **activeNames = NULL, **inactiveNames = NULL;
5324 5325
    inactive |= all;

5326
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5327
        return false;
5328 5329

    if (active) {
5330 5331
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
5332
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
5333
            return false;
5334
        }
5335
        if (maxactive) {
5336
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
5337

5338
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
5339
                                                    maxactive)) < 0) {
5340
                vshError(ctl, "%s", _("Failed to list active networks"));
5341
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5342
                return false;
5343
            }
5344

5345
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
5346
        }
5347 5348
    }
    if (inactive) {
5349 5350
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
5351
            vshError(ctl, "%s", _("Failed to list inactive networks"));
5352
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5353
            return false;
5354
        }
5355 5356 5357
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5358 5359 5360
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
5361
                vshError(ctl, "%s", _("Failed to list inactive networks"));
5362 5363
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5364
                return false;
5365
            }
5366

5367 5368
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
5369
    }
5370 5371
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
5372
    vshPrintExtra(ctl, "-----------------------------------------\n");
5373 5374

    for (i = 0; i < maxactive; i++) {
5375 5376
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
5377 5378
        const char *autostartStr;
        int autostart = 0;
5379 5380 5381

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5382
            VIR_FREE(activeNames[i]);
5383
            continue;
5384
        }
5385

5386 5387 5388
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5389
            autostartStr = autostart ? _("yes") : _("no");
5390 5391 5392 5393 5394

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
5395
        virNetworkFree(network);
5396
        VIR_FREE(activeNames[i]);
5397 5398 5399
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
5400 5401
        const char *autostartStr;
        int autostart = 0;
5402 5403 5404

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5405
            VIR_FREE(inactiveNames[i]);
5406
            continue;
5407
        }
5408

5409 5410 5411
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5412
            autostartStr = autostart ? _("yes") : _("no");
5413

5414
        vshPrint(ctl, "%-20s %-10s %-10s\n",
5415 5416 5417
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
5418 5419

        virNetworkFree(network);
5420
        VIR_FREE(inactiveNames[i]);
5421
    }
5422 5423
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5424
    return true;
5425 5426 5427 5428 5429 5430
}


/*
 * "net-name" command
 */
5431
static const vshCmdInfo info_network_name[] = {
5432
    {"help", N_("convert a network UUID to network name")},
5433
    {"desc", ""},
5434 5435 5436
    {NULL, NULL}
};

5437
static const vshCmdOptDef opts_network_name[] = {
5438
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
5439 5440 5441
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5442
static bool
5443
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
5444 5445 5446
{
    virNetworkPtr network;

5447
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5448
        return false;
J
Jim Meyering 已提交
5449
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5450
                                           VSH_BYUUID)))
E
Eric Blake 已提交
5451
        return false;
5452 5453 5454

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
5455
    return true;
5456 5457 5458 5459 5460 5461
}


/*
 * "net-start" command
 */
5462
static const vshCmdInfo info_network_start[] = {
5463 5464
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
5465 5466 5467
    {NULL, NULL}
};

5468
static const vshCmdOptDef opts_network_start[] = {
5469
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
5470 5471 5472
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5473
static bool
5474
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
5475 5476
{
    virNetworkPtr network;
E
Eric Blake 已提交
5477
    bool ret = true;
5478

5479
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5480
        return false;
5481

J
Jim Meyering 已提交
5482
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
5483
         return false;
5484 5485 5486

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
5487
                 virNetworkGetName(network));
5488
    } else {
5489
        vshError(ctl, _("Failed to start network %s"),
5490
                 virNetworkGetName(network));
E
Eric Blake 已提交
5491
        ret = false;
5492
    }
L
Laine Stump 已提交
5493
    virNetworkFree(network);
5494 5495 5496 5497 5498 5499 5500
    return ret;
}


/*
 * "net-undefine" command
 */
5501
static const vshCmdInfo info_network_undefine[] = {
5502 5503
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
5504 5505 5506
    {NULL, NULL}
};

5507
static const vshCmdOptDef opts_network_undefine[] = {
5508
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5509 5510 5511
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5512
static bool
5513
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
5514 5515
{
    virNetworkPtr network;
E
Eric Blake 已提交
5516
    bool ret = true;
5517
    const char *name;
5518

5519
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5520
        return false;
5521

J
Jim Meyering 已提交
5522
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5523
        return false;
5524 5525 5526 5527

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

L
Laine Stump 已提交
5532
    virNetworkFree(network);
5533 5534 5535 5536 5537 5538 5539
    return ret;
}


/*
 * "net-uuid" command
 */
5540
static const vshCmdInfo info_network_uuid[] = {
5541
    {"help", N_("convert a network name to network UUID")},
5542
    {"desc", ""},
5543 5544 5545
    {NULL, NULL}
};

5546
static const vshCmdOptDef opts_network_uuid[] = {
5547
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
5548 5549 5550
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5551
static bool
5552
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
5553 5554 5555 5556
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

5557
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5558
        return false;
5559

J
Jim Meyering 已提交
5560
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5561
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5562
        return false;
5563 5564 5565 5566

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

L
Laine Stump 已提交
5569
    virNetworkFree(network);
E
Eric Blake 已提交
5570
    return true;
5571 5572 5573
}


5574 5575 5576 5577 5578
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
5579 5580
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
5581 5582 5583 5584
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
5585 5586
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
5587 5588
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
5589
static bool
5590 5591 5592 5593 5594 5595 5596 5597 5598
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;

5599
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5600
        return false;
5601 5602 5603 5604

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
5605
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
5606
            return false;
5607 5608 5609 5610 5611 5612
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
5613
                vshError(ctl, "%s", _("Failed to list active interfaces"));
5614
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5615
                return false;
5616 5617 5618 5619 5620 5621 5622 5623
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
5624
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
5625
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5626
            return false;
5627 5628 5629 5630
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5631 5632 5633
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
5634
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
5635 5636
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5637
                return false;
5638 5639 5640 5641 5642
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
5643 5644
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
5645 5646 5647
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
5648 5649
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
5650 5651 5652

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
5653
            VIR_FREE(activeNames[i]);
5654 5655 5656 5657 5658 5659 5660 5661
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
5662
        VIR_FREE(activeNames[i]);
5663 5664
    }
    for (i = 0; i < maxinactive; i++) {
5665 5666
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
5667 5668 5669

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
5670
            VIR_FREE(inactiveNames[i]);
5671 5672 5673 5674 5675 5676 5677 5678
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
5679
        VIR_FREE(inactiveNames[i]);
5680
    }
5681 5682
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5683
    return true;
5684 5685 5686 5687 5688 5689 5690

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
5691
    {"help", N_("convert an interface MAC address to interface name")},
5692 5693 5694 5695 5696
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
5697
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
5698 5699 5700
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5701
static bool
5702 5703 5704 5705
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

5706
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5707
        return false;
5708 5709
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
5710
        return false;
5711 5712 5713

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
5714
    return true;
5715 5716 5717 5718 5719 5720
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
5721
    {"help", N_("convert an interface name to interface MAC address")},
5722 5723 5724 5725 5726
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
5727
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
5728 5729 5730
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5731
static bool
5732 5733 5734 5735
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

5736
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5737
        return false;
5738 5739
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5740
        return false;
5741 5742 5743

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
5744
    return true;
5745 5746 5747 5748 5749 5750
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
5751 5752
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
5753 5754 5755 5756
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
5757 5758
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
5759 5760 5761
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5762
static bool
5763 5764 5765
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5766
    bool ret = true;
5767
    char *dump;
5768 5769 5770 5771 5772
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
5773

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

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

5780
    dump = virInterfaceGetXMLDesc(iface, flags);
5781
    if (dump != NULL) {
5782
        vshPrint(ctl, "%s", dump);
5783
        VIR_FREE(dump);
5784
    } else {
E
Eric Blake 已提交
5785
        ret = false;
5786 5787 5788 5789 5790 5791 5792 5793 5794 5795
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
5796 5797
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
5798 5799 5800 5801
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
5802
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
5803 5804 5805
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5806
static bool
5807 5808
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
5809
    virInterfacePtr iface;
5810
    const char *from = NULL;
E
Eric Blake 已提交
5811
    bool ret = true;
5812 5813
    char *buffer;

5814
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5815
        return false;
5816

5817
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5818
        return false;
5819 5820

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

5823
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
5824
    VIR_FREE(buffer);
5825

5826
    if (iface != NULL) {
5827
        vshPrint(ctl, _("Interface %s defined from %s\n"),
5828
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
5829
        virInterfaceFree (iface);
5830
    } else {
5831
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
5832
        ret = false;
5833 5834 5835 5836 5837 5838 5839 5840
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
5841 5842
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
5843 5844 5845 5846
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
5847
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5848 5849 5850
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5851
static bool
5852 5853 5854
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5855
    bool ret = true;
5856
    const char *name;
5857

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

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5862
        return false;
5863 5864 5865 5866

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
5867
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
5868
        ret = false;
5869 5870 5871 5872 5873 5874 5875 5876 5877 5878
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
5879 5880
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
5881 5882 5883 5884
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
5885
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5886 5887 5888
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5889
static bool
5890 5891 5892
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5893
    bool ret = true;
5894
    const char *name;
5895

5896
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5897
        return false;
5898 5899

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5900
        return false;
5901 5902 5903 5904

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
5905
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
5906
        ret = false;
5907 5908 5909 5910 5911 5912 5913 5914 5915 5916
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
5917
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
5918
    {"desc", N_("forcefully stop a physical host interface.")},
5919 5920 5921 5922
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
5923
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5924 5925 5926
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5927
static bool
5928 5929 5930
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5931
    bool ret = true;
5932
    const char *name;
5933

5934
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5935
        return false;
5936 5937

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5938
        return false;
5939 5940 5941 5942

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
5943
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
5944
        ret = false;
5945 5946 5947 5948 5949 5950
    }

    virInterfaceFree(iface);
    return ret;
}

5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035
/*
 * "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;
}
6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050

/*
 * "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 已提交
6051
static bool
6052 6053 6054
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
6055
    const char *from = NULL;
E
Eric Blake 已提交
6056
    bool ret = true;
6057 6058
    char *buffer;

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

6062
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6063
        return false;
6064 6065

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6066
        return false;
6067 6068 6069 6070 6071 6072 6073 6074 6075 6076

    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 已提交
6077
        ret = false;
6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096
    }
    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 已提交
6097
static bool
6098 6099 6100
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6101
    bool ret = true;
6102
    const char *name;
6103

6104
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6105
        return false;
6106 6107

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
6108
        return false;
6109 6110 6111 6112 6113

    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 已提交
6114
        ret = false;
6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135
    }

    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 已提交
6136
static bool
6137 6138 6139
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6140
    bool ret = true;
6141 6142
    char *dump;

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

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
6147
        return false;
6148 6149 6150

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
6151
        vshPrint(ctl, "%s", dump);
6152 6153
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
6154
        ret = false;
6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173
    }

    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 已提交
6174
static bool
6175 6176 6177 6178 6179 6180
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

6181
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6182
        return false;
6183 6184 6185 6186

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
6187
        return false;
6188 6189 6190 6191 6192 6193 6194 6195
    }

    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 已提交
6196
        return false;
6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223
    }

    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 已提交
6224
    return true;
6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241
}


/*
 * "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 已提交
6242
static bool
6243 6244
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6245
    bool ret = false;
6246 6247 6248 6249 6250 6251
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

6252
    if (!vshConnectionUsability(ctl, ctl->conn))
6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278
        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 已提交
6279
        ret = true;
6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305
        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 已提交
6306
    ret = true;
6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324

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


6325
/**************************************************************************/
6326
/*
6327
 * "pool-autostart" command
6328
 */
6329
static const vshCmdInfo info_pool_autostart[] = {
6330
    {"help", N_("autostart a pool")},
6331
    {"desc",
6332
     N_("Configure a pool to be automatically started at boot.")},
6333
    {NULL, NULL}
6334 6335
};

6336
static const vshCmdOptDef opts_pool_autostart[] = {
6337 6338
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6339 6340
    {NULL, 0, 0, NULL}
};
6341

E
Eric Blake 已提交
6342
static bool
6343
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
6344
{
6345
    virStoragePoolPtr pool;
6346
    const char *name;
6347
    int autostart;
6348

6349
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6350
        return false;
6351

6352
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6353
        return false;
6354

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

6357 6358
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
6359
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
6360
        else
6361
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
6362
        virStoragePoolFree(pool);
E
Eric Blake 已提交
6363
        return false;
6364 6365
    }

6366
    if (autostart)
6367
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
6368
    else
6369
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
6370

L
Laine Stump 已提交
6371
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6372
    return true;
6373 6374
}

6375
/*
6376
 * "pool-create" command
6377
 */
6378
static const vshCmdInfo info_pool_create[] = {
6379 6380
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
6381 6382 6383
    {NULL, NULL}
};

6384
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
6385
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
6386
     N_("file containing an XML pool description")},
6387 6388 6389
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6390
static bool
6391
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
6392
{
6393
    virStoragePoolPtr pool;
6394
    const char *from = NULL;
E
Eric Blake 已提交
6395
    bool ret = true;
6396
    char *buffer;
6397

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

6401
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6402
        return false;
6403

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

6407
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
6408
    VIR_FREE(buffer);
6409 6410 6411 6412

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6413
        virStoragePoolFree(pool);
6414
    } else {
6415
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
6416
        ret = false;
6417 6418
    }
    return ret;
6419 6420
}

6421

6422 6423 6424 6425
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
6426
    {"help", N_("create a device defined "
6427
                          "by an XML file on the node")},
6428
    {"desc", N_("Create a device on the node.  Note that this "
6429 6430 6431 6432 6433 6434 6435
                          "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,
6436
     N_("file containing an XML description of the device")},
6437 6438 6439
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6440
static bool
6441 6442 6443
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
6444
    const char *from = NULL;
E
Eric Blake 已提交
6445
    bool ret = true;
6446 6447
    char *buffer;

6448
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6449
        return false;
6450

6451
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6452
        return false;
6453

6454
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6455
        return false;
6456 6457

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
6458
    VIR_FREE(buffer);
6459 6460 6461 6462

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
6463
        virNodeDeviceFree(dev);
6464
    } else {
6465
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
6466
        ret = false;
6467 6468 6469 6470 6471 6472 6473 6474 6475 6476
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
6477
    {"help", N_("destroy (stop) a device on the node")},
6478
    {"desc", N_("Destroy a device on the node.  Note that this "
6479
                "command destroys devices on the physical host")},
6480 6481 6482 6483 6484
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
6485
     N_("name of the device to be destroyed")},
6486 6487 6488
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6489
static bool
6490 6491 6492
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
6493
    bool ret = true;
6494
    const char *name = NULL;
6495

6496
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
6497
        return false;
6498 6499
    }

6500
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
6501
        return false;
6502 6503 6504 6505 6506 6507

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
6508
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
6509
        ret = false;
6510 6511 6512 6513 6514 6515 6516
    }

    virNodeDeviceFree(dev);
    return ret;
}


6517
/*
6518
 * XML Building helper for pool-define-as and pool-create-as
6519
 */
6520
static const vshCmdOptDef opts_pool_X_as[] = {
6521 6522 6523 6524 6525 6526 6527 6528
    {"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")},
6529
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
6530 6531 6532
    {NULL, 0, 0, NULL}
};

6533
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
6534

6535 6536
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
6537
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6538

6539
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6540
        goto cleanup;
6541
    if (vshCommandOptString(cmd, "type", &type) <= 0)
6542 6543
        goto cleanup;

6544 6545 6546 6547 6548
    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 ||
6549 6550
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
6551
        goto cleanup;
6552
    }
6553

6554 6555
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
6556
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
6557
        virBufferAddLit(&buf, "  <source>\n");
6558

6559
        if (srcHost)
6560
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
6561
        if (srcPath)
6562
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
6563
        if (srcDev)
6564
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
6565
        if (srcFormat)
6566
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
6567
        if (srcName)
6568
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
6569 6570

        virBufferAddLit(&buf, "  </source>\n");
6571 6572
    }
    if (target) {
6573
        virBufferAddLit(&buf, "  <target>\n");
6574
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
6575
        virBufferAddLit(&buf, "  </target>\n");
6576
    }
6577 6578 6579 6580
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
6581
        return false;
6582
    }
6583 6584 6585

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
6586
    return true;
6587 6588

cleanup:
6589
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6590
    return false;
6591 6592 6593 6594 6595 6596
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
6597 6598
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
6599 6600 6601
    {NULL, NULL}
};

E
Eric Blake 已提交
6602
static bool
6603 6604 6605
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
6606 6607
    const char *name;
    char *xml;
6608
    int printXML = vshCommandOptBool(cmd, "print-xml");
6609

6610
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6611
        return false;
6612 6613

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

6616
    if (printXML) {
6617
        vshPrint(ctl, "%s", xml);
6618
        VIR_FREE(xml);
6619
    } else {
6620
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
6621
        VIR_FREE(xml);
6622

6623 6624 6625 6626
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
6627
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
6628
            return false;
6629 6630
        }
    }
E
Eric Blake 已提交
6631
    return true;
6632 6633
}

6634

6635
/*
6636
 * "pool-define" command
6637
 */
6638
static const vshCmdInfo info_pool_define[] = {
6639 6640
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
6641 6642 6643
    {NULL, NULL}
};

6644
static const vshCmdOptDef opts_pool_define[] = {
6645
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
6646 6647 6648
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6649
static bool
6650
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
6651
{
6652
    virStoragePoolPtr pool;
6653
    const char *from = NULL;
E
Eric Blake 已提交
6654
    bool ret = true;
6655
    char *buffer;
6656

6657
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6658
        return false;
6659

6660
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6661
        return false;
6662

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

6666
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
6667
    VIR_FREE(buffer);
6668 6669 6670 6671

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6672
        virStoragePoolFree(pool);
6673
    } else {
6674
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
6675
        ret = false;
6676 6677
    }
    return ret;
6678 6679
}

6680

6681 6682 6683
/*
 * "pool-define-as" command
 */
6684
static const vshCmdInfo info_pool_define_as[] = {
6685 6686
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
6687 6688 6689
    {NULL, NULL}
};

E
Eric Blake 已提交
6690
static bool
6691
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
6692 6693
{
    virStoragePoolPtr pool;
6694 6695
    const char *name;
    char *xml;
6696
    int printXML = vshCommandOptBool(cmd, "print-xml");
6697

6698
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6699
        return false;
6700

6701
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
6702
        return false;
6703

6704
    if (printXML) {
6705
        vshPrint(ctl, "%s", xml);
6706
        VIR_FREE(xml);
6707
    } else {
6708
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
6709
        VIR_FREE(xml);
6710

6711 6712 6713 6714
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
6715
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
6716
            return false;
6717 6718
        }
    }
E
Eric Blake 已提交
6719
    return true;
6720 6721 6722
}


6723
/*
6724
 * "pool-build" command
6725
 */
6726
static const vshCmdInfo info_pool_build[] = {
6727 6728
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
6729 6730 6731
    {NULL, NULL}
};

6732
static const vshCmdOptDef opts_pool_build[] = {
6733
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6734 6735 6736
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6737
static bool
6738
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
6739
{
6740
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6741
    bool ret = true;
6742
    const char *name;
6743

6744
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6745
        return false;
6746

6747
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6748
        return false;
6749

6750
    if (virStoragePoolBuild(pool, 0) == 0) {
6751
        vshPrint(ctl, _("Pool %s built\n"), name);
6752
    } else {
6753
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
6754
        ret = false;
6755 6756
    }

6757 6758
    virStoragePoolFree(pool);

6759 6760 6761
    return ret;
}

6762

6763
/*
6764
 * "pool-destroy" command
6765
 */
6766
static const vshCmdInfo info_pool_destroy[] = {
6767 6768 6769
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
6770 6771 6772
    {NULL, NULL}
};

6773
static const vshCmdOptDef opts_pool_destroy[] = {
6774
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6775 6776 6777
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6778
static bool
6779
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
6780
{
6781
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6782
    bool ret = true;
6783
    const char *name;
6784

6785
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6786
        return false;
6787

6788
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6789
        return false;
6790

6791 6792 6793
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
6794
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
6795
        ret = false;
6796 6797
    }

6798
    virStoragePoolFree(pool);
6799 6800 6801
    return ret;
}

6802

6803
/*
6804 6805
 * "pool-delete" command
 */
6806
static const vshCmdInfo info_pool_delete[] = {
6807 6808
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
6809 6810 6811
    {NULL, NULL}
};

6812
static const vshCmdOptDef opts_pool_delete[] = {
6813
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6814 6815 6816
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6817
static bool
6818
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
6819 6820
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6821
    bool ret = true;
6822
    const char *name;
6823

6824
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6825
        return false;
6826 6827

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6828
        return false;
6829 6830

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
6831
        vshPrint(ctl, _("Pool %s deleted\n"), name);
6832
    } else {
6833
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
6834
        ret = false;
6835 6836
    }

L
Laine Stump 已提交
6837
    virStoragePoolFree(pool);
6838 6839 6840 6841 6842 6843 6844
    return ret;
}


/*
 * "pool-refresh" command
 */
6845
static const vshCmdInfo info_pool_refresh[] = {
6846 6847
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
6848 6849 6850
    {NULL, NULL}
};

6851
static const vshCmdOptDef opts_pool_refresh[] = {
6852
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6853 6854 6855
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6856
static bool
6857
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
6858 6859
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6860
    bool ret = true;
6861
    const char *name;
6862

6863
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6864
        return false;
6865 6866

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6867
        return false;
6868 6869 6870 6871

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
6872
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
6873
        ret = false;
6874 6875 6876 6877 6878 6879 6880 6881 6882 6883
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
6884
static const vshCmdInfo info_pool_dumpxml[] = {
6885 6886
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
6887 6888 6889
    {NULL, NULL}
};

6890
static const vshCmdOptDef opts_pool_dumpxml[] = {
6891
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6892 6893 6894
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6895
static bool
6896
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
6897 6898
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6899
    bool ret = true;
6900 6901
    char *dump;

6902
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6903
        return false;
6904 6905

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6906
        return false;
6907 6908 6909

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
6910
        vshPrint(ctl, "%s", dump);
6911
        VIR_FREE(dump);
6912
    } else {
E
Eric Blake 已提交
6913
        ret = false;
6914 6915 6916 6917 6918 6919 6920 6921 6922 6923
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
6924
static const vshCmdInfo info_pool_list[] = {
6925 6926
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
6927 6928 6929
    {NULL, NULL}
};

6930
static const vshCmdOptDef opts_pool_list[] = {
6931 6932
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
6933
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
6934 6935 6936
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6937
static bool
6938
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6939
{
6940 6941
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
6942 6943
    int i, ret;
    bool functionReturn;
6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959
    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 */
6960
    int all = vshCommandOptBool(cmd, "all");
6961 6962
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
6963 6964 6965
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

6966
    /* Check the connection to libvirtd daemon is still working */
6967
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6968
        return false;
6969

6970
    /* Retrieve the number of active storage pools */
6971
    if (active) {
6972 6973
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
6974
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
6975
            return false;
6976 6977
        }
    }
6978 6979

    /* Retrieve the number of inactive storage pools */
6980
    if (inactive) {
6981 6982
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
6983
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
6984
            return false;
6985
        }
6986
    }
6987

6988 6989
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
6990

6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002
    /* 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 已提交
7003
            return false;
7004 7005 7006
        }
    }

7007 7008 7009 7010 7011 7012 7013 7014
    /* 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 已提交
7015
            return false;
7016 7017
        }
    }
7018

7019 7020 7021 7022 7023 7024 7025 7026 7027 7028
    /* 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]);
7029
        if (!pool) {
7030
            VIR_FREE(poolNames[i]);
7031 7032 7033
            continue;
        }

7034
        /* Retrieve the autostart status of the pool */
7035
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
7036
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
7037
        else
7038 7039 7040 7041 7042 7043
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
7044 7045
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056
            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;
        }
7057

7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169
        /* 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 */
7170 7171 7172
        virStoragePoolFree(pool);
    }

7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190
    /* 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);
7191 7192
        }

7193
        /* Cleanup and return */
E
Eric Blake 已提交
7194
        functionReturn = true;
7195 7196
        goto cleanup;
    }
7197

7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235
    /* 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. */
7236
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
7237
             (unsigned long) nameStrLength);
7238
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
7239
             (unsigned long) stateStrLength);
7240
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
7241
             (unsigned long) autostartStrLength);
7242
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
7243
             (unsigned long) persistStrLength);
7244
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
7245
             (unsigned long) capStrLength);
7246
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
7247
             (unsigned long) allocStrLength);
7248
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 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
             (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 已提交
7292
    functionReturn = true;
7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306
    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 已提交
7307
    functionReturn = false;
7308

7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320
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]);
7321
    }
7322 7323 7324 7325 7326 7327 7328

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

    /* Return the desired value */
    return functionReturn;
7329 7330
}

7331 7332 7333 7334
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
7335 7336
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7337 7338 7339 7340 7341
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7342 7343 7344
     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")},
7345
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
7346 7347 7348
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7349
static bool
7350 7351
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7352
    const char *type = NULL, *host = NULL;
7353 7354
    char *srcSpec = NULL;
    char *srcList;
7355
    const char *initiator = NULL;
7356

7357 7358
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
7359 7360
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
7361
        return false;
7362
    }
7363

7364
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7365
        return false;
7366 7367

    if (host) {
7368
        const char *port = NULL;
7369
        virBuffer buf = VIR_BUFFER_INITIALIZER;
7370 7371 7372 7373

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7374
            return false;
7375
        }
7376
        virBufferAddLit(&buf, "<source>\n");
7377
        virBufferAsprintf(&buf, "  <host name='%s'", host);
7378
        if (port)
7379
            virBufferAsprintf(&buf, " port='%s'", port);
7380
        virBufferAddLit(&buf, "/>\n");
7381 7382
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
7383
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
7384 7385
            virBufferAddLit(&buf, "  </initiator>\n");
        }
7386 7387 7388
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
7389
            return false;
7390
        }
7391
        srcSpec = virBufferContentAndReset(&buf);
7392 7393 7394
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7395
    VIR_FREE(srcSpec);
7396
    if (srcList == NULL) {
7397
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7398
        return false;
7399 7400
    }
    vshPrint(ctl, "%s", srcList);
7401
    VIR_FREE(srcList);
7402

E
Eric Blake 已提交
7403
    return true;
7404 7405 7406 7407 7408 7409 7410
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
7411 7412
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7413 7414 7415 7416 7417
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7418
     N_("type of storage pool sources to discover")},
7419
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
7420
     N_("optional file of source xml to query for pools")},
7421 7422 7423
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7424
static bool
7425 7426
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7427
    const char *type = NULL, *srcSpecFile = NULL;
7428
    char *srcSpec = NULL, *srcList;
7429

7430
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
7431
        return false;
7432

7433 7434
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
7435
        return false;
7436
    }
7437

7438
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7439
        return false;
7440 7441

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
7442
        return false;
7443 7444

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7445
    VIR_FREE(srcSpec);
7446
    if (srcList == NULL) {
7447
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7448
        return false;
7449 7450
    }
    vshPrint(ctl, "%s", srcList);
7451
    VIR_FREE(srcList);
7452

E
Eric Blake 已提交
7453
    return true;
7454 7455 7456
}


7457 7458 7459
/*
 * "pool-info" command
 */
7460
static const vshCmdInfo info_pool_info[] = {
7461 7462
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
7463 7464 7465
    {NULL, NULL}
};

7466
static const vshCmdOptDef opts_pool_info[] = {
7467
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7468 7469 7470
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7471
static bool
7472
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
7473 7474 7475
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
7476 7477
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
7478
    bool ret = true;
7479 7480
    char uuid[VIR_UUID_STRING_BUFLEN];

7481
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7482
        return false;
7483 7484

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7485
        return false;
7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511

    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;
7512 7513 7514 7515
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
7516 7517
        }

7518 7519
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
7520 7521
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
7522 7523 7524 7525 7526 7527 7528
        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);
7529 7530
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
7531 7532 7533 7534 7535
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547
        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 已提交
7548
        ret = false;
7549 7550 7551 7552 7553 7554 7555 7556 7557 7558
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
7559
static const vshCmdInfo info_pool_name[] = {
7560
    {"help", N_("convert a pool UUID to pool name")},
7561
    {"desc", ""},
7562 7563 7564
    {NULL, NULL}
};

7565
static const vshCmdOptDef opts_pool_name[] = {
7566
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
7567 7568 7569
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7570
static bool
7571
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
7572 7573 7574
{
    virStoragePoolPtr pool;

7575
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7576
        return false;
7577
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7578
                                           VSH_BYUUID)))
E
Eric Blake 已提交
7579
        return false;
7580 7581 7582

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7583
    return true;
7584 7585 7586 7587 7588 7589
}


/*
 * "pool-start" command
 */
7590
static const vshCmdInfo info_pool_start[] = {
7591 7592
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
7593 7594 7595
    {NULL, NULL}
};

7596
static const vshCmdOptDef opts_pool_start[] = {
7597
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
7598 7599 7600
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7601
static bool
7602
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
7603 7604
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7605
    bool ret = true;
7606

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

7610
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
7611
         return false;
7612 7613 7614 7615 7616

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
7617
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
7618
        ret = false;
7619
    }
L
Laine Stump 已提交
7620 7621

    virStoragePoolFree(pool);
7622 7623 7624 7625
    return ret;
}


7626 7627 7628
/*
 * "vol-create-as" command
 */
7629
static const vshCmdInfo info_vol_create_as[] = {
7630 7631
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
7632 7633 7634
    {NULL, NULL}
};

7635
static const vshCmdOptDef opts_vol_create_as[] = {
7636 7637 7638 7639 7640
    {"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")},
7641 7642
    {"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")},
7643 7644 7645 7646 7647 7648 7649 7650 7651 7652
    {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 已提交
7653
        /* Deliberate fallthrough cases here :-) */
7654 7655 7656
        switch (*end) {
        case 'T':
            *val *= 1024;
7657
            /* fallthrough */
7658 7659
        case 'G':
            *val *= 1024;
7660
            /* fallthrough */
7661 7662
        case 'M':
            *val *= 1024;
7663
            /* fallthrough */
7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
7677
static bool
7678
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
7679 7680 7681
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7682
    char *xml;
7683 7684
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
7685
    unsigned long long capacity, allocation = 0;
7686
    virBuffer buf = VIR_BUFFER_INITIALIZER;
7687

7688
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7689
        return false;
7690 7691 7692

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

7695
    if (vshCommandOptString(cmd, "name", &name) <= 0)
7696 7697
        goto cleanup;

7698
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
7699 7700
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
7701
        vshError(ctl, _("Malformed size %s"), capacityStr);
7702

7703 7704
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
7705
        vshError(ctl, _("Malformed size %s"), allocationStr);
7706

7707 7708 7709 7710 7711 7712 7713
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

7714

7715
    virBufferAddLit(&buf, "<volume>\n");
7716 7717
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
7718
    if (allocationStr)
7719
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
7720 7721

    if (format) {
7722
        virBufferAddLit(&buf, "  <target>\n");
7723
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
7724
        virBufferAddLit(&buf, "  </target>\n");
7725
    }
7726

7727 7728 7729 7730
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
7731 7732
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
7733 7734 7735
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
7736 7737
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
7738 7739 7740 7741 7742
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
7743 7744
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
7745 7746 7747
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
7748 7749
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
7750 7751 7752 7753 7754
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
7755 7756
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
7757 7758 7759
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
7760 7761
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
7762 7763 7764 7765
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
E
Eric Blake 已提交
7766
            return false;
7767 7768 7769 7770 7771
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
7772
            return false;
7773 7774 7775 7776
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
7777
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
7778
        if (snapshotStrFormat)
7779
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
7780 7781 7782 7783 7784 7785 7786 7787
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

7789 7790
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7791
        return false;
7792 7793 7794
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
7795
    VIR_FREE(xml);
7796 7797 7798 7799 7800
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
7801
        return true;
7802
    } else {
7803
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
7804
        return false;
7805 7806 7807
    }

 cleanup:
7808
    virBufferFreeAndReset(&buf);
7809
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7810
    return false;
7811 7812 7813
}


7814 7815 7816
/*
 * "pool-undefine" command
 */
7817
static const vshCmdInfo info_pool_undefine[] = {
7818 7819
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
7820 7821 7822
    {NULL, NULL}
};

7823
static const vshCmdOptDef opts_pool_undefine[] = {
7824
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7825 7826 7827
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7828
static bool
7829
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
7830 7831
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7832
    bool ret = true;
7833
    const char *name;
7834

7835
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7836
        return false;
7837 7838

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7839
        return false;
7840 7841 7842 7843

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

L
Laine Stump 已提交
7848
    virStoragePoolFree(pool);
7849 7850 7851 7852 7853 7854 7855
    return ret;
}


/*
 * "pool-uuid" command
 */
7856
static const vshCmdInfo info_pool_uuid[] = {
7857
    {"help", N_("convert a pool name to pool UUID")},
7858
    {"desc", ""},
7859 7860 7861
    {NULL, NULL}
};

7862
static const vshCmdOptDef opts_pool_uuid[] = {
7863
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
7864 7865 7866
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7867
static bool
7868
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
7869 7870 7871 7872
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

7873
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7874
        return false;
7875 7876

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7877
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7878
        return false;
7879 7880 7881 7882

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

L
Laine Stump 已提交
7885
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7886
    return true;
7887 7888 7889 7890 7891 7892
}


/*
 * "vol-create" command
 */
7893
static const vshCmdInfo info_vol_create[] = {
7894 7895
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
7896 7897 7898
    {NULL, NULL}
};

7899
static const vshCmdOptDef opts_vol_create[] = {
7900 7901
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
7902 7903 7904
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7905
static bool
7906
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
7907 7908 7909
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7910
    const char *from = NULL;
E
Eric Blake 已提交
7911
    bool ret = true;
7912 7913
    char *buffer;

7914
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7915
        return false;
7916 7917

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

7921
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7922
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7923
        return false;
7924 7925 7926
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7927
        virshReportError(ctl);
7928
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7929
        return false;
7930 7931 7932
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
7933
    VIR_FREE(buffer);
7934 7935 7936 7937 7938 7939 7940
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
7941
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
7942
        ret = false;
7943 7944 7945 7946
    }
    return ret;
}

7947 7948 7949 7950
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
7951 7952
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
7953 7954 7955 7956
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
7957 7958 7959
    {"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 已提交
7960
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
7961 7962 7963
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7964
static bool
7965 7966 7967 7968
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
7969
    const char *from = NULL;
E
Eric Blake 已提交
7970
    bool ret = false;
7971 7972
    char *buffer = NULL;

7973
    if (!vshConnectionUsability(ctl, ctl->conn))
7974 7975 7976 7977 7978
        goto cleanup;

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

7979
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7980 7981 7982 7983 7984 7985 7986
        goto cleanup;
    }

    if (!(inputvol = vshCommandOptVol(ctl, cmd, "vol", "inputpool", NULL)))
        goto cleanup;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7987
        virshReportError(ctl);
7988 7989 7990 7991 7992 7993 7994 7995 7996
        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 {
7997
        vshError(ctl, _("Failed to create vol from %s"), from);
7998 7999 8000
        goto cleanup;
    }

E
Eric Blake 已提交
8001
    ret = true;
8002
cleanup:
8003
    VIR_FREE(buffer);
8004 8005 8006 8007
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
8008 8009
    if (newvol)
        virStorageVolFree(newvol);
8010 8011 8012 8013
    return ret;
}

static xmlChar *
8014
makeCloneXML(const char *origxml, const char *newname) {
8015

8016 8017 8018
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048
    xmlChar *newxml = NULL;
    int size;

    doc = xmlReadDoc((const xmlChar *) origxml, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET | XML_PARSE_NOWARNING);
    if (!doc)
        goto cleanup;
    ctxt = xmlXPathNewContext(doc);
    if (!ctxt)
        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[] = {
8049 8050
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
8051 8052 8053 8054
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
8055 8056
    {"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 已提交
8057
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8058 8059 8060
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8061
static bool
8062 8063 8064 8065
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
8066
    const char *name = NULL;
8067
    char *origxml = NULL;
8068
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
8069
    bool ret = false;
8070

8071
    if (!vshConnectionUsability(ctl, ctl->conn))
8072 8073 8074 8075 8076 8077 8078
        goto cleanup;

    if (!(origvol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        goto cleanup;

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
8079
        vshError(ctl, "%s", _("failed to get parent pool"));
8080 8081 8082
        goto cleanup;
    }

8083
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101
        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 {
8102
        vshError(ctl, _("Failed to clone vol from %s"),
8103 8104 8105 8106
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
8107
    ret = true;
8108 8109

cleanup:
8110
    VIR_FREE(origxml);
8111 8112 8113
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
8114 8115
    if (newvol)
        virStorageVolFree(newvol);
8116 8117 8118 8119 8120
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133

/*
 * "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 已提交
8134
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148
    {"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 已提交
8149
static bool
8150 8151 8152 8153
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8154
    bool ret = false;
8155 8156 8157 8158 8159 8160 8161 8162 8163 8164
    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 已提交
8165
        return false;
8166 8167 8168 8169
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8170
        return false;
8171 8172 8173
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8174
        return false;
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
    }

    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 已提交
8209
    ret = true;
8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233

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 已提交
8234
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8235 8236 8237 8238 8239
    {"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 已提交
8240
static bool
8241 8242 8243 8244
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8245
    bool ret = false;
8246 8247 8248 8249
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
8250
    bool created = false;
8251 8252

    if (!vshConnectionUsability(ctl, ctl->conn))
8253
        return false;
8254 8255 8256

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8257
        return false;
8258 8259 8260 8261
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8262
        return false;
8263 8264 8265
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
8266
        return false;
8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278

    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;
        }
8279 8280
    } else {
        created = true;
8281 8282 8283 8284 8285 8286 8287 8288
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

8289
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304
        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 已提交
8305
    ret = true;
8306 8307

cleanup:
8308
    VIR_FORCE_CLOSE(fd);
8309
    if (!ret && created)
8310 8311 8312 8313 8314 8315 8316 8317 8318
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


8319 8320 8321
/*
 * "vol-delete" command
 */
8322
static const vshCmdInfo info_vol_delete[] = {
8323 8324
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
8325 8326 8327
    {NULL, NULL}
};

8328
static const vshCmdOptDef opts_vol_delete[] = {
8329
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8330
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8331 8332 8333
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8334
static bool
8335
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
8336 8337
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8338
    bool ret = true;
8339
    const char *name;
8340

8341
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8342
        return false;
8343 8344

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8345
        return false;
8346 8347 8348
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
8349
        vshPrint(ctl, _("Vol %s deleted\n"), name);
8350
    } else {
8351
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
8352
        ret = false;
8353 8354
    }

L
Laine Stump 已提交
8355
    virStorageVolFree(vol);
8356 8357 8358 8359
    return ret;
}


D
David Allan 已提交
8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370
/*
 * "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 已提交
8371
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
8372 8373 8374
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8375
static bool
D
David Allan 已提交
8376 8377 8378
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8379
    bool ret = true;
8380
    const char *name;
D
David Allan 已提交
8381

8382
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8383
        return false;
D
David Allan 已提交
8384 8385

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8386
        return false;
D
David Allan 已提交
8387 8388 8389 8390 8391 8392
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
8393
        ret = false;
D
David Allan 已提交
8394 8395 8396 8397 8398 8399 8400
    }

    virStorageVolFree(vol);
    return ret;
}


8401 8402 8403
/*
 * "vol-info" command
 */
8404
static const vshCmdInfo info_vol_info[] = {
8405 8406
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
8407 8408 8409
    {NULL, NULL}
};

8410
static const vshCmdOptDef opts_vol_info[] = {
8411
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8412
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8413 8414 8415
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8416
static bool
8417
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
8418 8419 8420
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
8421
    bool ret = true;
8422

8423
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8424
        return false;
8425 8426

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8427
        return false;
8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443

    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 已提交
8444
        ret = false;
8445 8446 8447 8448 8449 8450 8451 8452 8453 8454
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
8455
static const vshCmdInfo info_vol_dumpxml[] = {
8456 8457
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
8458 8459 8460
    {NULL, NULL}
};

8461
static const vshCmdOptDef opts_vol_dumpxml[] = {
8462
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8463
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8464 8465 8466
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8467
static bool
8468
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
8469 8470
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8471
    bool ret = true;
8472 8473
    char *dump;

8474
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8475
        return false;
8476 8477

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8478
        return false;
8479 8480 8481

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
8482
        vshPrint(ctl, "%s", dump);
8483
        VIR_FREE(dump);
8484
    } else {
E
Eric Blake 已提交
8485
        ret = false;
8486 8487 8488 8489 8490 8491 8492 8493 8494 8495
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
8496
static const vshCmdInfo info_vol_list[] = {
8497 8498
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
8499 8500 8501
    {NULL, NULL}
};

8502
static const vshCmdOptDef opts_vol_list[] = {
8503
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8504
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
8505 8506 8507
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8508
static bool
8509
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8510
{
8511
    virStorageVolInfo volumeInfo;
8512 8513
    virStoragePoolPtr pool;
    char **activeNames = NULL;
8514 8515 8516 8517 8518
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
8519 8520
    int ret;
    bool functionReturn;
8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531
    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;
8532

8533
    /* Check the connection to libvirtd daemon is still working */
8534
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8535
        return false;
8536

8537
    /* Look up the pool information given to us by the user */
8538
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8539
        return false;
8540

8541 8542
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
8543

8544 8545 8546
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8547
        return false;
8548 8549
    }

8550 8551 8552 8553 8554
    /* 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) {
8555
            vshError(ctl, "%s", _("Failed to list active vols"));
8556
            VIR_FREE(activeNames);
8557
            virStoragePoolFree(pool);
E
Eric Blake 已提交
8558
            return false;
8559 8560
        }

8561 8562 8563 8564 8565
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

        /* Set aside memory for volume information pointers */
        volInfoTexts = vshCalloc(ctl, numVolumes, sizeof(*volInfoTexts));
8566 8567
    }

8568 8569 8570 8571 8572
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
8573

8574 8575 8576 8577
        /* 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"));
8578 8579
        }

8580 8581 8582 8583 8584 8585 8586 8587 8588
        /* 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 */
8589

8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644
                /* Volume type */
                if (volumeInfo.type == VIR_STORAGE_VOL_FILE)
                    volInfoTexts[i].type = vshStrdup(ctl, _("file"));
                else
                    volInfoTexts[i].type = vshStrdup(ctl, _("block"));

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

8646
        /* Cleanup memory allocation */
8647
        virStorageVolFree(vol);
8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665
    }

    /* 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 已提交
8666
        functionReturn = true;
8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697
        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 */
8698 8699 8700 8701 8702 8703 8704 8705 8706 8707
    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);
8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741

    /* 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 已提交
8742
    functionReturn = true;
8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756
    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 已提交
8757
    functionReturn = false;
8758 8759 8760 8761 8762 8763 8764 8765 8766 8767

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);
8768
        VIR_FREE(activeNames[i]);
8769
    }
8770 8771 8772 8773

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
8774
    VIR_FREE(activeNames);
8775
    virStoragePoolFree(pool);
8776 8777 8778

    /* Return the desired value */
    return functionReturn;
8779 8780 8781 8782 8783 8784
}


/*
 * "vol-name" command
 */
8785
static const vshCmdInfo info_vol_name[] = {
8786
    {"help", N_("returns the volume name for a given volume key or path")},
8787
    {"desc", ""},
8788 8789 8790
    {NULL, NULL}
};

8791
static const vshCmdOptDef opts_vol_name[] = {
8792
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
8793 8794 8795
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8796
static bool
8797
cmdVolName(vshControl *ctl, const vshCmd *cmd)
8798 8799 8800
{
    virStorageVolPtr vol;

8801
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8802
        return false;
8803 8804 8805

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
E
Eric Blake 已提交
8806
        return false;
8807 8808 8809

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8810
    return true;
8811 8812 8813
}


J
Justin Clift 已提交
8814 8815 8816 8817 8818 8819 8820 8821 8822 8823
/*
 * "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[] = {
8824
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
8825 8826 8827 8828
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8829
static bool
J
Justin Clift 已提交
8830 8831 8832 8833
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8834
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
8835 8836

    /* Check the connection to libvirtd daemon is still working */
8837
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8838
        return false;
J
Justin Clift 已提交
8839 8840 8841 8842

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
8843
        return false;
J
Justin Clift 已提交
8844 8845 8846 8847 8848 8849 8850
    }

    /* 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 已提交
8851
        return false;
J
Justin Clift 已提交
8852 8853
    }

8854 8855 8856 8857 8858 8859 8860 8861 8862
    /* 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 已提交
8863 8864 8865 8866

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8867
    return true;
J
Justin Clift 已提交
8868 8869
}

8870 8871 8872 8873

/*
 * "vol-key" command
 */
8874
static const vshCmdInfo info_vol_key[] = {
8875
    {"help", N_("returns the volume key for a given volume name or path")},
8876
    {"desc", ""},
8877 8878 8879
    {NULL, NULL}
};

8880
static const vshCmdOptDef opts_vol_key[] = {
8881
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
8882
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8883 8884 8885
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8886
static bool
8887
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
8888 8889 8890
{
    virStorageVolPtr vol;

8891
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8892
        return false;
8893

8894
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8895
        return false;
8896 8897 8898

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8899
    return true;
8900 8901 8902 8903 8904 8905 8906
}



/*
 * "vol-path" command
 */
8907
static const vshCmdInfo info_vol_path[] = {
8908
    {"help", N_("returns the volume path for a given volume name or key")},
8909
    {"desc", ""},
8910 8911 8912
    {NULL, NULL}
};

8913
static const vshCmdOptDef opts_vol_path[] = {
8914
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
8915
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8916 8917 8918
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8919
static bool
8920
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
8921 8922
{
    virStorageVolPtr vol;
8923
    const char *name = NULL;
8924

8925
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8926
        return false;
8927 8928

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8929
        return false;
8930
    }
8931 8932 8933

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8934
    return true;
8935 8936 8937
}


8938 8939 8940 8941
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
8942 8943
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
8944 8945
    {NULL, NULL}
};
8946

8947
static const vshCmdOptDef opts_secret_define[] = {
8948
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
8949 8950
    {NULL, 0, 0, NULL}
};
8951

E
Eric Blake 已提交
8952
static bool
8953 8954
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
8955
    const char *from = NULL;
8956
    char *buffer;
8957
    virSecretPtr res;
8958
    char uuid[VIR_UUID_STRING_BUFLEN];
8959

8960
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8961
        return false;
8962

8963
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8964
        return false;
8965 8966

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
8970
    VIR_FREE(buffer);
8971 8972

    if (res == NULL) {
8973
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
8974
        return false;
8975
    }
8976
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
8977
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
8978
        virSecretFree(res);
E
Eric Blake 已提交
8979
        return false;
8980 8981 8982
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
8983
    return true;
8984 8985 8986 8987 8988 8989
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
8990 8991
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
8992 8993 8994 8995
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
8996
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8997 8998 8999
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9000
static bool
9001 9002 9003
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9004
    bool ret = false;
9005 9006
    char *xml;

9007
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9008
        return false;
9009 9010 9011

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9012
        return false;
9013 9014 9015 9016

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
9017
    vshPrint(ctl, "%s", xml);
9018
    VIR_FREE(xml);
E
Eric Blake 已提交
9019
    ret = true;
9020 9021 9022 9023 9024 9025 9026 9027 9028 9029

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
9030 9031
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
9032 9033 9034 9035
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
9036 9037
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
9038 9039 9040
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9041
static bool
9042 9043 9044 9045
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
9046
    const char *base64 = NULL;
9047
    char *value;
E
Eric Blake 已提交
9048 9049
    int res;
    bool ret = false;
9050

9051
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9052
        return false;
9053 9054 9055

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9056
        return false;
9057

9058
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
9059 9060 9061
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
9062
        vshError(ctl, "%s", _("Invalid base64 data"));
9063 9064 9065
        goto cleanup;
    }
    if (value == NULL) {
9066
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
9067
        return false;
9068 9069 9070 9071
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
9072
    VIR_FREE(value);
9073 9074

    if (res != 0) {
9075
        vshError(ctl, "%s", _("Failed to set secret value"));
9076 9077 9078
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
9079
    ret = true;
9080 9081 9082 9083 9084 9085 9086 9087 9088 9089

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
9090 9091
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
9092 9093 9094 9095
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
9096
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9097 9098 9099
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9100
static bool
9101 9102 9103 9104 9105 9106
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
9107
    bool ret = false;
9108

9109
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9110
        return false;
9111 9112 9113

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9114
        return false;
9115 9116 9117 9118 9119 9120 9121

    value = virSecretGetValue(secret, &value_size, 0);
    if (value == NULL)
        goto cleanup;

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
9122
    VIR_FREE(value);
9123 9124

    if (base64 == NULL) {
9125
        vshError(ctl, "%s", _("Failed to allocate memory"));
9126 9127
        goto cleanup;
    }
9128
    vshPrint(ctl, "%s", base64);
9129
    memset(base64, 0, strlen(base64));
9130
    VIR_FREE(base64);
E
Eric Blake 已提交
9131
    ret = true;
9132 9133 9134 9135 9136 9137 9138 9139 9140 9141

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
9142 9143
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
9144 9145 9146 9147
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
9148
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9149 9150 9151
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9152
static bool
9153 9154 9155
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9156
    bool ret = false;
9157
    const char *uuid;
9158

9159
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9160
        return false;
9161 9162 9163

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
9164
        return false;
9165 9166

    if (virSecretUndefine(secret) < 0) {
9167
        vshError(ctl, _("Failed to delete secret %s"), uuid);
9168 9169 9170
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
9171
    ret = true;
9172 9173 9174 9175 9176 9177 9178 9179 9180 9181

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
9182 9183
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
9184 9185 9186
    {NULL, NULL}
};

E
Eric Blake 已提交
9187
static bool
9188 9189 9190 9191 9192
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

9193
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9194
        return false;
9195 9196 9197

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
9198
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
9199
        return false;
9200 9201 9202 9203 9204
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
9205
        vshError(ctl, "%s", _("Failed to list secrets"));
9206
        VIR_FREE(uuids);
E
Eric Blake 已提交
9207
        return false;
9208 9209 9210 9211
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

9212 9213
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
9214 9215

    for (i = 0; i < maxuuids; i++) {
9216 9217 9218 9219
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
9220
            VIR_FREE(uuids[i]);
9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238
            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);
9239
        VIR_FREE(uuids[i]);
9240
    }
9241
    VIR_FREE(uuids);
E
Eric Blake 已提交
9242
    return true;
9243
}
9244 9245 9246 9247 9248


/*
 * "version" command
 */
9249
static const vshCmdInfo info_version[] = {
9250 9251
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
9252 9253 9254
    {NULL, NULL}
};

9255 9256 9257 9258
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
9259

E
Eric Blake 已提交
9260
static bool
9261
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9262 9263 9264 9265 9266 9267
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
9268
    unsigned long daemonVersion;
9269 9270 9271 9272 9273
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

9274
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9275
        return false;
9276 9277 9278

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
9279
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
9280
        return false;
9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292
    }

    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) {
9293
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
9294
        return false;
9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311
    }
    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) {
9312
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
9313
        return false;
9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326
    }
    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);
    }
9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341

    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 已提交
9342
    return true;
9343 9344
}

9345 9346 9347 9348
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
9349
    {"help", N_("enumerate devices on this host")},
9350
    {"desc", ""},
9351 9352 9353 9354
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
9355 9356
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
9357 9358 9359
    {NULL, 0, 0, NULL}
};

9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381
#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] = '-';
9382 9383
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
9384 9385 9386
    }

    /* Print this device */
9387
    vshPrint(ctl, "%s", indentBuf);
9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410
    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) {
9411
        vshPrint(ctl, "%s", indentBuf);
9412
        vshPrint(ctl, " |\n");
9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434
    }

    /* 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) {
9435
        vshPrint(ctl, "%s", indentBuf);
9436 9437 9438 9439
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
9440
static bool
9441 9442
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
9443
    const char *cap = NULL;
9444
    char **devices;
9445
    int num_devices, i;
9446
    int tree = vshCommandOptBool(cmd, "tree");
9447

9448
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9449
        return false;
9450

9451
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
9452 9453 9454 9455
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
9456
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
9457
        return false;
9458
    } else if (num_devices == 0) {
E
Eric Blake 已提交
9459
        return true;
9460 9461 9462 9463 9464 9465
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
9466
        vshError(ctl, "%s", _("Failed to list node devices"));
9467
        VIR_FREE(devices);
E
Eric Blake 已提交
9468
        return false;
9469
    }
9470
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
9471 9472 9473 9474 9475 9476 9477
    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 已提交
9478
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497
            } 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++) {
9498 9499
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
9500
        }
9501
        VIR_FREE(parents);
9502 9503 9504
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
9505
            VIR_FREE(devices[i]);
9506
        }
9507
    }
9508
    VIR_FREE(devices);
E
Eric Blake 已提交
9509
    return true;
9510 9511 9512 9513 9514 9515
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
9516 9517
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
9518 9519 9520 9521 9522
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
9523
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9524 9525 9526
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9527
static bool
9528 9529
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
9530
    const char *name = NULL;
9531
    virNodeDevicePtr device;
L
Laine Stump 已提交
9532
    char *xml;
9533

9534
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9535
        return false;
9536
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9537
        return false;
9538
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9539
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9540
        return false;
9541 9542
    }

L
Laine Stump 已提交
9543 9544 9545
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
9546
        return false;
L
Laine Stump 已提交
9547 9548 9549
    }

    vshPrint(ctl, "%s\n", xml);
9550
    VIR_FREE(xml);
9551
    virNodeDeviceFree(device);
E
Eric Blake 已提交
9552
    return true;
9553 9554
}

9555 9556 9557 9558
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
9559 9560
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
9561 9562 9563 9564 9565
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
9566
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9567 9568 9569
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9570
static bool
9571 9572
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
9573
    const char *name = NULL;
9574
    virNodeDevicePtr device;
E
Eric Blake 已提交
9575
    bool ret = true;
9576

9577
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9578
        return false;
9579
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9580
        return false;
9581
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9582
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9583
        return false;
9584 9585 9586 9587 9588
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
9589
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
9590
        ret = false;
9591 9592 9593 9594 9595 9596 9597 9598 9599
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
9600 9601
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
9602 9603 9604 9605 9606
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
9607
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9608 9609 9610
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9611
static bool
9612 9613
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
9614
    const char *name = NULL;
9615
    virNodeDevicePtr device;
E
Eric Blake 已提交
9616
    bool ret = true;
9617

9618
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9619
        return false;
9620
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9621
        return false;
9622
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9623
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9624
        return false;
9625 9626 9627 9628 9629
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
9630
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
9631
        ret = false;
9632 9633 9634 9635 9636 9637 9638 9639 9640
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
9641 9642
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
9643 9644 9645 9646 9647
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
9648
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9649 9650 9651
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9652
static bool
9653 9654
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
9655
    const char *name = NULL;
9656
    virNodeDevicePtr device;
E
Eric Blake 已提交
9657
    bool ret = true;
9658

9659
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9660
        return false;
9661
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9662
        return false;
9663
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9664
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9665
        return false;
9666 9667 9668 9669 9670
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
9671
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
9672
        ret = false;
9673 9674 9675 9676 9677
    }
    virNodeDeviceFree(device);
    return ret;
}

9678
/*
E
Eric Blake 已提交
9679
 * "hostname" command
9680
 */
9681
static const vshCmdInfo info_hostname[] = {
9682
    {"help", N_("print the hypervisor hostname")},
9683
    {"desc", ""},
9684 9685 9686
    {NULL, NULL}
};

E
Eric Blake 已提交
9687
static bool
9688
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9689 9690 9691
{
    char *hostname;

9692
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9693
        return false;
9694 9695 9696

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
9697
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
9698
        return false;
9699 9700 9701
    }

    vshPrint (ctl, "%s\n", hostname);
9702
    VIR_FREE(hostname);
9703

E
Eric Blake 已提交
9704
    return true;
9705 9706 9707 9708 9709
}

/*
 * "uri" command
 */
9710
static const vshCmdInfo info_uri[] = {
9711
    {"help", N_("print the hypervisor canonical URI")},
9712
    {"desc", ""},
9713 9714 9715
    {NULL, NULL}
};

E
Eric Blake 已提交
9716
static bool
9717
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9718 9719 9720
{
    char *uri;

9721
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9722
        return false;
9723 9724 9725

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
9726
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
9727
        return false;
9728 9729 9730
    }

    vshPrint (ctl, "%s\n", uri);
9731
    VIR_FREE(uri);
9732

E
Eric Blake 已提交
9733
    return true;
9734 9735
}

E
Eric Blake 已提交
9736 9737 9738 9739 9740 9741 9742 9743 9744 9745
/*
 * "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 已提交
9746
static bool
E
Eric Blake 已提交
9747 9748 9749 9750 9751
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9752
        return false;
E
Eric Blake 已提交
9753 9754 9755 9756

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
9757
        return false;
E
Eric Blake 已提交
9758 9759 9760 9761 9762
    }

    vshPrint (ctl, "%s", sysinfo);
    VIR_FREE(sysinfo);

E
Eric Blake 已提交
9763
    return true;
E
Eric Blake 已提交
9764 9765
}

9766 9767 9768
/*
 * "vncdisplay" command
 */
9769
static const vshCmdInfo info_vncdisplay[] = {
9770 9771
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
9772 9773 9774
    {NULL, NULL}
};

9775
static const vshCmdOptDef opts_vncdisplay[] = {
9776
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9777 9778 9779
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9780
static bool
9781
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
9782 9783 9784 9785 9786
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9787
    bool ret = false;
9788 9789 9790
    int port = 0;
    char *doc;

9791
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9792
        return false;
9793

J
Jim Meyering 已提交
9794
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9795
        return false;
9796 9797 9798 9799 9800 9801 9802 9803

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
9804
    VIR_FREE(doc);
9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        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) ||
9823
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
9824 9825 9826 9827 9828 9829
        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 已提交
9830
    ret = true;
9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843

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

/*
 * "ttyconsole" command
 */
9844
static const vshCmdInfo info_ttyconsole[] = {
9845 9846
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
9847 9848 9849
    {NULL, NULL}
};

9850
static const vshCmdOptDef opts_ttyconsole[] = {
9851
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9852 9853 9854
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9855
static bool
9856
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
9857 9858 9859 9860 9861
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9862
    bool ret = false;
9863 9864
    char *doc;

9865
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9866
        return false;
9867

J
Jim Meyering 已提交
9868
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9869
        return false;
9870 9871 9872 9873 9874 9875 9876 9877

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
9878
    VIR_FREE(doc);
9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        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 已提交
9891
    ret = true;
9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903

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

/*
 * "attach-device" command
9904
 */
9905
static const vshCmdInfo info_attach_device[] = {
9906 9907
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
9908 9909 9910
    {NULL, NULL}
};

9911
static const vshCmdOptDef opts_attach_device[] = {
9912 9913 9914
    {"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")},
9915 9916 9917
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9918
static bool
9919
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
9920 9921
{
    virDomainPtr dom;
9922
    const char *from = NULL;
9923
    char *buffer;
W
Wen Congyang 已提交
9924
    int ret;
J
Jim Fehlig 已提交
9925
    unsigned int flags;
9926

9927
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9928
        return false;
9929

J
Jim Meyering 已提交
9930
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9931
        return false;
9932

9933
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9934
        virDomainFree(dom);
E
Eric Blake 已提交
9935
        return false;
9936 9937
    }

9938
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9939
        virshReportError(ctl);
9940
        virDomainFree(dom);
E
Eric Blake 已提交
9941
        return false;
9942
    }
9943

J
Jim Fehlig 已提交
9944
    if (vshCommandOptBool(cmd, "persistent")) {
9945
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
9946
        if (virDomainIsActive(dom) == 1)
9947
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
9948 9949 9950 9951
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
9952
    VIR_FREE(buffer);
9953 9954

    if (ret < 0) {
9955
        vshError(ctl, _("Failed to attach device from %s"), from);
9956
        virDomainFree(dom);
E
Eric Blake 已提交
9957
        return false;
9958
    } else {
J
Jim Meyering 已提交
9959
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
9960 9961 9962
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9963
    return true;
9964 9965 9966 9967 9968 9969
}


/*
 * "detach-device" command
 */
9970
static const vshCmdInfo info_detach_device[] = {
9971 9972
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
9973 9974 9975
    {NULL, NULL}
};

9976
static const vshCmdOptDef opts_detach_device[] = {
9977 9978 9979
    {"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")},
9980 9981 9982
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9983
static bool
9984
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
9985 9986
{
    virDomainPtr dom;
9987
    const char *from = NULL;
9988
    char *buffer;
W
Wen Congyang 已提交
9989
    int ret;
J
Jim Fehlig 已提交
9990
    unsigned int flags;
9991

9992
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9993
        return false;
9994

J
Jim Meyering 已提交
9995
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9996
        return false;
9997

9998
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9999
        virDomainFree(dom);
E
Eric Blake 已提交
10000
        return false;
10001 10002
    }

10003
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10004
        virshReportError(ctl);
10005
        virDomainFree(dom);
E
Eric Blake 已提交
10006
        return false;
10007
    }
10008

J
Jim Fehlig 已提交
10009
    if (vshCommandOptBool(cmd, "persistent")) {
10010
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10011
        if (virDomainIsActive(dom) == 1)
10012
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10013 10014 10015 10016
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
10017
    VIR_FREE(buffer);
10018 10019

    if (ret < 0) {
10020
        vshError(ctl, _("Failed to detach device from %s"), from);
10021
        virDomainFree(dom);
E
Eric Blake 已提交
10022
        return false;
10023
    } else {
J
Jim Meyering 已提交
10024
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
10025 10026 10027
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10028
    return true;
10029 10030
}

10031

10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044
/*
 * "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")},
10045
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
10046 10047 10048
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10049
static bool
10050 10051 10052
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
10053
    const char *from = NULL;
10054
    char *buffer;
W
Wen Congyang 已提交
10055
    int ret;
10056 10057
    unsigned int flags;

10058
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10059
        return false;
10060 10061

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

10064
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10065
        virDomainFree(dom);
E
Eric Blake 已提交
10066
        return false;
10067 10068 10069
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10070
        virshReportError(ctl);
10071
        virDomainFree(dom);
E
Eric Blake 已提交
10072
        return false;
10073 10074 10075
    }

    if (vshCommandOptBool(cmd, "persistent")) {
10076
        flags = VIR_DOMAIN_AFFECT_CONFIG;
10077
        if (virDomainIsActive(dom) == 1)
10078
           flags |= VIR_DOMAIN_AFFECT_LIVE;
10079
    } else {
10080
        flags = VIR_DOMAIN_AFFECT_LIVE;
10081
    }
10082 10083 10084 10085

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

10086 10087 10088 10089 10090 10091
    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 已提交
10092
        return false;
10093 10094 10095 10096 10097
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10098
    return true;
10099 10100 10101
}


10102 10103 10104
/*
 * "attach-interface" command
 */
10105
static const vshCmdInfo info_attach_interface[] = {
10106 10107
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
10108 10109 10110
    {NULL, NULL}
};

10111
static const vshCmdOptDef opts_attach_interface[] = {
10112 10113 10114 10115 10116 10117
    {"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")},
10118
    {"model", VSH_OT_DATA, 0, N_("model type")},
10119
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
10120 10121 10122
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10123
static bool
10124
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
10125 10126
{
    virDomainPtr dom = NULL;
10127 10128
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
10129
    int typ;
W
Wen Congyang 已提交
10130 10131
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
10132
    unsigned int flags;
10133 10134
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10135

10136
    if (!vshConnectionUsability(ctl, ctl->conn))
10137 10138
        goto cleanup;

J
Jim Meyering 已提交
10139
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10140 10141
        goto cleanup;

10142
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10143 10144
        goto cleanup;

10145 10146 10147 10148
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
10149 10150
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
10151
        goto cleanup;
10152
    }
10153 10154

    /* check interface type */
10155
    if (STREQ(type, "network")) {
10156
        typ = 1;
10157
    } else if (STREQ(type, "bridge")) {
10158 10159
        typ = 2;
    } else {
E
Eric Blake 已提交
10160 10161
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
10162 10163 10164 10165
        goto cleanup;
    }

    /* Make XML of interface */
10166
    virBufferAsprintf(&buf, "<interface type='%s'>\n", type);
10167

10168
    if (typ == 1)
10169
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
10170
    else if (typ == 2)
10171
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
10172

10173
    if (target != NULL)
10174
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10175
    if (mac != NULL)
10176
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
10177
    if (script != NULL)
10178
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
10179
    if (model != NULL)
10180
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
10181

10182
    virBufferAddLit(&buf, "</interface>\n");
10183

10184 10185
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
10186
        goto cleanup;
10187 10188
    }

10189
    xml = virBufferContentAndReset(&buf);
10190

J
Jim Fehlig 已提交
10191
    if (vshCommandOptBool(cmd, "persistent")) {
10192
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10193
        if (virDomainIsActive(dom) == 1)
10194
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10195
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
10196
    } else {
10197
        ret = virDomainAttachDevice(dom, xml);
10198
    }
10199

10200 10201
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10202
    if (ret != 0) {
L
Laine Stump 已提交
10203
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
10204 10205
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
10206
        functionReturn = true;
J
Jim Fehlig 已提交
10207
    }
10208 10209 10210 10211

 cleanup:
    if (dom)
        virDomainFree(dom);
10212
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10213
    return functionReturn;
10214 10215 10216 10217 10218
}

/*
 * "detach-interface" command
 */
10219
static const vshCmdInfo info_detach_interface[] = {
10220 10221
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
10222 10223 10224
    {NULL, NULL}
};

10225
static const vshCmdOptDef opts_detach_interface[] = {
10226 10227 10228 10229
    {"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")},
10230 10231 10232
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10233
static bool
10234
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
10235 10236 10237 10238 10239 10240 10241
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
10242
    const char *mac =NULL, *type = NULL;
10243
    char *doc;
10244
    char buf[64];
E
Eric Blake 已提交
10245
    int i = 0, diff_mac;
W
Wen Congyang 已提交
10246 10247
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
10248
    unsigned int flags;
10249

10250
    if (!vshConnectionUsability(ctl, ctl->conn))
10251 10252
        goto cleanup;

J
Jim Meyering 已提交
10253
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10254 10255
        goto cleanup;

10256
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10257 10258
        goto cleanup;

10259 10260
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
10261
        goto cleanup;
10262
    }
10263 10264 10265 10266 10267 10268 10269 10270

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
10271
    VIR_FREE(doc);
10272
    if (!xml) {
10273
        vshError(ctl, "%s", _("Failed to get interface information"));
10274 10275 10276 10277
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
10278
        vshError(ctl, "%s", _("Failed to get interface information"));
10279 10280 10281
        goto cleanup;
    }

E
Eric Blake 已提交
10282
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
10283 10284 10285
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10286
        vshError(ctl, _("No found interface whose type is %s"), type);
10287 10288 10289
        goto cleanup;
    }

10290 10291 10292 10293 10294 10295
    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;
    }

10296 10297 10298 10299 10300 10301 10302
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10303 10304 10305 10306 10307
            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);
10308 10309 10310 10311 10312 10313 10314
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10315
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
10316 10317 10318 10319 10320
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10321
        vshError(ctl, "%s", _("Failed to allocate memory"));
10322 10323 10324
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
10330
    if (vshCommandOptBool(cmd, "persistent")) {
10331
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10332
        if (virDomainIsActive(dom) == 1)
10333
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10334 10335 10336 10337 10338 10339 10340 10341
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10342
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
10343
    } else {
J
Jim Meyering 已提交
10344
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
10345
        functionReturn = true;
10346
    }
10347 10348 10349 10350

 cleanup:
    if (dom)
        virDomainFree(dom);
10351
    xmlXPathFreeObject(obj);
10352
    xmlXPathFreeContext(ctxt);
10353 10354 10355 10356
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
10357
    return functionReturn;
10358 10359 10360 10361 10362
}

/*
 * "attach-disk" command
 */
10363
static const vshCmdInfo info_attach_disk[] = {
10364 10365
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
10366 10367 10368
    {NULL, NULL}
};

10369
static const vshCmdOptDef opts_attach_disk[] = {
10370 10371 10372 10373 10374
    {"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")},
10375
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
10376 10377 10378
    {"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")},
10379
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
10380 10381 10382
    {"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")},
10383 10384 10385
    {NULL, 0, 0, NULL}
};

10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532
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 已提交
10533
static bool
10534
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
10535 10536
{
    virDomainPtr dom = NULL;
10537
    const char *source = NULL, *target = NULL, *driver = NULL,
10538 10539 10540
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
10541 10542
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
10543
    unsigned int flags;
10544
    const char *stype = NULL;
10545 10546
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10547

10548
    if (!vshConnectionUsability(ctl, ctl->conn))
10549 10550
        goto cleanup;

J
Jim Meyering 已提交
10551
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10552 10553
        goto cleanup;

10554
    if (vshCommandOptString(cmd, "source", &source) <= 0)
10555 10556
        goto cleanup;

10557
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10558 10559
        goto cleanup;

10560 10561 10562 10563
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
10564 10565 10566
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
10567
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
10568
        vshError(ctl, "%s", _("missing option"));
10569 10570
        goto cleanup;
    }
10571

10572 10573
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
10574
            isFile = true;
10575
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
10576
        isFile = true;
10577 10578 10579
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
10580 10581 10582
    }

    if (mode) {
10583
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
10584 10585
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
10586 10587 10588 10589 10590
            goto cleanup;
        }
    }

    /* Make XML of disk */
10591
    virBufferAsprintf(&buf, "<disk type='%s'",
10592 10593
                      (isFile) ? "file" : "block");
    if (type)
10594
        virBufferAsprintf(&buf, " device='%s'", type);
10595 10596
    virBufferAddLit(&buf, ">\n");

10597
    if (driver || subdriver)
10598
        virBufferAsprintf(&buf, "  <driver");
10599 10600

    if (driver)
10601
        virBufferAsprintf(&buf, " name='%s'", driver);
10602
    if (subdriver)
10603
        virBufferAsprintf(&buf, " type='%s'", subdriver);
10604 10605
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
10606

10607
    if (driver || subdriver || cache)
10608
        virBufferAddLit(&buf, "/>\n");
10609

10610
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
10611 10612
                      (isFile) ? "file" : "dev",
                      source);
10613
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10614
    if (mode)
10615
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
10616

10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664
    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;
            }
        }
    }

10665
    virBufferAddLit(&buf, "</disk>\n");
10666

10667 10668
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
10669
        return false;
10670 10671
    }

10672
    xml = virBufferContentAndReset(&buf);
10673

J
Jim Fehlig 已提交
10674
    if (vshCommandOptBool(cmd, "persistent")) {
10675
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10676
        if (virDomainIsActive(dom) == 1)
10677
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10678
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
10679
    } else {
10680
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
10681
    }
10682

10683 10684
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10685
    if (ret != 0) {
L
Laine Stump 已提交
10686
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
10687 10688
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
10689
        functionReturn = true;
J
Jim Fehlig 已提交
10690
    }
10691 10692 10693 10694

 cleanup:
    if (dom)
        virDomainFree(dom);
10695
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10696
    return functionReturn;
10697 10698 10699 10700 10701
}

/*
 * "detach-disk" command
 */
10702
static const vshCmdInfo info_detach_disk[] = {
10703 10704
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
10705 10706 10707
    {NULL, NULL}
};

10708
static const vshCmdOptDef opts_detach_disk[] = {
10709 10710 10711
    {"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")},
10712 10713 10714
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10715
static bool
10716
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
10717 10718 10719 10720 10721 10722 10723
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
10724
    const char *target = NULL;
10725
    char *doc;
E
Eric Blake 已提交
10726
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
10727 10728
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
10729
    unsigned int flags;
10730

10731
    if (!vshConnectionUsability(ctl, ctl->conn))
10732 10733
        goto cleanup;

J
Jim Meyering 已提交
10734
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10735 10736
        goto cleanup;

10737
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10738 10739 10740 10741 10742 10743 10744 10745 10746
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
10747
    VIR_FREE(doc);
10748
    if (!xml) {
10749
        vshError(ctl, "%s", _("Failed to get disk information"));
10750 10751 10752 10753
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
10754
        vshError(ctl, "%s", _("Failed to get disk information"));
10755 10756 10757 10758 10759 10760
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10761
        vshError(ctl, "%s", _("Failed to get disk information"));
10762 10763 10764 10765 10766 10767 10768
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10769 10770 10771 10772 10773
            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);
10774 10775 10776 10777 10778 10779 10780
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10781
    vshError(ctl, _("No found disk whose target is %s"), target);
10782 10783 10784 10785 10786
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10787
        vshError(ctl, "%s", _("Failed to allocate memory"));
10788 10789 10790
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
10796
    if (vshCommandOptBool(cmd, "persistent")) {
10797
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10798
        if (virDomainIsActive(dom) == 1)
10799
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10800 10801 10802 10803 10804 10805 10806 10807
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10808
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
10809
    } else {
J
Jim Meyering 已提交
10810
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
10811
        functionReturn = true;
10812
    }
10813 10814

 cleanup:
10815
    xmlXPathFreeObject(obj);
10816
    xmlXPathFreeContext(ctxt);
10817 10818 10819 10820 10821 10822
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
10823
    return functionReturn;
10824 10825
}

10826 10827 10828 10829
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
10830 10831
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
10832 10833 10834 10835
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
10836
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
10837 10838 10839
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10840
static bool
10841 10842
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
10843
    const char *from = NULL;
E
Eric Blake 已提交
10844
    bool ret = true;
10845 10846 10847
    char *buffer;
    int result;

10848
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10849
        return false;
10850

10851
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10852
        return false;
10853 10854

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
10858
    VIR_FREE(buffer);
10859 10860 10861 10862 10863

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
10864
        ret = false;
10865 10866 10867 10868 10869
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
10870
        ret = true;
10871 10872 10873 10874 10875
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
10876
        ret = true;
10877 10878 10879 10880 10881
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
10882
        ret = false;
10883 10884 10885 10886 10887
    }

    return ret;
}

10888 10889 10890 10891
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
10892 10893
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
10894 10895 10896 10897
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
10898
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
10899 10900 10901
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10902
static bool
10903 10904
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
10905
    const char *from = NULL;
E
Eric Blake 已提交
10906
    bool ret = true;
10907 10908 10909 10910 10911
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
10912
    xmlNodePtr node_list;
10913 10914 10915 10916 10917 10918
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

10919
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10920
        return false;
10921

10922
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10923
        return false;
10924 10925

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
10926
        return false;
10927 10928 10929 10930 10931

    doc = xmlNewDoc(NULL);
    if (doc == NULL)
        goto no_memory;

L
Laine Stump 已提交
10932 10933
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
10934 10935
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
10936
        ret = false;
10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972
        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 已提交
10973
        ret = false;
10974 10975 10976 10977 10978 10979 10980 10981
        goto cleanup;
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
10982
        ret = false;
10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999

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 已提交
11000
    ret = false;
11001
    goto cleanup;
11002 11003
}

11004 11005 11006 11007 11008 11009 11010 11011
/* 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;

11012
    ret = vshMalloc(ctl, PATH_MAX);
11013 11014 11015

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
11016 11017
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
11018
    if (fd == -1) {
11019
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
11020
                 strerror(errno));
11021
        VIR_FREE(ret);
11022 11023 11024 11025
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
11026 11027
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
11028
        VIR_FORCE_CLOSE(fd);
11029
        unlink (ret);
11030
        VIR_FREE(ret);
11031 11032
        return NULL;
    }
S
Stefan Berger 已提交
11033
    if (VIR_CLOSE(fd) < 0) {
11034 11035
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
11036
        unlink (ret);
11037
        VIR_FREE(ret);
11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052
        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 已提交
11053 11054 11055 11056
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
11057

11058
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
11059 11060 11061 11062
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
11063

11064 11065 11066 11067 11068
    /* 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 已提交
11069 11070
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
11071
     */
E
Eric Blake 已提交
11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083
    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);
11084 11085
    }

E
Eric Blake 已提交
11086 11087 11088 11089 11090 11091 11092
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
11093
    }
E
Eric Blake 已提交
11094
    ret = 0;
11095

E
Eric Blake 已提交
11096 11097 11098
cleanup:
    virCommandFree(cmd);
    return ret;
11099 11100 11101 11102 11103 11104 11105 11106
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
11107
        vshError(ctl,
11108
                 _("%s: failed to read temporary file: %s"),
11109
                 filename, strerror(errno));
11110 11111 11112 11113 11114
        return NULL;
    }
    return ret;
}

11115

P
Paolo Bonzini 已提交
11116 11117 11118 11119
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
11120 11121
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
11122 11123 11124 11125
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
11126
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
11127 11128 11129
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11130
static bool
11131
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
11132
{
11133
    const char *dir = NULL;
11134
    char *dir_malloced = NULL;
E
Eric Blake 已提交
11135
    bool ret = true;
P
Paolo Bonzini 已提交
11136 11137

    if (!ctl->imode) {
11138
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
11139
        return false;
P
Paolo Bonzini 已提交
11140 11141
    }

11142
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
11143
        uid_t uid = geteuid();
11144
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
11145 11146 11147 11148
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
11149
    if (chdir(dir) == -1) {
11150
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
11151
        ret = false;
P
Paolo Bonzini 已提交
11152 11153
    }

11154
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
11155
    return ret;
P
Paolo Bonzini 已提交
11156 11157 11158 11159 11160 11161
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
11162 11163
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
11164 11165 11166
    {NULL, NULL}
};

E
Eric Blake 已提交
11167
static bool
P
Paolo Bonzini 已提交
11168 11169 11170
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
11171
    bool ret = true;
P
Paolo Bonzini 已提交
11172

11173 11174
    cwd = getcwd(NULL, 0);
    if (!cwd) {
11175 11176
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
11177 11178
        ret = false;
    } else {
P
Paolo Bonzini 已提交
11179
        vshPrint (ctl, _("%s\n"), cwd);
11180 11181
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
11182

11183
    return ret;
P
Paolo Bonzini 已提交
11184 11185
}

E
Eric Blake 已提交
11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197
/*
 * "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")},
11198
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
11199 11200 11201 11202 11203 11204
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
11205
static bool
E
Eric Blake 已提交
11206 11207 11208 11209 11210
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
11211
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
11212 11213 11214 11215 11216 11217 11218 11219
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

11220
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
11221 11222 11223
        bool close_quote = false;
        char *q;

11224
        arg = opt->data;
E
Eric Blake 已提交
11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252
        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 已提交
11253
        return false;
E
Eric Blake 已提交
11254 11255 11256 11257 11258
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
11259
    return true;
E
Eric Blake 已提交
11260 11261
}

11262 11263 11264 11265
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
11266 11267
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
11268 11269 11270 11271
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
11272
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11273 11274 11275 11276 11277 11278
    {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 已提交
11279
static bool
11280 11281
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
11282
    bool ret = false;
11283 11284 11285 11286 11287
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
11288
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
11289

11290
    if (!vshConnectionUsability(ctl, ctl->conn))
11291 11292
        goto cleanup;

J
Jim Meyering 已提交
11293
    dom = vshCommandOptDomain (ctl, cmd, NULL);
11294 11295 11296 11297
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
11298
    doc = virDomainGetXMLDesc (dom, flags);
11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316
    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 已提交
11317
        ret = true;
11318 11319 11320 11321 11322 11323 11324
        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.
     */
11325
    doc_reread = virDomainGetXMLDesc (dom, flags);
11326 11327 11328 11329
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
11330 11331
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343
        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 已提交
11344
    ret = true;
11345 11346 11347 11348 11349

 cleanup:
    if (dom)
        virDomainFree (dom);

11350 11351 11352
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
11353 11354 11355

    if (tmp) {
        unlink (tmp);
11356
        VIR_FREE(tmp);
11357 11358 11359 11360 11361
    }

    return ret;
}

11362

11363 11364 11365 11366
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
11367 11368
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
11369 11370 11371 11372
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
11373
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
11374 11375 11376 11377 11378 11379 11380 11381 11382 11383
    {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[] = {
11384 11385
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
11386 11387 11388 11389
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
11390
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
11391 11392 11393 11394 11395 11396
    {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 已提交
11397 11398 11399
/*
 * "quit" command
 */
11400
static const vshCmdInfo info_quit[] = {
11401
    {"help", N_("quit this interactive terminal")},
11402
    {"desc", ""},
11403
    {NULL, NULL}
K
Karel Zak 已提交
11404 11405
};

E
Eric Blake 已提交
11406
static bool
11407
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11408
{
E
Eric Blake 已提交
11409 11410
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
11411 11412
}

11413 11414 11415 11416
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
11417 11418
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
11419 11420 11421 11422 11423 11424 11425 11426 11427
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11428
static bool
11429 11430 11431
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11432
    bool ret = false;
11433
    const char *from = NULL;
11434 11435 11436 11437 11438 11439 11440
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

11441
    if (!vshConnectionUsability(ctl, ctl->conn))
11442 11443 11444 11445 11446 11447
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11448
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
11449
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
11450 11451 11452 11453 11454 11455 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
    else {
        if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
            /* we have to report the error here because during cleanup
             * we'll run through virDomainFree(), which loses the
             * last error
             */
            virshReportError(ctl);
            goto cleanup;
        }
    }
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

    snapshot = virDomainSnapshotCreateXML(dom, buffer, 0);
    if (snapshot == NULL)
        goto cleanup;

    doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domainsnapshot.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        goto cleanup;

    name = virXPathString("string(/domainsnapshot/name)", ctxt);
    if (!name) {
        vshError(ctl, "%s",
                 _("Could not find 'name' element in domain snapshot XML"));
        goto cleanup;
    }

    vshPrint(ctl, _("Domain snapshot %s created"), name);
    if (from)
        vshPrint(ctl, _(" from '%s'"), from);
    vshPrint(ctl, "\n");

E
Eric Blake 已提交
11494
    ret = true;
11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510

cleanup:
    VIR_FREE(name);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523
/*
 * "snapshot-create-as" command
 */
static const vshCmdInfo info_snapshot_create_as[] = {
    {"help", N_("Create a snapshot from a set of args")},
    {"desc", N_("Create a snapshot (disk and RAM) from arguments")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_create_as[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"name", VSH_OT_DATA, 0, N_("name of snapshot")},
    {"description", VSH_OT_DATA, 0, N_("description of snapshot")},
E
Eric Blake 已提交
11524
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
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
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    const char *name = NULL;
    const char *desc = NULL;
    char *parsed_name = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    if (vshCommandOptString(cmd, "name", &name) < 0 ||
        vshCommandOptString(cmd, "description", &desc) < 0) {
        vshError(ctl, _("argument must not be empty"));
        goto cleanup;
    }

    virBufferAddLit(&buf, "<domainsnapshot>\n");
    if (name)
        virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    if (desc)
        virBufferAsprintf(&buf, "  <description>%s</description>\n", desc);
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
11569 11570 11571 11572 11573 11574
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617
    snapshot = virDomainSnapshotCreateXML(dom, buffer, 0);
    if (snapshot == NULL)
        goto cleanup;

    doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domainsnapshot.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        goto cleanup;

    parsed_name = virXPathString("string(/domainsnapshot/name)", ctxt);
    if (!parsed_name) {
        vshError(ctl, "%s",
                 _("Could not find 'name' element in domain snapshot XML"));
        goto cleanup;
    }

    vshPrint(ctl, _("Domain snapshot %s created\n"), name ? name : parsed_name);

    ret = true;

cleanup:
    VIR_FREE(parsed_name);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
    {"help", N_("Get the current snapshot")},
    {"desc", N_("Get the current snapshot")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11632
static bool
11633 11634 11635
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11636
    bool ret = false;
11637 11638 11639
    int current;
    virDomainSnapshotPtr snapshot = NULL;

11640
    if (!vshConnectionUsability(ctl, ctl->conn))
11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
        char *xml;

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

        xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
        if (!xml)
            goto cleanup;

        vshPrint(ctl, "%s", xml);
        VIR_FREE(xml);
    }

E
Eric Blake 已提交
11664
    ret = true;
11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-list" command
 */
static const vshCmdInfo info_snapshot_list[] = {
    {"help", N_("List snapshots for a domain")},
    {"desc", N_("Snapshot List")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11689
static bool
11690 11691 11692
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11693
    bool ret = false;
11694 11695
    int numsnaps;
    char **names = NULL;
11696
    int actual = 0;
11697 11698 11699 11700 11701 11702
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
11703 11704
    long long creation_longlong;
    time_t creation_time_t;
11705 11706 11707
    char timestr[100];
    struct tm time_info;

11708
    if (!vshConnectionUsability(ctl, ctl->conn))
11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

11720 11721
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762

    if (numsnaps) {
        if (VIR_ALLOC_N(names, numsnaps) < 0)
            goto cleanup;

        actual = virDomainSnapshotListNames(dom, names, numsnaps, 0);
        if (actual < 0)
            goto cleanup;

        qsort(&names[0], actual, sizeof(char*), namesorter);

        for (i = 0; i < actual; i++) {
            /* free up memory from previous iterations of the loop */
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
            if (xml)
                xmlFreeDoc(xml);
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

            xml = xmlReadDoc((const xmlChar *) doc, "domainsnapshot.xml", NULL,
                             XML_PARSE_NOENT | XML_PARSE_NONET |
                             XML_PARSE_NOWARNING);
            if (!xml)
                continue;
            ctxt = xmlXPathNewContext(xml);
            if (!ctxt)
                continue;

            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
11763 11764
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
11765
                continue;
11766 11767 11768 11769 11770 11771
            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);
11772
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
11773 11774 11775 11776 11777

            vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
        }
    }

E
Eric Blake 已提交
11778
    ret = true;
11779 11780 11781 11782 11783 11784 11785 11786 11787 11788

cleanup:
    /* this frees up memory from the last iteration of the loop */
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    VIR_FREE(doc);
11789 11790
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812
    VIR_FREE(names);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-dumpxml" command
 */
static const vshCmdInfo info_snapshot_dumpxml[] = {
    {"help", N_("Dump XML for a domain snapshot")},
    {"desc", N_("Snapshot Dump XML")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11813
static bool
11814 11815 11816
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11817
    bool ret = false;
11818
    const char *name = NULL;
11819 11820 11821
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

11822
    if (!vshConnectionUsability(ctl, ctl->conn))
11823 11824 11825 11826 11827 11828
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11829
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11830 11831 11832 11833 11834 11835 11836 11837 11838 11839
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

11840
    vshPrint(ctl, "%s", xml);
11841

E
Eric Blake 已提交
11842
    ret = true;
11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
11855
 * "snapshot-revert" command
11856
 */
11857
static const vshCmdInfo info_snapshot_revert[] = {
11858 11859 11860 11861 11862
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

11863
static const vshCmdOptDef opts_snapshot_revert[] = {
11864 11865 11866 11867 11868
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11869
static bool
11870
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
11871 11872
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11873
    bool ret = false;
11874
    const char *name = NULL;
11875 11876
    virDomainSnapshotPtr snapshot = NULL;

11877
    if (!vshConnectionUsability(ctl, ctl->conn))
11878 11879 11880 11881 11882 11883
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11884
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11885 11886 11887 11888 11889 11890 11891 11892 11893
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    if (virDomainRevertToSnapshot(snapshot, 0) < 0)
        goto cleanup;

E
Eric Blake 已提交
11894
    ret = true;
11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-delete" command
 */
static const vshCmdInfo info_snapshot_delete[] = {
    {"help", N_("Delete a domain snapshot")},
    {"desc", N_("Snapshot Delete")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_delete[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {"children", VSH_OT_BOOL, 0, N_("delete snapshot and all children")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11921
static bool
11922 11923 11924
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11925
    bool ret = false;
11926
    const char *name = NULL;
11927 11928 11929
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

11930
    if (!vshConnectionUsability(ctl, ctl->conn))
11931 11932 11933 11934 11935 11936
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11937
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11938 11939 11940 11941 11942 11943 11944 11945 11946
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

11947 11948 11949 11950
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
        vshPrint(ctl, _("Domain snapshot %s deleted\n"), name);
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
11951
        goto cleanup;
11952
    }
11953

E
Eric Blake 已提交
11954
    ret = true;
11955 11956 11957 11958 11959 11960 11961 11962 11963 11964

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11965 11966 11967 11968
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
11969 11970
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
11971 11972 11973 11974 11975 11976
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"cmd", VSH_OT_DATA, VSH_OFLAG_REQ, N_("command")},
11977
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
11978 11979 11980
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11981
static bool
11982 11983 11984
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11985
    bool ret = false;
11986
    const char *monitor_cmd = NULL;
11987
    char *result = NULL;
11988
    unsigned int flags = 0;
11989 11990 11991 11992 11993 11994 11995 11996

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11997
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
11998 11999 12000 12001
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

12002 12003 12004 12005
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
12006 12007 12008 12009
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
12010
    ret = true;
12011 12012 12013 12014 12015 12016 12017 12018 12019

cleanup:
    VIR_FREE(result);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065
/*
 * "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;
}

12066
static const vshCmdDef domManagementCmds[] = {
12067 12068 12069 12070 12071 12072 12073 12074
    {"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},
12075
#ifndef WIN32
12076
    {"console", cmdConsole, opts_console, info_console, 0},
12077
#endif
12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100
    {"cpu-baseline", cmdCPUBaseline, opts_cpu_baseline, info_cpu_baseline, 0},
    {"cpu-compare", cmdCPUCompare, opts_cpu_compare, info_cpu_compare, 0},
    {"create", cmdCreate, opts_create, info_create, 0},
    {"define", cmdDefine, opts_define, info_define, 0},
    {"destroy", cmdDestroy, opts_destroy, info_destroy, 0},
    {"detach-device", cmdDetachDevice, opts_detach_device,
     info_detach_device, 0},
    {"detach-disk", cmdDetachDisk, opts_detach_disk, info_detach_disk, 0},
    {"detach-interface", cmdDetachInterface, opts_detach_interface,
     info_detach_interface, 0},
    {"domid", cmdDomid, opts_domid, info_domid, 0},
    {"domjobabort", cmdDomjobabort, opts_domjobabort, info_domjobabort, 0},
    {"domjobinfo", cmdDomjobinfo, opts_domjobinfo, info_domjobinfo, 0},
    {"domname", cmdDomname, opts_domname, info_domname, 0},
    {"domuuid", cmdDomuuid, opts_domuuid, info_domuuid, 0},
    {"domxml-from-native", cmdDomXMLFromNative, opts_domxmlfromnative,
     info_domxmlfromnative, 0},
    {"domxml-to-native", cmdDomXMLToNative, opts_domxmltonative,
     info_domxmltonative, 0},
    {"dump", cmdDump, opts_dump, info_dump, 0},
    {"dumpxml", cmdDumpXML, opts_dumpxml, info_dumpxml, 0},
    {"edit", cmdEdit, opts_edit, info_edit, 0},
    {"inject-nmi", cmdInjectNMI, opts_inject_nmi, info_inject_nmi, 0},
12101
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
12102 12103 12104 12105 12106 12107 12108 12109
    {"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},
12110 12111
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
12112 12113 12114 12115 12116
    {"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},
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
12117
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129
    {"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 已提交
12130
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
12131
    {"version", cmdVersion, opts_version, info_version, 0},
12132 12133
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
12134 12135 12136
};

static const vshCmdDef domMonitoringCmds[] = {
12137 12138
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
12139
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
12140 12141 12142 12143 12144 12145
    {"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}
12146 12147 12148
};

static const vshCmdDef storagePoolCmds[] = {
12149
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
12150
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
12151
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172
     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}
12173 12174 12175
};

static const vshCmdDef storageVolCmds[] = {
12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193
    {"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}
12194
};
12195

12196
static const vshCmdDef networkCmds[] = {
12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215
    {"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}
12216
};
12217

12218
static const vshCmdDef nodedevCmds[] = {
12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233
    {"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}
12234 12235 12236
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
12237 12238 12239 12240
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254
    {"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 已提交
12255 12256
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
12257 12258 12259 12260 12261
    {"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}
12262
};
12263

12264
static const vshCmdDef nwfilterCmds[] = {
12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275
    {"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}
12276
};
12277

12278
static const vshCmdDef secretCmds[] = {
12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290
    {"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}
12291
};
12292

12293
static const vshCmdDef virshCmds[] = {
12294 12295 12296 12297 12298 12299 12300
    {"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}
12301
};
12302

12303
static const vshCmdDef snapshotCmds[] = {
12304 12305
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
12306 12307
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318
    {"snapshot-current", cmdSnapshotCurrent, opts_snapshot_current,
     info_snapshot_current, 0},
    {"snapshot-delete", cmdSnapshotDelete, opts_snapshot_delete,
     info_snapshot_delete, 0},
    {"snapshot-dumpxml", cmdSnapshotDumpXML, opts_snapshot_dumpxml,
     info_snapshot_dumpxml, 0},
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
12319
};
12320

12321
static const vshCmdDef hostAndHypervisorCmds[] = {
12322 12323 12324 12325 12326
    {"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},
12327
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
12328
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
12329
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
12330
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
12331 12332 12333 12334 12335
    {"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 已提交
12336 12337
};

12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354
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 已提交
12355 12356 12357 12358
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
12359
static const char *
12360
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
12361
{
12362
    const vshCmdInfo *info;
12363

K
Karel Zak 已提交
12364
    for (info = cmd->info; info && info->name; info++) {
12365
        if (STREQ(info->name, name))
K
Karel Zak 已提交
12366 12367 12368 12369 12370
            return info->data;
    }
    return NULL;
}

12371
static int
E
Eric Blake 已提交
12372
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
12373 12374 12375 12376 12377
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
12378 12379 12380
    *opts_need_arg = 0;
    *opts_required = 0;

12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393
    if (!cmd->opts)
        return 0;

    for (i = 0; cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];

        if (i > 31)
            return -1; /* too many options */
        if (opt->type == VSH_OT_BOOL) {
            if (opt->flag & VSH_OFLAG_REQ)
                return -1; /* bool options can't be mandatory */
            continue;
        }
L
Lai Jiangshan 已提交
12394 12395 12396 12397 12398 12399
        if (opt->flag & VSH_OFLAG_REQ_OPT) {
            if (opt->flag & VSH_OFLAG_REQ)
                *opts_required |= 1 << i;
            continue;
        }

12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411
        *opts_need_arg |= 1 << i;
        if (opt->flag & VSH_OFLAG_REQ) {
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
    }
    return 0;
}

12412
static const vshCmdOptDef *
12413 12414
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
12415
{
12416 12417 12418 12419
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
12420

12421 12422 12423 12424 12425
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
12426 12427 12428 12429 12430
            if (opt->type == VSH_OT_ARGV) {
                vshError(ctl, _("variable argument <%s> "
                         "should not be used with --<%s>"), name, name);
                return NULL;
            }
12431
            *opts_seen |= 1 << i;
K
Karel Zak 已提交
12432
            return opt;
12433 12434 12435 12436 12437
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
12438 12439 12440
    return NULL;
}

12441
static const vshCmdOptDef *
12442 12443
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
12444
{
12445
    int i;
12446
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
12447

12448 12449 12450 12451 12452 12453 12454 12455 12456 12457
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
    i = count_one_bits(*opts_need_arg ^ (*opts_need_arg - 1)) - 1;
    opt = &cmd->opts[i];
    if (opt->type != VSH_OT_ARGV)
        *opts_need_arg &= ~(1 << i);
    *opts_seen |= 1 << i;
    return opt;
K
Karel Zak 已提交
12458 12459
}

12460 12461 12462
/*
 * Checks for required options
 */
12463
static int
12464 12465
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
12466
{
12467
    const vshCmdDef *def = cmd->def;
12468 12469 12470 12471 12472 12473 12474 12475 12476
    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];
12477

12478
            vshError(ctl,
12479
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
12480 12481 12482
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
12483 12484
        }
    }
12485
    return -1;
12486 12487
}

12488
static const vshCmdDef *
12489 12490
vshCmddefSearch(const char *cmdname)
{
12491
    const vshCmdGrp *g;
12492
    const vshCmdDef *c;
12493

12494 12495
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
12496
            if (STREQ(c->name, cmdname))
12497 12498 12499 12500
                return c;
        }
    }

K
Karel Zak 已提交
12501 12502 12503
    return NULL;
}

12504 12505 12506 12507 12508 12509
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
12510
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
12511 12512 12513 12514 12515 12516
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
12517
static bool
12518 12519 12520 12521 12522 12523 12524
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 已提交
12525
        return false;
12526 12527 12528 12529 12530 12531 12532 12533 12534 12535
    } 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 已提交
12536
    return true;
12537 12538
}

E
Eric Blake 已提交
12539
static bool
12540
vshCmddefHelp(vshControl *ctl, const char *cmdname)
12541
{
12542
    const vshCmdDef *def = vshCmddefSearch(cmdname);
12543

K
Karel Zak 已提交
12544
    if (!def) {
12545
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
12546
        return false;
12547
    } else {
E
Eric Blake 已提交
12548 12549
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
12550
        const char *help = _(vshCmddefGetInfo(def, "help"));
12551
        char buf[256];
12552 12553 12554 12555 12556 12557
        uint32_t opts_need_arg;
        uint32_t opts_required;

        if (vshCmddefOptParse(def, &opts_need_arg, &opts_required)) {
            vshError(ctl, _("internal error: bad options in command: '%s'"),
                     def->name);
E
Eric Blake 已提交
12558
            return false;
12559
        }
K
Karel Zak 已提交
12560

12561
        fputs(_("  NAME\n"), stdout);
12562 12563
        fprintf(stdout, "    %s - %s\n", def->name, help);

12564 12565 12566 12567 12568
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
12569
                const char *fmt = "%s";
12570 12571
                switch (opt->type) {
                case VSH_OT_BOOL:
12572
                    fmt = "[--%s]";
12573 12574
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
12575
                    /* xgettext:c-format */
12576 12577
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
12578 12579
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
12580 12581
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
12582 12583
                    break;
                case VSH_OT_DATA:
12584
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
12585 12586 12587
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
12588 12589
                    fmt = (opt->flag & VSH_OFLAG_REQ) ? _("<%s>...")
                           : _("[<%s>]...");
12590 12591
                    break;
                default:
12592
                    assert(0);
12593
                }
12594
                fputc(' ', stdout);
E
Eric Blake 已提交
12595
                fprintf(stdout, fmt, opt->name);
12596
            }
K
Karel Zak 已提交
12597
        }
12598 12599 12600
        fputc('\n', stdout);

        if (desc[0]) {
12601
            /* Print the description only if it's not empty.  */
12602
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
12603
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
12604
        }
12605

K
Karel Zak 已提交
12606
        if (def->opts) {
12607
            const vshCmdOptDef *opt;
12608
            fputs(_("\n  OPTIONS\n"), stdout);
12609
            for (opt = def->opts; opt->name; opt++) {
12610 12611
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
12612
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
12613 12614
                    break;
                case VSH_OT_INT:
12615 12616 12617
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
12618 12619
                    break;
                case VSH_OT_STRING:
12620
                    /* OT_STRING should never be VSH_OFLAG_REQ */
12621
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
12622 12623
                    break;
                case VSH_OT_DATA:
12624 12625
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
12626 12627 12628
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
12629 12630
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
12631 12632 12633
                default:
                    assert(0);
                }
12634

E
Eric Blake 已提交
12635
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
12636
            }
K
Karel Zak 已提交
12637 12638 12639
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
12640
    return true;
K
Karel Zak 已提交
12641 12642 12643 12644 12645 12646
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
12647 12648 12649
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
12650 12651
    vshCmdOpt *a = arg;

12652
    while (a) {
K
Karel Zak 已提交
12653
        vshCmdOpt *tmp = a;
12654

K
Karel Zak 已提交
12655 12656
        a = a->next;

12657 12658
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
12659 12660 12661 12662
    }
}

static void
12663
vshCommandFree(vshCmd *cmd)
12664
{
K
Karel Zak 已提交
12665 12666
    vshCmd *c = cmd;

12667
    while (c) {
K
Karel Zak 已提交
12668
        vshCmd *tmp = c;
12669

K
Karel Zak 已提交
12670 12671 12672 12673
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
12674
        VIR_FREE(tmp);
K
Karel Zak 已提交
12675 12676 12677
    }
}

E
Eric Blake 已提交
12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688
/**
 * 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 已提交
12689
 */
E
Eric Blake 已提交
12690 12691
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
12692
{
E
Eric Blake 已提交
12693 12694
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
12695

E
Eric Blake 已提交
12696 12697 12698 12699 12700 12701 12702
    /* 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 已提交
12703
    }
E
Eric Blake 已提交
12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
            return (valid->flag & VSH_OFLAG_REQ) == 0 ? 0 : -1;
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
12716 12717
}

E
Eric Blake 已提交
12718 12719
/**
 * vshCommandOptInt:
12720 12721 12722 12723 12724 12725 12726
 * @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 已提交
12727
 * 0 if option not found and not required (@value untouched)
12728
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
12729 12730
 */
static int
12731
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
12732
{
E
Eric Blake 已提交
12733 12734 12735
    vshCmdOpt *arg;
    int ret;
    int num;
12736
    char *end_p = NULL;
12737

E
Eric Blake 已提交
12738 12739 12740 12741 12742 12743 12744
    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;
12745
    }
E
Eric Blake 已提交
12746 12747 12748 12749 12750 12751 12752

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
12753 12754
}

12755

E
Eric Blake 已提交
12756 12757 12758 12759 12760 12761
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
12762 12763 12764 12765 12766 12767
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
12768 12769 12770
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
12771 12772
    char *end_p = NULL;

E
Eric Blake 已提交
12773 12774 12775 12776 12777 12778 12779
    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;
12780
    }
E
Eric Blake 已提交
12781 12782 12783 12784 12785 12786 12787

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
12788 12789 12790
}


12791
/*
E
Eric Blake 已提交
12792 12793 12794 12795 12796
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
12797 12798 12799 12800 12801
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
12802
{
E
Eric Blake 已提交
12803 12804
    vshCmdOpt *arg;
    int ret;
12805
    unsigned long num;
12806 12807
    char *end_p = NULL;

E
Eric Blake 已提交
12808 12809 12810 12811 12812 12813 12814
    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;
12815
    }
E
Eric Blake 已提交
12816 12817 12818 12819 12820 12821 12822

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
12823 12824
}

E
Eric Blake 已提交
12825 12826 12827 12828 12829 12830
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
12831
 * Returns option as STRING
E
Eric Blake 已提交
12832 12833 12834 12835
 * 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 已提交
12836
 */
12837 12838
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
12839
{
E
Eric Blake 已提交
12840 12841 12842 12843 12844 12845 12846 12847 12848 12849
    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;
12850
    }
12851

E
Eric Blake 已提交
12852 12853 12854 12855 12856
    if (!*arg->data && !(arg->def->flag & VSH_OFLAG_EMPTY_OK)) {
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
12857 12858
}

E
Eric Blake 已提交
12859 12860 12861 12862 12863 12864
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
12865
 * Returns option as long long
12866
 * See vshCommandOptInt()
12867
 */
12868 12869 12870
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
12871
{
E
Eric Blake 已提交
12872 12873
    vshCmdOpt *arg;
    int ret;
12874
    long long num;
12875 12876
    char *end_p = NULL;

E
Eric Blake 已提交
12877 12878 12879 12880 12881 12882 12883
    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;
12884
    }
E
Eric Blake 已提交
12885 12886 12887 12888 12889 12890 12891

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
12892 12893
}

E
Eric Blake 已提交
12894 12895 12896 12897 12898 12899 12900 12901 12902
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
12903 12904 12905 12906
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
12907 12908
    vshCmdOpt *arg;
    int ret;
12909 12910 12911
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
12912 12913 12914 12915 12916 12917 12918
    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;
12919
    }
E
Eric Blake 已提交
12920 12921 12922 12923 12924 12925 12926

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
12927 12928 12929
}


E
Eric Blake 已提交
12930 12931 12932 12933 12934 12935 12936 12937 12938
/**
 * 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 已提交
12939
 */
E
Eric Blake 已提交
12940
static bool
12941
vshCommandOptBool(const vshCmd *cmd, const char *name)
12942
{
E
Eric Blake 已提交
12943 12944 12945
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
12946 12947
}

E
Eric Blake 已提交
12948 12949 12950 12951 12952
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
12953 12954
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
12955
 *
12956
 * Requires that a VSH_OT_ARGV option be last in the
12957 12958
 * list of supported options in CMD->def->opts.
 */
12959 12960
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
12961
{
12962
    opt = opt ? opt->next : cmd->opts;
12963 12964

    while (opt) {
E
Eric Blake 已提交
12965
        if (opt->def->type == VSH_OT_ARGV) {
12966
            return opt;
12967 12968 12969 12970 12971 12972
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990
/* 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)
12991
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
12992 12993 12994
                 cmd->def->name, optname);
    return found;
}
12995

K
Karel Zak 已提交
12996
static virDomainPtr
J
Jim Meyering 已提交
12997
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
12998
                      const char **name, int flag)
12999
{
K
Karel Zak 已提交
13000
    virDomainPtr dom = NULL;
13001
    const char *n = NULL;
K
Karel Zak 已提交
13002
    int id;
J
Jim Meyering 已提交
13003 13004 13005
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
13006

13007
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13008 13009
        return NULL;

13010
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13011 13012
             cmd->def->name, optname, n);

K
Karel Zak 已提交
13013 13014
    if (name)
        *name = n;
13015

K
Karel Zak 已提交
13016
    /* try it by ID */
13017
    if (flag & VSH_BYID) {
13018
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
13019 13020
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
13021 13022 13023
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
13024
    }
K
Karel Zak 已提交
13025
    /* try it by UUID */
13026
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
13027
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
13028
                 cmd->def->name, optname);
K
Karel Zak 已提交
13029
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
13030
    }
K
Karel Zak 已提交
13031
    /* try it by NAME */
13032
    if (dom==NULL && (flag & VSH_BYNAME)) {
13033
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
13034
                 cmd->def->name, optname);
K
Karel Zak 已提交
13035
        dom = virDomainLookupByName(ctl->conn, n);
13036
    }
K
Karel Zak 已提交
13037

13038
    if (!dom)
13039
        vshError(ctl, _("failed to get domain '%s'"), n);
13040

K
Karel Zak 已提交
13041 13042 13043
    return dom;
}

13044
static virNetworkPtr
J
Jim Meyering 已提交
13045
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
13046
                       const char **name, int flag)
13047 13048
{
    virNetworkPtr network = NULL;
13049
    const char *n = NULL;
J
Jim Meyering 已提交
13050 13051 13052
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
13053

13054
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13055 13056
        return NULL;

13057
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13058 13059 13060 13061 13062 13063
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
13064
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13065
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
13066
                 cmd->def->name, optname);
13067 13068 13069 13070
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
13071
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
13072 13073 13074 13075 13076
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
13077
        vshError(ctl, _("failed to get network '%s'"), n);
13078 13079 13080 13081

    return network;
}

13082 13083 13084

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
13085
                        const char **name, int flag)
13086 13087
{
    virNWFilterPtr nwfilter = NULL;
13088
    const char *n = NULL;
13089 13090 13091 13092
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13093
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13094 13095
        return NULL;

13096
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13097 13098 13099 13100 13101 13102 13103
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13104
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
13105 13106 13107 13108 13109
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
13110
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
13111 13112 13113 13114 13115 13116 13117 13118 13119 13120
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

13121 13122
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
13123
                         const char **name, int flag)
13124 13125
{
    virInterfacePtr iface = NULL;
13126
    const char *n = NULL;
13127 13128 13129 13130
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13131
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13132 13133
        return NULL;

13134
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13135 13136 13137 13138 13139 13140
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
13141
    if ((flag & VSH_BYNAME)) {
13142
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
13143 13144 13145 13146 13147
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
13148
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
13149 13150 13151 13152 13153
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
13154
        vshError(ctl, _("failed to get interface '%s'"), n);
13155 13156 13157 13158

    return iface;
}

13159
static virStoragePoolPtr
13160
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
13161
                    const char **name, int flag)
13162 13163
{
    virStoragePoolPtr pool = NULL;
13164
    const char *n = NULL;
13165

13166
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13167 13168
        return NULL;

13169
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13170 13171 13172 13173 13174 13175
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
13176
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13177
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
13178
                 cmd->def->name, optname);
13179 13180 13181
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
13182
    if (pool == NULL && (flag & VSH_BYNAME)) {
13183
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
13184 13185 13186 13187 13188
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
13189
        vshError(ctl, _("failed to get pool '%s'"), n);
13190 13191 13192 13193 13194

    return pool;
}

static virStorageVolPtr
13195
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
13196 13197
                   const char *optname,
                   const char *pooloptname,
13198
                   const char **name, int flag)
13199 13200 13201
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
13202
    const char *n = NULL, *p = NULL;
13203

13204
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13205 13206
        return NULL;

13207 13208
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
13209
        return NULL;
13210
    }
13211 13212 13213 13214

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

13215
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
13216 13217 13218 13219 13220
             cmd->def->name, optname, n);

    if (name)
        *name = n;

13221
    /* try it by name */
13222
    if (pool && (flag & VSH_BYNAME)) {
13223
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
13224 13225 13226
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
13227
    /* try it by key */
13228
    if (vol == NULL && (flag & VSH_BYUUID)) {
13229
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
13230 13231 13232
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
13233
    /* try it by path */
13234
    if (vol == NULL && (flag & VSH_BYUUID)) {
13235
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
13236 13237 13238 13239 13240
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
13241
        vshError(ctl, _("failed to get vol '%s'"), n);
13242 13243 13244 13245 13246 13247 13248

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

13249
static virSecretPtr
13250
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
13251 13252
{
    virSecretPtr secret = NULL;
13253
    const char *n = NULL;
13254 13255 13256 13257 13258
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13259
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13260 13261
        return NULL;

13262 13263
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
13264 13265 13266 13267 13268 13269 13270

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
13271
        vshError(ctl, _("failed to get secret '%s'"), n);
13272 13273 13274 13275

    return secret;
}

K
Karel Zak 已提交
13276 13277 13278
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
13279
static bool
13280
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
13281
{
E
Eric Blake 已提交
13282
    bool ret = true;
13283 13284

    while (cmd) {
K
Karel Zak 已提交
13285
        struct timeval before, after;
13286
        bool enable_timing = ctl->timing;
13287

13288 13289
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
13290 13291
            vshReconnect(ctl);

13292
        if (enable_timing)
K
Karel Zak 已提交
13293
            GETTIMEOFDAY(&before);
13294

K
Karel Zak 已提交
13295 13296
        ret = cmd->def->handler(ctl, cmd);

13297
        if (enable_timing)
K
Karel Zak 已提交
13298
            GETTIMEOFDAY(&after);
13299

13300
        if (!ret)
J
John Levon 已提交
13301 13302
            virshReportError(ctl);

13303
        /* try to automatically catch disconnections */
13304
        if (!ret &&
13305 13306 13307 13308 13309 13310 13311 13312 13313
            ((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);

13314
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
13315 13316
            return ret;

13317
        if (enable_timing)
13318
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
13319 13320
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
13321
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
13322 13323 13324 13325 13326 13327
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
13328
 * Command parsing
K
Karel Zak 已提交
13329 13330 13331
 * ---------------
 */

13332 13333 13334 13335 13336 13337 13338 13339 13340 13341
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 已提交
13342
    /* vshCommandStringGetArg() */
13343
    char *pos;
L
Lai Jiangshan 已提交
13344 13345 13346
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
13347 13348
} vshCommandParser;

E
Eric Blake 已提交
13349
static bool
13350
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
13351
{
K
Karel Zak 已提交
13352 13353 13354
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
13355

K
Karel Zak 已提交
13356 13357 13358 13359
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
13360

13361
    while (1) {
K
Karel Zak 已提交
13362
        vshCmdOpt *last = NULL;
13363
        const vshCmdDef *cmd = NULL;
13364
        vshCommandToken tk;
L
Lai Jiangshan 已提交
13365
        bool data_only = false;
13366 13367 13368
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
13369

K
Karel Zak 已提交
13370
        first = NULL;
13371

13372
        while (1) {
13373
            const vshCmdOptDef *opt = NULL;
13374

K
Karel Zak 已提交
13375
            tkdata = NULL;
13376
            tk = parser->getNextArg(ctl, parser, &tkdata);
13377 13378

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
13379
                goto syntaxError;
H
Hu Tao 已提交
13380 13381
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
13382
                break;
H
Hu Tao 已提交
13383
            }
13384 13385

            if (cmd == NULL) {
K
Karel Zak 已提交
13386 13387
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
13388
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
13389
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
13390
                }
13391 13392 13393 13394 13395 13396 13397
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
13398
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
13399 13400 13401 13402
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
13403 13404 13405 13406 13407
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
13408 13409
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
13410
                    VIR_FREE(optstr);
K
Karel Zak 已提交
13411 13412
                    goto syntaxError;
                }
13413
                VIR_FREE(tkdata);
K
Karel Zak 已提交
13414 13415 13416

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
13417 13418 13419
                    if (optstr)
                        tkdata = optstr;
                    else
13420
                        tk = parser->getNextArg(ctl, parser, &tkdata);
13421
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
13422
                        goto syntaxError;
13423
                    if (tk != VSH_TK_ARG) {
13424
                        vshError(ctl,
13425
                                 _("expected syntax: --%s <%s>"),
13426 13427
                                 opt->name,
                                 opt->type ==
13428
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
13429 13430
                        goto syntaxError;
                    }
13431
                    opts_need_arg &= ~opts_seen;
13432 13433 13434 13435 13436 13437 13438 13439
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
13440
                }
L
Lai Jiangshan 已提交
13441 13442 13443 13444
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
13445
            } else {
L
Lai Jiangshan 已提交
13446
get_data:
13447 13448
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
13449
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
13450 13451 13452 13453 13454
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
13455
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
13456

K
Karel Zak 已提交
13457 13458 13459 13460
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
13461

K
Karel Zak 已提交
13462 13463 13464 13465 13466
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
13467

13468
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
13469 13470
                         cmd->name,
                         opt->name,
13471 13472
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
13473 13474
            }
        }
13475

D
Daniel Veillard 已提交
13476
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
13477
        if (cmd) {
13478
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
13479

K
Karel Zak 已提交
13480 13481 13482 13483
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

13484
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
13485
                VIR_FREE(c);
13486
                goto syntaxError;
13487
            }
13488

K
Karel Zak 已提交
13489 13490 13491 13492 13493 13494
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
13495 13496 13497

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
13498
    }
13499

E
Eric Blake 已提交
13500
    return true;
K
Karel Zak 已提交
13501

13502
 syntaxError:
13503
    if (ctl->cmd) {
K
Karel Zak 已提交
13504
        vshCommandFree(ctl->cmd);
13505 13506
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
13507 13508
    if (first)
        vshCommandOptFree(first);
13509
    VIR_FREE(tkdata);
E
Eric Blake 已提交
13510
    return false;
K
Karel Zak 已提交
13511 13512
}

13513 13514 13515 13516 13517 13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530
/* --------------------
 * 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 已提交
13531 13532
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
13533 13534 13535 13536
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
13537
        return false;
13538 13539 13540 13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551 13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609

    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 已提交
13610 13611
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
13612 13613 13614 13615
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
13616
        return false;
13617 13618 13619 13620 13621 13622

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
13623
/* ---------------
13624
 * Misc utils
K
Karel Zak 已提交
13625 13626
 * ---------------
 */
13627 13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654
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 已提交
13655
static const char *
13656 13657
vshDomainStateToString(int state)
{
13658
    switch ((virDomainState) state) {
13659
    case VIR_DOMAIN_RUNNING:
13660
        return N_("running");
13661
    case VIR_DOMAIN_BLOCKED:
13662
        return N_("idle");
13663
    case VIR_DOMAIN_PAUSED:
13664
        return N_("paused");
13665
    case VIR_DOMAIN_SHUTDOWN:
13666
        return N_("in shutdown");
13667
    case VIR_DOMAIN_SHUTOFF:
13668
        return N_("shut off");
13669
    case VIR_DOMAIN_CRASHED:
13670
        return N_("crashed");
13671
    case VIR_DOMAIN_NOSTATE:
13672
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
13673
    }
13674
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
13675 13676
}

13677 13678 13679 13680 13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694 13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777
static const char *
vshDomainStateReasonToString(int state, int reason)
{
    switch ((virDomainState) state) {
    case VIR_DOMAIN_NOSTATE:
        switch ((virDomainNostateReason) reason) {
        case VIR_DOMAIN_NOSTATE_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_RUNNING:
        switch ((virDomainRunningReason) reason) {
        case VIR_DOMAIN_RUNNING_BOOTED:
            return N_("booted");
        case VIR_DOMAIN_RUNNING_MIGRATED:
            return N_("migrated");
        case VIR_DOMAIN_RUNNING_RESTORED:
            return N_("restored");
        case VIR_DOMAIN_RUNNING_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_RUNNING_UNPAUSED:
            return N_("unpaused");
        case VIR_DOMAIN_RUNNING_MIGRATION_CANCELED:
            return N_("migration canceled");
        case VIR_DOMAIN_RUNNING_SAVE_CANCELED:
            return N_("save canceled");
        case VIR_DOMAIN_RUNNING_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_BLOCKED:
        switch ((virDomainBlockedReason) reason) {
        case VIR_DOMAIN_BLOCKED_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_PAUSED:
        switch ((virDomainPausedReason) reason) {
        case VIR_DOMAIN_PAUSED_USER:
            return N_("user");
        case VIR_DOMAIN_PAUSED_MIGRATION:
            return N_("migrating");
        case VIR_DOMAIN_PAUSED_SAVE:
            return N_("saving");
        case VIR_DOMAIN_PAUSED_DUMP:
            return N_("dumping");
        case VIR_DOMAIN_PAUSED_IOERROR:
            return N_("I/O error");
        case VIR_DOMAIN_PAUSED_WATCHDOG:
            return N_("watchdog");
        case VIR_DOMAIN_PAUSED_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_PAUSED_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_SHUTDOWN:
        switch ((virDomainShutdownReason) reason) {
        case VIR_DOMAIN_SHUTDOWN_USER:
            return N_("user");
        case VIR_DOMAIN_SHUTDOWN_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_SHUTOFF:
        switch ((virDomainShutoffReason) reason) {
        case VIR_DOMAIN_SHUTOFF_SHUTDOWN:
            return N_("shutdown");
        case VIR_DOMAIN_SHUTOFF_DESTROYED:
            return N_("destroyed");
        case VIR_DOMAIN_SHUTOFF_CRASHED:
            return N_("crashed");
        case VIR_DOMAIN_SHUTOFF_MIGRATED:
            return N_("migrated");
        case VIR_DOMAIN_SHUTOFF_SAVED:
            return N_("saved");
        case VIR_DOMAIN_SHUTOFF_FAILED:
            return N_("failed");
        case VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_SHUTOFF_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_CRASHED:
        switch ((virDomainCrashedReason) reason) {
        case VIR_DOMAIN_CRASHED_UNKNOWN:
            ;
        }
        break;
    }

    return N_("unknown");
}

13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794
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");
}

13795 13796 13797 13798
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
13799
    case VIR_VCPU_OFFLINE:
13800
        return N_("offline");
13801
    case VIR_VCPU_BLOCKED:
13802
        return N_("idle");
13803
    case VIR_VCPU_RUNNING:
13804
        return N_("running");
13805
    default:
13806
        ;/*FALLTHROUGH*/
13807
    }
13808
    return N_("no state");
13809 13810
}

E
Eric Blake 已提交
13811
static bool
13812
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
13813
{
13814 13815
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
13816 13817
     */
    if (!conn) {
13818
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
13819
        return false;
K
Karel Zak 已提交
13820
    }
E
Eric Blake 已提交
13821
    return true;
K
Karel Zak 已提交
13822 13823
}

K
Karel Zak 已提交
13824
static void
13825
vshDebug(vshControl *ctl, int level, const char *format, ...)
13826
{
K
Karel Zak 已提交
13827
    va_list ap;
13828
    char *str;
K
Karel Zak 已提交
13829

13830 13831 13832 13833 13834 13835 13836
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

13837
    va_start(ap, format);
13838
    vshOutputLogFile(ctl, level, format, ap);
13839 13840
    va_end(ap);

K
Karel Zak 已提交
13841
    va_start(ap, format);
13842 13843 13844 13845 13846
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
13847
    va_end(ap);
13848 13849
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
13850 13851 13852
}

static void
13853
vshPrintExtra(vshControl *ctl, const char *format, ...)
13854
{
K
Karel Zak 已提交
13855
    va_list ap;
13856
    char *str;
13857

13858
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
13859
        return;
13860

K
Karel Zak 已提交
13861
    va_start(ap, format);
13862 13863 13864 13865 13866
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
13867
    va_end(ap);
13868
    fputs(str, stdout);
13869
    VIR_FREE(str);
K
Karel Zak 已提交
13870 13871
}

K
Karel Zak 已提交
13872

K
Karel Zak 已提交
13873
static void
13874
vshError(vshControl *ctl, const char *format, ...)
13875
{
K
Karel Zak 已提交
13876
    va_list ap;
13877
    char *str;
13878

13879 13880 13881 13882 13883
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
13884

13885
    fputs(_("error: "), stderr);
13886

K
Karel Zak 已提交
13887
    va_start(ap, format);
13888 13889 13890
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
13891 13892
    va_end(ap);

13893 13894
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
13895 13896
}

13897

K
Karel Zak 已提交
13898
/*
13899
 * Initialize connection.
K
Karel Zak 已提交
13900
 */
E
Eric Blake 已提交
13901
static bool
13902
vshInit(vshControl *ctl)
13903
{
13904 13905
    char *debugEnv;

K
Karel Zak 已提交
13906
    if (ctl->conn)
E
Eric Blake 已提交
13907
        return false;
K
Karel Zak 已提交
13908

J
Jiri Denemark 已提交
13909
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
13910 13911 13912
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
13913 13914 13915
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
13916 13917
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
13918 13919
            } else {
                ctl->debug = debug;
13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

13932 13933
    vshOpenLogFile(ctl);

13934 13935
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
13936

13937 13938 13939
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

13940
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
13941
        return false;
13942

13943 13944 13945 13946
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
13947

13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958
        /* 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;
        }
13959
    }
K
Karel Zak 已提交
13960

E
Eric Blake 已提交
13961
    return true;
K
Karel Zak 已提交
13962 13963
}

13964 13965
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984
/**
 * 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:
13985
                vshError(ctl, "%s",
J
Jim Meyering 已提交
13986
                         _("failed to get the log file information"));
13987
                exit(EXIT_FAILURE);
13988 13989 13990
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
13991 13992
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
13993 13994 13995 13996
        }
    }

    /* log file open */
13997
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
13998
        vshError(ctl, "%s",
J
Jim Meyering 已提交
13999
                 _("failed to open the log file. check the log file path"));
14000
        exit(EXIT_FAILURE);
14001 14002 14003 14004 14005 14006 14007 14008 14009
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
14010 14011
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
14012
{
14013 14014 14015
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029
    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);
14030
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
14031 14032 14033 14034 14035 14036
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
14037 14038
                      SIGN_NAME,
                      (int) getpid());
14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058
    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;
    }
14059 14060 14061
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
14062

14063 14064
    if (virBufferError(&buf))
        goto error;
14065

14066 14067 14068 14069 14070
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
14071
    }
14072

14073 14074 14075 14076 14077 14078 14079 14080 14081 14082 14083
    /* 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);
14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
14095 14096 14097
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
14098 14099 14100
    }

    if (ctl->logfile) {
14101
        VIR_FREE(ctl->logfile);
14102 14103 14104 14105
        ctl->logfile = NULL;
    }
}

14106
#ifdef USE_READLINE
14107

K
Karel Zak 已提交
14108 14109 14110 14111 14112
/* -----------------
 * Readline stuff
 * -----------------
 */

14113
/*
K
Karel Zak 已提交
14114 14115
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
14116
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
14117 14118
 */
static char *
14119 14120
vshReadlineCommandGenerator(const char *text, int state)
{
14121
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
14122
    const char *name;
14123 14124
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
14125 14126

    if (!state) {
14127 14128
        grp_list_index = 0;
        cmd_list_index = 0;
14129
        len = strlen(text);
K
Karel Zak 已提交
14130 14131
    }

14132 14133
    grp = cmdGroups;

K
Karel Zak 已提交
14134
    /* Return the next name which partially matches from the
14135
     * command list.
K
Karel Zak 已提交
14136
     */
14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150
    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 已提交
14151 14152 14153 14154 14155 14156 14157
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
14158 14159
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
14160
    static int list_index, len;
14161
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
14162
    const char *name;
K
Karel Zak 已提交
14163 14164 14165 14166 14167 14168 14169 14170 14171

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

14172
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
14173
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
14174 14175 14176

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
14177
        len = strlen(text);
14178
        VIR_FREE(cmdname);
K
Karel Zak 已提交
14179 14180 14181 14182
    }

    if (!cmd)
        return NULL;
14183

14184 14185 14186
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
14187
    while ((name = cmd->opts[list_index].name)) {
14188
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
14189
        char *res;
14190

K
Karel Zak 已提交
14191
        list_index++;
14192

14193
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
14194 14195
            /* ignore non --option */
            continue;
14196

K
Karel Zak 已提交
14197
        if (len > 2) {
14198
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
14199 14200
                continue;
        }
14201
        res = vshMalloc(NULL, strlen(name) + 3);
14202
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
14203 14204 14205 14206 14207 14208 14209 14210
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
14211 14212 14213
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
14214 14215
    char **matches = (char **) NULL;

14216
    if (start == 0)
K
Karel Zak 已提交
14217
        /* command name generator */
14218
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
14219 14220
    else
        /* commands options */
14221
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
14222 14223 14224 14225
    return matches;
}


14226 14227
static int
vshReadlineInit(vshControl *ctl)
14228
{
14229 14230
    char *userdir = NULL;

K
Karel Zak 已提交
14231 14232 14233 14234 14235
    /* 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;
14236 14237 14238

    /* Limit the total size of the history buffer */
    stifle_history(500);
14239 14240

    /* Prepare to read/write history from/to the ~/.virsh/history file */
14241
    userdir = virGetUserDirectory(getuid());
14242

14243 14244
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
14245
        return -1;
14246
    }
14247 14248 14249

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
14250
        VIR_FREE(userdir);
14251 14252 14253 14254 14255
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
14256
        VIR_FREE(userdir);
14257 14258 14259
        return -1;
    }

14260
    VIR_FREE(userdir);
14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278

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

14279 14280
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
14281 14282
}

14283 14284 14285 14286 14287 14288
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

14289
#else /* !USE_READLINE */
14290

14291 14292 14293 14294 14295 14296 14297
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

14298
static void
14299
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322
{
    /* 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);
}

14323
#endif /* !USE_READLINE */
14324

K
Karel Zak 已提交
14325
/*
J
Jim Meyering 已提交
14326
 * Deinitialize virsh
K
Karel Zak 已提交
14327
 */
E
Eric Blake 已提交
14328
static bool
14329
vshDeinit(vshControl *ctl)
14330
{
14331
    vshReadlineDeinit(ctl);
14332
    vshCloseLogFile(ctl);
14333
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
14334
    if (ctl->conn) {
14335 14336 14337
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
14338 14339
        }
    }
D
Daniel P. Berrange 已提交
14340 14341
    virResetLastError();

E
Eric Blake 已提交
14342
    return true;
K
Karel Zak 已提交
14343
}
14344

K
Karel Zak 已提交
14345 14346 14347 14348
/*
 * Print usage
 */
static void
14349
vshUsage(void)
14350
{
14351
    const vshCmdGrp *grp;
14352
    const vshCmdDef *cmd;
14353

L
Lai Jiangshan 已提交
14354 14355
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
14356 14357 14358
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
14359
                      "    -d | --debug <num>      debug level [0-4]\n"
14360 14361 14362 14363
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
14364
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
14365
                      "    -V | --version=long     version and full options\n\n"
14366
                      "  commands (non interactive mode):\n\n"), progname, progname);
14367

14368 14369
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
14370

14371 14372 14373 14374 14375 14376 14377 14378 14379
        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"));
14380 14381 14382
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
14383 14384
}

14385 14386 14387 14388 14389 14390 14391 14392 14393 14394
/*
 * 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 已提交
14395 14396
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431
#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 已提交
14432
    vshPrint(ctl, "%s", _(" Networking:"));
14433 14434 14435 14436 14437 14438 14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458
#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 已提交
14459
    vshPrint(ctl, "%s", _(" Storage:"));
14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474 14475 14476 14477 14478 14479 14480 14481 14482
#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 已提交
14483
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
14484
#ifdef WITH_SECDRIVER_APPARMOR
14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507
    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 已提交
14508 14509 14510 14511
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
14512
static bool
14513
vshParseArgv(vshControl *ctl, int argc, char **argv)
14514
{
14515 14516
    bool help = false;
    int arg;
K
Karel Zak 已提交
14517
    struct option opt[] = {
E
Eric Blake 已提交
14518 14519 14520 14521 14522 14523 14524 14525 14526
        {"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}
14527 14528
    };

14529 14530 14531
    /* 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. */
14532
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
14533
        switch (arg) {
14534
        case 'd':
D
Daniel Veillard 已提交
14535
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
14536
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
14537 14538
                exit(EXIT_FAILURE);
            }
14539 14540
            break;
        case 'h':
14541
            help = true;
14542 14543
            break;
        case 'q':
E
Eric Blake 已提交
14544
            ctl->quiet = true;
14545 14546
            break;
        case 't':
E
Eric Blake 已提交
14547
            ctl->timing = true;
14548 14549 14550 14551
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
14552 14553 14554 14555 14556 14557
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
14558 14559 14560
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
14561
        case 'r':
E
Eric Blake 已提交
14562
            ctl->readonly = true;
14563
            break;
14564 14565 14566
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
14567
        default:
14568 14569
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
14570 14571 14572 14573
        }
    }

    if (help) {
14574 14575
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
14576 14577
            exit(EXIT_FAILURE);
        }
14578 14579 14580

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
14581
        exit(EXIT_SUCCESS);
14582 14583
    }

14584
    if (argc > optind) {
K
Karel Zak 已提交
14585
        /* parse command */
E
Eric Blake 已提交
14586
        ctl->imode = false;
14587
        if (argc - optind == 1) {
14588
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
14589
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
14590
        } else {
14591
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
14592 14593
        }
    }
E
Eric Blake 已提交
14594
    return true;
K
Karel Zak 已提交
14595 14596
}

14597 14598 14599 14600
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
14601
    char *defaultConn;
E
Eric Blake 已提交
14602
    bool ret = true;
K
Karel Zak 已提交
14603

14604 14605 14606
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
14607
    ctl->debug = VSH_DEBUG_DEFAULT;
14608

14609 14610
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
14611
        /* failure to setup locale is not fatal */
14612
    }
14613
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
14614
        perror("bindtextdomain");
E
Eric Blake 已提交
14615
        return EXIT_FAILURE;
14616
    }
14617
    if (!textdomain(PACKAGE)) {
14618
        perror("textdomain");
E
Eric Blake 已提交
14619
        return EXIT_FAILURE;
14620 14621
    }

14622 14623 14624 14625 14626
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

14627
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
14628 14629 14630
        progname = argv[0];
    else
        progname++;
14631

14632
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
14633
        ctl->name = vshStrdup(ctl, defaultConn);
14634 14635
    }

D
Daniel P. Berrange 已提交
14636 14637
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
14638
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
14639
    }
14640

D
Daniel P. Berrange 已提交
14641 14642
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
14643
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
14644
    }
14645

K
Karel Zak 已提交
14646
    if (!ctl->imode) {
14647
        ret = vshCommandRun(ctl, ctl->cmd);
14648
    } else {
K
Karel Zak 已提交
14649 14650
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
14651
            vshPrint(ctl,
14652
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
14653
                     progname);
J
Jim Meyering 已提交
14654
            vshPrint(ctl, "%s",
14655
                     _("Type:  'help' for help with commands\n"
14656
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
14657
        }
14658 14659 14660 14661 14662 14663

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
14664
        do {
14665
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
14666
            ctl->cmdstr =
14667
                vshReadline(ctl, prompt);
14668 14669
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
14670
            if (*ctl->cmdstr) {
14671
#if USE_READLINE
K
Karel Zak 已提交
14672
                add_history(ctl->cmdstr);
14673
#endif
14674
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
14675 14676
                    vshCommandRun(ctl, ctl->cmd);
            }
14677
            VIR_FREE(ctl->cmdstr);
14678
        } while (ctl->imode);
K
Karel Zak 已提交
14679

14680 14681
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
14682
    }
14683

K
Karel Zak 已提交
14684 14685
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
14686
}