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

13
#include <config.h>
14

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

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

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

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

static char *progname;

65 66
#define VIRSH_MAX_XML_FILE 10*1024*1024

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

70 71
#define VIR_FROM_THIS VIR_FROM_NONE

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

    sigaction(SIGPIPE, &sig_action, NULL);
}

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

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

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

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

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

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

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

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

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

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

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

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

            vshPrint(ctl, "\n");
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

770 771
#ifndef WIN32

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

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

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

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

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

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

 cleanup:
810

811 812 813
    return ret;
}

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

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

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

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

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

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

839 840 841
#endif /* WIN32 */


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

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

K
Karel Zak 已提交
859

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cleanup:
    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    if (managed_save)
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;

    if (!managed_save)
        flags = -1;
1456

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

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

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

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

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

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

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

            rc = virDomainUndefine(dom);
        }
    }

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

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


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

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

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

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

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

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

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

1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
    /* We can emulate force boot, even for older servers that reject it.  */
    if (flags & VIR_DOMAIN_START_FORCE_BOOT) {
        if (virDomainCreateWithFlags(dom, flags) == 0)
            goto started;
        if (last_error->code != VIR_ERR_NO_SUPPORT &&
            last_error->code != VIR_ERR_INVALID_ARG) {
            virshReportError(ctl);
            goto cleanup;
        }
        virFreeError(last_error);
        last_error = NULL;
        rc = virDomainHasManagedSaveImage(dom, 0);
        if (rc < 0) {
            /* No managed save image to remove */
            virFreeError(last_error);
            last_error = NULL;
        } else if (rc > 0) {
            if (virDomainManagedSaveRemove(dom, 0) < 0) {
                virshReportError(ctl);
                goto cleanup;
            }
        }
        flags &= ~VIR_DOMAIN_START_FORCE_BOOT;
    }

E
Eric Blake 已提交
1607 1608
    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
1609
         : virDomainCreate(dom)) < 0) {
1610
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
1611
        goto cleanup;
1612
    }
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624

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

    ret = true;

cleanup:
1625
    virDomainFree(dom);
1626 1627 1628
    return ret;
}

1629 1630 1631
/*
 * "save" command
 */
1632
static const vshCmdInfo info_save[] = {
1633
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
1634
    {"desc", N_("Save the RAM state of a running domain.")},
1635
    {NULL, NULL}
1636 1637
};

1638
static const vshCmdOptDef opts_save[] = {
1639
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
1640 1641
    {"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")},
1642 1643
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
1644 1645
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on restore")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on restore")},
1646
    {NULL, 0, 0, NULL}
1647 1648
};

E
Eric Blake 已提交
1649
static bool
1650
cmdSave(vshControl *ctl, const vshCmd *cmd)
1651
{
1652
    virDomainPtr dom;
1653 1654
    const char *name = NULL;
    const char *to = NULL;
1655
    bool ret = false;
E
Eric Blake 已提交
1656
    unsigned int flags = 0;
1657 1658
    const char *xmlfile = NULL;
    char *xml = NULL;
1659

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

1663
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1664
        return false;
1665

1666 1667
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
1668 1669 1670 1671
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
1672

1673 1674 1675 1676 1677
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

1681 1682 1683 1684 1685 1686
    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
        goto cleanup;

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
1687
         : virDomainSave(dom, to)) < 0) {
1688
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
1689
        goto cleanup;
1690
    }
1691

1692 1693 1694 1695
    vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
    ret = true;

cleanup:
1696
    VIR_FREE(xml);
1697 1698 1699 1700
    virDomainFree(dom);
    return ret;
}

1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
/*
 * "save-image-dumpxml" command
 */
static const vshCmdInfo info_save_image_dumpxml[] = {
    {"help", N_("saved state domain information in XML")},
    {"desc", N_("Output the domain information for a saved state file,\n"
                "as an XML dump to stdout.")},
    {NULL, NULL}
};

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

static bool
cmdSaveImageDumpxml(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
E
Eric Blake 已提交
1722
    unsigned int flags = 0;
1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758
    char *xml = NULL;

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;

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

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

    xml = virDomainSaveImageGetXMLDesc(ctl->conn, file, flags);
    if (!xml)
        goto cleanup;

    vshPrint(ctl, "%s", xml);
    ret = true;

cleanup:
    VIR_FREE(xml);
    return ret;
}

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

static const vshCmdOptDef opts_save_image_define[] = {
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("saved state file to modify")},
    {"xml", VSH_OT_STRING, VSH_OFLAG_REQ,
     N_("filename containing updated XML for the target")},
1759 1760
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on restore")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on restore")},
1761 1762 1763 1764 1765 1766 1767 1768 1769 1770
    {NULL, 0, 0, NULL}
};

static bool
cmdSaveImageDefine(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
    const char *xmlfile = NULL;
    char *xml = NULL;
1771 1772 1773 1774 1775 1776
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815

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

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

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

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

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

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

cleanup:
    VIR_FREE(xml);
    return ret;
}

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

static const vshCmdOptDef opts_save_image_edit[] = {
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("saved state file to edit")},
1816 1817
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on restore")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on restore")},
1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828
    {NULL, 0, 0, NULL}
};

static bool
cmdSaveImageEdit(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844
    unsigned int getxml_flags = VIR_DOMAIN_XML_SECURE;
    unsigned int define_flags = 0;

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

    /* Normally, we let the API reject mutually exclusive flags.
     * However, in the edit cycle, we let the user retry if the define
     * step fails, but the define step will always fail on invalid
     * flags, so we reject it up front to avoid looping.  */
    if (define_flags == (VIR_DOMAIN_SAVE_RUNNING | VIR_DOMAIN_SAVE_PAUSED)) {
        vshError(ctl, "%s", _("--running and --saved are mutually exclusive"));
        return false;
    }
1845 1846 1847 1848 1849 1850 1851 1852

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

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

    /* Get the XML configuration of the saved image.  */
1853
    doc = virDomainSaveImageGetXMLDesc(ctl->conn, file, getxml_flags);
1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870
    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;

1871 1872 1873
    /* Compare original XML with edited.  Short-circuit if it did not
     * change, and we do not have any flags.  */
    if (STREQ(doc, doc_edited) && !define_flags) {
1874 1875 1876 1877 1878 1879 1880
        vshPrint(ctl, _("Saved image %s XML configuration not changed.\n"),
                 file);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
1881 1882
    if (virDomainSaveImageDefineXML(ctl->conn, file, doc_edited,
                                    define_flags) < 0) {
1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899
        vshError(ctl, _("Failed to update %s"), file);
        goto cleanup;
    }

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

cleanup:
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
    return ret;
}

1900 1901 1902 1903 1904
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1905 1906 1907 1908
    {"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.")},
1909 1910 1911 1912
    {NULL, NULL}
};

static const vshCmdOptDef opts_managedsave[] = {
1913
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
1914
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1915 1916
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on next start")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on next start")},
1917 1918 1919
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1920
static bool
1921 1922 1923
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1924
    const char *name;
1925
    bool ret = false;
E
Eric Blake 已提交
1926
    unsigned int flags = 0;
1927

1928
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1929
        return false;
1930

1931 1932
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
1933 1934 1935 1936
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
1937

1938
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1939
        return false;
1940

1941
    if (virDomainManagedSave(dom, flags) < 0) {
1942
        vshError(ctl, _("Failed to save domain %s state"), name);
1943
        goto cleanup;
1944 1945
    }

1946 1947 1948 1949
    vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    ret = true;

cleanup:
1950 1951 1952 1953
    virDomainFree(dom);
    return ret;
}

1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967
/*
 * "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 已提交
1968
static bool
1969 1970 1971
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1972
    const char *name;
E
Eric Blake 已提交
1973
    bool ret = false;
1974 1975
    int hassave;

1976
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1977
        return false;
1978 1979

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1980
        return false;
1981 1982 1983

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1984
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000
        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 已提交
2001
    ret = true;
2002 2003 2004 2005 2006 2007

cleanup:
    virDomainFree(dom);
    return ret;
}

2008 2009 2010
/*
 * "schedinfo" command
 */
2011
static const vshCmdInfo info_schedinfo[] = {
2012 2013
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
2014 2015 2016
    {NULL, NULL}
};

2017
static const vshCmdOptDef opts_schedinfo[] = {
2018 2019 2020 2021
    {"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")},
2022 2023 2024
    {"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")},
2025 2026 2027
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
2028
static int
2029
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
2030
                   virTypedParameterPtr param)
2031
{
2032
    const char *data = NULL;
2033 2034 2035

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
2036
        param->type == VIR_TYPED_PARAM_UINT &&
2037 2038
        vshCommandOptBool(cmd, "weight")) {
        int val;
2039
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
2040
            vshError(ctl, "%s", _("Invalid value of weight"));
2041
            return -1;
2042
        } else {
2043
            param->value.ui = val;
2044
        }
2045
        return 1;
2046 2047
    }

2048 2049
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
2050
        param->type == VIR_TYPED_PARAM_UINT &&
2051 2052
        vshCommandOptBool(cmd, "cap")) {
        int val;
2053
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
2054
            vshError(ctl, "%s", _("Invalid value of cap"));
2055
            return -1;
2056
        } else {
2057
            param->value.ui = val;
2058
        }
2059
        return 1;
2060
    }
2061

2062
    if (vshCommandOptString(cmd, "set", &data) > 0) {
2063 2064 2065
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
2066
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
2067
            return -1;
2068
        }
2069 2070 2071 2072 2073 2074 2075 2076 2077
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
2078
        case VIR_TYPED_PARAM_INT:
2079
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
2080
                vshError(ctl, "%s",
2081 2082 2083 2084
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
2085
        case VIR_TYPED_PARAM_UINT:
2086
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
2087
                vshError(ctl, "%s",
2088 2089 2090 2091
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
2092
        case VIR_TYPED_PARAM_LLONG:
2093
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
2094
                vshError(ctl, "%s",
J
Jim Meyering 已提交
2095
                         _("Invalid value for parameter, expecting a long long"));
2096 2097 2098
                return -1;
            }
            break;
2099
        case VIR_TYPED_PARAM_ULLONG:
2100
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
2101
                vshError(ctl, "%s",
2102 2103 2104 2105
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
2106
        case VIR_TYPED_PARAM_DOUBLE:
2107
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
2108
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
2109 2110 2111
                return -1;
            }
            break;
2112
        case VIR_TYPED_PARAM_BOOLEAN:
2113
            param->value.b = STREQ(val, "0") ? 0 : 1;
2114
        }
2115
        return 1;
2116
    }
2117

2118 2119
    return 0;
}
2120

2121

E
Eric Blake 已提交
2122
static bool
2123 2124 2125 2126
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
2127
    virTypedParameterPtr params = NULL;
2128 2129 2130
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
2131
    bool ret_val = false;
2132 2133 2134 2135 2136 2137 2138 2139 2140 2141
    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;
        }
2142
        flags = VIR_DOMAIN_AFFECT_CURRENT;
2143 2144
    } else {
        if (config)
2145
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
2146
        if (live)
2147
            flags |= VIR_DOMAIN_AFFECT_LIVE;
2148
    }
2149

2150
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2151
        return false;
2152

2153
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2154
        return false;
2155 2156 2157

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
2158
    if (schedulertype != NULL) {
2159
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
2160
             schedulertype);
2161
        VIR_FREE(schedulertype);
2162
    } else {
2163
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
2164
        goto cleanup;
2165 2166
    }

2167
    if (nparams) {
2168
        params = vshMalloc(ctl, sizeof(*params) * nparams);
2169

2170
        memset(params, 0, sizeof(*params) * nparams);
2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181
        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);
        }
2182 2183 2184 2185
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
2186
        for (i = 0; i < nparams; i++) {
2187 2188 2189 2190 2191 2192 2193 2194 2195 2196
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
2197 2198 2199 2200 2201
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
2202 2203 2204
            if (ret == -1)
                goto cleanup;

2205 2206 2207 2208 2209 2210 2211
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
2212 2213
            if (ret == -1)
                goto cleanup;
2214 2215 2216 2217
        } 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.  */
2218 2219
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
2220 2221 2222 2223
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
2224 2225 2226 2227 2228 2229
            /* 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;
            }
2230 2231
        }

E
Eric Blake 已提交
2232
        ret_val = true;
2233
        for (i = 0; i < nparams; i++) {
2234
            switch (params[i].type) {
2235
            case VIR_TYPED_PARAM_INT:
2236
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
2237
                 break;
2238
            case VIR_TYPED_PARAM_UINT:
2239
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
2240
                 break;
2241
            case VIR_TYPED_PARAM_LLONG:
2242
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
2243
                 break;
2244
            case VIR_TYPED_PARAM_ULLONG:
2245
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
2246
                 break;
2247
            case VIR_TYPED_PARAM_DOUBLE:
2248
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
2249
                 break;
2250
            case VIR_TYPED_PARAM_BOOLEAN:
2251
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
2252 2253
                 break;
            default:
2254
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
2255 2256 2257
            }
        }
    }
2258

2259
 cleanup:
2260
    VIR_FREE(params);
2261
    virDomainFree(dom);
2262
    return ret_val;
2263 2264
}

2265 2266 2267
/*
 * "restore" command
 */
2268
static const vshCmdInfo info_restore[] = {
2269 2270
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
2271
    {NULL, NULL}
2272 2273
};

2274
static const vshCmdOptDef opts_restore[] = {
2275
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
2276 2277
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when restoring")},
2278 2279
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2280 2281
    {"running", VSH_OT_BOOL, 0, N_("restore domain into running state")},
    {"paused", VSH_OT_BOOL, 0, N_("restore domain into paused state")},
2282
    {NULL, 0, 0, NULL}
2283 2284
};

E
Eric Blake 已提交
2285
static bool
2286
cmdRestore(vshControl *ctl, const vshCmd *cmd)
2287
{
2288
    const char *from = NULL;
2289
    bool ret = false;
E
Eric Blake 已提交
2290
    unsigned int flags = 0;
2291 2292
    const char *xmlfile = NULL;
    char *xml = NULL;
2293

2294
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2295
        return false;
2296

2297
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2298
        return false;
2299

2300 2301
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2302 2303 2304 2305
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2306

2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

    if (((flags || xml)
         ? virDomainRestoreFlags(ctl->conn, from, xml, flags)
2318
         : virDomainRestore(ctl->conn, from)) < 0) {
2319
        vshError(ctl, _("Failed to restore domain from %s"), from);
2320
        goto cleanup;
2321
    }
2322 2323 2324 2325 2326

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

cleanup:
2327
    VIR_FREE(xml);
2328 2329 2330
    return ret;
}

D
Daniel Veillard 已提交
2331 2332 2333
/*
 * "dump" command
 */
2334
static const vshCmdInfo info_dump[] = {
2335 2336
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
2337 2338 2339
    {NULL, NULL}
};

2340
static const vshCmdOptDef opts_dump[] = {
2341 2342
    {"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")},
2343 2344
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when saving")},
2345 2346
    {"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 已提交
2347 2348 2349
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2350
static bool
2351
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
2352 2353
{
    virDomainPtr dom;
2354 2355
    const char *name = NULL;
    const char *to = NULL;
2356
    bool ret = false;
E
Eric Blake 已提交
2357
    unsigned int flags = 0;
D
Daniel Veillard 已提交
2358

2359
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2360
        return false;
D
Daniel Veillard 已提交
2361

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

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

P
Paolo Bonzini 已提交
2368 2369
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
2370 2371
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;
2372 2373
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DUMP_BYPASS_CACHE;
2374

2375
    if (virDomainCoreDump(dom, to, flags) < 0) {
2376
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
2377
        goto cleanup;
D
Daniel Veillard 已提交
2378 2379
    }

2380 2381 2382 2383
    vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
    ret = true;

cleanup:
D
Daniel Veillard 已提交
2384 2385 2386 2387
    virDomainFree(dom);
    return ret;
}

2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534
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;
}

2535 2536 2537
/*
 * "resume" command
 */
2538
static const vshCmdInfo info_resume[] = {
2539 2540
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
2541
    {NULL, NULL}
2542 2543
};

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

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

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

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

    if (virDomainResume(dom) == 0) {
2563
        vshPrint(ctl, _("Domain %s resumed\n"), name);
2564
    } else {
2565
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
2566
        ret = false;
2567
    }
2568

2569 2570 2571 2572
    virDomainFree(dom);
    return ret;
}

2573 2574 2575
/*
 * "shutdown" command
 */
2576
static const vshCmdInfo info_shutdown[] = {
2577 2578
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
2579
    {NULL, NULL}
2580 2581
};

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

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

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

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

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

2607 2608 2609 2610
    virDomainFree(dom);
    return ret;
}

2611 2612 2613
/*
 * "reboot" command
 */
2614
static const vshCmdInfo info_reboot[] = {
2615 2616
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
2617 2618 2619
    {NULL, NULL}
};

2620
static const vshCmdOptDef opts_reboot[] = {
2621
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2622 2623 2624
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2625
static bool
2626
cmdReboot(vshControl *ctl, const vshCmd *cmd)
2627 2628
{
    virDomainPtr dom;
E
Eric Blake 已提交
2629
    bool ret = true;
2630
    const char *name;
2631

2632
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2633
        return false;
2634

J
Jim Meyering 已提交
2635
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2636
        return false;
2637 2638

    if (virDomainReboot(dom, 0) == 0) {
2639
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
2640
    } else {
2641
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
2642
        ret = false;
2643 2644 2645 2646 2647 2648
    }

    virDomainFree(dom);
    return ret;
}

2649 2650 2651
/*
 * "destroy" command
 */
2652
static const vshCmdInfo info_destroy[] = {
2653 2654 2655
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
2656
    {NULL, NULL}
2657 2658
};

2659
static const vshCmdOptDef opts_destroy[] = {
2660
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2661
    {NULL, 0, 0, NULL}
2662 2663
};

E
Eric Blake 已提交
2664
static bool
2665
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2666
{
2667
    virDomainPtr dom;
E
Eric Blake 已提交
2668
    bool ret = true;
2669
    const char *name;
2670

2671
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2672
        return false;
2673

J
Jim Meyering 已提交
2674
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2675
        return false;
2676 2677

    if (virDomainDestroy(dom) == 0) {
2678
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2679
    } else {
2680
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
2681
        ret = false;
2682
    }
2683

2684
    virDomainFree(dom);
K
Karel Zak 已提交
2685 2686 2687 2688
    return ret;
}

/*
2689
 * "dominfo" command
K
Karel Zak 已提交
2690
 */
2691
static const vshCmdInfo info_dominfo[] = {
2692 2693
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2694
    {NULL, NULL}
K
Karel Zak 已提交
2695 2696
};

2697
static const vshCmdOptDef opts_dominfo[] = {
2698
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2699
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2700 2701
};

E
Eric Blake 已提交
2702
static bool
2703
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2704
{
K
Karel Zak 已提交
2705 2706
    virDomainInfo info;
    virDomainPtr dom;
2707
    virSecurityModel secmodel;
2708
    virSecurityLabelPtr seclabel;
2709
    int persistent = 0;
E
Eric Blake 已提交
2710 2711
    bool ret = true;
    int autostart;
2712
    unsigned int id;
2713
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2714
    int has_managed_save = 0;
2715

2716
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2717
        return false;
K
Karel Zak 已提交
2718

J
Jim Meyering 已提交
2719
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2720
        return false;
2721

2722 2723
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2724
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2725
    else
2726
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2727 2728
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2729
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2730
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2731 2732

    if ((str = virDomainGetOSType(dom))) {
2733
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2734
        VIR_FREE(str);
2735 2736 2737
    }

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

2741
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2742 2743

        if (info.cpuTime != 0) {
2744
            double cpuUsed = info.cpuTime;
2745

2746
            cpuUsed /= 1000000000.0;
2747

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

2751 2752
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2753
                 info.maxMem);
2754
        else
2755
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2756 2757
                 _("no limit"));

2758
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2759 2760
                 info.memory);

K
Karel Zak 已提交
2761
    } else {
E
Eric Blake 已提交
2762
        ret = false;
K
Karel Zak 已提交
2763
    }
2764

2765 2766
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
2767 2768
    vshDebug(ctl, VSH_ERR_DEBUG, "Domain persistent flag value: %d\n",
             persistent);
2769 2770 2771 2772 2773 2774
    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 */
2775
    if (!virDomainGetAutostart(dom, &autostart)) {
2776
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2777 2778 2779
                 autostart ? _("enable") : _("disable") );
    }

2780 2781 2782 2783 2784 2785 2786
    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"));

2787 2788 2789
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2790 2791
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
2792
            return false;
2793 2794 2795
        } else {
            virFreeError(last_error);
            last_error = NULL;
2796
        }
2797 2798 2799 2800 2801 2802 2803
    } 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 */
2804
            if (VIR_ALLOC(seclabel) < 0) {
2805
                virDomainFree(dom);
E
Eric Blake 已提交
2806
                return false;
2807 2808 2809 2810 2811
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
2812
                return false;
2813
            } else {
2814
                if (seclabel->label[0] != '\0')
2815
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
2816
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
2817
            }
2818 2819

            VIR_FREE(seclabel);
2820 2821
        }
    }
2822
    virDomainFree(dom);
K
Karel Zak 已提交
2823 2824 2825
    return ret;
}

2826 2827 2828 2829
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2830 2831
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2832 2833 2834 2835
    {NULL, NULL}
};

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


E
Eric Blake 已提交
2841
static bool
2842 2843 2844 2845
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
2846
    bool ret = true;
2847

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2852
        return false;
2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878

    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 已提交
2879
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2880
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2881
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2882
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2883
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2884 2885 2886
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2887
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2888
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2889
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2890
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2891
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2892 2893 2894
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2895
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2896
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2897
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2898
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2899
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2900 2901
        }
    } else {
E
Eric Blake 已提交
2902
        ret = false;
2903 2904 2905 2906 2907 2908
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2909 2910 2911 2912
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2913 2914
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2915 2916 2917 2918
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2919
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2920 2921 2922
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2923
static bool
2924 2925 2926
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2927
    bool ret = true;
2928

2929
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2930
        return false;
2931 2932

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
2936
        ret = false;
2937 2938 2939 2940 2941

    virDomainFree(dom);
    return ret;
}

2942 2943 2944
/*
 * "freecell" command
 */
2945
static const vshCmdInfo info_freecell[] = {
2946 2947
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2948 2949 2950
    {NULL, NULL}
};

2951
static const vshCmdOptDef opts_freecell[] = {
2952
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2953
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
2954 2955 2956
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2957
static bool
2958
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2959
{
W
Wen Congyang 已提交
2960
    bool func_ret = false;
2961
    int ret;
2962
    int cell = -1, cell_given;
2963
    unsigned long long memory;
2964 2965 2966 2967
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
2968
    int all_given;
2969 2970 2971 2972
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
2973

2974

2975
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2976
        return false;
2977

2978 2979 2980 2981
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
2982 2983 2984 2985 2986 2987 2988 2989 2990
    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) {
2991 2992 2993
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2994 2995 2996
            goto cleanup;
        }

2997
        xml = virXMLParseStringCtxt(cap_xml, "node.xml", &ctxt);
2998 2999
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3000 3001
            goto cleanup;
        }
3002 3003 3004 3005
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
3006
            vshError(ctl, "%s", _("could not get information about "
3007
                                  "NUMA topology"));
3008 3009 3010
            goto cleanup;
        }

3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031
        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;
            }
        }

3032
        memory = 0;
3033 3034 3035 3036
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
3037 3038 3039 3040
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
3041
    } else {
3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055
        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));
3056 3057
    }

E
Eric Blake 已提交
3058
    func_ret = true;
3059

3060
cleanup:
3061
    xmlXPathFreeContext(ctxt);
3062
    xmlFreeDoc(xml);
3063
    VIR_FREE(nodes);
3064 3065 3066
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
3067
    return func_ret;
3068 3069
}

E
Eric Blake 已提交
3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083
/*
 * "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 已提交
3084
static bool
E
Eric Blake 已提交
3085 3086
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
3087
    const char *type = NULL;
E
Eric Blake 已提交
3088 3089
    int vcpus;

3090 3091
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
3092
        return false;
3093
    }
E
Eric Blake 已提交
3094 3095

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3096
        return false;
E
Eric Blake 已提交
3097 3098 3099

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

E
Eric Blake 已提交
3103
    return true;
E
Eric Blake 已提交
3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117
}

/*
 * "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")},
3118
    {"active", VSH_OT_BOOL, 0, N_("get number of currently active vcpus")},
E
Eric Blake 已提交
3119
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
3120 3121 3122
    {"config", VSH_OT_BOOL, 0, N_("get value to be used on next boot")},
    {"current", VSH_OT_BOOL, 0,
     N_("get value according to current domain state")},
E
Eric Blake 已提交
3123 3124 3125
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3126
static bool
E
Eric Blake 已提交
3127 3128 3129
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3130
    bool ret = true;
E
Eric Blake 已提交
3131
    int maximum = vshCommandOptBool(cmd, "maximum");
3132
    int active = vshCommandOptBool(cmd, "active");
E
Eric Blake 已提交
3133 3134
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3135 3136
    int current = vshCommandOptBool(cmd, "current");
    bool all = maximum + active + current + config + live == 0;
E
Eric Blake 已提交
3137 3138
    int count;

3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153
    /* We want one of each pair of mutually exclusive options; that
     * is, use of flags requires exactly two options.  We reject the
     * use of more than 2 flags later on.  */
    if (maximum + active + current + config + live == 1) {
        if (maximum || active) {
            vshError(ctl,
                     _("when using --%s, one of --config, --live, or --current "
                       "must be specified"),
                     maximum ? "maximum" : "active");
        } else {
            vshError(ctl,
                     _("when using --%s, either --maximum or --active must be "
                       "specified"),
                     (current ? "current" : config ? "config" : "live"));
        }
E
Eric Blake 已提交
3154
        return false;
E
Eric Blake 已提交
3155
    }
3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168

    /* Backwards compatibility: prior to 0.9.4,
     * VIR_DOMAIN_AFFECT_CURRENT was unsupported, and --current meant
     * the opposite of --maximum.  Translate the old '--current
     * --live' into the new '--active --live', while treating the new
     * '--maximum --current' correctly rather than rejecting it as
     * '--maximum --active'.  */
    if (!maximum && !active && current) {
        current = false;
        active = true;
    }

    if (maximum && active) {
E
Eric Blake 已提交
3169
        vshError(ctl, "%s",
3170
                 _("--maximum and --active cannot both be specified"));
E
Eric Blake 已提交
3171
        return false;
E
Eric Blake 已提交
3172
    }
3173 3174 3175
    if (current + config + live > 1) {
        vshError(ctl, "%s",
                 _("--config, --live, and --current are mutually exclusive"));
E
Eric Blake 已提交
3176
        return false;
E
Eric Blake 已提交
3177 3178 3179
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3180
        return false;
E
Eric Blake 已提交
3181 3182

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

    /* In all cases, try the new API first; if it fails because we are
3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199
     * talking to an older client, generally we try a fallback API
     * before giving up.  --current requires the new API, since we
     * don't know whether the domain is running or inactive.  */
    if (current) {
        count = virDomainGetVcpusFlags(dom,
                                       maximum ? VIR_DOMAIN_VCPU_MAXIMUM : 0);
        if (count < 0) {
            virshReportError(ctl);
            ret = false;
        } else {
            vshPrint(ctl, "%d\n", count);
        }
    }

E
Eric Blake 已提交
3200 3201
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
3202
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
3203 3204 3205 3206 3207 3208 3209 3210 3211
        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;
            }
3212 3213
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
3214 3215 3216 3217 3218
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
3219
            ret = false;
E
Eric Blake 已提交
3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231
        } 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 |
3232
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
3233 3234 3235 3236 3237 3238 3239
        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 已提交
3240
            ret = false;
E
Eric Blake 已提交
3241 3242 3243 3244 3245 3246 3247 3248 3249 3250
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3251
    if (all || (active && config)) {
3252
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276
        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 已提交
3277
            ret = false;
E
Eric Blake 已提交
3278 3279 3280 3281 3282 3283 3284 3285 3286 3287
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3288
    if (all || (active && live)) {
3289
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
3290 3291 3292 3293 3294 3295 3296 3297 3298
        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 已提交
3299
            ret = false;
E
Eric Blake 已提交
3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313
        } 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;
}

3314 3315 3316
/*
 * "vcpuinfo" command
 */
3317
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
3318
    {"help", N_("detailed domain vcpu information")},
3319
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
3320 3321 3322
    {NULL, NULL}
};

3323
static const vshCmdOptDef opts_vcpuinfo[] = {
3324
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3325 3326 3327
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3328
static bool
3329
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
3330 3331 3332 3333 3334
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
3335 3336
    unsigned char *cpumaps;
    int ncpus, maxcpu;
3337
    size_t cpumaplen;
E
Eric Blake 已提交
3338
    bool ret = true;
3339
    int n, m;
3340

3341
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3342
        return false;
3343

J
Jim Meyering 已提交
3344
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3345
        return false;
3346 3347 3348

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3349
        return false;
3350 3351 3352 3353
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3354
        return false;
3355 3356
    }

3357
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
3358 3359 3360
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
3361

3362 3363
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
3364
                                   cpumaps, cpumaplen)) >= 0) {
3365 3366 3367 3368
        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 已提交
3369
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
3370 3371 3372 3373 3374 3375 3376 3377
            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:"));
3378 3379
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
3380 3381 3382 3383 3384 3385
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
3386
    } else {
3387
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
3388
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3389 3390 3391
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
3392
            /* fallback plan to use virDomainGetVcpuPinInfo */
3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410

            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;
3411
        }
3412 3413
    }

3414
    VIR_FREE(cpumaps);
3415
    VIR_FREE(cpuinfo);
3416 3417 3418 3419 3420 3421 3422
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
3423
static const vshCmdInfo info_vcpupin[] = {
3424
    {"help", N_("control or query domain vcpu affinity")},
3425
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
3426 3427 3428
    {NULL, NULL}
};

3429
static const vshCmdOptDef opts_vcpupin[] = {
3430
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3431 3432 3433
    {"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")},
3434 3435 3436
    {"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")},
3437 3438 3439
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3440
static bool
E
Eric Blake 已提交
3441
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
3442 3443 3444 3445
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
3446
    int vcpu = -1;
3447
    const char *cpulist = NULL;
E
Eric Blake 已提交
3448
    bool ret = true;
3449 3450
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
3451
    size_t cpumaplen;
3452 3453
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
3454
    bool unuse = false;
3455
    const char *cur;
3456 3457 3458
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
3459
    bool query = false; /* Query mode if no cpulist */
E
Eric Blake 已提交
3460
    unsigned int flags = 0;
3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476

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

3478
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3479
        return false;
3480

J
Jim Meyering 已提交
3481
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3482
        return false;
3483

3484 3485
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
3486
        virDomainFree(dom);
E
Eric Blake 已提交
3487
        return false;
3488
    }
3489
    query = !cpulist;
3490

3491 3492 3493 3494
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
3495
        virDomainFree(dom);
E
Eric Blake 已提交
3496
        return false;
3497
    }
3498

3499 3500
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3501
        return false;
3502 3503 3504
    }

    if (virDomainGetInfo(dom, &info) != 0) {
3505
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
3506
        virDomainFree(dom);
E
Eric Blake 已提交
3507
        return false;
3508 3509 3510
    }

    if (vcpu >= info.nrVirtCpu) {
3511
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
3512
        virDomainFree(dom);
E
Eric Blake 已提交
3513
        return false;
3514 3515
    }

3516 3517
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
3518

3519 3520 3521 3522 3523 3524 3525 3526
    /* 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 已提交
3527
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572
                                             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);
3573 3574
    /* Parse cpulist */
    cur = cpulist;
3575
    if (*cur == 0) {
3576
        goto parse_error;
3577 3578 3579
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
3580
        cur = "";
3581
    }
3582 3583 3584 3585 3586 3587 3588

    while (*cur != 0) {

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

3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602
        /* 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);
3603

3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630
        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);
        }
3631

3632 3633 3634 3635 3636 3637
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
3638
        } else {
3639
            goto parse_error;
3640
        }
3641
    }
3642

3643 3644 3645 3646 3647 3648 3649 3650
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
3651 3652
    }

3653
cleanup:
3654
    VIR_FREE(cpumap);
3655 3656
    virDomainFree(dom);
    return ret;
3657 3658 3659 3660 3661

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

3664 3665 3666
/*
 * "setvcpus" command
 */
3667
static const vshCmdInfo info_setvcpus[] = {
3668 3669
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
3670 3671 3672
    {NULL, NULL}
};

3673
static const vshCmdOptDef opts_setvcpus[] = {
3674
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3675
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
3676 3677 3678
    {"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")},
3679
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3680 3681 3682
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3683
static bool
3684
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
3685 3686
{
    virDomainPtr dom;
3687
    int count = 0;
E
Eric Blake 已提交
3688
    bool ret = true;
E
Eric Blake 已提交
3689 3690 3691
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3692
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
3693
    unsigned int flags = 0;
3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709

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

3711
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3712
        return false;
3713

J
Jim Meyering 已提交
3714
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3715
        return false;
3716

3717 3718 3719 3720
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
3721

3722
    if (flags == -1) {
E
Eric Blake 已提交
3723
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
3724
            ret = false;
E
Eric Blake 已提交
3725 3726
        }
    } else {
3727 3728 3729
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
3730
            vshDebug(ctl, VSH_ERR_DEBUG, "--maximum flag was given\n");
3731

3732 3733
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

3734 3735 3736 3737 3738 3739 3740 3741
            /* 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 已提交
3742
                ret = false;
3743 3744 3745 3746 3747
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
3748
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
3749
            ret = false;
E
Eric Blake 已提交
3750
        }
3751 3752
    }

3753
  cleanup:
3754 3755 3756 3757
    virDomainFree(dom);
    return ret;
}

3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791
/*
 * "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;
}

3792 3793 3794 3795 3796
/*
 * "send-key" command
 */
static const vshCmdInfo info_send_key[] = {
    {"help", N_("Send keycodes to the guest")},
3797
    {"desc", N_("Send keycodes (integers or symbolic names) to the guest")},
3798 3799 3800 3801 3802
    {NULL, NULL}
};

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3803 3804
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT,
     N_("the codeset of keycodes, default:linux")},
3805
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
3806
     N_("the time (in millseconds) how long the keys will be held")},
3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878
    {"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;
}

3879 3880 3881
/*
 * "setmemory" command
 */
3882
static const vshCmdInfo info_setmem[] = {
3883 3884
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
3885 3886 3887
    {NULL, NULL}
};

3888
static const vshCmdOptDef opts_setmem[] = {
3889
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3890
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
3891 3892
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
3893
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3894 3895 3896
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3897
static bool
3898
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
3899 3900
{
    virDomainPtr dom;
3901
    virDomainInfo info;
3902
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
3903
    bool ret = true;
3904 3905
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3906
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
3907
    unsigned int flags = 0;
3908

3909 3910 3911
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3912
            return false;
3913
        }
3914
        flags = VIR_DOMAIN_AFFECT_CURRENT;
3915 3916
    } else {
        if (config)
3917
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3918
        if (live)
3919
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3920 3921 3922
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
3923
    }
3924

3925
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3926
        return false;
3927

J
Jim Meyering 已提交
3928
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3929
        return false;
3930

3931 3932
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3933
        return false;
3934 3935
    }

3936
    if (kilobytes <= 0) {
3937
        virDomainFree(dom);
3938
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
3939
        return false;
3940 3941
    }

3942 3943
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
3944
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
3945
        return false;
3946 3947 3948 3949
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
3950
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
3951
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
3952
        return false;
3953 3954
    }

3955
    if (flags == -1) {
3956
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
3957
            ret = false;
3958 3959 3960
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
3961
            ret = false;
3962
        }
3963 3964 3965 3966 3967 3968 3969 3970 3971
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
3972
static const vshCmdInfo info_setmaxmem[] = {
3973 3974
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
3975 3976 3977
    {NULL, NULL}
};

3978
static const vshCmdOptDef opts_setmaxmem[] = {
3979
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3980
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
3981 3982 3983
    {"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")},
3984 3985 3986
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3987
static bool
3988
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
3989 3990
{
    virDomainPtr dom;
3991
    int kilobytes = 0;
E
Eric Blake 已提交
3992
    bool ret = true;
3993 3994 3995
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
3996
    unsigned int flags = VIR_DOMAIN_MEM_MAXIMUM;
3997 3998 3999 4000

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4001
            return false;
4002 4003 4004
        }
    } else {
        if (config)
4005
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4006
        if (live)
4007
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4008 4009 4010 4011
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
4012

4013
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4014
        return false;
4015

J
Jim Meyering 已提交
4016
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4017
        return false;
4018

4019 4020
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4021
        return false;
4022 4023
    }

4024
    if (kilobytes <= 0) {
4025
        virDomainFree(dom);
4026
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
4027
        return false;
4028 4029
    }

4030 4031 4032
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4033
            ret = false;
4034 4035 4036 4037
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4038
            ret = false;
4039
        }
4040 4041
    }

4042 4043 4044 4045
    virDomainFree(dom);
    return ret;
}

4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061
/*
 * "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 已提交
4062 4063 4064
    {"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")},
4065 4066 4067
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4068
static bool
4069 4070 4071 4072 4073
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
4074
    int rv = 0;
4075
    unsigned int i = 0;
4076
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4077
    bool ret = false;
H
Hu Tao 已提交
4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094
    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;
    }
4095 4096

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4097
        return false;
4098 4099

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

4102
    if ((rv = vshCommandOptInt(cmd, "weight", &weight)) < 0) {
4103 4104 4105 4106 4107
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

4108
    if (rv > 0) {
4109
        nparams++;
4110
        if (weight <= 0) {
4111 4112 4113 4114 4115 4116 4117
            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 已提交
4118
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
4119 4120 4121 4122 4123 4124 4125
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4126
            ret = true;
4127 4128 4129 4130 4131
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
4132
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
4133 4134 4135 4136 4137 4138
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4139
                case VIR_TYPED_PARAM_INT:
4140 4141 4142
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4143
                case VIR_TYPED_PARAM_UINT:
4144 4145 4146
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4147
                case VIR_TYPED_PARAM_LLONG:
4148 4149 4150
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4151
                case VIR_TYPED_PARAM_ULLONG:
4152 4153 4154
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
4155
                case VIR_TYPED_PARAM_DOUBLE:
4156 4157 4158
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4159
                case VIR_TYPED_PARAM_BOOLEAN:
4160 4161 4162 4163 4164 4165 4166 4167
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
4168
        ret = true;
4169 4170 4171 4172 4173 4174
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4175
            temp->type = VIR_TYPED_PARAM_UINT;
4176 4177 4178 4179 4180 4181 4182 4183

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
H
Hu Tao 已提交
4184
        if (virDomainSetBlkioParameters(dom, params, nparams, flags) != 0)
4185 4186
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
4187
            ret = true;
4188 4189 4190 4191 4192 4193 4194 4195
    }

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

4196 4197 4198 4199
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
4200 4201 4202
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
4203 4204 4205 4206 4207 4208 4209
                "    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")},
4210
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4211
     N_("Max memory in kilobytes")},
4212
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4213
     N_("Memory during contention in kilobytes")},
4214
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4215
     N_("Max memory plus swap in kilobytes")},
4216
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
4217
     N_("Min guaranteed memory in kilobytes")},
4218 4219 4220
    {"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")},
4221 4222 4223
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4224
static bool
4225 4226 4227
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
4228 4229
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
4230 4231
    int nparams = 0;
    unsigned int i = 0;
4232
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4233
    bool ret = false;
4234 4235 4236 4237 4238 4239 4240 4241 4242 4243
    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;
        }
4244
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4245 4246
    } else {
        if (config)
4247
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4248
        if (live)
4249
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4250
    }
4251 4252

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4253
        return false;
4254 4255

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

4258 4259 4260 4261 4262 4263 4264 4265 4266
    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;
    }

4267 4268 4269 4270 4271 4272 4273 4274 4275
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

4276 4277 4278
    if (min_guarantee)
        nparams++;

4279 4280
    if (nparams == 0) {
        /* get the number of memory parameters */
4281
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
4282 4283 4284 4285 4286
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

4287 4288
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4289
            ret = true;
4290 4291 4292
            goto cleanup;
        }

4293
        /* now go get all the memory parameters */
E
Eric Blake 已提交
4294
        params = vshCalloc(ctl, nparams, sizeof(*params));
4295
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
4296 4297 4298 4299 4300 4301
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4302
                case VIR_TYPED_PARAM_INT:
4303 4304 4305
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4306
                case VIR_TYPED_PARAM_UINT:
4307 4308 4309
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4310
                case VIR_TYPED_PARAM_LLONG:
4311 4312 4313
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4314
                case VIR_TYPED_PARAM_ULLONG:
4315 4316 4317 4318 4319
                    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);
4320
                    break;
4321
                case VIR_TYPED_PARAM_DOUBLE:
4322 4323 4324
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4325
                case VIR_TYPED_PARAM_BOOLEAN:
4326 4327 4328 4329
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
4330
                    vshPrint(ctl, "unimplemented memory parameter type\n");
4331 4332 4333
            }
        }

E
Eric Blake 已提交
4334
        ret = true;
4335 4336
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
4337
        params = vshCalloc(ctl, nparams, sizeof(*params));
4338 4339 4340

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4341
            temp->type = VIR_TYPED_PARAM_ULLONG;
4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360

            /*
             * 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;
4361
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
4362 4363
                        sizeof(temp->field));
                swap_hard_limit = 0;
4364 4365 4366 4367 4368
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
4369
            }
4370 4371 4372 4373

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
4374
        }
4375
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
4376
            vshError(ctl, "%s", _("Unable to change memory parameters"));
4377
        else
E
Eric Blake 已提交
4378
            ret = true;
4379 4380 4381
    }

  cleanup:
E
Eric Blake 已提交
4382
    VIR_FREE(params);
4383 4384 4385 4386
    virDomainFree(dom);
    return ret;
}

4387 4388 4389
/*
 * "nodeinfo" command
 */
4390
static const vshCmdInfo info_nodeinfo[] = {
4391 4392
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
4393 4394 4395
    {NULL, NULL}
};

E
Eric Blake 已提交
4396
static bool
4397
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4398 4399
{
    virNodeInfo info;
4400

4401
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4402
        return false;
4403 4404

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
4405
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
4406
        return false;
4407 4408 4409 4410 4411 4412 4413 4414 4415 4416
    }
    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 已提交
4417
    return true;
4418 4419
}

4420 4421 4422 4423 4424
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
4425
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
4426 4427 4428 4429 4430 4431 4432 4433 4434 4435
    {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
4436
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
4437 4438 4439 4440
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
4441 4442
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485
    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;

4486
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
4487
                cpu_stats[i].sys = value;
4488
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
4489
                cpu_stats[i].user = value;
4490
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
4491
                cpu_stats[i].idle = value;
4492
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
4493
                cpu_stats[i].iowait = value;
4494
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508
                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) {
4509
            vshPrint(ctl, "%-15s %20llu\n", _("user:"), cpu_stats[0].user);
4510
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
4511
            vshPrint(ctl, "%-15s %20llu\n", _("idle:"), cpu_stats[0].idle);
4512 4513 4514 4515 4516 4517 4518
            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);
4519
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle:"), 100 - usage);
4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531
        } 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",
4532
                     _("user:"), user_time / total_time * 100);
4533
            vshPrint(ctl, "%-15s %5.1lf%%\n",
4534
                     _("system:"), sys_time  / total_time * 100);
4535
            vshPrint(ctl, "%-15s %5.1lf%%\n",
4536
                     _("idle:"), idle_time     / total_time * 100);
4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567
/*
 * "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;
4568 4569
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609
    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;
}

4610 4611 4612
/*
 * "capabilities" command
 */
4613
static const vshCmdInfo info_capabilities[] = {
4614 4615
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
4616 4617 4618
    {NULL, NULL}
};

E
Eric Blake 已提交
4619
static bool
4620
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4621 4622 4623
{
    char *caps;

4624
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4625
        return false;
4626 4627

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
4628
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
4629
        return false;
4630 4631
    }
    vshPrint (ctl, "%s\n", caps);
4632
    VIR_FREE(caps);
4633

E
Eric Blake 已提交
4634
    return true;
4635 4636
}

4637 4638 4639
/*
 * "dumpxml" command
 */
4640
static const vshCmdInfo info_dumpxml[] = {
4641 4642
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
4643
    {NULL, NULL}
4644 4645
};

4646
static const vshCmdOptDef opts_dumpxml[] = {
4647 4648 4649
    {"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")},
4650
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
4651
    {NULL, 0, 0, NULL}
4652 4653
};

E
Eric Blake 已提交
4654
static bool
4655
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
4656
{
4657
    virDomainPtr dom;
E
Eric Blake 已提交
4658
    bool ret = true;
4659
    char *dump;
E
Eric Blake 已提交
4660
    unsigned int flags = 0;
4661 4662
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
4663
    int update = vshCommandOptBool(cmd, "update-cpu");
4664 4665 4666 4667 4668

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
4669 4670
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
4671

4672
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4673
        return false;
4674

J
Jim Meyering 已提交
4675
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4676
        return false;
4677

4678
    dump = virDomainGetXMLDesc(dom, flags);
4679
    if (dump != NULL) {
4680
        vshPrint(ctl, "%s", dump);
4681
        VIR_FREE(dump);
4682
    } else {
E
Eric Blake 已提交
4683
        ret = false;
4684
    }
4685

4686 4687 4688 4689
    virDomainFree(dom);
    return ret;
}

4690 4691 4692 4693
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
4694 4695
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
4696 4697 4698 4699
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
4700 4701
    {"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")},
4702 4703 4704
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4705
static bool
4706 4707
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4708
    bool ret = true;
4709 4710
    const char *format = NULL;
    const char *configFile = NULL;
4711 4712
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
4713
    unsigned int flags = 0;
4714

4715
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4716
        return false;
4717

4718 4719
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
4720
        return false;
4721

4722
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
4723
        return false;
4724 4725 4726

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
4727
        vshPrint(ctl, "%s", xmlData);
4728
        VIR_FREE(xmlData);
4729
    } else {
E
Eric Blake 已提交
4730
        ret = false;
4731 4732 4733 4734 4735 4736 4737 4738 4739
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
4740 4741
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
4742 4743 4744 4745
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
4746 4747
    {"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")},
4748 4749 4750
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4751
static bool
4752 4753
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4754
    bool ret = true;
4755 4756
    const char *format = NULL;
    const char *xmlFile = NULL;
4757 4758
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
4759
    unsigned int flags = 0;
4760

4761
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4762
        return false;
4763

4764 4765
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
4766
        return false;
4767

4768
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
4769
        return false;
4770 4771 4772

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
4773
        vshPrint(ctl, "%s", configData);
4774
        VIR_FREE(configData);
4775
    } else {
E
Eric Blake 已提交
4776
        ret = false;
4777 4778 4779 4780 4781
    }

    return ret;
}

K
Karel Zak 已提交
4782
/*
K
Karel Zak 已提交
4783
 * "domname" command
K
Karel Zak 已提交
4784
 */
4785
static const vshCmdInfo info_domname[] = {
4786
    {"help", N_("convert a domain id or UUID to domain name")},
4787
    {"desc", ""},
4788
    {NULL, NULL}
K
Karel Zak 已提交
4789 4790
};

4791
static const vshCmdOptDef opts_domname[] = {
4792
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
4793
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4794 4795
};

E
Eric Blake 已提交
4796
static bool
4797
cmdDomname(vshControl *ctl, const vshCmd *cmd)
4798
{
K
Karel Zak 已提交
4799 4800
    virDomainPtr dom;

4801
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4802
        return false;
J
Jim Meyering 已提交
4803
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4804
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
4805
        return false;
4806

K
Karel Zak 已提交
4807 4808
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
4809
    return true;
K
Karel Zak 已提交
4810 4811 4812
}

/*
K
Karel Zak 已提交
4813
 * "domid" command
K
Karel Zak 已提交
4814
 */
4815
static const vshCmdInfo info_domid[] = {
4816
    {"help", N_("convert a domain name or UUID to domain id")},
4817
    {"desc", ""},
4818
    {NULL, NULL}
K
Karel Zak 已提交
4819 4820
};

4821
static const vshCmdOptDef opts_domid[] = {
4822
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
4823
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4824 4825
};

E
Eric Blake 已提交
4826
static bool
4827
cmdDomid(vshControl *ctl, const vshCmd *cmd)
4828
{
4829
    virDomainPtr dom;
4830
    unsigned int id;
K
Karel Zak 已提交
4831

4832
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4833
        return false;
J
Jim Meyering 已提交
4834
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4835
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
4836
        return false;
4837

4838 4839
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
4840
        vshPrint(ctl, "%s\n", "-");
4841
    else
4842
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
4843
    virDomainFree(dom);
E
Eric Blake 已提交
4844
    return true;
K
Karel Zak 已提交
4845
}
4846

K
Karel Zak 已提交
4847 4848 4849
/*
 * "domuuid" command
 */
4850
static const vshCmdInfo info_domuuid[] = {
4851
    {"help", N_("convert a domain name or id to domain UUID")},
4852
    {"desc", ""},
K
Karel Zak 已提交
4853 4854 4855
    {NULL, NULL}
};

4856
static const vshCmdOptDef opts_domuuid[] = {
4857
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
4858 4859 4860
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4861
static bool
4862
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
4863 4864
{
    virDomainPtr dom;
4865
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
4866

4867
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4868
        return false;
J
Jim Meyering 已提交
4869
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4870
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
4871
        return false;
4872

K
Karel Zak 已提交
4873 4874 4875
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
4876
        vshError(ctl, "%s", _("failed to get domain UUID"));
4877

4878
    virDomainFree(dom);
E
Eric Blake 已提交
4879
    return true;
K
Karel Zak 已提交
4880 4881
}

4882 4883 4884
/*
 * "migrate" command
 */
4885
static const vshCmdInfo info_migrate[] = {
4886 4887
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
4888 4889 4890
    {NULL, NULL}
};

4891
static const vshCmdOptDef opts_migrate[] = {
4892 4893 4894 4895 4896 4897 4898
    {"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")},
4899 4900
    {"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)")},
4901 4902
    {"change-protection", VSH_OT_BOOL, 0,
     N_("prevent any configuration changes to domain until migration ends)")},
W
Wen Congyang 已提交
4903
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
4904
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4905
    {"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)")},
4906 4907
    {"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 已提交
4908
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
4909
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
4910 4911 4912
    {NULL, 0, 0, NULL}
};

4913 4914 4915 4916 4917 4918 4919 4920
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
4921
{
4922
    char ret = '1';
4923
    virDomainPtr dom = NULL;
4924 4925 4926
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
E
Eric Blake 已提交
4927
    unsigned int flags = 0;
4928 4929 4930
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
4931 4932
    const char *xmlfile = NULL;
    char *xml = NULL;
4933
    sigset_t sigmask, oldsigmask;
4934 4935 4936 4937 4938

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

4940
    if (!vshConnectionUsability (ctl, ctl->conn))
4941
        goto out;
4942

J
Jim Meyering 已提交
4943
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
4944
        goto out;
4945

4946 4947
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
4948 4949
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
4950
        goto out;
4951
    }
4952

4953 4954 4955 4956 4957
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

4958 4959
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
4960 4961
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
4962
    if (vshCommandOptBool (cmd, "tunnelled"))
4963
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
4964

C
Chris Lalancette 已提交
4965 4966 4967 4968 4969
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

4970 4971 4972
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

4973 4974 4975 4976 4977 4978
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

4979 4980
    if (vshCommandOptBool (cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;
4981 4982 4983 4984 4985 4986

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


4987 4988 4989 4990
    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. */
4991

4992
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
4993
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
4994
            goto out;
4995
        }
4996

4997
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
4998
            ret = '0';
4999 5000 5001 5002 5003 5004
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
5005
        if (!dconn) goto out;
5006

5007
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
5008 5009
        if (ddom) {
            virDomainFree(ddom);
5010
            ret = '0';
5011 5012 5013
        }
        virConnectClose (dconn);
    }
5014

5015 5016 5017
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
5018
    if (dom) virDomainFree (dom);
5019
    VIR_FREE(xml);
5020 5021 5022
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
5023
static void
5024 5025
print_job_progress(const char *label, unsigned long long remaining,
                   unsigned long long total)
W
Wen Congyang 已提交
5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044
{
    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;
        }
    }

5045 5046
    /* see comments in vshError about why we must flush */
    fflush(stdout);
5047
    fprintf(stderr, "\r%s: [%3d %%]", label, progress);
5048
    fflush(stderr);
W
Wen Congyang 已提交
5049 5050
}

E
Eric Blake 已提交
5051
static bool
5052 5053 5054 5055 5056
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
5057
    bool functionReturn = false;
5058 5059 5060 5061 5062
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
5063 5064
    virDomainJobInfo jobinfo;
    bool verbose = false;
5065
    int timeout = 0;
W
Wen Congyang 已提交
5066 5067
    struct timeval start, curr;
    bool live_flag = false;
5068
    vshCtrlData data;
5069 5070 5071 5072
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
5073 5074

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

W
Wen Congyang 已提交
5077 5078 5079
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
5080
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
5081
        live_flag = true;
5082
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099
        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;
        }
    }

5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122
    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 已提交
5123
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
5124
    while (1) {
5125
repoll:
W
Wen Congyang 已提交
5126 5127 5128 5129
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
5130
                    functionReturn = true;
W
Wen Congyang 已提交
5131 5132
                    if (verbose) {
                        /* print [100 %] */
5133
                        print_job_progress("Migration", 0, 1);
W
Wen Congyang 已提交
5134 5135
                    }
                } else
W
Wen Congyang 已提交
5136
                    functionReturn = false;
5137
            } else
W
Wen Congyang 已提交
5138
                functionReturn = false;
W
Wen Congyang 已提交
5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
5150
            functionReturn = false;
W
Wen Congyang 已提交
5151 5152 5153
            break;
        }

W
Wen Congyang 已提交
5154 5155 5156 5157
        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. */
5158 5159
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "suspend the domain when migration timeouts\n");
W
Wen Congyang 已提交
5160 5161 5162 5163
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
5164 5165 5166 5167 5168
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
5169 5170
                print_job_progress("Migration", jobinfo.dataRemaining,
                                   jobinfo.dataTotal);
5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
5182
    return functionReturn;
5183 5184
}

5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195
/*
 * "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")},
5196
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
5197 5198 5199
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5200
static bool
5201 5202 5203
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
5204
    long long downtime = 0;
E
Eric Blake 已提交
5205
    bool ret = false;
5206

5207
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5208
        return false;
5209 5210

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

5213 5214
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
5215 5216 5217 5218 5219 5220 5221
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
5222
    ret = true;
5223 5224 5225 5226 5227 5228

done:
    virDomainFree(dom);
    return ret;
}

5229 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 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272
/*
 * "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;
}

5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311
/*
 * "migrate-getspeed" command
 */
static const vshCmdInfo info_migrate_getspeed[] = {
    {"help", N_("Get the maximum migration bandwidth")},
    {"desc", N_("Get the maximum migration bandwidth (in Mbps) for a domain.")},
    {NULL, NULL}
};

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

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

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

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

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

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

    ret = true;

done:
    virDomainFree(dom);
    return ret;
}

5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328
typedef enum {
    VSH_CMD_BLOCK_JOB_ABORT = 0,
    VSH_CMD_BLOCK_JOB_INFO = 1,
    VSH_CMD_BLOCK_JOB_SPEED = 2,
    VSH_CMD_BLOCK_JOB_PULL = 3,
} VSH_CMD_BLOCK_JOB_MODE;

static int
blockJobImpl(vshControl *ctl, const vshCmd *cmd,
              virDomainBlockJobInfoPtr info, int mode)
{
    virDomainPtr dom = NULL;
    const char *name, *path;
    unsigned long bandwidth = 0;
    int ret = -1;

    if (!vshConnectionUsability(ctl, ctl->conn))
5329
        goto cleanup;
5330 5331

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
5332
        goto cleanup;
5333 5334

    if (vshCommandOptString(cmd, "path", &path) < 0)
5335
        goto cleanup;
5336

5337 5338
    if (vshCommandOptUL(cmd, "bandwidth", &bandwidth) < 0) {
        vshError(ctl, "%s", _("bandwidth must be a number"));
5339
        goto cleanup;
5340
    }
5341 5342 5343 5344 5345 5346 5347 5348 5349 5350

    if (mode == VSH_CMD_BLOCK_JOB_ABORT)
        ret = virDomainBlockJobAbort(dom, path, 0);
    else if (mode == VSH_CMD_BLOCK_JOB_INFO)
        ret = virDomainGetBlockJobInfo(dom, path, info, 0);
    else if (mode == VSH_CMD_BLOCK_JOB_SPEED)
        ret = virDomainBlockJobSetSpeed(dom, path, bandwidth, 0);
    else if (mode == VSH_CMD_BLOCK_JOB_PULL)
        ret = virDomainBlockPull(dom, path, bandwidth, 0);

5351
cleanup:
5352 5353
    if (dom)
        virDomainFree(dom);
5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437
    return ret;
}

/*
 * "blockpull" command
 */
static const vshCmdInfo info_block_pull[] = {
    {"help", N_("Populate a disk from its backing image.")},
    {"desc", N_("Populate a disk from its backing image.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_block_pull[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified path of disk")},
    {"bandwidth", VSH_OT_DATA, VSH_OFLAG_NONE, N_("Bandwidth limit in MB/s")},
    {NULL, 0, 0, NULL}
};

static bool
cmdBlockPull(vshControl *ctl, const vshCmd *cmd)
{
    if (blockJobImpl(ctl, cmd, NULL, VSH_CMD_BLOCK_JOB_PULL) != 0)
        return false;
    return true;
}

/*
 * "blockjobinfo" command
 */
static const vshCmdInfo info_block_job[] = {
    {"help", N_("Manage active block operations.")},
    {"desc", N_("Manage active block operations.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_block_job[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified path of disk")},
    {"abort", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("Abort the active job on the speficied disk")},
    {"info", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("Get active job information for the specified disk")},
    {"bandwidth", VSH_OT_DATA, VSH_OFLAG_NONE, N_("Set the Bandwidth limit in MB/s")},
    {NULL, 0, 0, NULL}
};

static bool
cmdBlockJob(vshControl *ctl, const vshCmd *cmd)
{
    int mode;
    virDomainBlockJobInfo info;
    const char *type;
    int ret;

    if (vshCommandOptBool (cmd, "abort")) {
        mode = VSH_CMD_BLOCK_JOB_ABORT;
    } else if (vshCommandOptBool (cmd, "info")) {
        mode = VSH_CMD_BLOCK_JOB_INFO;
    } else if (vshCommandOptBool (cmd, "bandwidth")) {
        mode = VSH_CMD_BLOCK_JOB_SPEED;
    } else {
        vshError(ctl, "%s",
                 _("One of --abort, --info, or --bandwidth is required"));
        return false;
    }

    ret = blockJobImpl(ctl, cmd, &info, mode);
    if (ret < 0)
        return false;

    if (ret == 0 || mode != VSH_CMD_BLOCK_JOB_INFO)
        return true;

    if (info.type == VIR_DOMAIN_BLOCK_JOB_TYPE_PULL)
        type = "Block Pull";
    else
        type = "Unknown job";

    print_job_progress(type, info.end - info.cur, info.end);
    if (info.bandwidth != 0)
        vshPrint(ctl, "    Bandwidth limit: %lu MB/s\n", info.bandwidth);
    return true;
}


5438 5439 5440
/*
 * "net-autostart" command
 */
5441
static const vshCmdInfo info_network_autostart[] = {
5442
    {"help", N_("autostart a network")},
5443
    {"desc",
5444
     N_("Configure a network to be automatically started at boot.")},
5445 5446 5447
    {NULL, NULL}
};

5448
static const vshCmdOptDef opts_network_autostart[] = {
5449 5450
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5451 5452 5453
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5454
static bool
5455
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
5456 5457
{
    virNetworkPtr network;
5458
    const char *name;
5459 5460
    int autostart;

5461
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5462
        return false;
5463

J
Jim Meyering 已提交
5464
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5465
        return false;
5466 5467 5468 5469

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
5470
        if (autostart)
5471
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
5472
        else
5473
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
5474
        virNetworkFree(network);
E
Eric Blake 已提交
5475
        return false;
5476 5477
    }

5478
    if (autostart)
5479
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
5480
    else
5481
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
5482

L
Laine Stump 已提交
5483
    virNetworkFree(network);
E
Eric Blake 已提交
5484
    return true;
5485
}
K
Karel Zak 已提交
5486

5487 5488 5489
/*
 * "net-create" command
 */
5490
static const vshCmdInfo info_network_create[] = {
5491 5492
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
5493 5494 5495
    {NULL, NULL}
};

5496
static const vshCmdOptDef opts_network_create[] = {
5497
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5498 5499 5500
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5501
static bool
5502
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
5503 5504
{
    virNetworkPtr network;
5505
    const char *from = NULL;
E
Eric Blake 已提交
5506
    bool ret = true;
5507
    char *buffer;
5508

5509
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5510
        return false;
5511

5512
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5513
        return false;
5514

5515
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5516
        return false;
5517 5518

    network = virNetworkCreateXML(ctl->conn, buffer);
5519
    VIR_FREE(buffer);
5520

5521 5522 5523
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
5524
        virNetworkFree(network);
5525
    } else {
5526
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
5527
        ret = false;
5528 5529 5530 5531 5532 5533 5534 5535
    }
    return ret;
}


/*
 * "net-define" command
 */
5536
static const vshCmdInfo info_network_define[] = {
5537 5538
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
5539 5540 5541
    {NULL, NULL}
};

5542
static const vshCmdOptDef opts_network_define[] = {
5543
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5544 5545 5546
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5547
static bool
5548
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
5549 5550
{
    virNetworkPtr network;
5551
    const char *from = NULL;
E
Eric Blake 已提交
5552
    bool ret = true;
5553
    char *buffer;
5554

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

5558
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5559
        return false;
5560

5561
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5562
        return false;
5563 5564

    network = virNetworkDefineXML(ctl->conn, buffer);
5565
    VIR_FREE(buffer);
5566

5567 5568 5569
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
5570
        virNetworkFree(network);
5571
    } else {
5572
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
5573
        ret = false;
5574 5575 5576 5577 5578 5579 5580 5581
    }
    return ret;
}


/*
 * "net-destroy" command
 */
5582
static const vshCmdInfo info_network_destroy[] = {
5583 5584
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
5585 5586 5587
    {NULL, NULL}
};

5588
static const vshCmdOptDef opts_network_destroy[] = {
5589
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5590 5591 5592
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5593
static bool
5594
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
5595 5596
{
    virNetworkPtr network;
E
Eric Blake 已提交
5597
    bool ret = true;
5598
    const char *name;
5599

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

J
Jim Meyering 已提交
5603
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5604
        return false;
5605 5606 5607 5608

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

5613
    virNetworkFree(network);
5614 5615 5616 5617 5618 5619 5620
    return ret;
}


/*
 * "net-dumpxml" command
 */
5621
static const vshCmdInfo info_network_dumpxml[] = {
5622 5623
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
5624 5625 5626
    {NULL, NULL}
};

5627
static const vshCmdOptDef opts_network_dumpxml[] = {
5628
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5629 5630 5631
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5632
static bool
5633
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
5634 5635
{
    virNetworkPtr network;
E
Eric Blake 已提交
5636
    bool ret = true;
5637 5638
    char *dump;

5639
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5640
        return false;
5641

J
Jim Meyering 已提交
5642
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
5643
        return false;
5644 5645 5646

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
5647
        vshPrint(ctl, "%s", dump);
5648
        VIR_FREE(dump);
5649
    } else {
E
Eric Blake 已提交
5650
        ret = false;
5651 5652 5653 5654 5655 5656
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670
/*
 * "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 已提交
5671
static bool
O
Osier Yang 已提交
5672 5673 5674 5675 5676 5677 5678 5679 5680 5681
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 已提交
5682
        return false;
O
Osier Yang 已提交
5683 5684 5685

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5686
        return false;
O
Osier Yang 已提交
5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711

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

5712
    VIR_FREE(bridge);
O
Osier Yang 已提交
5713
    virNetworkFree(network);
E
Eric Blake 已提交
5714
    return true;
O
Osier Yang 已提交
5715
}
5716

5717 5718 5719 5720
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
5721 5722
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
5723 5724 5725 5726
    {NULL, NULL}
};

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

E
Eric Blake 已提交
5731
static bool
5732 5733
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5734
    bool ret = false;
5735 5736 5737 5738 5739
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
5740
    unsigned int flags = VIR_INTERFACE_XML_INACTIVE;
5741

5742
    if (!vshConnectionUsability(ctl, ctl->conn))
5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768
        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 已提交
5769
        ret = true;
5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781
        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)) {
5782 5783
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795
        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 已提交
5796
    ret = true;
5797 5798 5799 5800 5801

cleanup:
    if (iface)
        virInterfaceFree (iface);

5802 5803 5804
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
5805 5806 5807

    if (tmp) {
        unlink (tmp);
5808
        VIR_FREE(tmp);
5809 5810 5811 5812 5813
    }

    return ret;
}

5814 5815 5816
/*
 * "net-list" command
 */
5817
static const vshCmdInfo info_network_list[] = {
5818 5819
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
5820 5821 5822
    {NULL, NULL}
};

5823
static const vshCmdOptDef opts_network_list[] = {
5824 5825
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
5826 5827 5828
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5829
static bool
5830
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5831 5832 5833 5834 5835
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
5836
    char **activeNames = NULL, **inactiveNames = NULL;
5837 5838
    inactive |= all;

5839
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5840
        return false;
5841 5842

    if (active) {
5843 5844
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
5845
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
5846
            return false;
5847
        }
5848
        if (maxactive) {
5849
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
5850

5851
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
5852
                                                    maxactive)) < 0) {
5853
                vshError(ctl, "%s", _("Failed to list active networks"));
5854
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5855
                return false;
5856
            }
5857

5858
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
5859
        }
5860 5861
    }
    if (inactive) {
5862 5863
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
5864
            vshError(ctl, "%s", _("Failed to list inactive networks"));
5865
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5866
            return false;
5867
        }
5868 5869 5870
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5871 5872 5873
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
5874
                vshError(ctl, "%s", _("Failed to list inactive networks"));
5875 5876
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5877
                return false;
5878
            }
5879

5880 5881
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
5882
    }
5883 5884
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
5885
    vshPrintExtra(ctl, "-----------------------------------------\n");
5886 5887

    for (i = 0; i < maxactive; i++) {
5888 5889
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
5890 5891
        const char *autostartStr;
        int autostart = 0;
5892 5893 5894

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5895
            VIR_FREE(activeNames[i]);
5896
            continue;
5897
        }
5898

5899 5900 5901
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5902
            autostartStr = autostart ? _("yes") : _("no");
5903 5904 5905 5906 5907

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
5908
        virNetworkFree(network);
5909
        VIR_FREE(activeNames[i]);
5910 5911 5912
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
5913 5914
        const char *autostartStr;
        int autostart = 0;
5915 5916 5917

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5918
            VIR_FREE(inactiveNames[i]);
5919
            continue;
5920
        }
5921

5922 5923 5924
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5925
            autostartStr = autostart ? _("yes") : _("no");
5926

5927
        vshPrint(ctl, "%-20s %-10s %-10s\n",
5928 5929 5930
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
5931 5932

        virNetworkFree(network);
5933
        VIR_FREE(inactiveNames[i]);
5934
    }
5935 5936
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5937
    return true;
5938 5939 5940 5941 5942 5943
}


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

5950
static const vshCmdOptDef opts_network_name[] = {
5951
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
5952 5953 5954
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5955
static bool
5956
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
5957 5958 5959
{
    virNetworkPtr network;

5960
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5961
        return false;
J
Jim Meyering 已提交
5962
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5963
                                           VSH_BYUUID)))
E
Eric Blake 已提交
5964
        return false;
5965 5966 5967

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
5968
    return true;
5969 5970 5971 5972 5973 5974
}


/*
 * "net-start" command
 */
5975
static const vshCmdInfo info_network_start[] = {
5976 5977
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
5978 5979 5980
    {NULL, NULL}
};

5981
static const vshCmdOptDef opts_network_start[] = {
5982
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
5983 5984 5985
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5986
static bool
5987
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
5988 5989
{
    virNetworkPtr network;
E
Eric Blake 已提交
5990
    bool ret = true;
5991

5992
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5993
        return false;
5994

J
Jim Meyering 已提交
5995
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
5996
         return false;
5997 5998 5999

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
6000
                 virNetworkGetName(network));
6001
    } else {
6002
        vshError(ctl, _("Failed to start network %s"),
6003
                 virNetworkGetName(network));
E
Eric Blake 已提交
6004
        ret = false;
6005
    }
L
Laine Stump 已提交
6006
    virNetworkFree(network);
6007 6008 6009 6010 6011 6012 6013
    return ret;
}


/*
 * "net-undefine" command
 */
6014
static const vshCmdInfo info_network_undefine[] = {
6015 6016
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
6017 6018 6019
    {NULL, NULL}
};

6020
static const vshCmdOptDef opts_network_undefine[] = {
6021
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6022 6023 6024
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6025
static bool
6026
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
6027 6028
{
    virNetworkPtr network;
E
Eric Blake 已提交
6029
    bool ret = true;
6030
    const char *name;
6031

6032
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6033
        return false;
6034

J
Jim Meyering 已提交
6035
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6036
        return false;
6037 6038 6039 6040

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

L
Laine Stump 已提交
6045
    virNetworkFree(network);
6046 6047 6048 6049 6050 6051 6052
    return ret;
}


/*
 * "net-uuid" command
 */
6053
static const vshCmdInfo info_network_uuid[] = {
6054
    {"help", N_("convert a network name to network UUID")},
6055
    {"desc", ""},
6056 6057 6058
    {NULL, NULL}
};

6059
static const vshCmdOptDef opts_network_uuid[] = {
6060
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
6061 6062 6063
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6064
static bool
6065
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
6066 6067 6068 6069
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

6070
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6071
        return false;
6072

J
Jim Meyering 已提交
6073
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
6074
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6075
        return false;
6076 6077 6078 6079

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

L
Laine Stump 已提交
6082
    virNetworkFree(network);
E
Eric Blake 已提交
6083
    return true;
6084 6085 6086
}


6087 6088 6089 6090 6091
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
6092 6093
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
6094 6095 6096 6097
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
6098 6099
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
6100 6101
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
6102
static bool
6103 6104 6105 6106 6107 6108 6109 6110 6111
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;

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

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
6118
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
6119
            return false;
6120 6121 6122 6123 6124 6125
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
6126
                vshError(ctl, "%s", _("Failed to list active interfaces"));
6127
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6128
                return false;
6129 6130 6131 6132 6133 6134 6135 6136
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
6137
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6138
            VIR_FREE(activeNames);
E
Eric Blake 已提交
6139
            return false;
6140 6141 6142 6143
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

6144 6145 6146
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
6147
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6148 6149
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6150
                return false;
6151 6152 6153 6154 6155
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
6156 6157
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
6158 6159 6160
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
6161 6162
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
6163 6164 6165

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6166
            VIR_FREE(activeNames[i]);
6167 6168 6169 6170 6171 6172 6173 6174
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6175
        VIR_FREE(activeNames[i]);
6176 6177
    }
    for (i = 0; i < maxinactive; i++) {
6178 6179
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
6180 6181 6182

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6183
            VIR_FREE(inactiveNames[i]);
6184 6185 6186 6187 6188 6189 6190 6191
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6192
        VIR_FREE(inactiveNames[i]);
6193
    }
6194 6195
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6196
    return true;
6197 6198 6199 6200 6201 6202 6203

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
6204
    {"help", N_("convert an interface MAC address to interface name")},
6205 6206 6207 6208 6209
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
6210
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
6211 6212 6213
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6214
static bool
6215 6216 6217 6218
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6219
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6220
        return false;
6221 6222
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
6223
        return false;
6224 6225 6226

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6227
    return true;
6228 6229 6230 6231 6232 6233
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
6234
    {"help", N_("convert an interface name to interface MAC address")},
6235 6236 6237 6238 6239
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
6240
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
6241 6242 6243
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6244
static bool
6245 6246 6247 6248
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6249
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6250
        return false;
6251 6252
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6253
        return false;
6254 6255 6256

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6257
    return true;
6258 6259 6260 6261 6262 6263
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
6264 6265
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
6266 6267 6268 6269
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
6270 6271
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
6272 6273 6274
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6275
static bool
6276 6277 6278
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6279
    bool ret = true;
6280
    char *dump;
E
Eric Blake 已提交
6281
    unsigned int flags = 0;
6282 6283 6284 6285
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
6286

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

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

6293
    dump = virInterfaceGetXMLDesc(iface, flags);
6294
    if (dump != NULL) {
6295
        vshPrint(ctl, "%s", dump);
6296
        VIR_FREE(dump);
6297
    } else {
E
Eric Blake 已提交
6298
        ret = false;
6299 6300 6301 6302 6303 6304 6305 6306 6307 6308
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
6309 6310
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
6311 6312 6313 6314
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
6315
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
6316 6317 6318
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6319
static bool
6320 6321
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
6322
    virInterfacePtr iface;
6323
    const char *from = NULL;
E
Eric Blake 已提交
6324
    bool ret = true;
6325 6326
    char *buffer;

6327
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6328
        return false;
6329

6330
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6331
        return false;
6332 6333

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

6336
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
6337
    VIR_FREE(buffer);
6338

6339
    if (iface != NULL) {
6340
        vshPrint(ctl, _("Interface %s defined from %s\n"),
6341
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
6342
        virInterfaceFree (iface);
6343
    } else {
6344
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
6345
        ret = false;
6346 6347 6348 6349 6350 6351 6352 6353
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
6354 6355
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
6356 6357 6358 6359
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
6360
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6361 6362 6363
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6364
static bool
6365 6366 6367
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6368
    bool ret = true;
6369
    const char *name;
6370

6371
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6372
        return false;
6373 6374

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6375
        return false;
6376 6377 6378 6379

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
6380
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
6381
        ret = false;
6382 6383 6384 6385 6386 6387 6388 6389 6390 6391
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
6392 6393
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
6394 6395 6396 6397
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
6398
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6399 6400 6401
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6402
static bool
6403 6404 6405
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6406
    bool ret = true;
6407
    const char *name;
6408

6409
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6410
        return false;
6411 6412

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6413
        return false;
6414 6415 6416 6417

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
6418
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
6419
        ret = false;
6420 6421 6422 6423 6424 6425 6426 6427 6428 6429
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
6430
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
6431
    {"desc", N_("forcefully stop a physical host interface.")},
6432 6433 6434 6435
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
6436
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6437 6438 6439
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6440
static bool
6441 6442 6443
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6444
    bool ret = true;
6445
    const char *name;
6446

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

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6451
        return false;
6452 6453 6454 6455

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
6456
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
6457
        ret = false;
6458 6459 6460 6461 6462 6463
    }

    virInterfaceFree(iface);
    return ret;
}

6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548
/*
 * "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;
}
6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563

/*
 * "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 已提交
6564
static bool
6565 6566 6567
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
6568
    const char *from = NULL;
E
Eric Blake 已提交
6569
    bool ret = true;
6570 6571
    char *buffer;

6572
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6573
        return false;
6574

6575
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6576
        return false;
6577 6578

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6579
        return false;
6580 6581 6582 6583 6584 6585 6586 6587 6588 6589

    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 已提交
6590
        ret = false;
6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609
    }
    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 已提交
6610
static bool
6611 6612 6613
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6614
    bool ret = true;
6615
    const char *name;
6616

6617
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6618
        return false;
6619 6620

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
6621
        return false;
6622 6623 6624 6625 6626

    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 已提交
6627
        ret = false;
6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648
    }

    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 已提交
6649
static bool
6650 6651 6652
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6653
    bool ret = true;
6654 6655
    char *dump;

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

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
6660
        return false;
6661 6662 6663

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
6664
        vshPrint(ctl, "%s", dump);
6665 6666
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
6667
        ret = false;
6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686
    }

    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 已提交
6687
static bool
6688 6689 6690 6691 6692 6693
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
6700
        return false;
6701 6702 6703 6704 6705 6706 6707 6708
    }

    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 已提交
6709
        return false;
6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736
    }

    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 已提交
6737
    return true;
6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754
}


/*
 * "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 已提交
6755
static bool
6756 6757
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6758
    bool ret = false;
6759 6760 6761 6762 6763 6764
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

6765
    if (!vshConnectionUsability(ctl, ctl->conn))
6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791
        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 已提交
6792
        ret = true;
6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818
        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 已提交
6819
    ret = true;
6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837

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


6838
/**************************************************************************/
6839
/*
6840
 * "pool-autostart" command
6841
 */
6842
static const vshCmdInfo info_pool_autostart[] = {
6843
    {"help", N_("autostart a pool")},
6844
    {"desc",
6845
     N_("Configure a pool to be automatically started at boot.")},
6846
    {NULL, NULL}
6847 6848
};

6849
static const vshCmdOptDef opts_pool_autostart[] = {
6850 6851
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6852 6853
    {NULL, 0, 0, NULL}
};
6854

E
Eric Blake 已提交
6855
static bool
6856
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
6857
{
6858
    virStoragePoolPtr pool;
6859
    const char *name;
6860
    int autostart;
6861

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

6865
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6866
        return false;
6867

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

6870 6871
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
6872
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
6873
        else
6874
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
6875
        virStoragePoolFree(pool);
E
Eric Blake 已提交
6876
        return false;
6877 6878
    }

6879
    if (autostart)
6880
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
6881
    else
6882
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
6883

L
Laine Stump 已提交
6884
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6885
    return true;
6886 6887
}

6888
/*
6889
 * "pool-create" command
6890
 */
6891
static const vshCmdInfo info_pool_create[] = {
6892 6893
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
6894 6895 6896
    {NULL, NULL}
};

6897
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
6898
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
6899
     N_("file containing an XML pool description")},
6900 6901 6902
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6903
static bool
6904
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
6905
{
6906
    virStoragePoolPtr pool;
6907
    const char *from = NULL;
E
Eric Blake 已提交
6908
    bool ret = true;
6909
    char *buffer;
6910

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

6914
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6915
        return false;
6916

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

6920
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
6921
    VIR_FREE(buffer);
6922 6923 6924 6925

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6926
        virStoragePoolFree(pool);
6927
    } else {
6928
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
6929
        ret = false;
6930 6931
    }
    return ret;
6932 6933
}

6934

6935 6936 6937 6938
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
6939
    {"help", N_("create a device defined "
6940
                          "by an XML file on the node")},
6941
    {"desc", N_("Create a device on the node.  Note that this "
6942 6943 6944 6945 6946 6947 6948
                          "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,
6949
     N_("file containing an XML description of the device")},
6950 6951 6952
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6953
static bool
6954 6955 6956
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
6957
    const char *from = NULL;
E
Eric Blake 已提交
6958
    bool ret = true;
6959 6960
    char *buffer;

6961
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6962
        return false;
6963

6964
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6965
        return false;
6966

6967
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6968
        return false;
6969 6970

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
6971
    VIR_FREE(buffer);
6972 6973 6974 6975

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
6976
        virNodeDeviceFree(dev);
6977
    } else {
6978
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
6979
        ret = false;
6980 6981 6982 6983 6984 6985 6986 6987 6988 6989
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
6990
    {"help", N_("destroy (stop) a device on the node")},
6991
    {"desc", N_("Destroy a device on the node.  Note that this "
6992
                "command destroys devices on the physical host")},
6993 6994 6995 6996 6997
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
6998
     N_("name of the device to be destroyed")},
6999 7000 7001
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7002
static bool
7003 7004 7005
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
7006
    bool ret = true;
7007
    const char *name = NULL;
7008

7009
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
7010
        return false;
7011 7012
    }

7013
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
7014
        return false;
7015 7016 7017 7018 7019 7020

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
7021
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
7022
        ret = false;
7023 7024 7025 7026 7027 7028 7029
    }

    virNodeDeviceFree(dev);
    return ret;
}


7030
/*
7031
 * XML Building helper for pool-define-as and pool-create-as
7032
 */
7033
static const vshCmdOptDef opts_pool_X_as[] = {
7034 7035 7036 7037 7038 7039 7040 7041
    {"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")},
7042
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
7043 7044 7045
    {NULL, 0, 0, NULL}
};

7046
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
7047

7048 7049
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
7050
    virBuffer buf = VIR_BUFFER_INITIALIZER;
7051

7052
    if (vshCommandOptString(cmd, "name", &name) <= 0)
7053
        goto cleanup;
7054
    if (vshCommandOptString(cmd, "type", &type) <= 0)
7055 7056
        goto cleanup;

7057 7058 7059 7060 7061
    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 ||
7062 7063
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
7064
        goto cleanup;
7065
    }
7066

7067 7068
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
7069
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
7070
        virBufferAddLit(&buf, "  <source>\n");
7071

7072
        if (srcHost)
7073
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
7074
        if (srcPath)
7075
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
7076
        if (srcDev)
7077
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
7078
        if (srcFormat)
7079
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
7080
        if (srcName)
7081
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
7082 7083

        virBufferAddLit(&buf, "  </source>\n");
7084 7085
    }
    if (target) {
7086
        virBufferAddLit(&buf, "  <target>\n");
7087
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
7088
        virBufferAddLit(&buf, "  </target>\n");
7089
    }
7090 7091 7092 7093
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7094
        return false;
7095
    }
7096 7097 7098

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
7099
    return true;
7100 7101

cleanup:
7102
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7103
    return false;
7104 7105 7106 7107 7108 7109
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
7110 7111
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
7112 7113 7114
    {NULL, NULL}
};

E
Eric Blake 已提交
7115
static bool
7116 7117 7118
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
7119 7120
    const char *name;
    char *xml;
7121
    int printXML = vshCommandOptBool(cmd, "print-xml");
7122

7123
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7124
        return false;
7125 7126

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

7129
    if (printXML) {
7130
        vshPrint(ctl, "%s", xml);
7131
        VIR_FREE(xml);
7132
    } else {
7133
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
7134
        VIR_FREE(xml);
7135

7136 7137 7138 7139
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
7140
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
7141
            return false;
7142 7143
        }
    }
E
Eric Blake 已提交
7144
    return true;
7145 7146
}

7147

7148
/*
7149
 * "pool-define" command
7150
 */
7151
static const vshCmdInfo info_pool_define[] = {
7152 7153
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
7154 7155 7156
    {NULL, NULL}
};

7157
static const vshCmdOptDef opts_pool_define[] = {
7158
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
7159 7160 7161
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7162
static bool
7163
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
7164
{
7165
    virStoragePoolPtr pool;
7166
    const char *from = NULL;
E
Eric Blake 已提交
7167
    bool ret = true;
7168
    char *buffer;
7169

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

7173
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7174
        return false;
7175

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

7179
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
7180
    VIR_FREE(buffer);
7181 7182 7183 7184

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7185
        virStoragePoolFree(pool);
7186
    } else {
7187
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
7188
        ret = false;
7189 7190
    }
    return ret;
7191 7192
}

7193

7194 7195 7196
/*
 * "pool-define-as" command
 */
7197
static const vshCmdInfo info_pool_define_as[] = {
7198 7199
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
7200 7201 7202
    {NULL, NULL}
};

E
Eric Blake 已提交
7203
static bool
7204
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
7205 7206
{
    virStoragePoolPtr pool;
7207 7208
    const char *name;
    char *xml;
7209
    int printXML = vshCommandOptBool(cmd, "print-xml");
7210

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

7214
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
7215
        return false;
7216

7217
    if (printXML) {
7218
        vshPrint(ctl, "%s", xml);
7219
        VIR_FREE(xml);
7220
    } else {
7221
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
7222
        VIR_FREE(xml);
7223

7224 7225 7226 7227
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
7228
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
7229
            return false;
7230 7231
        }
    }
E
Eric Blake 已提交
7232
    return true;
7233 7234 7235
}


7236
/*
7237
 * "pool-build" command
7238
 */
7239
static const vshCmdInfo info_pool_build[] = {
7240 7241
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
7242 7243 7244
    {NULL, NULL}
};

7245
static const vshCmdOptDef opts_pool_build[] = {
7246
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7247 7248
    {"no-overwrite", VSH_OT_BOOL, 0, N_("do not overwrite an existing pool of this type")},
    {"overwrite", VSH_OT_BOOL, 0, N_("overwrite any existing data")},
7249 7250 7251
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7252
static bool
7253
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
7254
{
7255
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7256
    bool ret = true;
7257
    const char *name;
7258
    unsigned int flags = 0;
7259

7260
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7261
        return false;
7262

7263
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7264
        return false;
7265

7266 7267 7268 7269 7270 7271 7272 7273 7274
    if (vshCommandOptBool (cmd, "no-overwrite")) {
        flags |= VIR_STORAGE_POOL_BUILD_NO_OVERWRITE;
    }

    if (vshCommandOptBool (cmd, "overwrite")) {
        flags |= VIR_STORAGE_POOL_BUILD_OVERWRITE;
    }

    if (virStoragePoolBuild(pool, flags) == 0) {
7275
        vshPrint(ctl, _("Pool %s built\n"), name);
7276
    } else {
7277
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
7278
        ret = false;
7279 7280
    }

7281 7282
    virStoragePoolFree(pool);

7283 7284 7285
    return ret;
}

7286
/*
7287
 * "pool-destroy" command
7288
 */
7289
static const vshCmdInfo info_pool_destroy[] = {
7290 7291 7292
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
7293 7294 7295
    {NULL, NULL}
};

7296
static const vshCmdOptDef opts_pool_destroy[] = {
7297
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7298 7299 7300
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7301
static bool
7302
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
7303
{
7304
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7305
    bool ret = true;
7306
    const char *name;
7307

7308
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7309
        return false;
7310

7311
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7312
        return false;
7313

7314 7315 7316
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
7317
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
7318
        ret = false;
7319 7320
    }

7321
    virStoragePoolFree(pool);
7322 7323 7324
    return ret;
}

7325

7326
/*
7327 7328
 * "pool-delete" command
 */
7329
static const vshCmdInfo info_pool_delete[] = {
7330 7331
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
7332 7333 7334
    {NULL, NULL}
};

7335
static const vshCmdOptDef opts_pool_delete[] = {
7336
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7337 7338 7339
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7340
static bool
7341
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
7342 7343
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7344
    bool ret = true;
7345
    const char *name;
7346

7347
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7348
        return false;
7349 7350

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7351
        return false;
7352 7353

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
7354
        vshPrint(ctl, _("Pool %s deleted\n"), name);
7355
    } else {
7356
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
7357
        ret = false;
7358 7359
    }

L
Laine Stump 已提交
7360
    virStoragePoolFree(pool);
7361 7362 7363 7364 7365 7366 7367
    return ret;
}


/*
 * "pool-refresh" command
 */
7368
static const vshCmdInfo info_pool_refresh[] = {
7369 7370
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
7371 7372 7373
    {NULL, NULL}
};

7374
static const vshCmdOptDef opts_pool_refresh[] = {
7375
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7376 7377 7378
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7379
static bool
7380
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
7381 7382
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7383
    bool ret = true;
7384
    const char *name;
7385

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

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7390
        return false;
7391 7392 7393 7394

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
7395
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
7396
        ret = false;
7397 7398 7399 7400 7401 7402 7403 7404 7405 7406
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
7407
static const vshCmdInfo info_pool_dumpxml[] = {
7408 7409
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
7410 7411 7412
    {NULL, NULL}
};

7413
static const vshCmdOptDef opts_pool_dumpxml[] = {
7414
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7415 7416 7417
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7418
static bool
7419
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
7420 7421
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7422
    bool ret = true;
7423 7424
    char *dump;

7425
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7426
        return false;
7427 7428

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7429
        return false;
7430 7431 7432

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
7433
        vshPrint(ctl, "%s", dump);
7434
        VIR_FREE(dump);
7435
    } else {
E
Eric Blake 已提交
7436
        ret = false;
7437 7438 7439 7440 7441 7442 7443 7444 7445 7446
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
7447
static const vshCmdInfo info_pool_list[] = {
7448 7449
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
7450 7451 7452
    {NULL, NULL}
};

7453
static const vshCmdOptDef opts_pool_list[] = {
7454 7455
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
7456
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
7457 7458 7459
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7460
static bool
7461
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7462
{
7463 7464
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
7465 7466
    int i, ret;
    bool functionReturn;
7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482
    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 */
7483
    int all = vshCommandOptBool(cmd, "all");
7484 7485
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
7486 7487 7488
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

7489
    /* Check the connection to libvirtd daemon is still working */
7490
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7491
        return false;
7492

7493
    /* Retrieve the number of active storage pools */
7494
    if (active) {
7495 7496
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
7497
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
7498
            return false;
7499 7500
        }
    }
7501 7502

    /* Retrieve the number of inactive storage pools */
7503
    if (inactive) {
7504 7505
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
7506
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
7507
            return false;
7508
        }
7509
    }
7510

7511 7512
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
7513

7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525
    /* 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 已提交
7526
            return false;
7527 7528 7529
        }
    }

7530 7531 7532 7533 7534 7535 7536 7537
    /* 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 已提交
7538
            return false;
7539 7540
        }
    }
7541

7542 7543 7544 7545 7546 7547 7548 7549 7550 7551
    /* 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]);
7552
        if (!pool) {
7553
            VIR_FREE(poolNames[i]);
7554 7555 7556
            continue;
        }

7557
        /* Retrieve the autostart status of the pool */
7558
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
7559
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
7560
        else
7561 7562 7563 7564 7565 7566
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
7567 7568
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579
            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;
        }
7580

7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692
        /* 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 */
7693 7694 7695
        virStoragePoolFree(pool);
    }

7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713
    /* 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);
7714 7715
        }

7716
        /* Cleanup and return */
E
Eric Blake 已提交
7717
        functionReturn = true;
7718 7719
        goto cleanup;
    }
7720

7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758
    /* 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. */
7759
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
7760
             (unsigned long) nameStrLength);
7761
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
7762
             (unsigned long) stateStrLength);
7763
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
7764
             (unsigned long) autostartStrLength);
7765
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
7766
             (unsigned long) persistStrLength);
7767
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
7768
             (unsigned long) capStrLength);
7769
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
7770
             (unsigned long) allocStrLength);
7771
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814
             (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 已提交
7815
    functionReturn = true;
7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829
    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 已提交
7830
    functionReturn = false;
7831

7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843
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]);
7844
    }
7845 7846 7847 7848 7849 7850 7851

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

    /* Return the desired value */
    return functionReturn;
7852 7853
}

7854 7855 7856 7857
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
7858 7859
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7860 7861 7862 7863 7864
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7865 7866 7867
     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")},
7868
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
7869 7870 7871
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7872
static bool
7873 7874
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7875
    const char *type = NULL, *host = NULL;
7876 7877
    char *srcSpec = NULL;
    char *srcList;
7878
    const char *initiator = NULL;
7879

7880 7881
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
7882 7883
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
7884
        return false;
7885
    }
7886

7887
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7888
        return false;
7889 7890

    if (host) {
7891
        const char *port = NULL;
7892
        virBuffer buf = VIR_BUFFER_INITIALIZER;
7893 7894 7895 7896

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7897
            return false;
7898
        }
7899
        virBufferAddLit(&buf, "<source>\n");
7900
        virBufferAsprintf(&buf, "  <host name='%s'", host);
7901
        if (port)
7902
            virBufferAsprintf(&buf, " port='%s'", port);
7903
        virBufferAddLit(&buf, "/>\n");
7904 7905
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
7906
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
7907 7908
            virBufferAddLit(&buf, "  </initiator>\n");
        }
7909 7910 7911
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
7912
            return false;
7913
        }
7914
        srcSpec = virBufferContentAndReset(&buf);
7915 7916 7917
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7918
    VIR_FREE(srcSpec);
7919
    if (srcList == NULL) {
7920
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7921
        return false;
7922 7923
    }
    vshPrint(ctl, "%s", srcList);
7924
    VIR_FREE(srcList);
7925

E
Eric Blake 已提交
7926
    return true;
7927 7928 7929 7930 7931 7932 7933
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
7934 7935
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7936 7937 7938 7939 7940
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7941
     N_("type of storage pool sources to discover")},
7942
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
7943
     N_("optional file of source xml to query for pools")},
7944 7945 7946
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7947
static bool
7948 7949
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7950
    const char *type = NULL, *srcSpecFile = NULL;
7951
    char *srcSpec = NULL, *srcList;
7952

7953
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
7954
        return false;
7955

7956 7957
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
7958
        return false;
7959
    }
7960

7961
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7962
        return false;
7963 7964

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
7965
        return false;
7966 7967

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7968
    VIR_FREE(srcSpec);
7969
    if (srcList == NULL) {
7970
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7971
        return false;
7972 7973
    }
    vshPrint(ctl, "%s", srcList);
7974
    VIR_FREE(srcList);
7975

E
Eric Blake 已提交
7976
    return true;
7977 7978 7979
}


7980 7981 7982
/*
 * "pool-info" command
 */
7983
static const vshCmdInfo info_pool_info[] = {
7984 7985
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
7986 7987 7988
    {NULL, NULL}
};

7989
static const vshCmdOptDef opts_pool_info[] = {
7990
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7991 7992 7993
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7994
static bool
7995
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
7996 7997 7998
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
7999 8000
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
8001
    bool ret = true;
8002 8003
    char uuid[VIR_UUID_STRING_BUFLEN];

8004
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8005
        return false;
8006 8007

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8008
        return false;
8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034

    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;
8035 8036 8037 8038
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
8039 8040
        }

8041 8042
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
8043 8044
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
8045 8046 8047 8048 8049 8050 8051
        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);
8052 8053
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
8054 8055 8056 8057 8058
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070
        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 已提交
8071
        ret = false;
8072 8073 8074 8075 8076 8077 8078 8079 8080 8081
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
8082
static const vshCmdInfo info_pool_name[] = {
8083
    {"help", N_("convert a pool UUID to pool name")},
8084
    {"desc", ""},
8085 8086 8087
    {NULL, NULL}
};

8088
static const vshCmdOptDef opts_pool_name[] = {
8089
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
8090 8091 8092
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8093
static bool
8094
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
8095 8096 8097
{
    virStoragePoolPtr pool;

8098
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8099
        return false;
8100
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8101
                                           VSH_BYUUID)))
E
Eric Blake 已提交
8102
        return false;
8103 8104 8105

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8106
    return true;
8107 8108 8109 8110 8111 8112
}


/*
 * "pool-start" command
 */
8113
static const vshCmdInfo info_pool_start[] = {
8114 8115
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
8116 8117 8118
    {NULL, NULL}
};

8119
static const vshCmdOptDef opts_pool_start[] = {
8120
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
8121 8122 8123
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8124
static bool
8125
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
8126 8127
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8128
    bool ret = true;
8129

8130
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8131
        return false;
8132

8133
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
8134
         return false;
8135 8136 8137 8138 8139

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
8140
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
8141
        ret = false;
8142
    }
L
Laine Stump 已提交
8143 8144

    virStoragePoolFree(pool);
8145 8146 8147 8148
    return ret;
}


8149 8150 8151
/*
 * "vol-create-as" command
 */
8152
static const vshCmdInfo info_vol_create_as[] = {
8153 8154
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
8155 8156 8157
    {NULL, NULL}
};

8158
static const vshCmdOptDef opts_vol_create_as[] = {
8159 8160 8161 8162 8163
    {"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")},
8164 8165
    {"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")},
8166 8167 8168 8169 8170 8171 8172 8173 8174 8175
    {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 已提交
8176
        /* Deliberate fallthrough cases here :-) */
8177 8178 8179
        switch (*end) {
        case 'T':
            *val *= 1024;
8180
            /* fallthrough */
8181 8182
        case 'G':
            *val *= 1024;
8183
            /* fallthrough */
8184 8185
        case 'M':
            *val *= 1024;
8186
            /* fallthrough */
8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
8200
static bool
8201
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
8202 8203 8204
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8205
    char *xml;
8206 8207
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
8208
    unsigned long long capacity, allocation = 0;
8209
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8210

8211
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8212
        return false;
8213 8214 8215

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

8218
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8219 8220
        goto cleanup;

8221
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
8222 8223
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
8224
        vshError(ctl, _("Malformed size %s"), capacityStr);
8225

8226 8227
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
8228
        vshError(ctl, _("Malformed size %s"), allocationStr);
8229

8230 8231 8232 8233 8234 8235 8236
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

8237

8238
    virBufferAddLit(&buf, "<volume>\n");
8239 8240
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
8241
    if (allocationStr)
8242
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
8243 8244

    if (format) {
8245
        virBufferAddLit(&buf, "  <target>\n");
8246
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
8247
        virBufferAddLit(&buf, "  </target>\n");
8248
    }
8249

8250 8251 8252 8253
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
8254 8255
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
8256 8257 8258
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
8259 8260
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
8261 8262 8263 8264 8265
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
8266 8267
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
8268 8269 8270
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
8271 8272
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
8273 8274 8275 8276 8277
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
8278 8279
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
8280 8281 8282
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
8283 8284
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
8285 8286 8287 8288
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
8289
            goto cleanup;
8290 8291 8292 8293 8294
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
8295
            goto cleanup;
8296 8297 8298 8299
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
8300
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
8301
        if (snapshotStrFormat)
8302
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
8303 8304 8305 8306 8307 8308 8309 8310
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

8312 8313
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
8314
        goto cleanup;
8315 8316 8317
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
8318
    VIR_FREE(xml);
8319 8320 8321 8322 8323
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
8324
        return true;
8325
    } else {
8326
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
8327
        return false;
8328 8329 8330
    }

 cleanup:
8331
    virBufferFreeAndReset(&buf);
8332
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8333
    return false;
8334 8335 8336
}


8337 8338 8339
/*
 * "pool-undefine" command
 */
8340
static const vshCmdInfo info_pool_undefine[] = {
8341 8342
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
8343 8344 8345
    {NULL, NULL}
};

8346
static const vshCmdOptDef opts_pool_undefine[] = {
8347
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8348 8349 8350
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8351
static bool
8352
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
8353 8354
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8355
    bool ret = true;
8356
    const char *name;
8357

8358
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8359
        return false;
8360 8361

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8362
        return false;
8363 8364 8365 8366

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

L
Laine Stump 已提交
8371
    virStoragePoolFree(pool);
8372 8373 8374 8375 8376 8377 8378
    return ret;
}


/*
 * "pool-uuid" command
 */
8379
static const vshCmdInfo info_pool_uuid[] = {
8380
    {"help", N_("convert a pool name to pool UUID")},
8381
    {"desc", ""},
8382 8383 8384
    {NULL, NULL}
};

8385
static const vshCmdOptDef opts_pool_uuid[] = {
8386
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
8387 8388 8389
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8390
static bool
8391
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
8392 8393 8394 8395
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

8396
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8397
        return false;
8398 8399

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8400
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8401
        return false;
8402 8403 8404 8405

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

L
Laine Stump 已提交
8408
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8409
    return true;
8410 8411 8412 8413 8414 8415
}


/*
 * "vol-create" command
 */
8416
static const vshCmdInfo info_vol_create[] = {
8417 8418
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
8419 8420 8421
    {NULL, NULL}
};

8422
static const vshCmdOptDef opts_vol_create[] = {
8423 8424
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
8425 8426 8427
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8428
static bool
8429
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
8430 8431 8432
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8433
    const char *from = NULL;
E
Eric Blake 已提交
8434
    bool ret = true;
8435 8436
    char *buffer;

8437
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8438
        return false;
8439 8440

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

8444
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8445
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8446
        return false;
8447 8448 8449
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8450
        virshReportError(ctl);
8451
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8452
        return false;
8453 8454 8455
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
8456
    VIR_FREE(buffer);
8457 8458 8459 8460 8461 8462 8463
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
8464
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
8465
        ret = false;
8466 8467 8468 8469
    }
    return ret;
}

8470 8471 8472 8473
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
8474 8475
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
8476 8477 8478 8479
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
8480 8481 8482
    {"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 已提交
8483
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
8484 8485 8486
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8487
static bool
8488 8489 8490 8491
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
8492
    const char *from = NULL;
E
Eric Blake 已提交
8493
    bool ret = false;
8494 8495
    char *buffer = NULL;

8496
    if (!vshConnectionUsability(ctl, ctl->conn))
8497 8498 8499 8500 8501
        goto cleanup;

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

8502
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8503 8504 8505 8506 8507 8508 8509
        goto cleanup;
    }

    if (!(inputvol = vshCommandOptVol(ctl, cmd, "vol", "inputpool", NULL)))
        goto cleanup;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8510
        virshReportError(ctl);
8511 8512 8513 8514 8515 8516 8517 8518 8519
        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 {
8520
        vshError(ctl, _("Failed to create vol from %s"), from);
8521 8522 8523
        goto cleanup;
    }

E
Eric Blake 已提交
8524
    ret = true;
8525
cleanup:
8526
    VIR_FREE(buffer);
8527 8528 8529 8530
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
8531 8532
    if (newvol)
        virStorageVolFree(newvol);
8533 8534 8535 8536
    return ret;
}

static xmlChar *
8537
makeCloneXML(const char *origxml, const char *newname) {
8538

8539 8540 8541
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
8542 8543 8544
    xmlChar *newxml = NULL;
    int size;

8545
    doc = virXMLParseStringCtxt(origxml, "domain.xml", &ctxt);
8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567
    if (!doc)
        goto cleanup;

    obj = xmlXPathEval(BAD_CAST "/volume/name", ctxt);
    if ((obj == NULL) || (obj->nodesetval == NULL) ||
        (obj->nodesetval->nodeTab == NULL))
        goto cleanup;

    xmlNodeSetContent(obj->nodesetval->nodeTab[0], (const xmlChar *)newname);
    xmlDocDumpMemory(doc, &newxml, &size);

cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(doc);
    return newxml;
}

/*
 * "vol-clone" command
 */
static const vshCmdInfo info_vol_clone[] = {
8568 8569
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
8570 8571 8572 8573
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
8574 8575
    {"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 已提交
8576
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8577 8578 8579
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8580
static bool
8581 8582 8583 8584
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
8585
    const char *name = NULL;
8586
    char *origxml = NULL;
8587
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
8588
    bool ret = false;
8589

8590
    if (!vshConnectionUsability(ctl, ctl->conn))
8591 8592 8593 8594 8595 8596 8597
        goto cleanup;

    if (!(origvol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        goto cleanup;

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
8598
        vshError(ctl, "%s", _("failed to get parent pool"));
8599 8600 8601
        goto cleanup;
    }

8602
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620
        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 {
8621
        vshError(ctl, _("Failed to clone vol from %s"),
8622 8623 8624 8625
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
8626
    ret = true;
8627 8628

cleanup:
8629
    VIR_FREE(origxml);
8630 8631 8632
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
8633 8634
    if (newvol)
        virStorageVolFree(newvol);
8635 8636 8637 8638 8639
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652

/*
 * "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 已提交
8653
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667
    {"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 已提交
8668
static bool
8669 8670 8671 8672
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8673
    bool ret = false;
8674 8675 8676 8677 8678 8679 8680 8681 8682 8683
    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 已提交
8684
        return false;
8685 8686 8687 8688
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8689
        return false;
8690 8691 8692
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8693
        return false;
8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727
    }

    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 已提交
8728
    ret = true;
8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752

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 已提交
8753
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8754 8755 8756 8757 8758
    {"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 已提交
8759
static bool
8760 8761 8762 8763
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8764
    bool ret = false;
8765 8766 8767 8768
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
8769
    bool created = false;
8770 8771

    if (!vshConnectionUsability(ctl, ctl->conn))
8772
        return false;
8773 8774 8775

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8776
        return false;
8777 8778 8779 8780
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8781
        return false;
8782 8783 8784
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
8785
        return false;
8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797

    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;
        }
8798 8799
    } else {
        created = true;
8800 8801 8802 8803 8804 8805 8806 8807
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

8808
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823
        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 已提交
8824
    ret = true;
8825 8826

cleanup:
8827
    VIR_FORCE_CLOSE(fd);
8828
    if (!ret && created)
8829 8830 8831 8832 8833 8834 8835 8836 8837
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


8838 8839 8840
/*
 * "vol-delete" command
 */
8841
static const vshCmdInfo info_vol_delete[] = {
8842 8843
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
8844 8845 8846
    {NULL, NULL}
};

8847
static const vshCmdOptDef opts_vol_delete[] = {
8848
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8849
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8850 8851 8852
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8853
static bool
8854
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
8855 8856
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8857
    bool ret = true;
8858
    const char *name;
8859

8860
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8861
        return false;
8862 8863

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8864
        return false;
8865 8866 8867
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
8868
        vshPrint(ctl, _("Vol %s deleted\n"), name);
8869
    } else {
8870
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
8871
        ret = false;
8872 8873
    }

L
Laine Stump 已提交
8874
    virStorageVolFree(vol);
8875 8876 8877 8878
    return ret;
}


D
David Allan 已提交
8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889
/*
 * "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 已提交
8890
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
8891 8892 8893
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8894
static bool
D
David Allan 已提交
8895 8896 8897
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8898
    bool ret = true;
8899
    const char *name;
D
David Allan 已提交
8900

8901
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8902
        return false;
D
David Allan 已提交
8903 8904

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8905
        return false;
D
David Allan 已提交
8906 8907 8908 8909 8910 8911
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
8912
        ret = false;
D
David Allan 已提交
8913 8914 8915 8916 8917 8918 8919
    }

    virStorageVolFree(vol);
    return ret;
}


8920 8921 8922
/*
 * "vol-info" command
 */
8923
static const vshCmdInfo info_vol_info[] = {
8924 8925
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
8926 8927 8928
    {NULL, NULL}
};

8929
static const vshCmdOptDef opts_vol_info[] = {
8930
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8931
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8932 8933 8934
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8935
static bool
8936
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
8937 8938 8939
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
8940
    bool ret = true;
8941

8942
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8943
        return false;
8944 8945

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8946
        return false;
8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962

    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 已提交
8963
        ret = false;
8964 8965 8966 8967 8968 8969 8970 8971 8972 8973
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
8974
static const vshCmdInfo info_vol_dumpxml[] = {
8975 8976
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
8977 8978 8979
    {NULL, NULL}
};

8980
static const vshCmdOptDef opts_vol_dumpxml[] = {
8981
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8982
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8983 8984 8985
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8986
static bool
8987
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
8988 8989
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8990
    bool ret = true;
8991 8992
    char *dump;

8993
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8994
        return false;
8995 8996

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8997
        return false;
8998 8999 9000

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
9001
        vshPrint(ctl, "%s", dump);
9002
        VIR_FREE(dump);
9003
    } else {
E
Eric Blake 已提交
9004
        ret = false;
9005 9006 9007 9008 9009 9010 9011 9012 9013 9014
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
9015
static const vshCmdInfo info_vol_list[] = {
9016 9017
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
9018 9019 9020
    {NULL, NULL}
};

9021
static const vshCmdOptDef opts_vol_list[] = {
9022
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9023
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
9024 9025 9026
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9027
static bool
9028
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9029
{
9030
    virStorageVolInfo volumeInfo;
9031 9032
    virStoragePoolPtr pool;
    char **activeNames = NULL;
9033 9034 9035 9036 9037
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
9038 9039
    int ret;
    bool functionReturn;
9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050
    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;
9051

9052
    /* Check the connection to libvirtd daemon is still working */
9053
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9054
        return false;
9055

9056
    /* Look up the pool information given to us by the user */
9057
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
9058
        return false;
9059

9060 9061
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
9062

9063 9064 9065
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9066
        return false;
9067 9068
    }

9069 9070 9071 9072 9073
    /* 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) {
9074
            vshError(ctl, "%s", _("Failed to list active vols"));
9075
            VIR_FREE(activeNames);
9076
            virStoragePoolFree(pool);
E
Eric Blake 已提交
9077
            return false;
9078 9079
        }

9080 9081 9082 9083 9084
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

        /* Set aside memory for volume information pointers */
        volInfoTexts = vshCalloc(ctl, numVolumes, sizeof(*volInfoTexts));
9085 9086
    }

9087 9088 9089 9090 9091
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
9092

9093 9094 9095 9096
        /* 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"));
9097 9098
        }

9099 9100 9101 9102 9103 9104 9105 9106 9107
        /* 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 */
9108

9109
                /* Volume type */
9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122
                switch (volumeInfo.type) {
                        case VIR_STORAGE_VOL_FILE:
                            volInfoTexts[i].type = vshStrdup(ctl, _("file"));
                            break;
                        case VIR_STORAGE_VOL_BLOCK:
                            volInfoTexts[i].type = vshStrdup(ctl, _("block"));
                            break;
                        case VIR_STORAGE_VOL_DIR:
                            volInfoTexts[i].type = vshStrdup(ctl, _("dir"));
                            break;
                        default:
                            volInfoTexts[i].type = vshStrdup(ctl, _("unknown"));
                }
9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172

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

9174
        /* Cleanup memory allocation */
9175
        virStorageVolFree(vol);
9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193
    }

    /* 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 已提交
9194
        functionReturn = true;
9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225
        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 */
9226 9227 9228 9229 9230 9231 9232 9233 9234 9235
    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);
9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269

    /* 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 已提交
9270
    functionReturn = true;
9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284
    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 已提交
9285
    functionReturn = false;
9286 9287 9288 9289 9290 9291 9292 9293 9294 9295

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);
9296
        VIR_FREE(activeNames[i]);
9297
    }
9298 9299 9300 9301

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
9302
    VIR_FREE(activeNames);
9303
    virStoragePoolFree(pool);
9304 9305 9306

    /* Return the desired value */
    return functionReturn;
9307 9308 9309 9310 9311 9312
}


/*
 * "vol-name" command
 */
9313
static const vshCmdInfo info_vol_name[] = {
9314
    {"help", N_("returns the volume name for a given volume key or path")},
9315
    {"desc", ""},
9316 9317 9318
    {NULL, NULL}
};

9319
static const vshCmdOptDef opts_vol_name[] = {
9320
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
9321 9322 9323
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9324
static bool
9325
cmdVolName(vshControl *ctl, const vshCmd *cmd)
9326 9327 9328
{
    virStorageVolPtr vol;

9329
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9330
        return false;
9331

9332
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
9333
                                   VSH_BYUUID)))
E
Eric Blake 已提交
9334
        return false;
9335 9336 9337

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9338
    return true;
9339 9340 9341
}


J
Justin Clift 已提交
9342 9343 9344 9345 9346 9347 9348 9349 9350 9351
/*
 * "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[] = {
9352
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
9353 9354 9355 9356
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9357
static bool
J
Justin Clift 已提交
9358 9359 9360 9361
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9362
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
9363 9364

    /* Check the connection to libvirtd daemon is still working */
9365
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9366
        return false;
J
Justin Clift 已提交
9367 9368

    /* Use the supplied string to locate the volume */
9369
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
9370
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
9371
        return false;
J
Justin Clift 已提交
9372 9373 9374 9375 9376 9377 9378
    }

    /* 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 已提交
9379
        return false;
J
Justin Clift 已提交
9380 9381
    }

9382 9383 9384 9385 9386 9387 9388 9389 9390
    /* 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 已提交
9391 9392 9393 9394

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9395
    return true;
J
Justin Clift 已提交
9396 9397
}

9398 9399 9400 9401

/*
 * "vol-key" command
 */
9402
static const vshCmdInfo info_vol_key[] = {
9403
    {"help", N_("returns the volume key for a given volume name or path")},
9404
    {"desc", ""},
9405 9406 9407
    {NULL, NULL}
};

9408
static const vshCmdOptDef opts_vol_key[] = {
9409
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
9410
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9411 9412 9413
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9414
static bool
9415
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
9416 9417 9418
{
    virStorageVolPtr vol;

9419
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9420
        return false;
9421

9422
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9423
        return false;
9424 9425 9426

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9427
    return true;
9428 9429 9430 9431 9432 9433 9434
}



/*
 * "vol-path" command
 */
9435
static const vshCmdInfo info_vol_path[] = {
9436
    {"help", N_("returns the volume path for a given volume name or key")},
9437
    {"desc", ""},
9438 9439 9440
    {NULL, NULL}
};

9441
static const vshCmdOptDef opts_vol_path[] = {
9442
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
9443
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9444 9445 9446
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9447
static bool
9448
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
9449 9450
{
    virStorageVolPtr vol;
9451
    const char *name = NULL;
9452
    char * StorageVolPath;
9453

9454
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9455
        return false;
9456 9457

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9458
        return false;
9459
    }
9460

9461 9462 9463 9464 9465 9466 9467
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
9468
    virStorageVolFree(vol);
E
Eric Blake 已提交
9469
    return true;
9470 9471 9472
}


9473 9474 9475 9476
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
9477 9478
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
9479 9480
    {NULL, NULL}
};
9481

9482
static const vshCmdOptDef opts_secret_define[] = {
9483
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
9484 9485
    {NULL, 0, 0, NULL}
};
9486

E
Eric Blake 已提交
9487
static bool
9488 9489
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
9490
    const char *from = NULL;
9491
    char *buffer;
9492
    virSecretPtr res;
9493
    char uuid[VIR_UUID_STRING_BUFLEN];
9494

9495
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9496
        return false;
9497

9498
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9499
        return false;
9500 9501

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
9505
    VIR_FREE(buffer);
9506 9507

    if (res == NULL) {
9508
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
9509
        return false;
9510
    }
9511
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
9512
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
9513
        virSecretFree(res);
E
Eric Blake 已提交
9514
        return false;
9515 9516 9517
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
9518
    return true;
9519 9520 9521 9522 9523 9524
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
9525 9526
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
9527 9528 9529 9530
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
9531
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9532 9533 9534
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9535
static bool
9536 9537 9538
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9539
    bool ret = false;
9540 9541
    char *xml;

9542
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9543
        return false;
9544 9545 9546

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9547
        return false;
9548 9549 9550 9551

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
9552
    vshPrint(ctl, "%s", xml);
9553
    VIR_FREE(xml);
E
Eric Blake 已提交
9554
    ret = true;
9555 9556 9557 9558 9559 9560 9561 9562 9563 9564

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
9565 9566
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
9567 9568 9569 9570
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
9571 9572
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
9573 9574 9575
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9576
static bool
9577 9578 9579 9580
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
9581
    const char *base64 = NULL;
9582
    char *value;
E
Eric Blake 已提交
9583 9584
    int res;
    bool ret = false;
9585

9586
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9587
        return false;
9588 9589 9590

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9591
        return false;
9592

9593
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
9594 9595 9596
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
9597
        vshError(ctl, "%s", _("Invalid base64 data"));
9598 9599 9600
        goto cleanup;
    }
    if (value == NULL) {
9601
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
9602
        return false;
9603 9604 9605 9606
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
9607
    VIR_FREE(value);
9608 9609

    if (res != 0) {
9610
        vshError(ctl, "%s", _("Failed to set secret value"));
9611 9612 9613
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
9614
    ret = true;
9615 9616 9617 9618 9619 9620 9621 9622 9623 9624

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
9625 9626
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
9627 9628 9629 9630
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
9631
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9632 9633 9634
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9635
static bool
9636 9637 9638 9639 9640 9641
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
9642
    bool ret = false;
9643

9644
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9645
        return false;
9646 9647 9648

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9649
        return false;
9650 9651 9652 9653 9654 9655 9656

    value = virSecretGetValue(secret, &value_size, 0);
    if (value == NULL)
        goto cleanup;

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
9657
    VIR_FREE(value);
9658 9659

    if (base64 == NULL) {
9660
        vshError(ctl, "%s", _("Failed to allocate memory"));
9661 9662
        goto cleanup;
    }
9663
    vshPrint(ctl, "%s", base64);
9664
    memset(base64, 0, strlen(base64));
9665
    VIR_FREE(base64);
E
Eric Blake 已提交
9666
    ret = true;
9667 9668 9669 9670 9671 9672 9673 9674 9675 9676

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
9677 9678
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
9679 9680 9681 9682
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
9683
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9684 9685 9686
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9687
static bool
9688 9689 9690
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9691
    bool ret = false;
9692
    const char *uuid;
9693

9694
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9695
        return false;
9696 9697 9698

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
9699
        return false;
9700 9701

    if (virSecretUndefine(secret) < 0) {
9702
        vshError(ctl, _("Failed to delete secret %s"), uuid);
9703 9704 9705
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
9706
    ret = true;
9707 9708 9709 9710 9711 9712 9713 9714 9715 9716

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
9717 9718
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
9719 9720 9721
    {NULL, NULL}
};

E
Eric Blake 已提交
9722
static bool
9723 9724 9725 9726 9727
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

9728
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9729
        return false;
9730 9731 9732

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
9733
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
9734
        return false;
9735 9736 9737 9738 9739
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
9740
        vshError(ctl, "%s", _("Failed to list secrets"));
9741
        VIR_FREE(uuids);
E
Eric Blake 已提交
9742
        return false;
9743 9744 9745 9746
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

9747 9748
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
9749 9750

    for (i = 0; i < maxuuids; i++) {
9751 9752 9753 9754
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
9755
            VIR_FREE(uuids[i]);
9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773
            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);
9774
        VIR_FREE(uuids[i]);
9775
    }
9776
    VIR_FREE(uuids);
E
Eric Blake 已提交
9777
    return true;
9778
}
9779 9780 9781 9782 9783


/*
 * "version" command
 */
9784
static const vshCmdInfo info_version[] = {
9785 9786
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
9787 9788 9789
    {NULL, NULL}
};

9790 9791 9792 9793
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
9794

E
Eric Blake 已提交
9795
static bool
9796
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9797 9798 9799 9800 9801 9802
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
9803
    unsigned long daemonVersion;
9804 9805 9806 9807 9808
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

9809
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9810
        return false;
9811 9812 9813

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
9814
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
9815
        return false;
9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827
    }

    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) {
9828
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
9829
        return false;
9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846
    }
    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) {
9847
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
9848
        return false;
9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861
    }
    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);
    }
9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876

    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 已提交
9877
    return true;
9878 9879
}

9880 9881 9882 9883
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
9884
    {"help", N_("enumerate devices on this host")},
9885
    {"desc", ""},
9886 9887 9888 9889
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
9890 9891
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
9892 9893 9894
    {NULL, 0, 0, NULL}
};

9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916
#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] = '-';
9917 9918
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
9919 9920 9921
    }

    /* Print this device */
9922
    vshPrint(ctl, "%s", indentBuf);
9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945
    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) {
9946
        vshPrint(ctl, "%s", indentBuf);
9947
        vshPrint(ctl, " |\n");
9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969
    }

    /* 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) {
9970
        vshPrint(ctl, "%s", indentBuf);
9971 9972 9973 9974
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
9975
static bool
9976 9977
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
9978
    const char *cap = NULL;
9979
    char **devices;
9980
    int num_devices, i;
9981
    int tree = vshCommandOptBool(cmd, "tree");
9982

9983
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9984
        return false;
9985

9986
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
9987 9988 9989 9990
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
9991
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
9992
        return false;
9993
    } else if (num_devices == 0) {
E
Eric Blake 已提交
9994
        return true;
9995 9996 9997 9998 9999 10000
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
10001
        vshError(ctl, "%s", _("Failed to list node devices"));
10002
        VIR_FREE(devices);
E
Eric Blake 已提交
10003
        return false;
10004
    }
10005
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
10006 10007 10008 10009 10010 10011 10012
    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 已提交
10013
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032
            } 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++) {
10033 10034
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
10035
        }
10036
        VIR_FREE(parents);
10037 10038 10039
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
10040
            VIR_FREE(devices[i]);
10041
        }
10042
    }
10043
    VIR_FREE(devices);
E
Eric Blake 已提交
10044
    return true;
10045 10046 10047 10048 10049 10050
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
10051 10052
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
10053 10054 10055 10056 10057
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
10058
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10059 10060 10061
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10062
static bool
10063 10064
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
10065
    const char *name = NULL;
10066
    virNodeDevicePtr device;
L
Laine Stump 已提交
10067
    char *xml;
10068

10069
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10070
        return false;
10071
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10072
        return false;
10073
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10074
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10075
        return false;
10076 10077
    }

L
Laine Stump 已提交
10078 10079 10080
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
10081
        return false;
L
Laine Stump 已提交
10082 10083 10084
    }

    vshPrint(ctl, "%s\n", xml);
10085
    VIR_FREE(xml);
10086
    virNodeDeviceFree(device);
E
Eric Blake 已提交
10087
    return true;
10088 10089
}

10090 10091 10092 10093
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
10094 10095
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
10096 10097 10098 10099 10100
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
10101
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10102 10103 10104
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10105
static bool
10106 10107
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
10108
    const char *name = NULL;
10109
    virNodeDevicePtr device;
E
Eric Blake 已提交
10110
    bool ret = true;
10111

10112
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10113
        return false;
10114
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10115
        return false;
10116
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10117
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10118
        return false;
10119 10120 10121 10122 10123
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
10124
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
10125
        ret = false;
10126 10127 10128 10129 10130 10131 10132 10133 10134
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
10135 10136
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
10137 10138 10139 10140 10141
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
10142
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10143 10144 10145
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10146
static bool
10147 10148
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
10149
    const char *name = NULL;
10150
    virNodeDevicePtr device;
E
Eric Blake 已提交
10151
    bool ret = true;
10152

10153
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10154
        return false;
10155
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10156
        return false;
10157
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10158
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10159
        return false;
10160 10161 10162 10163 10164
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
10165
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
10166
        ret = false;
10167 10168 10169 10170 10171 10172 10173 10174 10175
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
10176 10177
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
10178 10179 10180 10181 10182
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
10183
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10184 10185 10186
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10187
static bool
10188 10189
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
10190
    const char *name = NULL;
10191
    virNodeDevicePtr device;
E
Eric Blake 已提交
10192
    bool ret = true;
10193

10194
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10195
        return false;
10196
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10197
        return false;
10198
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10199
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10200
        return false;
10201 10202 10203 10204 10205
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
10206
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
10207
        ret = false;
10208 10209 10210 10211 10212
    }
    virNodeDeviceFree(device);
    return ret;
}

10213
/*
E
Eric Blake 已提交
10214
 * "hostname" command
10215
 */
10216
static const vshCmdInfo info_hostname[] = {
10217
    {"help", N_("print the hypervisor hostname")},
10218
    {"desc", ""},
10219 10220 10221
    {NULL, NULL}
};

E
Eric Blake 已提交
10222
static bool
10223
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10224 10225 10226
{
    char *hostname;

10227
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10228
        return false;
10229 10230 10231

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
10232
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
10233
        return false;
10234 10235 10236
    }

    vshPrint (ctl, "%s\n", hostname);
10237
    VIR_FREE(hostname);
10238

E
Eric Blake 已提交
10239
    return true;
10240 10241 10242 10243 10244
}

/*
 * "uri" command
 */
10245
static const vshCmdInfo info_uri[] = {
10246
    {"help", N_("print the hypervisor canonical URI")},
10247
    {"desc", ""},
10248 10249 10250
    {NULL, NULL}
};

E
Eric Blake 已提交
10251
static bool
10252
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10253 10254 10255
{
    char *uri;

10256
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10257
        return false;
10258 10259 10260

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
10261
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
10262
        return false;
10263 10264 10265
    }

    vshPrint (ctl, "%s\n", uri);
10266
    VIR_FREE(uri);
10267

E
Eric Blake 已提交
10268
    return true;
10269 10270
}

E
Eric Blake 已提交
10271 10272 10273 10274 10275 10276 10277 10278 10279 10280
/*
 * "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 已提交
10281
static bool
E
Eric Blake 已提交
10282 10283 10284 10285 10286
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10287
        return false;
E
Eric Blake 已提交
10288 10289 10290 10291

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
10292
        return false;
E
Eric Blake 已提交
10293 10294 10295 10296 10297
    }

    vshPrint (ctl, "%s", sysinfo);
    VIR_FREE(sysinfo);

E
Eric Blake 已提交
10298
    return true;
E
Eric Blake 已提交
10299 10300
}

10301 10302 10303
/*
 * "vncdisplay" command
 */
10304
static const vshCmdInfo info_vncdisplay[] = {
10305 10306
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
10307 10308 10309
    {NULL, NULL}
};

10310
static const vshCmdOptDef opts_vncdisplay[] = {
10311
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10312 10313 10314
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10315
static bool
10316
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
10317 10318 10319 10320 10321
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10322
    bool ret = false;
10323 10324 10325
    int port = 0;
    char *doc;

10326
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10327
        return false;
10328

J
Jim Meyering 已提交
10329
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10330
        return false;
10331 10332 10333 10334 10335

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10336
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10337
    VIR_FREE(doc);
10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352
    if (!xml)
        goto cleanup;

    obj = xmlXPathEval(BAD_CAST "string(/domain/devices/graphics[@type='vnc']/@port)", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_STRING) ||
        (obj->stringval == NULL) || (obj->stringval[0] == 0)) {
        goto cleanup;
    }
    if (virStrToLong_i((const char *)obj->stringval, NULL, 10, &port) || port < 0)
        goto cleanup;
    xmlXPathFreeObject(obj);

    obj = xmlXPathEval(BAD_CAST "string(/domain/devices/graphics[@type='vnc']/@listen)", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_STRING) ||
        (obj->stringval == NULL) || (obj->stringval[0] == 0) ||
10353
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
10354 10355 10356 10357 10358 10359
        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 已提交
10360
    ret = true;
10361 10362 10363 10364

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10365
    xmlFreeDoc(xml);
10366 10367 10368 10369 10370 10371 10372
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
10373
static const vshCmdInfo info_ttyconsole[] = {
10374 10375
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
10376 10377 10378
    {NULL, NULL}
};

10379
static const vshCmdOptDef opts_ttyconsole[] = {
10380
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10381 10382 10383
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10384
static bool
10385
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
10386 10387 10388 10389 10390
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10391
    bool ret = false;
10392 10393
    char *doc;

10394
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10395
        return false;
10396

J
Jim Meyering 已提交
10397
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10398
        return false;
10399 10400 10401 10402 10403

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10404
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10405
    VIR_FREE(doc);
10406 10407 10408 10409 10410 10411 10412 10413 10414
    if (!xml)
        goto cleanup;

    obj = xmlXPathEval(BAD_CAST "string(/domain/devices/console/@tty)", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_STRING) ||
        (obj->stringval == NULL) || (obj->stringval[0] == 0)) {
        goto cleanup;
    }
    vshPrint(ctl, "%s\n", (const char *)obj->stringval);
E
Eric Blake 已提交
10415
    ret = true;
10416 10417 10418 10419

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10420
    xmlFreeDoc(xml);
10421 10422 10423 10424 10425 10426
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
10427
 */
10428
static const vshCmdInfo info_attach_device[] = {
10429 10430
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
10431 10432 10433
    {NULL, NULL}
};

10434
static const vshCmdOptDef opts_attach_device[] = {
10435 10436 10437
    {"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")},
10438 10439 10440
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10441
static bool
10442
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
10443 10444
{
    virDomainPtr dom;
10445
    const char *from = NULL;
10446
    char *buffer;
W
Wen Congyang 已提交
10447
    int ret;
J
Jim Fehlig 已提交
10448
    unsigned int flags;
10449

10450
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10451
        return false;
10452

J
Jim Meyering 已提交
10453
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10454
        return false;
10455

10456
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10457
        virDomainFree(dom);
E
Eric Blake 已提交
10458
        return false;
10459 10460
    }

10461
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10462
        virshReportError(ctl);
10463
        virDomainFree(dom);
E
Eric Blake 已提交
10464
        return false;
10465
    }
10466

J
Jim Fehlig 已提交
10467
    if (vshCommandOptBool(cmd, "persistent")) {
10468
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10469
        if (virDomainIsActive(dom) == 1)
10470
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10471 10472 10473 10474
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
10475
    VIR_FREE(buffer);
10476 10477

    if (ret < 0) {
10478
        vshError(ctl, _("Failed to attach device from %s"), from);
10479
        virDomainFree(dom);
E
Eric Blake 已提交
10480
        return false;
10481
    } else {
J
Jim Meyering 已提交
10482
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
10483 10484 10485
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10486
    return true;
10487 10488 10489 10490 10491 10492
}


/*
 * "detach-device" command
 */
10493
static const vshCmdInfo info_detach_device[] = {
10494 10495
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
10496 10497 10498
    {NULL, NULL}
};

10499
static const vshCmdOptDef opts_detach_device[] = {
10500 10501 10502
    {"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")},
10503 10504 10505
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10506
static bool
10507
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
10508 10509
{
    virDomainPtr dom;
10510
    const char *from = NULL;
10511
    char *buffer;
W
Wen Congyang 已提交
10512
    int ret;
J
Jim Fehlig 已提交
10513
    unsigned int flags;
10514

10515
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10516
        return false;
10517

J
Jim Meyering 已提交
10518
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10519
        return false;
10520

10521
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10522
        virDomainFree(dom);
E
Eric Blake 已提交
10523
        return false;
10524 10525
    }

10526
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10527
        virshReportError(ctl);
10528
        virDomainFree(dom);
E
Eric Blake 已提交
10529
        return false;
10530
    }
10531

J
Jim Fehlig 已提交
10532
    if (vshCommandOptBool(cmd, "persistent")) {
10533
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10534
        if (virDomainIsActive(dom) == 1)
10535
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10536 10537 10538 10539
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
10540
    VIR_FREE(buffer);
10541 10542

    if (ret < 0) {
10543
        vshError(ctl, _("Failed to detach device from %s"), from);
10544
        virDomainFree(dom);
E
Eric Blake 已提交
10545
        return false;
10546
    } else {
J
Jim Meyering 已提交
10547
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
10548 10549 10550
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10551
    return true;
10552 10553
}

10554

10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567
/*
 * "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")},
10568
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
10569 10570 10571
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10572
static bool
10573 10574 10575
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
10576
    const char *from = NULL;
10577
    char *buffer;
W
Wen Congyang 已提交
10578
    int ret;
10579 10580
    unsigned int flags;

10581
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10582
        return false;
10583 10584

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

10587
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10588
        virDomainFree(dom);
E
Eric Blake 已提交
10589
        return false;
10590 10591 10592
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10593
        virshReportError(ctl);
10594
        virDomainFree(dom);
E
Eric Blake 已提交
10595
        return false;
10596 10597 10598
    }

    if (vshCommandOptBool(cmd, "persistent")) {
10599
        flags = VIR_DOMAIN_AFFECT_CONFIG;
10600
        if (virDomainIsActive(dom) == 1)
10601
           flags |= VIR_DOMAIN_AFFECT_LIVE;
10602
    } else {
10603
        flags = VIR_DOMAIN_AFFECT_LIVE;
10604
    }
10605 10606 10607 10608

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

10609 10610 10611 10612 10613 10614
    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 已提交
10615
        return false;
10616 10617 10618 10619 10620
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10621
    return true;
10622 10623 10624
}


10625 10626 10627
/*
 * "attach-interface" command
 */
10628
static const vshCmdInfo info_attach_interface[] = {
10629 10630
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
10631 10632 10633
    {NULL, NULL}
};

10634
static const vshCmdOptDef opts_attach_interface[] = {
10635 10636 10637 10638 10639 10640
    {"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")},
10641
    {"model", VSH_OT_DATA, 0, N_("model type")},
10642
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
10643 10644 10645
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10646
static bool
10647
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
10648 10649
{
    virDomainPtr dom = NULL;
10650 10651
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
10652
    int typ;
W
Wen Congyang 已提交
10653 10654
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
10655
    unsigned int flags;
10656 10657
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10658

10659
    if (!vshConnectionUsability(ctl, ctl->conn))
10660 10661
        goto cleanup;

J
Jim Meyering 已提交
10662
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10663 10664
        goto cleanup;

10665
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10666 10667
        goto cleanup;

10668 10669 10670 10671
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
10672 10673
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
10674
        goto cleanup;
10675
    }
10676 10677

    /* check interface type */
10678
    if (STREQ(type, "network")) {
10679
        typ = 1;
10680
    } else if (STREQ(type, "bridge")) {
10681 10682
        typ = 2;
    } else {
E
Eric Blake 已提交
10683 10684
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
10685 10686 10687 10688
        goto cleanup;
    }

    /* Make XML of interface */
10689
    virBufferAsprintf(&buf, "<interface type='%s'>\n", type);
10690

10691
    if (typ == 1)
10692
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
10693
    else if (typ == 2)
10694
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
10695

10696
    if (target != NULL)
10697
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10698
    if (mac != NULL)
10699
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
10700
    if (script != NULL)
10701
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
10702
    if (model != NULL)
10703
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
10704

10705
    virBufferAddLit(&buf, "</interface>\n");
10706

10707 10708
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
10709
        goto cleanup;
10710 10711
    }

10712
    xml = virBufferContentAndReset(&buf);
10713

J
Jim Fehlig 已提交
10714
    if (vshCommandOptBool(cmd, "persistent")) {
10715
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10716
        if (virDomainIsActive(dom) == 1)
10717
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10718
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
10719
    } else {
10720
        ret = virDomainAttachDevice(dom, xml);
10721
    }
10722

10723 10724
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10725
    if (ret != 0) {
L
Laine Stump 已提交
10726
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
10727 10728
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
10729
        functionReturn = true;
J
Jim Fehlig 已提交
10730
    }
10731 10732 10733 10734

 cleanup:
    if (dom)
        virDomainFree(dom);
10735
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10736
    return functionReturn;
10737 10738 10739 10740 10741
}

/*
 * "detach-interface" command
 */
10742
static const vshCmdInfo info_detach_interface[] = {
10743 10744
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
10745 10746 10747
    {NULL, NULL}
};

10748
static const vshCmdOptDef opts_detach_interface[] = {
10749 10750 10751 10752
    {"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")},
10753 10754 10755
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10756
static bool
10757
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
10758 10759 10760 10761 10762 10763 10764
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
10765
    const char *mac =NULL, *type = NULL;
10766
    char *doc;
10767
    char buf[64];
E
Eric Blake 已提交
10768
    int i = 0, diff_mac;
W
Wen Congyang 已提交
10769 10770
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
10771
    unsigned int flags;
10772

10773
    if (!vshConnectionUsability(ctl, ctl->conn))
10774 10775
        goto cleanup;

J
Jim Meyering 已提交
10776
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10777 10778
        goto cleanup;

10779
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10780 10781
        goto cleanup;

10782 10783
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
10784
        goto cleanup;
10785
    }
10786 10787 10788 10789 10790

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10791
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10792
    VIR_FREE(doc);
10793
    if (!xml) {
10794
        vshError(ctl, "%s", _("Failed to get interface information"));
10795 10796 10797
        goto cleanup;
    }

E
Eric Blake 已提交
10798
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
10799 10800 10801
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10802
        vshError(ctl, _("No found interface whose type is %s"), type);
10803 10804 10805
        goto cleanup;
    }

10806 10807 10808 10809 10810 10811
    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;
    }

10812 10813 10814 10815 10816 10817 10818
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10819 10820 10821 10822 10823
            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);
10824 10825 10826 10827 10828 10829 10830
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10831
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
10832 10833 10834 10835 10836
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10837
        vshError(ctl, "%s", _("Failed to allocate memory"));
10838 10839 10840
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
10846
    if (vshCommandOptBool(cmd, "persistent")) {
10847
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10848
        if (virDomainIsActive(dom) == 1)
10849
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10850 10851 10852 10853 10854 10855 10856 10857
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10858
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
10859
    } else {
J
Jim Meyering 已提交
10860
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
10861
        functionReturn = true;
10862
    }
10863 10864 10865 10866

 cleanup:
    if (dom)
        virDomainFree(dom);
10867
    xmlXPathFreeObject(obj);
10868
    xmlXPathFreeContext(ctxt);
10869 10870
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
10871
    return functionReturn;
10872 10873 10874 10875 10876
}

/*
 * "attach-disk" command
 */
10877
static const vshCmdInfo info_attach_disk[] = {
10878 10879
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
10880 10881 10882
    {NULL, NULL}
};

10883
static const vshCmdOptDef opts_attach_disk[] = {
10884 10885 10886 10887 10888
    {"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")},
10889
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
10890 10891 10892
    {"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")},
10893
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
10894 10895 10896
    {"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")},
10897 10898 10899
    {NULL, 0, 0, NULL}
};

10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 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 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046
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 已提交
11047
static bool
11048
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
11049 11050
{
    virDomainPtr dom = NULL;
11051
    const char *source = NULL, *target = NULL, *driver = NULL,
11052 11053 11054
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
11055 11056
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
11057
    unsigned int flags;
11058
    const char *stype = NULL;
11059 11060
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
11061

11062
    if (!vshConnectionUsability(ctl, ctl->conn))
11063 11064
        goto cleanup;

J
Jim Meyering 已提交
11065
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11066 11067
        goto cleanup;

11068
    if (vshCommandOptString(cmd, "source", &source) <= 0)
11069 11070
        goto cleanup;

11071
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11072 11073
        goto cleanup;

11074 11075 11076 11077
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
11078 11079 11080
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
11081
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
11082
        vshError(ctl, "%s", _("missing option"));
11083 11084
        goto cleanup;
    }
11085

11086 11087
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
11088
            isFile = true;
11089
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
11090
        isFile = true;
11091 11092 11093
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
11094 11095 11096
    }

    if (mode) {
11097
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
11098 11099
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
11100 11101 11102 11103 11104
            goto cleanup;
        }
    }

    /* Make XML of disk */
11105
    virBufferAsprintf(&buf, "<disk type='%s'",
11106 11107
                      (isFile) ? "file" : "block");
    if (type)
11108
        virBufferAsprintf(&buf, " device='%s'", type);
11109 11110
    virBufferAddLit(&buf, ">\n");

11111
    if (driver || subdriver)
11112
        virBufferAsprintf(&buf, "  <driver");
11113 11114

    if (driver)
11115
        virBufferAsprintf(&buf, " name='%s'", driver);
11116
    if (subdriver)
11117
        virBufferAsprintf(&buf, " type='%s'", subdriver);
11118 11119
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
11120

11121
    if (driver || subdriver || cache)
11122
        virBufferAddLit(&buf, "/>\n");
11123

11124
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
11125 11126
                      (isFile) ? "file" : "dev",
                      source);
11127
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11128
    if (mode)
11129
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
11130

11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178
    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;
            }
        }
    }

11179
    virBufferAddLit(&buf, "</disk>\n");
11180

11181 11182
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
11183
        return false;
11184 11185
    }

11186
    xml = virBufferContentAndReset(&buf);
11187

J
Jim Fehlig 已提交
11188
    if (vshCommandOptBool(cmd, "persistent")) {
11189
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11190
        if (virDomainIsActive(dom) == 1)
11191
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11192
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
11193
    } else {
11194
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
11195
    }
11196

11197 11198
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11199
    if (ret != 0) {
L
Laine Stump 已提交
11200
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
11201 11202
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
11203
        functionReturn = true;
J
Jim Fehlig 已提交
11204
    }
11205 11206 11207 11208

 cleanup:
    if (dom)
        virDomainFree(dom);
11209
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11210
    return functionReturn;
11211 11212 11213 11214 11215
}

/*
 * "detach-disk" command
 */
11216
static const vshCmdInfo info_detach_disk[] = {
11217 11218
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
11219 11220 11221
    {NULL, NULL}
};

11222
static const vshCmdOptDef opts_detach_disk[] = {
11223 11224 11225
    {"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")},
11226 11227 11228
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11229
static bool
11230
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
11231 11232 11233 11234 11235 11236 11237
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
11238
    const char *target = NULL;
11239
    char *doc;
E
Eric Blake 已提交
11240
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
11241 11242
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11243
    unsigned int flags;
11244

11245
    if (!vshConnectionUsability(ctl, ctl->conn))
11246 11247
        goto cleanup;

J
Jim Meyering 已提交
11248
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11249 11250
        goto cleanup;

11251
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11252 11253 11254 11255 11256 11257
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11258
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
11259
    VIR_FREE(doc);
11260
    if (!xml) {
11261
        vshError(ctl, "%s", _("Failed to get disk information"));
11262 11263 11264 11265 11266 11267
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11268
        vshError(ctl, "%s", _("Failed to get disk information"));
11269 11270 11271 11272 11273 11274 11275
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11276 11277 11278 11279 11280
            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);
11281 11282 11283 11284 11285 11286 11287
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11288
    vshError(ctl, _("No found disk whose target is %s"), target);
11289 11290 11291 11292 11293
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11294
        vshError(ctl, "%s", _("Failed to allocate memory"));
11295 11296 11297
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
11303
    if (vshCommandOptBool(cmd, "persistent")) {
11304
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11305
        if (virDomainIsActive(dom) == 1)
11306
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11307 11308 11309 11310 11311 11312 11313 11314
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11315
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
11316
    } else {
J
Jim Meyering 已提交
11317
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
11318
        functionReturn = true;
11319
    }
11320 11321

 cleanup:
11322
    xmlXPathFreeObject(obj);
11323
    xmlXPathFreeContext(ctxt);
11324 11325
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
11326 11327
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
11328
    return functionReturn;
11329 11330
}

11331 11332 11333 11334
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
11335 11336
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
11337 11338 11339 11340
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
11341
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
11342 11343 11344
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11345
static bool
11346 11347
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
11348
    const char *from = NULL;
E
Eric Blake 已提交
11349
    bool ret = true;
11350 11351 11352
    char *buffer;
    int result;

11353
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11354
        return false;
11355

11356
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11357
        return false;
11358 11359

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
11363
    VIR_FREE(buffer);
11364 11365 11366 11367 11368

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
11369
        ret = false;
11370 11371 11372 11373 11374
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
11375
        ret = true;
11376 11377 11378 11379 11380
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
11381
        ret = true;
11382 11383 11384 11385 11386
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
11387
        ret = false;
11388 11389 11390 11391 11392
    }

    return ret;
}

11393 11394 11395 11396
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
11397 11398
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
11399 11400 11401 11402
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
11403
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
11404 11405 11406
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11407
static bool
11408 11409
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
11410
    const char *from = NULL;
E
Eric Blake 已提交
11411
    bool ret = true;
11412 11413 11414 11415 11416
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
11417
    xmlNodePtr node_list;
11418 11419 11420 11421 11422 11423
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

11424
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11425
        return false;
11426

11427
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11428
        return false;
11429 11430

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
11431
        return false;
11432 11433 11434 11435 11436

    doc = xmlNewDoc(NULL);
    if (doc == NULL)
        goto no_memory;

L
Laine Stump 已提交
11437 11438
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
11439 11440
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
11441
        ret = false;
11442 11443 11444 11445 11446 11447 11448 11449 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
        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 已提交
11478
        ret = false;
11479 11480 11481 11482 11483 11484 11485 11486
        goto cleanup;
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
11487
        ret = false;
11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504

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 已提交
11505
    ret = false;
11506
    goto cleanup;
11507 11508
}

11509 11510 11511 11512 11513 11514 11515 11516
/* 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;

11517
    ret = vshMalloc(ctl, PATH_MAX);
11518 11519 11520

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
11521 11522
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
11523
    if (fd == -1) {
11524
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
11525
                 strerror(errno));
11526
        VIR_FREE(ret);
11527 11528 11529 11530
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
11531 11532
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
11533
        VIR_FORCE_CLOSE(fd);
11534
        unlink (ret);
11535
        VIR_FREE(ret);
11536 11537
        return NULL;
    }
S
Stefan Berger 已提交
11538
    if (VIR_CLOSE(fd) < 0) {
11539 11540
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
11541
        unlink (ret);
11542
        VIR_FREE(ret);
11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557
        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 已提交
11558 11559 11560 11561
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
11562

11563
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
11564 11565 11566 11567
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
11568

11569 11570 11571 11572 11573
    /* 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 已提交
11574 11575
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
11576
     */
E
Eric Blake 已提交
11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588
    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);
11589 11590
    }

E
Eric Blake 已提交
11591 11592 11593 11594 11595 11596 11597
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
11598
    }
E
Eric Blake 已提交
11599
    ret = 0;
11600

E
Eric Blake 已提交
11601 11602 11603
cleanup:
    virCommandFree(cmd);
    return ret;
11604 11605 11606 11607 11608 11609 11610 11611
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
11612
        vshError(ctl,
11613
                 _("%s: failed to read temporary file: %s"),
11614
                 filename, strerror(errno));
11615 11616 11617 11618 11619
        return NULL;
    }
    return ret;
}

11620

P
Paolo Bonzini 已提交
11621 11622 11623 11624
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
11625 11626
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
11627 11628 11629 11630
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
11631
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
11632 11633 11634
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11635
static bool
11636
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
11637
{
11638
    const char *dir = NULL;
11639
    char *dir_malloced = NULL;
E
Eric Blake 已提交
11640
    bool ret = true;
P
Paolo Bonzini 已提交
11641 11642

    if (!ctl->imode) {
11643
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
11644
        return false;
P
Paolo Bonzini 已提交
11645 11646
    }

11647
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
11648
        uid_t uid = geteuid();
11649
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
11650 11651 11652 11653
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
11654
    if (chdir(dir) == -1) {
11655
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
11656
        ret = false;
P
Paolo Bonzini 已提交
11657 11658
    }

11659
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
11660
    return ret;
P
Paolo Bonzini 已提交
11661 11662 11663 11664 11665 11666
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
11667 11668
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
11669 11670 11671
    {NULL, NULL}
};

E
Eric Blake 已提交
11672
static bool
P
Paolo Bonzini 已提交
11673 11674 11675
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
11676
    bool ret = true;
P
Paolo Bonzini 已提交
11677

11678 11679
    cwd = getcwd(NULL, 0);
    if (!cwd) {
11680 11681
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
11682 11683
        ret = false;
    } else {
P
Paolo Bonzini 已提交
11684
        vshPrint (ctl, _("%s\n"), cwd);
11685 11686
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
11687

11688
    return ret;
P
Paolo Bonzini 已提交
11689 11690
}

E
Eric Blake 已提交
11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702
/*
 * "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")},
11703
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
11704 11705 11706 11707 11708 11709
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
11710
static bool
E
Eric Blake 已提交
11711 11712 11713 11714 11715
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
11716
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
11717 11718 11719 11720 11721 11722 11723 11724
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

11725
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
11726 11727 11728
        bool close_quote = false;
        char *q;

11729
        arg = opt->data;
E
Eric Blake 已提交
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
        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 已提交
11758
        return false;
E
Eric Blake 已提交
11759 11760 11761 11762 11763
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
11764
    return true;
E
Eric Blake 已提交
11765 11766
}

11767 11768 11769 11770
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
11771 11772
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
11773 11774 11775 11776
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
11777
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11778 11779 11780 11781 11782 11783
    {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 已提交
11784
static bool
11785 11786
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
11787
    bool ret = false;
11788 11789 11790 11791 11792
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
11793
    unsigned int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
11794

11795
    if (!vshConnectionUsability(ctl, ctl->conn))
11796 11797
        goto cleanup;

J
Jim Meyering 已提交
11798
    dom = vshCommandOptDomain (ctl, cmd, NULL);
11799 11800 11801 11802
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
11803
    doc = virDomainGetXMLDesc (dom, flags);
11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821
    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 已提交
11822
        ret = true;
11823 11824 11825 11826 11827 11828 11829
        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.
     */
11830
    doc_reread = virDomainGetXMLDesc (dom, flags);
11831 11832 11833 11834
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
11835 11836
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848
        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 已提交
11849
    ret = true;
11850 11851 11852 11853 11854

 cleanup:
    if (dom)
        virDomainFree (dom);

11855 11856 11857
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
11858 11859 11860

    if (tmp) {
        unlink (tmp);
11861
        VIR_FREE(tmp);
11862 11863 11864 11865 11866
    }

    return ret;
}

11867

11868 11869 11870 11871
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
11872 11873
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
11874 11875 11876 11877
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
11878
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
11879 11880 11881 11882 11883 11884 11885 11886 11887 11888
    {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[] = {
11889 11890
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
11891 11892 11893 11894
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
11895
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
11896 11897 11898 11899 11900 11901
    {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 已提交
11902 11903 11904
/*
 * "quit" command
 */
11905
static const vshCmdInfo info_quit[] = {
11906
    {"help", N_("quit this interactive terminal")},
11907
    {"desc", ""},
11908
    {NULL, NULL}
K
Karel Zak 已提交
11909 11910
};

E
Eric Blake 已提交
11911
static bool
11912
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11913
{
E
Eric Blake 已提交
11914 11915
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
11916 11917
}

11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933
/* Helper for snapshot-create and snapshot-create-as */
static bool
vshSnapshotCreate(vshControl *ctl, virDomainPtr dom, const char *buffer,
                  unsigned int flags, const char *from)
{
    bool ret = false;
    virDomainSnapshotPtr snapshot;
    char *doc = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *name = NULL;

    snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
    if (snapshot == NULL)
        goto cleanup;

11934 11935 11936 11937
    if (flags & VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA)
        doc = vshStrdup(ctl, buffer);
    else
        doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968
    if (!doc)
        goto cleanup;

    xml = virXMLParseStringCtxt(doc, "domainsnapshot.xml", &ctxt);
    if (!xml)
        goto cleanup;

    name = virXPathString("string(/domainsnapshot/name)", ctxt);
    if (!name) {
        vshError(ctl, "%s",
                 _("Could not find 'name' element in domain snapshot XML"));
        goto cleanup;
    }

    if (from)
        vshPrint(ctl, _("Domain snapshot %s created from '%s'"), name, from);
    else
        vshPrint(ctl, _("Domain snapshot %s created"), name);

    ret = true;

cleanup:
    VIR_FREE(name);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    return ret;
}

11969 11970 11971 11972
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
11973 11974
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
11975 11976 11977 11978 11979 11980
    {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")},
11981 11982 11983
    {"redefine", VSH_OT_BOOL, 0, N_("redefine metadata for existing snapshot")},
    {"current", VSH_OT_BOOL, 0, N_("with redefine, set current snapshot")},
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
11984 11985 11986
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11987
static bool
11988 11989 11990
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11991
    bool ret = false;
11992
    const char *from = NULL;
11993
    char *buffer = NULL;
11994 11995 11996 11997 11998 11999 12000 12001
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "redefine"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE;
    if (vshCommandOptBool(cmd, "current"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT;
    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
12002

12003
    if (!vshConnectionUsability(ctl, ctl->conn))
12004 12005 12006 12007 12008 12009
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

12010
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
12011
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026
    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;
    }

12027
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, from);
12028 12029 12030 12031 12032 12033 12034 12035 12036

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049
/*
 * "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 已提交
12050
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
12051
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    char *buffer = NULL;
    const char *name = NULL;
    const char *desc = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
12064 12065 12066 12067
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083

    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)
12084
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
12085
    if (desc)
12086
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
12087 12088 12089 12090 12091 12092 12093 12094
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
12095 12096 12097 12098 12099 12100
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

12101
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, NULL);
12102 12103 12104 12105 12106 12107 12108 12109 12110

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211
/*
 * "snapshot-edit" command
 */
static const vshCmdInfo info_snapshot_edit[] = {
    {"help", N_("edit XML for a snapshot")},
    {"desc", N_("Edit the domain snapshot XML for a named snapshot")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_edit[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("also set edited snapshot as current")},
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotEdit(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    const char *name;
    bool ret = false;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    unsigned int getxml_flags = VIR_DOMAIN_XML_SECURE;
    unsigned int define_flags = VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE;

    if (vshCommandOptBool(cmd, "current"))
        define_flags |= VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT;

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

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    /* Get the XML configuration of the snapshot.  */
    doc = virDomainSnapshotGetXMLDesc(snapshot, getxml_flags);
    if (!doc)
        goto cleanup;
    virDomainSnapshotFree(snapshot);
    snapshot = NULL;

    /* Create and open the temporary file.  */
    tmp = editWriteToTempFile(ctl, doc);
    if (!tmp)
        goto cleanup;

    /* Start the editor.  */
    if (editFile(ctl, tmp) == -1)
        goto cleanup;

    /* Read back the edited file.  */
    doc_edited = editReadBackFile(ctl, tmp);
    if (!doc_edited)
        goto cleanup;

    /* Compare original XML with edited.  Short-circuit if it did not
     * change, and we do not have any flags.  */
    if (STREQ(doc, doc_edited) &&
        !(define_flags & VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT)) {
        vshPrint(ctl, _("Snapshot %s XML configuration not changed.\n"),
                 name);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
    snapshot = virDomainSnapshotCreateXML(dom, doc_edited, define_flags);
    if (!snapshot) {
        vshError(ctl, _("Failed to update %s"), name);
        goto cleanup;
    }

    vshPrint(ctl, _("Snapshot %s edited.\n"), name);
    ret = true;

cleanup:
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);
    return ret;
}

12212 12213 12214 12215
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
12216 12217
    {"help", N_("Get or set the current snapshot")},
    {"desc", N_("Get or set the current snapshot")},
12218 12219 12220 12221 12222
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12223
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
12224 12225
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
12226 12227
    {"snapshotname", VSH_OT_DATA, 0,
     N_("name of existing snapshot to make current")},
12228 12229 12230
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12231
static bool
12232 12233 12234
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12235
    bool ret = false;
12236 12237
    int current;
    virDomainSnapshotPtr snapshot = NULL;
12238
    char *xml = NULL;
12239
    const char *snapshotname = NULL;
12240 12241 12242 12243
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;
12244

12245
    if (!vshConnectionUsability(ctl, ctl->conn))
12246 12247 12248 12249 12250 12251
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280
    if (vshCommandOptString(cmd, "snapshotname", &snapshotname) < 0) {
        vshError(ctl, _("invalid snapshotname argument '%s'"), snapshotname);
        goto cleanup;
    }
    if (snapshotname) {
        virDomainSnapshotPtr snapshot2 = NULL;
        flags = (VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE |
                 VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT);

        if (vshCommandOptBool(cmd, "name")) {
            vshError(ctl, "%s",
                     _("--name and snapshotname are mutually exclusive"));
            goto cleanup;
        }
        snapshot = virDomainSnapshotLookupByName(dom, snapshotname, 0);
        if (snapshot == NULL)
            goto cleanup;
        xml = virDomainSnapshotGetXMLDesc(snapshot, VIR_DOMAIN_XML_SECURE);
        if (!xml)
            goto cleanup;
        snapshot2 = virDomainSnapshotCreateXML(dom, xml, flags);
        if (snapshot2 == NULL)
            goto cleanup;
        virDomainSnapshotFree(snapshot2);
        vshPrint(ctl, _("Snapshot %s set as current"), snapshotname);
        ret = true;
        goto cleanup;
    }

12281 12282 12283 12284
    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
12285
        char *name = NULL;
12286 12287 12288 12289

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

12290
        xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
12291 12292 12293
        if (!xml)
            goto cleanup;

12294 12295 12296 12297
        if (vshCommandOptBool(cmd, "name")) {
            xmlDocPtr xmldoc = NULL;
            xmlXPathContextPtr ctxt = NULL;

12298
            xmldoc = virXMLParseStringCtxt(xml, "domainsnapshot.xml", &ctxt);
12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310
            if (!xmldoc)
                goto cleanup;

            name = virXPathString("string(/domainsnapshot/name)", ctxt);
            xmlXPathFreeContext(ctxt);
            xmlFreeDoc(xmldoc);
            if (!name)
                goto cleanup;
        }

        vshPrint(ctl, "%s", name ? name : xml);
        VIR_FREE(name);
12311 12312
    }

E
Eric Blake 已提交
12313
    ret = true;
12314 12315

cleanup:
12316
    VIR_FREE(xml);
12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335
    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")},
12336
    {"parent", VSH_OT_BOOL, 0, N_("add a column showing parent snapshot")},
12337 12338 12339
    {"roots", VSH_OT_BOOL, 0, N_("list only snapshots without parents")},
    {"metadata", VSH_OT_BOOL, 0,
     N_("list only snapshots that have metadata that would prevent undefine")},
12340 12341 12342
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12343
static bool
12344 12345 12346
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12347
    bool ret = false;
12348
    unsigned int flags = 0;
12349 12350
    int parent_filter = 0; /* -1 for roots filtering, 0 for no parent
                              information needed, 1 for parent column */
12351 12352
    int numsnaps;
    char **names = NULL;
12353
    int actual = 0;
12354 12355 12356 12357 12358 12359
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
12360
    char *parent = NULL;
12361 12362
    long long creation_longlong;
    time_t creation_time_t;
12363 12364 12365
    char timestr[100];
    struct tm time_info;

12366
    if (vshCommandOptBool(cmd, "parent")) {
12367 12368 12369 12370 12371
        if (vshCommandOptBool(cmd, "roots")) {
            vshError(ctl, "%s",
                     _("--parent and --roots are mutually exlusive"));
            return false;
        }
12372
        parent_filter = 1;
12373 12374 12375 12376 12377 12378
    } else if (vshCommandOptBool(cmd, "roots")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
    }

    if (vshCommandOptBool(cmd, "metadata")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_METADATA;
12379 12380
    }

12381
    if (!vshConnectionUsability(ctl, ctl->conn))
12382 12383 12384 12385 12386 12387
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

12388
    numsnaps = virDomainSnapshotNum(dom, flags);
12389

12390 12391 12392 12393 12394 12395 12396 12397 12398 12399
    /* Fall back to simulation if --roots was unsupported.  */
    if (numsnaps < 0 && last_error->code == VIR_ERR_INVALID_ARG &&
        (flags & VIR_DOMAIN_SNAPSHOT_LIST_ROOTS)) {
        virFreeError(last_error);
        last_error = NULL;
        parent_filter = -1;
        flags &= ~VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
        numsnaps = virDomainSnapshotNum(dom, flags);
    }

12400 12401 12402
    if (numsnaps < 0)
        goto cleanup;

12403 12404 12405 12406 12407 12408 12409 12410
    if (parent_filter > 0)
        vshPrintExtra(ctl, " %-20s %-25s %-15s %s",
                      _("Name"), _("Creation Time"), _("State"), _("Parent"));
    else
        vshPrintExtra(ctl, " %-20s %-25s %s",
                      _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "\n\
------------------------------------------------------------\n");
12411 12412 12413 12414 12415

    if (numsnaps) {
        if (VIR_ALLOC_N(names, numsnaps) < 0)
            goto cleanup;

12416
        actual = virDomainSnapshotListNames(dom, names, numsnaps, flags);
12417 12418 12419 12420 12421 12422 12423
        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 */
12424
            VIR_FREE(parent);
12425 12426 12427 12428
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
12429
            xmlFreeDoc(xml);
12430 12431 12432 12433 12434 12435 12436 12437 12438 12439
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

12440
            xml = virXMLParseStringCtxt(doc, "domainsnapshot.xml", &ctxt);
12441 12442 12443
            if (!xml)
                continue;

12444 12445 12446
            if (parent_filter) {
                parent = virXPathString("string(/domainsnapshot/parent/name)",
                                        ctxt);
12447 12448
                if (!parent && parent_filter < 0)
                    continue;
12449 12450
            }

12451 12452 12453
            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
12454 12455
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
12456
                continue;
12457 12458 12459 12460 12461 12462
            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);
12463 12464
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z",
                     &time_info);
12465

12466 12467 12468 12469 12470
            if (parent)
                vshPrint(ctl, " %-20s %-25s %-15s %s\n",
                         names[i], timestr, state, parent);
            else
                vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
12471 12472 12473
        }
    }

E
Eric Blake 已提交
12474
    ret = true;
12475 12476 12477

cleanup:
    /* this frees up memory from the last iteration of the loop */
12478
    VIR_FREE(parent);
12479 12480 12481 12482
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    xmlXPathFreeContext(ctxt);
12483
    xmlFreeDoc(xml);
12484
    VIR_FREE(doc);
12485 12486
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505
    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")},
12506 12507
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
12508 12509 12510
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12511
static bool
12512 12513 12514
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12515
    bool ret = false;
12516
    const char *name = NULL;
12517 12518
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
12519 12520 12521 12522
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;
12523

12524
    if (!vshConnectionUsability(ctl, ctl->conn))
12525 12526 12527 12528 12529 12530
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

12531
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12532 12533 12534 12535 12536 12537
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

12538
    xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
12539 12540 12541
    if (!xml)
        goto cleanup;

12542
    vshPrint(ctl, "%s", xml);
12543

E
Eric Blake 已提交
12544
    ret = true;
12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

E
Eric Blake 已提交
12556 12557 12558 12559
/*
 * "snapshot-parent" command
 */
static const vshCmdInfo info_snapshot_parent[] = {
E
Eric Blake 已提交
12560
    {"help", N_("Get the name of the parent of a snapshot")},
E
Eric Blake 已提交
12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600
    {"desc", N_("Extract the snapshot's parent, if any")},
    {NULL, NULL}
};

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

static bool
cmdSnapshotParent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    const char *name = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
    char *parent = NULL;
    xmlDocPtr xmldoc = NULL;
    xmlXPathContextPtr ctxt = NULL;

    if (!vshConnectionUsability(ctl, ctl->conn))
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

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

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

12601
    xmldoc = virXMLParseStringCtxt(xml, "domainsnapshot.xml", &ctxt);
E
Eric Blake 已提交
12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615
    if (!xmldoc)
        goto cleanup;

    parent = virXPathString("string(/domainsnapshot/parent/name)", ctxt);
    if (!parent)
        goto cleanup;

    vshPrint(ctl, "%s", parent);

    ret = true;

cleanup:
    VIR_FREE(parent);
    xmlXPathFreeContext(ctxt);
12616
    xmlFreeDoc(xmldoc);
E
Eric Blake 已提交
12617 12618 12619 12620 12621 12622 12623 12624 12625
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12626
/*
12627
 * "snapshot-revert" command
12628
 */
12629
static const vshCmdInfo info_snapshot_revert[] = {
12630 12631 12632 12633 12634
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

12635
static const vshCmdOptDef opts_snapshot_revert[] = {
12636 12637
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
12638 12639
    {"running", VSH_OT_BOOL, 0, N_("after reverting, change state to running")},
    {"paused", VSH_OT_BOOL, 0, N_("after reverting, change state to paused")},
12640 12641 12642
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12643
static bool
12644
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
12645 12646
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12647
    bool ret = false;
12648
    const char *name = NULL;
12649
    virDomainSnapshotPtr snapshot = NULL;
12650 12651 12652 12653 12654 12655
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED;
12656

12657
    if (!vshConnectionUsability(ctl, ctl->conn))
12658 12659 12660 12661 12662 12663
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

12664
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12665 12666 12667 12668 12669 12670
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

12671
    if (virDomainRevertToSnapshot(snapshot, flags) < 0)
12672 12673
        goto cleanup;

E
Eric Blake 已提交
12674
    ret = true;
12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700

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 已提交
12701
static bool
12702 12703 12704
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12705
    bool ret = false;
12706
    const char *name = NULL;
12707 12708 12709
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

12710
    if (!vshConnectionUsability(ctl, ctl->conn))
12711 12712 12713 12714 12715 12716
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

12717
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12718 12719 12720 12721 12722 12723 12724 12725 12726
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

12727 12728 12729 12730
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
        vshPrint(ctl, _("Domain snapshot %s deleted\n"), name);
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
12731
        goto cleanup;
12732
    }
12733

E
Eric Blake 已提交
12734
    ret = true;
12735 12736 12737 12738 12739 12740 12741 12742 12743 12744

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12745 12746 12747 12748
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
12749 12750
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
12751 12752 12753 12754 12755
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12756
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
12757
    {"cmd", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("command")},
12758 12759 12760
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12761
static bool
12762 12763 12764
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12765
    bool ret = false;
12766
    char *monitor_cmd = NULL;
12767
    char *result = NULL;
12768
    unsigned int flags = 0;
12769 12770 12771
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
12772 12773 12774 12775 12776 12777 12778 12779

    if (!vshConnectionUsability(ctl, ctl->conn))
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

12780 12781 12782 12783 12784 12785 12786 12787
    while ((opt = vshCommandOptArgv(cmd, opt))) {
        if (pad)
            virBufferAddChar(&buf, ' ');
        pad = true;
        virBufferAdd(&buf, opt->data, -1);
    }
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to collect command"));
12788 12789
        goto cleanup;
    }
12790
    monitor_cmd = virBufferContentAndReset(&buf);
12791

12792 12793 12794 12795
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
12796 12797 12798 12799
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
12800
    ret = true;
12801 12802 12803

cleanup:
    VIR_FREE(result);
12804
    VIR_FREE(monitor_cmd);
12805 12806 12807 12808 12809 12810
    if (dom)
        virDomainFree(dom);

    return ret;
}

12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856
/*
 * "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;
}

12857
static const vshCmdDef domManagementCmds[] = {
12858 12859 12860 12861 12862 12863 12864 12865
    {"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},
12866 12867
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
12868
#ifndef WIN32
12869
    {"console", cmdConsole, opts_console, info_console, 0},
12870
#endif
12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893
    {"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},
12894
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
12895 12896 12897 12898 12899 12900 12901 12902
    {"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},
12903 12904
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
12905 12906
    {"migrate-getspeed", cmdMigrateGetMaxSpeed,
     opts_migrate_getspeed, info_migrate_getspeed, 0},
12907 12908 12909 12910
    {"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},
12911 12912 12913 12914 12915 12916
    {"save-image-define", cmdSaveImageDefine, opts_save_image_define,
     info_save_image_define, 0},
    {"save-image-dumpxml", cmdSaveImageDumpxml, opts_save_image_dumpxml,
     info_save_image_dumpxml, 0},
    {"save-image-edit", cmdSaveImageEdit, opts_save_image_edit,
     info_save_image_edit, 0},
12917
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
12918
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930
    {"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 已提交
12931
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
12932
    {"version", cmdVersion, opts_version, info_version, 0},
12933 12934
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
12935 12936 12937
};

static const vshCmdDef domMonitoringCmds[] = {
12938 12939
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
12940
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
12941 12942 12943 12944 12945 12946
    {"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}
12947 12948 12949
};

static const vshCmdDef storagePoolCmds[] = {
12950
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
12951
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
12952
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973
     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}
12974 12975 12976
};

static const vshCmdDef storageVolCmds[] = {
12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994
    {"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}
12995
};
12996

12997
static const vshCmdDef networkCmds[] = {
12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016
    {"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}
13017
};
13018

13019
static const vshCmdDef nodedevCmds[] = {
13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034
    {"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}
13035 13036 13037
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
13038 13039 13040 13041
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055
    {"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 已提交
13056 13057
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
13058 13059 13060 13061 13062
    {"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}
13063
};
13064

13065
static const vshCmdDef nwfilterCmds[] = {
13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076
    {"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}
13077
};
13078

13079
static const vshCmdDef secretCmds[] = {
13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091
    {"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}
13092
};
13093

13094
static const vshCmdDef virshCmds[] = {
13095 13096 13097 13098 13099 13100 13101
    {"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}
13102
};
13103

13104
static const vshCmdDef snapshotCmds[] = {
13105 13106
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
13107 13108
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
13109 13110 13111 13112 13113 13114
    {"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},
13115 13116
    {"snapshot-edit", cmdSnapshotEdit, opts_snapshot_edit,
     info_snapshot_edit, 0},
13117 13118
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
E
Eric Blake 已提交
13119 13120
    {"snapshot-parent", cmdSnapshotParent, opts_snapshot_parent,
     info_snapshot_parent, 0},
13121 13122 13123
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
13124
};
13125

13126
static const vshCmdDef hostAndHypervisorCmds[] = {
13127 13128 13129 13130 13131
    {"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},
13132
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
13133
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
13134
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
13135
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
13136 13137 13138 13139 13140
    {"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 已提交
13141 13142
};

13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159
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 已提交
13160 13161 13162 13163
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
13164
static const char *
13165
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
13166
{
13167
    const vshCmdInfo *info;
13168

K
Karel Zak 已提交
13169
    for (info = cmd->info; info && info->name; info++) {
13170
        if (STREQ(info->name, name))
K
Karel Zak 已提交
13171 13172 13173 13174 13175
            return info->data;
    }
    return NULL;
}

13176
static int
E
Eric Blake 已提交
13177
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
13178 13179 13180 13181 13182
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
13183 13184 13185
    *opts_need_arg = 0;
    *opts_required = 0;

13186 13187 13188 13189 13190 13191 13192 13193 13194
    if (!cmd->opts)
        return 0;

    for (i = 0; cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];

        if (i > 31)
            return -1; /* too many options */
        if (opt->type == VSH_OT_BOOL) {
E
Eric Blake 已提交
13195
            if (opt->flags & VSH_OFLAG_REQ)
13196 13197 13198
                return -1; /* bool options can't be mandatory */
            continue;
        }
E
Eric Blake 已提交
13199 13200
        if (opt->flags & VSH_OFLAG_REQ_OPT) {
            if (opt->flags & VSH_OFLAG_REQ)
L
Lai Jiangshan 已提交
13201 13202 13203 13204
                *opts_required |= 1 << i;
            continue;
        }

13205
        *opts_need_arg |= 1 << i;
E
Eric Blake 已提交
13206
        if (opt->flags & VSH_OFLAG_REQ) {
13207 13208 13209 13210 13211 13212 13213 13214 13215 13216
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
    }
    return 0;
}

13217
static const vshCmdOptDef *
13218 13219
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
13220
{
13221 13222 13223 13224
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
13225

13226 13227 13228 13229 13230
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
13231 13232 13233 13234 13235
            if (opt->type == VSH_OT_ARGV) {
                vshError(ctl, _("variable argument <%s> "
                         "should not be used with --<%s>"), name, name);
                return NULL;
            }
13236
            *opts_seen |= 1 << i;
K
Karel Zak 已提交
13237
            return opt;
13238 13239 13240 13241 13242
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
13243 13244 13245
    return NULL;
}

13246
static const vshCmdOptDef *
13247 13248
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
13249
{
13250
    int i;
13251
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
13252

13253 13254 13255 13256
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
13257
    i = ffs(*opts_need_arg) - 1;
13258 13259 13260 13261 13262
    opt = &cmd->opts[i];
    if (opt->type != VSH_OT_ARGV)
        *opts_need_arg &= ~(1 << i);
    *opts_seen |= 1 << i;
    return opt;
K
Karel Zak 已提交
13263 13264
}

13265 13266 13267
/*
 * Checks for required options
 */
13268
static int
13269 13270
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
13271
{
13272
    const vshCmdDef *def = cmd->def;
13273 13274 13275 13276 13277 13278 13279 13280 13281
    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];
13282

13283
            vshError(ctl,
13284
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
13285 13286 13287
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
13288 13289
        }
    }
13290
    return -1;
13291 13292
}

13293
static const vshCmdDef *
13294 13295
vshCmddefSearch(const char *cmdname)
{
13296
    const vshCmdGrp *g;
13297
    const vshCmdDef *c;
13298

13299 13300
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
13301
            if (STREQ(c->name, cmdname))
13302 13303 13304 13305
                return c;
        }
    }

K
Karel Zak 已提交
13306 13307 13308
    return NULL;
}

13309 13310 13311 13312 13313 13314
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
13315
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
13316 13317 13318 13319 13320 13321
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
13322
static bool
13323 13324 13325 13326 13327 13328 13329
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 已提交
13330
        return false;
13331 13332 13333 13334 13335 13336 13337 13338 13339 13340
    } 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 已提交
13341
    return true;
13342 13343
}

E
Eric Blake 已提交
13344
static bool
13345
vshCmddefHelp(vshControl *ctl, const char *cmdname)
13346
{
13347
    const vshCmdDef *def = vshCmddefSearch(cmdname);
13348

K
Karel Zak 已提交
13349
    if (!def) {
13350
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
13351
        return false;
13352
    } else {
E
Eric Blake 已提交
13353 13354
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
13355
        const char *help = _(vshCmddefGetInfo(def, "help"));
13356
        char buf[256];
13357 13358 13359 13360 13361 13362
        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 已提交
13363
            return false;
13364
        }
K
Karel Zak 已提交
13365

13366
        fputs(_("  NAME\n"), stdout);
13367 13368
        fprintf(stdout, "    %s - %s\n", def->name, help);

13369 13370 13371 13372 13373
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
13374
                const char *fmt = "%s";
13375 13376
                switch (opt->type) {
                case VSH_OT_BOOL:
13377
                    fmt = "[--%s]";
13378 13379
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
13380
                    /* xgettext:c-format */
E
Eric Blake 已提交
13381
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>"
13382
                           : _("[--%s <number>]"));
13383 13384
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
13385 13386
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
13387 13388
                    break;
                case VSH_OT_DATA:
E
Eric Blake 已提交
13389
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
13390 13391 13392
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
E
Eric Blake 已提交
13393
                    fmt = (opt->flags & VSH_OFLAG_REQ) ? _("<%s>...")
13394
                           : _("[<%s>]...");
13395 13396
                    break;
                default:
13397
                    assert(0);
13398
                }
13399
                fputc(' ', stdout);
E
Eric Blake 已提交
13400
                fprintf(stdout, fmt, opt->name);
13401
            }
K
Karel Zak 已提交
13402
        }
13403 13404 13405
        fputc('\n', stdout);

        if (desc[0]) {
13406
            /* Print the description only if it's not empty.  */
13407
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
13408
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
13409
        }
13410

K
Karel Zak 已提交
13411
        if (def->opts) {
13412
            const vshCmdOptDef *opt;
13413
            fputs(_("\n  OPTIONS\n"), stdout);
13414
            for (opt = def->opts; opt->name; opt++) {
13415 13416
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
13417
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
13418 13419
                    break;
                case VSH_OT_INT:
13420
                    snprintf(buf, sizeof(buf),
E
Eric Blake 已提交
13421
                             (opt->flags & VSH_OFLAG_REQ) ? _("[--%s] <number>")
13422
                             : _("--%s <number>"), opt->name);
13423 13424
                    break;
                case VSH_OT_STRING:
13425
                    /* OT_STRING should never be VSH_OFLAG_REQ */
13426
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
13427 13428
                    break;
                case VSH_OT_DATA:
13429 13430
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
13431 13432 13433
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
13434 13435
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
13436 13437 13438
                default:
                    assert(0);
                }
13439

E
Eric Blake 已提交
13440
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
13441
            }
K
Karel Zak 已提交
13442 13443 13444
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
13445
    return true;
K
Karel Zak 已提交
13446 13447 13448 13449 13450 13451
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
13452 13453 13454
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
13455 13456
    vshCmdOpt *a = arg;

13457
    while (a) {
K
Karel Zak 已提交
13458
        vshCmdOpt *tmp = a;
13459

K
Karel Zak 已提交
13460 13461
        a = a->next;

13462 13463
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
13464 13465 13466 13467
    }
}

static void
13468
vshCommandFree(vshCmd *cmd)
13469
{
K
Karel Zak 已提交
13470 13471
    vshCmd *c = cmd;

13472
    while (c) {
K
Karel Zak 已提交
13473
        vshCmd *tmp = c;
13474

K
Karel Zak 已提交
13475 13476 13477 13478
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
13479
        VIR_FREE(tmp);
K
Karel Zak 已提交
13480 13481 13482
    }
}

E
Eric Blake 已提交
13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493
/**
 * 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 已提交
13494
 */
E
Eric Blake 已提交
13495 13496
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
13497
{
E
Eric Blake 已提交
13498 13499
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
13500

E
Eric Blake 已提交
13501 13502 13503 13504 13505 13506 13507
    /* 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 已提交
13508
    }
E
Eric Blake 已提交
13509 13510 13511 13512 13513 13514 13515

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
E
Eric Blake 已提交
13516
            return (valid->flags & VSH_OFLAG_REQ) == 0 ? 0 : -1;
E
Eric Blake 已提交
13517 13518 13519 13520
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
13521 13522
}

E
Eric Blake 已提交
13523 13524
/**
 * vshCommandOptInt:
13525 13526 13527 13528 13529 13530 13531
 * @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 已提交
13532
 * 0 if option not found and not required (@value untouched)
13533
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
13534 13535
 */
static int
13536
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
13537
{
E
Eric Blake 已提交
13538 13539 13540
    vshCmdOpt *arg;
    int ret;
    int num;
13541
    char *end_p = NULL;
13542

E
Eric Blake 已提交
13543 13544 13545 13546 13547 13548 13549
    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;
13550
    }
E
Eric Blake 已提交
13551 13552 13553 13554 13555 13556 13557

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
13558 13559
}

13560

E
Eric Blake 已提交
13561 13562 13563 13564 13565 13566
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
13567 13568 13569 13570 13571 13572
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
13573 13574 13575
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
13576 13577
    char *end_p = NULL;

E
Eric Blake 已提交
13578 13579 13580 13581 13582 13583 13584
    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;
13585
    }
E
Eric Blake 已提交
13586 13587 13588 13589 13590 13591 13592

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13593 13594 13595
}


13596
/*
E
Eric Blake 已提交
13597 13598 13599 13600 13601
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
13602 13603 13604 13605 13606
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
13607
{
E
Eric Blake 已提交
13608 13609
    vshCmdOpt *arg;
    int ret;
13610
    unsigned long num;
13611 13612
    char *end_p = NULL;

E
Eric Blake 已提交
13613 13614 13615 13616 13617 13618 13619
    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;
13620
    }
E
Eric Blake 已提交
13621 13622 13623 13624 13625 13626 13627

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13628 13629
}

E
Eric Blake 已提交
13630 13631 13632 13633 13634 13635
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
13636
 * Returns option as STRING
E
Eric Blake 已提交
13637 13638 13639 13640
 * 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 已提交
13641
 */
13642 13643
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
13644
{
E
Eric Blake 已提交
13645 13646 13647 13648 13649 13650 13651 13652 13653 13654
    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;
13655
    }
13656

E
Eric Blake 已提交
13657
    if (!*arg->data && !(arg->def->flags & VSH_OFLAG_EMPTY_OK)) {
E
Eric Blake 已提交
13658 13659 13660 13661
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
13662 13663
}

E
Eric Blake 已提交
13664 13665 13666 13667 13668 13669
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
13670
 * Returns option as long long
13671
 * See vshCommandOptInt()
13672
 */
13673 13674 13675
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
13676
{
E
Eric Blake 已提交
13677 13678
    vshCmdOpt *arg;
    int ret;
13679
    long long num;
13680 13681
    char *end_p = NULL;

E
Eric Blake 已提交
13682 13683 13684 13685 13686 13687 13688
    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;
13689
    }
E
Eric Blake 已提交
13690 13691 13692 13693 13694 13695 13696

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13697 13698
}

E
Eric Blake 已提交
13699 13700 13701 13702 13703 13704 13705 13706 13707
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
13708 13709 13710 13711
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
13712 13713
    vshCmdOpt *arg;
    int ret;
13714 13715 13716
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
13717 13718 13719 13720 13721 13722 13723
    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;
13724
    }
E
Eric Blake 已提交
13725 13726 13727 13728 13729 13730 13731

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13732 13733 13734
}


E
Eric Blake 已提交
13735 13736 13737 13738 13739 13740 13741 13742 13743
/**
 * 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 已提交
13744
 */
E
Eric Blake 已提交
13745
static bool
13746
vshCommandOptBool(const vshCmd *cmd, const char *name)
13747
{
E
Eric Blake 已提交
13748 13749 13750
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
13751 13752
}

E
Eric Blake 已提交
13753 13754 13755 13756 13757
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
13758 13759
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
13760
 *
13761
 * Requires that a VSH_OT_ARGV option be last in the
13762 13763
 * list of supported options in CMD->def->opts.
 */
13764 13765
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
13766
{
13767
    opt = opt ? opt->next : cmd->opts;
13768 13769

    while (opt) {
E
Eric Blake 已提交
13770
        if (opt->def->type == VSH_OT_ARGV) {
13771
            return opt;
13772 13773 13774 13775 13776 13777
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794 13795
/* 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)
13796
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
13797 13798 13799
                 cmd->def->name, optname);
    return found;
}
13800

K
Karel Zak 已提交
13801
static virDomainPtr
J
Jim Meyering 已提交
13802
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
13803
                      const char **name, int flag)
13804
{
K
Karel Zak 已提交
13805
    virDomainPtr dom = NULL;
13806
    const char *n = NULL;
K
Karel Zak 已提交
13807
    int id;
J
Jim Meyering 已提交
13808 13809 13810
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
13811

13812
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13813 13814
        return NULL;

13815
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13816 13817
             cmd->def->name, optname, n);

K
Karel Zak 已提交
13818 13819
    if (name)
        *name = n;
13820

K
Karel Zak 已提交
13821
    /* try it by ID */
13822
    if (flag & VSH_BYID) {
13823
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
13824 13825
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
13826 13827 13828
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
13829
    }
K
Karel Zak 已提交
13830
    /* try it by UUID */
13831
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
13832
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
13833
                 cmd->def->name, optname);
K
Karel Zak 已提交
13834
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
13835
    }
K
Karel Zak 已提交
13836
    /* try it by NAME */
13837
    if (dom==NULL && (flag & VSH_BYNAME)) {
13838
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
13839
                 cmd->def->name, optname);
K
Karel Zak 已提交
13840
        dom = virDomainLookupByName(ctl->conn, n);
13841
    }
K
Karel Zak 已提交
13842

13843
    if (!dom)
13844
        vshError(ctl, _("failed to get domain '%s'"), n);
13845

K
Karel Zak 已提交
13846 13847 13848
    return dom;
}

13849
static virNetworkPtr
J
Jim Meyering 已提交
13850
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
13851
                       const char **name, int flag)
13852 13853
{
    virNetworkPtr network = NULL;
13854
    const char *n = NULL;
J
Jim Meyering 已提交
13855 13856 13857
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
13858

13859
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13860 13861
        return NULL;

13862
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13863 13864 13865 13866 13867 13868
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
13869
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13870
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
13871
                 cmd->def->name, optname);
13872 13873 13874 13875
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
13876
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
13877 13878 13879 13880 13881
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
13882
        vshError(ctl, _("failed to get network '%s'"), n);
13883 13884 13885 13886

    return network;
}

13887 13888 13889

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
13890
                        const char **name, int flag)
13891 13892
{
    virNWFilterPtr nwfilter = NULL;
13893
    const char *n = NULL;
13894 13895 13896 13897
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13898
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13899 13900
        return NULL;

13901
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13902 13903 13904 13905 13906 13907 13908
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13909
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
13910 13911 13912 13913 13914
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
13915
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
13916 13917 13918 13919 13920 13921 13922 13923 13924 13925
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

13926 13927
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
13928
                         const char **name, int flag)
13929 13930
{
    virInterfacePtr iface = NULL;
13931
    const char *n = NULL;
13932 13933 13934 13935
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13936
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13937 13938
        return NULL;

13939
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13940 13941 13942 13943 13944 13945
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
13946
    if ((flag & VSH_BYNAME)) {
13947
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
13948 13949 13950 13951 13952
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
13953
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
13954 13955 13956 13957 13958
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
13959
        vshError(ctl, _("failed to get interface '%s'"), n);
13960 13961 13962 13963

    return iface;
}

13964
static virStoragePoolPtr
13965
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
13966
                    const char **name, int flag)
13967 13968
{
    virStoragePoolPtr pool = NULL;
13969
    const char *n = NULL;
13970

13971
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13972 13973
        return NULL;

13974
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13975 13976 13977 13978 13979 13980
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
13981
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13982
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
13983
                 cmd->def->name, optname);
13984 13985 13986
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
13987
    if (pool == NULL && (flag & VSH_BYNAME)) {
13988
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
13989 13990 13991 13992 13993
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
13994
        vshError(ctl, _("failed to get pool '%s'"), n);
13995 13996 13997 13998 13999

    return pool;
}

static virStorageVolPtr
14000
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
14001 14002
                   const char *optname,
                   const char *pooloptname,
14003
                   const char **name, int flag)
14004 14005 14006
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
14007
    const char *n = NULL, *p = NULL;
14008

14009
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14010 14011
        return NULL;

14012
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
14013
        vshError(ctl, "%s", _("missing option"));
14014
        return NULL;
14015
    }
14016 14017 14018 14019

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

14020
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
14021 14022 14023 14024 14025
             cmd->def->name, optname, n);

    if (name)
        *name = n;

14026
    /* try it by name */
14027
    if (pool && (flag & VSH_BYNAME)) {
14028
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
14029 14030 14031
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
14032
    /* try it by key */
14033
    if (vol == NULL && (flag & VSH_BYUUID)) {
14034
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
14035 14036 14037
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
14038
    /* try it by path */
14039
    if (vol == NULL && (flag & VSH_BYUUID)) {
14040
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
14041 14042 14043 14044 14045
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
14046
        vshError(ctl, _("failed to get vol '%s'"), n);
14047 14048 14049 14050 14051 14052 14053

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

14054
static virSecretPtr
14055
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
14056 14057
{
    virSecretPtr secret = NULL;
14058
    const char *n = NULL;
14059 14060 14061 14062 14063
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14064
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14065 14066
        return NULL;

14067 14068
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
14069 14070 14071 14072 14073 14074 14075

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
14076
        vshError(ctl, _("failed to get secret '%s'"), n);
14077 14078 14079 14080

    return secret;
}

K
Karel Zak 已提交
14081 14082 14083
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
14084
static bool
14085
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
14086
{
E
Eric Blake 已提交
14087
    bool ret = true;
14088 14089

    while (cmd) {
K
Karel Zak 已提交
14090
        struct timeval before, after;
14091
        bool enable_timing = ctl->timing;
14092

14093 14094
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
14095 14096
            vshReconnect(ctl);

14097
        if (enable_timing)
K
Karel Zak 已提交
14098
            GETTIMEOFDAY(&before);
14099

K
Karel Zak 已提交
14100 14101
        ret = cmd->def->handler(ctl, cmd);

14102
        if (enable_timing)
K
Karel Zak 已提交
14103
            GETTIMEOFDAY(&after);
14104

14105
        if (!ret)
J
John Levon 已提交
14106 14107
            virshReportError(ctl);

14108
        /* try to automatically catch disconnections */
14109
        if (!ret &&
14110 14111 14112 14113 14114 14115 14116 14117 14118
            ((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);

14119
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
14120 14121
            return ret;

14122
        if (enable_timing)
14123
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
14124 14125
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
14126
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
14127 14128 14129 14130 14131 14132
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
14133
 * Command parsing
K
Karel Zak 已提交
14134 14135 14136
 * ---------------
 */

14137 14138 14139 14140 14141 14142 14143 14144 14145 14146
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 已提交
14147
    /* vshCommandStringGetArg() */
14148
    char *pos;
L
Lai Jiangshan 已提交
14149 14150 14151
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
14152 14153
} vshCommandParser;

E
Eric Blake 已提交
14154
static bool
14155
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
14156
{
K
Karel Zak 已提交
14157 14158 14159
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
14160

K
Karel Zak 已提交
14161 14162 14163 14164
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
14165

14166
    while (1) {
K
Karel Zak 已提交
14167
        vshCmdOpt *last = NULL;
14168
        const vshCmdDef *cmd = NULL;
14169
        vshCommandToken tk;
L
Lai Jiangshan 已提交
14170
        bool data_only = false;
14171 14172 14173
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
14174

K
Karel Zak 已提交
14175
        first = NULL;
14176

14177
        while (1) {
14178
            const vshCmdOptDef *opt = NULL;
14179

K
Karel Zak 已提交
14180
            tkdata = NULL;
14181
            tk = parser->getNextArg(ctl, parser, &tkdata);
14182 14183

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14184
                goto syntaxError;
H
Hu Tao 已提交
14185 14186
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
14187
                break;
H
Hu Tao 已提交
14188
            }
14189 14190

            if (cmd == NULL) {
K
Karel Zak 已提交
14191 14192
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
14193
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
14194
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
14195
                }
14196 14197 14198 14199 14200 14201 14202
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
14203
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
14204 14205 14206 14207
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
14208 14209 14210 14211 14212
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
14213 14214
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
14215
                    VIR_FREE(optstr);
K
Karel Zak 已提交
14216 14217
                    goto syntaxError;
                }
14218
                VIR_FREE(tkdata);
K
Karel Zak 已提交
14219 14220 14221

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
14222 14223 14224
                    if (optstr)
                        tkdata = optstr;
                    else
14225
                        tk = parser->getNextArg(ctl, parser, &tkdata);
14226
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14227
                        goto syntaxError;
14228
                    if (tk != VSH_TK_ARG) {
14229
                        vshError(ctl,
14230
                                 _("expected syntax: --%s <%s>"),
14231 14232
                                 opt->name,
                                 opt->type ==
14233
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
14234 14235
                        goto syntaxError;
                    }
14236
                    opts_need_arg &= ~opts_seen;
14237 14238 14239 14240 14241 14242 14243 14244
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
14245
                }
L
Lai Jiangshan 已提交
14246 14247 14248 14249
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
14250
            } else {
L
Lai Jiangshan 已提交
14251
get_data:
14252 14253
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
14254
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
14255 14256 14257 14258 14259
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
14260
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
14261

K
Karel Zak 已提交
14262 14263 14264 14265
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
14266

K
Karel Zak 已提交
14267 14268 14269 14270 14271
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
14272

14273
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
14274 14275
                         cmd->name,
                         opt->name,
14276 14277
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
14278 14279
            }
        }
14280

D
Daniel Veillard 已提交
14281
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
14282
        if (cmd) {
14283
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
14284

K
Karel Zak 已提交
14285 14286 14287 14288
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

14289
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
14290
                VIR_FREE(c);
14291
                goto syntaxError;
14292
            }
14293

K
Karel Zak 已提交
14294 14295 14296 14297 14298 14299
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
14300 14301 14302

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
14303
    }
14304

E
Eric Blake 已提交
14305
    return true;
K
Karel Zak 已提交
14306

14307
 syntaxError:
14308
    if (ctl->cmd) {
K
Karel Zak 已提交
14309
        vshCommandFree(ctl->cmd);
14310 14311
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
14312 14313
    if (first)
        vshCommandOptFree(first);
14314
    VIR_FREE(tkdata);
E
Eric Blake 已提交
14315
    return false;
K
Karel Zak 已提交
14316 14317
}

14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335
/* --------------------
 * 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 已提交
14336 14337
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
14338 14339 14340 14341
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
14342
        return false;
14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414

    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 已提交
14415 14416
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
14417 14418 14419 14420
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
14421
        return false;
14422 14423 14424 14425 14426 14427

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
14428
/* ---------------
14429
 * Misc utils
K
Karel Zak 已提交
14430 14431
 * ---------------
 */
14432 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 14459
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 已提交
14460
static const char *
14461 14462
vshDomainStateToString(int state)
{
14463
    switch ((virDomainState) state) {
14464
    case VIR_DOMAIN_RUNNING:
14465
        return N_("running");
14466
    case VIR_DOMAIN_BLOCKED:
14467
        return N_("idle");
14468
    case VIR_DOMAIN_PAUSED:
14469
        return N_("paused");
14470
    case VIR_DOMAIN_SHUTDOWN:
14471
        return N_("in shutdown");
14472
    case VIR_DOMAIN_SHUTOFF:
14473
        return N_("shut off");
14474
    case VIR_DOMAIN_CRASHED:
14475
        return N_("crashed");
14476
    case VIR_DOMAIN_NOSTATE:
14477
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
14478
    }
14479
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
14480 14481
}

14482 14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507 14508 14509 14510 14511 14512 14513 14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535 14536 14537 14538 14539 14540 14541 14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582
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");
}

14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599
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");
}

14600 14601 14602 14603
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
14604
    case VIR_VCPU_OFFLINE:
14605
        return N_("offline");
14606
    case VIR_VCPU_BLOCKED:
14607
        return N_("idle");
14608
    case VIR_VCPU_RUNNING:
14609
        return N_("running");
14610
    default:
14611
        ;/*FALLTHROUGH*/
14612
    }
14613
    return N_("no state");
14614 14615
}

E
Eric Blake 已提交
14616
static bool
14617
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
14618
{
14619 14620
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
14621 14622
     */
    if (!conn) {
14623
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
14624
        return false;
K
Karel Zak 已提交
14625
    }
E
Eric Blake 已提交
14626
    return true;
K
Karel Zak 已提交
14627 14628
}

K
Karel Zak 已提交
14629
static void
14630
vshDebug(vshControl *ctl, int level, const char *format, ...)
14631
{
K
Karel Zak 已提交
14632
    va_list ap;
14633
    char *str;
K
Karel Zak 已提交
14634

14635 14636 14637 14638 14639 14640 14641
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

14642
    va_start(ap, format);
14643
    vshOutputLogFile(ctl, level, format, ap);
14644 14645
    va_end(ap);

K
Karel Zak 已提交
14646
    va_start(ap, format);
14647 14648 14649 14650 14651
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
14652
    va_end(ap);
14653 14654
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
14655 14656 14657
}

static void
14658
vshPrintExtra(vshControl *ctl, const char *format, ...)
14659
{
K
Karel Zak 已提交
14660
    va_list ap;
14661
    char *str;
14662

14663
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
14664
        return;
14665

K
Karel Zak 已提交
14666
    va_start(ap, format);
14667 14668 14669 14670 14671
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
14672
    va_end(ap);
14673
    fputs(str, stdout);
14674
    VIR_FREE(str);
K
Karel Zak 已提交
14675 14676
}

K
Karel Zak 已提交
14677

K
Karel Zak 已提交
14678
static void
14679
vshError(vshControl *ctl, const char *format, ...)
14680
{
K
Karel Zak 已提交
14681
    va_list ap;
14682
    char *str;
14683

14684 14685 14686 14687 14688
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
14689

14690 14691 14692 14693
    /* Most output is to stdout, but if someone ran virsh 2>&1, then
     * printing to stderr will not interleave correctly with stdout
     * unless we flush between every transition between streams.  */
    fflush(stdout);
14694
    fputs(_("error: "), stderr);
14695

K
Karel Zak 已提交
14696
    va_start(ap, format);
14697 14698 14699
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
14700 14701
    va_end(ap);

14702
    fprintf(stderr, "%s\n", NULLSTR(str));
14703
    fflush(stderr);
14704
    VIR_FREE(str);
K
Karel Zak 已提交
14705 14706
}

14707

K
Karel Zak 已提交
14708
/*
14709
 * Initialize connection.
K
Karel Zak 已提交
14710
 */
E
Eric Blake 已提交
14711
static bool
14712
vshInit(vshControl *ctl)
14713
{
14714 14715
    char *debugEnv;

K
Karel Zak 已提交
14716
    if (ctl->conn)
E
Eric Blake 已提交
14717
        return false;
K
Karel Zak 已提交
14718

J
Jiri Denemark 已提交
14719
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
14720 14721 14722
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
14723 14724 14725
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
14726 14727
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
14728 14729
            } else {
                ctl->debug = debug;
14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740 14741
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

14742 14743
    vshOpenLogFile(ctl);

14744 14745
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
14746

14747 14748 14749
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

14750
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
14751
        return false;
14752

14753 14754 14755 14756
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
14757

14758 14759 14760 14761 14762 14763 14764 14765 14766 14767 14768
        /* 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;
        }
14769
    }
K
Karel Zak 已提交
14770

E
Eric Blake 已提交
14771
    return true;
K
Karel Zak 已提交
14772 14773
}

14774 14775
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

14776 14777 14778 14779 14780 14781 14782 14783 14784 14785 14786 14787 14788 14789 14790 14791 14792 14793 14794
/**
 * 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:
14795
                vshError(ctl, "%s",
J
Jim Meyering 已提交
14796
                         _("failed to get the log file information"));
14797
                exit(EXIT_FAILURE);
14798 14799 14800
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
14801 14802
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
14803 14804 14805 14806
        }
    }

    /* log file open */
14807
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
14808
        vshError(ctl, "%s",
J
Jim Meyering 已提交
14809
                 _("failed to open the log file. check the log file path"));
14810
        exit(EXIT_FAILURE);
14811 14812 14813 14814 14815 14816 14817 14818 14819
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
14820 14821
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
14822
{
14823 14824 14825
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839
    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);
14840
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
14841 14842 14843 14844 14845 14846
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
14847 14848
                      SIGN_NAME,
                      (int) getpid());
14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868
    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;
    }
14869 14870 14871
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
14872

14873 14874
    if (virBufferError(&buf))
        goto error;
14875

14876 14877 14878 14879 14880
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
14881
    }
14882

14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893
    /* 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);
14894 14895 14896 14897 14898 14899 14900 14901 14902 14903 14904
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
14905 14906 14907
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
14908 14909 14910
    }

    if (ctl->logfile) {
14911
        VIR_FREE(ctl->logfile);
14912 14913 14914 14915
        ctl->logfile = NULL;
    }
}

14916
#ifdef USE_READLINE
14917

K
Karel Zak 已提交
14918 14919 14920 14921 14922
/* -----------------
 * Readline stuff
 * -----------------
 */

14923
/*
K
Karel Zak 已提交
14924 14925
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
14926
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
14927 14928
 */
static char *
14929 14930
vshReadlineCommandGenerator(const char *text, int state)
{
14931
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
14932
    const char *name;
14933 14934
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
14935 14936

    if (!state) {
14937 14938
        grp_list_index = 0;
        cmd_list_index = 0;
14939
        len = strlen(text);
K
Karel Zak 已提交
14940 14941
    }

14942 14943
    grp = cmdGroups;

K
Karel Zak 已提交
14944
    /* Return the next name which partially matches from the
14945
     * command list.
K
Karel Zak 已提交
14946
     */
14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960
    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 已提交
14961 14962 14963 14964 14965 14966 14967
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
14968 14969
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
14970
    static int list_index, len;
14971
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
14972
    const char *name;
K
Karel Zak 已提交
14973 14974 14975 14976 14977 14978 14979 14980 14981

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

14982
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
14983
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
14984 14985 14986

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
14987
        len = strlen(text);
14988
        VIR_FREE(cmdname);
K
Karel Zak 已提交
14989 14990 14991 14992
    }

    if (!cmd)
        return NULL;
14993

14994 14995 14996
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
14997
    while ((name = cmd->opts[list_index].name)) {
14998
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
14999
        char *res;
15000

K
Karel Zak 已提交
15001
        list_index++;
15002

15003
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
15004 15005
            /* ignore non --option */
            continue;
15006

K
Karel Zak 已提交
15007
        if (len > 2) {
15008
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
15009 15010
                continue;
        }
15011
        res = vshMalloc(NULL, strlen(name) + 3);
15012
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
15013 15014 15015 15016 15017 15018 15019 15020
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
15021 15022 15023
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
15024 15025
    char **matches = (char **) NULL;

15026
    if (start == 0)
K
Karel Zak 已提交
15027
        /* command name generator */
15028
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
15029 15030
    else
        /* commands options */
15031
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
15032 15033 15034 15035
    return matches;
}


15036 15037
static int
vshReadlineInit(vshControl *ctl)
15038
{
15039 15040
    char *userdir = NULL;

K
Karel Zak 已提交
15041 15042 15043 15044 15045
    /* 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;
15046 15047 15048

    /* Limit the total size of the history buffer */
    stifle_history(500);
15049 15050

    /* Prepare to read/write history from/to the ~/.virsh/history file */
15051
    userdir = virGetUserDirectory(getuid());
15052

15053 15054
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
15055
        return -1;
15056
    }
15057 15058 15059

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15060
        VIR_FREE(userdir);
15061 15062 15063 15064 15065
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15066
        VIR_FREE(userdir);
15067 15068 15069
        return -1;
    }

15070
    VIR_FREE(userdir);
15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088

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

15089 15090
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
15091 15092
}

15093 15094 15095 15096 15097 15098
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

15099
#else /* !USE_READLINE */
15100

15101 15102 15103 15104 15105 15106 15107
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

15108
static void
15109
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
15110 15111 15112 15113 15114 15115 15116 15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132
{
    /* 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);
}

15133
#endif /* !USE_READLINE */
15134

K
Karel Zak 已提交
15135
/*
J
Jim Meyering 已提交
15136
 * Deinitialize virsh
K
Karel Zak 已提交
15137
 */
E
Eric Blake 已提交
15138
static bool
15139
vshDeinit(vshControl *ctl)
15140
{
15141
    vshReadlineDeinit(ctl);
15142
    vshCloseLogFile(ctl);
15143
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
15144
    if (ctl->conn) {
15145 15146 15147
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
15148 15149
        }
    }
D
Daniel P. Berrange 已提交
15150 15151
    virResetLastError();

E
Eric Blake 已提交
15152
    return true;
K
Karel Zak 已提交
15153
}
15154

K
Karel Zak 已提交
15155 15156 15157 15158
/*
 * Print usage
 */
static void
15159
vshUsage(void)
15160
{
15161
    const vshCmdGrp *grp;
15162
    const vshCmdDef *cmd;
15163

L
Lai Jiangshan 已提交
15164 15165
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
15166 15167 15168
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
15169
                      "    -d | --debug <num>      debug level [0-4]\n"
15170 15171 15172 15173
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
15174
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
15175
                      "    -V | --version=long     version and full options\n\n"
15176
                      "  commands (non interactive mode):\n\n"), progname, progname);
15177

15178 15179
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
15180

15181 15182 15183 15184 15185 15186 15187 15188 15189
        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"));
15190 15191 15192
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
15193 15194
}

15195 15196 15197 15198 15199 15200 15201 15202 15203 15204
/*
 * 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 已提交
15205 15206
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
15207 15208 15209 15210 15211 15212 15213 15214 15215 15216 15217 15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239 15240 15241
#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 已提交
15242
    vshPrint(ctl, "%s", _(" Networking:"));
15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254 15255 15256 15257 15258 15259 15260 15261 15262 15263 15264 15265 15266 15267 15268
#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 已提交
15269
    vshPrint(ctl, "%s", _(" Storage:"));
15270 15271 15272 15273 15274 15275 15276 15277 15278 15279 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290 15291 15292
#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 已提交
15293
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
15294
#ifdef WITH_SECDRIVER_APPARMOR
15295 15296 15297 15298 15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 15312 15313 15314 15315 15316 15317
    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 已提交
15318 15319 15320 15321
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
15322
static bool
15323
vshParseArgv(vshControl *ctl, int argc, char **argv)
15324
{
15325 15326
    bool help = false;
    int arg;
K
Karel Zak 已提交
15327
    struct option opt[] = {
E
Eric Blake 已提交
15328 15329 15330 15331 15332 15333 15334 15335 15336
        {"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}
15337 15338
    };

15339 15340 15341
    /* 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. */
15342
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
15343
        switch (arg) {
15344
        case 'd':
D
Daniel Veillard 已提交
15345
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
15346
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
15347 15348
                exit(EXIT_FAILURE);
            }
15349 15350
            break;
        case 'h':
15351
            help = true;
15352 15353
            break;
        case 'q':
E
Eric Blake 已提交
15354
            ctl->quiet = true;
15355 15356
            break;
        case 't':
E
Eric Blake 已提交
15357
            ctl->timing = true;
15358 15359 15360 15361
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
15362 15363 15364 15365 15366 15367
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
15368 15369 15370
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
15371
        case 'r':
E
Eric Blake 已提交
15372
            ctl->readonly = true;
15373
            break;
15374 15375 15376
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
15377
        default:
15378 15379
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
15380 15381 15382 15383
        }
    }

    if (help) {
15384 15385
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
15386 15387
            exit(EXIT_FAILURE);
        }
15388 15389 15390

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
15391
        exit(EXIT_SUCCESS);
15392 15393
    }

15394
    if (argc > optind) {
K
Karel Zak 已提交
15395
        /* parse command */
E
Eric Blake 已提交
15396
        ctl->imode = false;
15397
        if (argc - optind == 1) {
15398
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
15399
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
15400
        } else {
15401
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
15402 15403
        }
    }
E
Eric Blake 已提交
15404
    return true;
K
Karel Zak 已提交
15405 15406
}

15407 15408 15409 15410
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
15411
    char *defaultConn;
E
Eric Blake 已提交
15412
    bool ret = true;
K
Karel Zak 已提交
15413

15414 15415 15416
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
15417
    ctl->debug = VSH_DEBUG_DEFAULT;
15418

15419 15420
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
15421
        /* failure to setup locale is not fatal */
15422
    }
15423
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
15424
        perror("bindtextdomain");
E
Eric Blake 已提交
15425
        return EXIT_FAILURE;
15426
    }
15427
    if (!textdomain(PACKAGE)) {
15428
        perror("textdomain");
E
Eric Blake 已提交
15429
        return EXIT_FAILURE;
15430 15431
    }

15432 15433 15434 15435 15436
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

15437
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
15438 15439 15440
        progname = argv[0];
    else
        progname++;
15441

15442
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
15443
        ctl->name = vshStrdup(ctl, defaultConn);
15444 15445
    }

D
Daniel P. Berrange 已提交
15446 15447
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
15448
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
15449
    }
15450

D
Daniel P. Berrange 已提交
15451 15452
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
15453
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
15454
    }
15455

K
Karel Zak 已提交
15456
    if (!ctl->imode) {
15457
        ret = vshCommandRun(ctl, ctl->cmd);
15458
    } else {
K
Karel Zak 已提交
15459 15460
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
15461
            vshPrint(ctl,
15462
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
15463
                     progname);
J
Jim Meyering 已提交
15464
            vshPrint(ctl, "%s",
15465
                     _("Type:  'help' for help with commands\n"
15466
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
15467
        }
15468 15469 15470 15471 15472 15473

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
15474
        do {
15475
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
15476
            ctl->cmdstr =
15477
                vshReadline(ctl, prompt);
15478 15479
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
15480
            if (*ctl->cmdstr) {
15481
#if USE_READLINE
K
Karel Zak 已提交
15482
                add_history(ctl->cmdstr);
15483
#endif
15484
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
15485 15486
                    vshCommandRun(ctl, ctl->cmd);
            }
15487
            VIR_FREE(ctl->cmdstr);
15488
        } while (ctl->imode);
K
Karel Zak 已提交
15489

15490 15491
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
15492
    }
15493

K
Karel Zak 已提交
15494 15495
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
15496
}