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

13
#include <config.h>
14

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

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

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

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

static char *progname;

#ifndef TRUE
64 65
# define TRUE 1
# define FALSE 0
K
Karel Zak 已提交
66 67
#endif

68 69
#define VIRSH_MAX_XML_FILE 10*1024*1024

K
Karel Zak 已提交
70 71 72 73 74 75 76 77
#define VSH_PROMPT_RW    "virsh # "
#define VSH_PROMPT_RO    "virsh > "

#define GETTIMEOFDAY(T) gettimeofday(T, NULL)
#define DIFF_MSEC(T, U) \
        ((((int) ((T)->tv_sec - (U)->tv_sec)) * 1000000.0 + \
          ((int) ((T)->tv_usec - (U)->tv_usec))) / 1000.0)

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

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

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

136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
/*
 * 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 已提交
152 153 154
/*
 * Command Option Flags
 */
E
Eric Blake 已提交
155 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 */
};
K
Karel Zak 已提交
160 161 162 163 164 165 166 167

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

/*
 * vshCmdInfo -- information about command
 */
168 169 170
typedef struct {
    const char *name;           /* name of information */
    const char *data;           /* information */
K
Karel Zak 已提交
171 172 173 174 175
} vshCmdInfo;

/*
 * vshCmdOptDef - command option definition
 */
176 177 178 179 180
typedef struct {
    const char *name;           /* the name of option */
    vshCmdOptType type;         /* option type */
    int flag;                   /* flags */
    const char *help;           /* help string */
K
Karel Zak 已提交
181 182 183 184 185 186
} vshCmdOptDef;

/*
 * vshCmdOpt - command options
 */
typedef struct vshCmdOpt {
187
    const vshCmdOptDef *def;    /* pointer to relevant option */
188 189
    char *data;                 /* allocated data */
    struct vshCmdOpt *next;
K
Karel Zak 已提交
190 191 192 193 194
} vshCmdOpt;

/*
 * vshCmdDef - command definition
 */
195 196
typedef struct {
    const char *name;
197
    int (*handler) (vshControl *, const vshCmd *);    /* command handler */
198 199
    const vshCmdOptDef *opts;   /* definition of command options */
    const vshCmdInfo *info;     /* details about command */
K
Karel Zak 已提交
200 201 202 203 204 205
} vshCmdDef;

/*
 * vshCmd - parsed command
 */
typedef struct __vshCmd {
206
    const vshCmdDef *def;       /* command definition */
207 208
    vshCmdOpt *opts;            /* list of command arguments */
    struct __vshCmd *next;      /* next command */
K
Karel Zak 已提交
209 210 211 212 213 214
} __vshCmd;

/*
 * vshControl
 */
typedef struct __vshControl {
K
Karel Zak 已提交
215
    char *name;                 /* connection name */
216
    virConnectPtr conn;         /* connection to hypervisor (MAY BE NULL) */
217 218 219 220 221 222
    vshCmd *cmd;                /* the current command */
    char *cmdstr;               /* string with command */
    int imode;                  /* interactive mode? */
    int quiet;                  /* quiet mode */
    int debug;                  /* print debug messages? */
    int timing;                 /* print timing info? */
223 224 225
    int readonly;               /* connect readonly (first time only, not
                                 * during explicit connect command)
                                 */
226 227
    char *logfile;              /* log file name */
    int log_fd;                 /* log file descriptor */
228 229
    char *historydir;           /* readline history directory name */
    char *historyfile;          /* readline history file name */
K
Karel Zak 已提交
230
} __vshControl;
231

232 233 234 235 236
typedef struct vshCmdGrp {
    const char *name;
    const char *keyword; /* help keyword */
    const vshCmdDef *commands;
} vshCmdGrp;
237

238
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
239

240 241
static void vshError(vshControl *ctl, const char *format, ...)
    ATTRIBUTE_FMT_PRINTF(2, 3);
242 243
static int vshInit(vshControl *ctl);
static int vshDeinit(vshControl *ctl);
244
static void vshUsage(void);
245 246 247
static void vshOpenLogFile(vshControl *ctl);
static void vshOutputLogFile(vshControl *ctl, int log_level, const char *format, va_list ap);
static void vshCloseLogFile(vshControl *ctl);
K
Karel Zak 已提交
248

249
static int vshParseArgv(vshControl *ctl, int argc, char **argv);
K
Karel Zak 已提交
250

251
static const char *vshCmddefGetInfo(const vshCmdDef *cmd, const char *info);
252
static const vshCmdDef *vshCmddefSearch(const char *cmdname);
253
static int vshCmddefHelp(vshControl *ctl, const char *name);
254 255
static const vshCmdGrp *vshCmdGrpSearch(const char *grpname);
static int vshCmdGrpHelp(vshControl *ctl, const char *name);
K
Karel Zak 已提交
256

257
static vshCmdOpt *vshCommandOpt(const vshCmd *cmd, const char *name);
258 259 260 261 262 263 264 265 266 267 268
static int vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
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;
269 270 271
static int vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                                  unsigned long long *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
272
static int vshCommandOptBool(const vshCmd *cmd, const char *name);
273
static char *vshCommandOptArgv(const vshCmd *cmd, int count);
K
Karel Zak 已提交
274

275 276 277
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
278
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
279

280
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
281
                                          const char **name, int flag);
K
Karel Zak 已提交
282 283

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

287
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
288
                                            const char **name, int flag);
289 290

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
291 292
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
293 294
                           VSH_BYUUID|VSH_BYNAME)

295
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
296
                                                  const char **name, int flag);
297 298 299 300 301 302

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

303
static virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
304
                                                const char **name, int flag);
305 306 307 308 309 310

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

311
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
312
                            const char *optname, const char **name, int flag);
313 314 315 316 317 318

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

319
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
320 321
                                           const char *optname,
                                           const char *pooloptname,
322
                                           const char **name, int flag);
323 324

/* default is lookup by Name and UUID */
325
#define vshCommandOptVol(_ctl, _cmd, _optname, _pooloptname, _name)   \
326 327 328
    vshCommandOptVolBy(_ctl, _cmd, _optname, _pooloptname, _name,     \
                           VSH_BYUUID|VSH_BYNAME)

329
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
330
                                        const char **name);
331

332
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
333
    ATTRIBUTE_FMT_PRINTF(2, 3);
334
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
335
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
336 337

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

K
Karel Zak 已提交
340
static const char *vshDomainStateToString(int state);
341
static const char *vshDomainVcpuStateToString(int state);
342
static int vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
K
Karel Zak 已提交
343

344 345 346 347
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

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

357
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
358 359
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
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
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434

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;

435
  /* User visible sort, so we want locale-specific case comparison.  */
436 437 438
  return strcasecmp(*sa, *sb);
}

439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
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 已提交
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
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)
{
486 487 488 489 490 491 492 493
    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)
494
            goto out;
495
    }
J
John Levon 已提交
496 497

    if (last_error->code == VIR_ERR_OK) {
498
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
499 500 501
        goto out;
    }

502
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
503 504 505 506 507 508

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

509 510 511 512 513 514 515 516 517
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;
}

518 519 520 521 522
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

523 524 525 526 527
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

528 529 530 531 532 533
/*
 * 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
 */
534 535 536 537
static void vshCatchDisconnect(int sig, siginfo_t *siginfo,
                               void *context ATTRIBUTE_UNUSED) {
    if ((sig == SIGPIPE) ||
        (SA_SIGINFO && siginfo->si_signo == SIGPIPE))
538 539 540 541 542 543 544 545 546
        disconnected++;
}

/*
 * vshSetupSignals:
 *
 * Catch SIGPIPE signals which may arise when disconnection
 * from libvirtd occurs
 */
L
Laine Stump 已提交
547
static void
548 549 550 551 552 553 554 555 556 557 558 559 560
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 已提交
561
 * Reconnect after a disconnect from libvirtd
562 563
 *
 */
L
Laine Stump 已提交
564
static void
565 566 567 568 569 570 571 572 573 574 575 576 577
vshReconnect(vshControl *ctl) {
    if (ctl->conn != NULL)
        virConnectClose(ctl->conn);

    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);
    if (!ctl->conn)
        vshError(ctl, "%s", _("Failed to reconnect to the hypervisor"));
    else
        vshError(ctl, "%s", _("Reconnected to the hypervisor"));
    disconnected = 0;
}
578

K
Karel Zak 已提交
579 580 581 582 583 584
/* ---------------
 * Commands
 * ---------------
 */

/*
585
 * "help" command
K
Karel Zak 已提交
586
 */
587
static const vshCmdInfo info_help[] = {
588
    {"help", N_("print help")},
589 590
    {"desc", N_("Prints global help, command specific help, or help for a\n"
                "    group of related commands")},
591

592
    {NULL, NULL}
K
Karel Zak 已提交
593 594
};

595
static const vshCmdOptDef opts_help[] = {
596
    {"command", VSH_OT_DATA, 0, N_("Prints global help, command specific help, or help for a group of related commands")},
597
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
598 599 600
};

static int
601
cmdHelp(vshControl *ctl, const vshCmd *cmd)
602
 {
603
    const char *name = NULL;
604

605
    if (vshCommandOptString(cmd, "command", &name) <= 0) {
606
        const vshCmdGrp *grp;
607
        const vshCmdDef *def;
608

609 610 611 612 613 614 615 616 617 618 619 620 621
        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");
        }

622 623
        return TRUE;
    }
624

E
Eric Blake 已提交
625
    if (vshCmddefSearch(name)) {
626
        return vshCmddefHelp(ctl, name);
E
Eric Blake 已提交
627
    } else if (vshCmdGrpSearch(name)) {
628 629 630 631
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
        return FALSE;
K
Karel Zak 已提交
632 633 634
    }
}

635 636 637
/*
 * "autostart" command
 */
638
static const vshCmdInfo info_autostart[] = {
639
    {"help", N_("autostart a domain")},
640
    {"desc",
641
     N_("Configure a domain to be automatically started at boot.")},
642 643 644
    {NULL, NULL}
};

645
static const vshCmdOptDef opts_autostart[] = {
646 647
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
648 649 650 651
    {NULL, 0, 0, NULL}
};

static int
652
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
653 654
{
    virDomainPtr dom;
655
    const char *name;
656 657
    int autostart;

658
    if (!vshConnectionUsability(ctl, ctl->conn))
659 660
        return FALSE;

J
Jim Meyering 已提交
661
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
662 663 664 665 666
        return FALSE;

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
667
        if (autostart)
668
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
669
        else
670
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
671 672 673 674
        virDomainFree(dom);
        return FALSE;
    }

675
    if (autostart)
676
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
677
    else
678
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
679

680
    virDomainFree(dom);
681 682 683
    return TRUE;
}

K
Karel Zak 已提交
684
/*
685
 * "connect" command
K
Karel Zak 已提交
686
 */
687
static const vshCmdInfo info_connect[] = {
688
    {"help", N_("(re)connect to hypervisor")},
689
    {"desc",
690
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
691
    {NULL, NULL}
K
Karel Zak 已提交
692 693
};

694
static const vshCmdOptDef opts_connect[] = {
E
Eric Blake 已提交
695 696
    {"name",     VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("hypervisor connection URI")},
697
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
698
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
699 700 701
};

static int
702
cmdConnect(vshControl *ctl, const vshCmd *cmd)
703
{
K
Karel Zak 已提交
704
    int ro = vshCommandOptBool(cmd, "readonly");
705
    const char *name = NULL;
706

K
Karel Zak 已提交
707
    if (ctl->conn) {
708 709 710
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
711 712 713 714
            return FALSE;
        }
        ctl->conn = NULL;
    }
715

716
    VIR_FREE(ctl->name);
717 718
    if (vshCommandOptString(cmd, "name", &name) < 0) {
        vshError(ctl, "%s", _("Please specify valid connection URI"));
719
        return FALSE;
720
    }
721
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
722

723 724 725 726 727
    if (!ro) {
        ctl->readonly = 0;
    } else {
        ctl->readonly = 1;
    }
K
Karel Zak 已提交
728

729 730 731
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

K
Karel Zak 已提交
735 736 737
    return ctl->conn ? TRUE : FALSE;
}

738 739
#ifndef WIN32

740
/*
741
 * "console" command
742
 */
743
static const vshCmdInfo info_console[] = {
744
    {"help", N_("connect to the guest console")},
745
    {"desc",
746
     N_("Connect the virtual serial console for the guest")},
747 748 749
    {NULL, NULL}
};

750
static const vshCmdOptDef opts_console[] = {
751
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
752
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
753 754 755 756
    {NULL, 0, 0, NULL}
};

static int
757
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
758 759
{
    int ret = FALSE;
760
    virDomainInfo dominfo;
761

762 763 764 765 766 767 768 769 770 771
    if (virDomainGetInfo(dom, &dominfo) < 0) {
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

    if (dominfo.state == VIR_DOMAIN_SHUTOFF) {
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

772 773
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
    vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
774
    if (vshRunConsole(dom, name) == 0)
775
        ret = TRUE;
776 777

 cleanup:
778

779 780 781
    return ret;
}

782 783 784 785
static int
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
786
    int ret = FALSE;
787
    const char *name = NULL;
788

789
    if (!vshConnectionUsability(ctl, ctl->conn))
790 791 792 793 794
        return FALSE;

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

795 796 797 798
    if (vshCommandOptString(cmd, "devname", &name) < 0) {
        vshError(ctl, "%s", _("Invalid devname"));
        goto cleanup;
    }
799

800
    ret = cmdRunConsole(ctl, dom, name);
801

802
cleanup:
803 804 805 806
    virDomainFree(dom);
    return ret;
}

807 808 809
#endif /* WIN32 */


K
Karel Zak 已提交
810 811 812
/*
 * "list" command
 */
813
static const vshCmdInfo info_list[] = {
814 815
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
816
    {NULL, NULL}
K
Karel Zak 已提交
817 818
};

819
static const vshCmdOptDef opts_list[] = {
820 821
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
822 823 824
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
825 826

static int
827
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
828
{
829 830 831 832
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
833
    char **names = NULL;
834 835
    int maxname = 0;
    inactive |= all;
K
Karel Zak 已提交
836

837
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
838
        return FALSE;
839

840
    if (active) {
841 842
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
843
            vshError(ctl, "%s", _("Failed to list active domains"));
844 845 846 847 848 849
            return FALSE;
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
850
                vshError(ctl, "%s", _("Failed to list active domains"));
851
                VIR_FREE(ids);
852 853 854
                return FALSE;
            }

855
            qsort(&ids[0], maxid, sizeof(int), idsorter);
856
        }
857 858
    }
    if (inactive) {
859 860
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
861
            vshError(ctl, "%s", _("Failed to list inactive domains"));
862
            VIR_FREE(ids);
863
            return FALSE;
864
        }
865 866 867 868
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
869
                vshError(ctl, "%s", _("Failed to list inactive domains"));
870 871
                VIR_FREE(ids);
                VIR_FREE(names);
872 873
                return FALSE;
            }
874

875
            qsort(&names[0], maxname, sizeof(char*), namesorter);
876
        }
877
    }
878
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
879
    vshPrintExtra(ctl, "----------------------------------\n");
880 881

    for (i = 0; i < maxid; i++) {
K
Karel Zak 已提交
882 883
        virDomainInfo info;
        virDomainPtr dom = virDomainLookupByID(ctl->conn, ids[i]);
884
        const char *state;
885 886

        /* this kind of work with domains is not atomic operation */
K
Karel Zak 已提交
887 888
        if (!dom)
            continue;
889 890 891 892

        if (virDomainGetInfo(dom, &info) < 0)
            state = _("no state");
        else
E
Eric Blake 已提交
893
            state = _(vshDomainStateToString(info.state));
894

K
Karel Zak 已提交
895
        vshPrint(ctl, "%3d %-20s %s\n",
896 897
                 virDomainGetID(dom),
                 virDomainGetName(dom),
898
                 state);
899
        virDomainFree(dom);
K
Karel Zak 已提交
900
    }
901 902 903
    for (i = 0; i < maxname; i++) {
        virDomainInfo info;
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);
904
        const char *state;
905 906

        /* this kind of work with domains is not atomic operation */
907
        if (!dom) {
908
            VIR_FREE(names[i]);
909
            continue;
910
        }
911 912 913 914

        if (virDomainGetInfo(dom, &info) < 0)
            state = _("no state");
        else
E
Eric Blake 已提交
915
            state = _(vshDomainStateToString(info.state));
916 917

        vshPrint(ctl, "%3s %-20s %s\n", "-", names[i], state);
918

919
        virDomainFree(dom);
920
        VIR_FREE(names[i]);
921
    }
922 923
    VIR_FREE(ids);
    VIR_FREE(names);
K
Karel Zak 已提交
924 925 926 927
    return TRUE;
}

/*
K
Karel Zak 已提交
928
 * "domstate" command
K
Karel Zak 已提交
929
 */
930
static const vshCmdInfo info_domstate[] = {
931 932
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
933
    {NULL, NULL}
K
Karel Zak 已提交
934 935
};

936
static const vshCmdOptDef opts_domstate[] = {
937
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
938
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
939 940 941
};

static int
942
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
943
{
944
    virDomainInfo info;
K
Karel Zak 已提交
945
    virDomainPtr dom;
K
Karel Zak 已提交
946
    int ret = TRUE;
947

948
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
949
        return FALSE;
950

J
Jim Meyering 已提交
951
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
K
Karel Zak 已提交
952
        return FALSE;
953 954

    if (virDomainGetInfo(dom, &info) == 0)
K
Karel Zak 已提交
955
        vshPrint(ctl, "%s\n",
E
Eric Blake 已提交
956
                 _(vshDomainStateToString(info.state)));
K
Karel Zak 已提交
957 958
    else
        ret = FALSE;
959

960 961 962 963
    virDomainFree(dom);
    return ret;
}

964 965
/* "domblkstat" command
 */
966
static const vshCmdInfo info_domblkstat[] = {
967 968
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
969 970 971
    {NULL,NULL}
};

972
static const vshCmdOptDef opts_domblkstat[] = {
973 974
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
975 976 977 978
    {NULL, 0, 0, NULL}
};

static int
979
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
980 981
{
    virDomainPtr dom;
982
    const char *name = NULL, *device = NULL;
983 984
    struct _virDomainBlockStats stats;

985
    if (!vshConnectionUsability (ctl, ctl->conn))
986 987
        return FALSE;

J
Jim Meyering 已提交
988
    if (!(dom = vshCommandOptDomain (ctl, cmd, &name)))
989 990
        return FALSE;

991
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
L
Laine Stump 已提交
992
        virDomainFree(dom);
993
        return FALSE;
L
Laine Stump 已提交
994
    }
995 996

    if (virDomainBlockStats (dom, device, &stats, sizeof stats) == -1) {
997
        vshError(ctl, _("Failed to get block stats %s %s"), name, device);
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
        virDomainFree(dom);
        return FALSE;
    }

    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);
    return TRUE;
}

/* "domifstat" command
 */
1023
static const vshCmdInfo info_domifstat[] = {
1024 1025
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1026 1027 1028
    {NULL,NULL}
};

1029
static const vshCmdOptDef opts_domifstat[] = {
1030 1031
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1032 1033 1034 1035
    {NULL, 0, 0, NULL}
};

static int
1036
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1037 1038
{
    virDomainPtr dom;
1039
    const char *name = NULL, *device = NULL;
1040 1041
    struct _virDomainInterfaceStats stats;

1042
    if (!vshConnectionUsability (ctl, ctl->conn))
1043 1044
        return FALSE;

J
Jim Meyering 已提交
1045
    if (!(dom = vshCommandOptDomain (ctl, cmd, &name)))
1046 1047
        return FALSE;

1048
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1049
        virDomainFree(dom);
1050
        return FALSE;
L
Laine Stump 已提交
1051
    }
1052 1053

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1054
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
        virDomainFree(dom);
        return FALSE;
    }

    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);
    return TRUE;
}

1087 1088 1089
/*
 * "dommemstats" command
 */
1090
static const vshCmdInfo info_dommemstat[] = {
1091 1092
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1093 1094 1095
    {NULL,NULL}
};

1096
static const vshCmdOptDef opts_dommemstat[] = {
1097
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1098 1099 1100 1101
    {NULL, 0, 0, NULL}
};

static int
1102
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1103 1104
{
    virDomainPtr dom;
1105
    const char *name;
1106 1107 1108
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1109
    if (!vshConnectionUsability(ctl, ctl->conn))
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
        return FALSE;

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
        return FALSE;

    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);
        return FALSE;
    }

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

    virDomainFree(dom);
    return TRUE;
}

1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
/*
 * "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}
};

static int
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
    int ret = TRUE;
1162
    const char *device = NULL;
1163

1164
    if (!vshConnectionUsability(ctl, ctl->conn))
1165 1166 1167 1168 1169
        return FALSE;

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

1170
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
        virDomainFree(dom);
        return FALSE;
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
        return FALSE;
    }

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

1188 1189 1190
/*
 * "suspend" command
 */
1191
static const vshCmdInfo info_suspend[] = {
1192 1193
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1194
    {NULL, NULL}
1195 1196
};

1197
static const vshCmdOptDef opts_suspend[] = {
1198
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1199
    {NULL, 0, 0, NULL}
1200 1201 1202
};

static int
1203
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1204
{
1205
    virDomainPtr dom;
1206
    const char *name;
K
Karel Zak 已提交
1207
    int ret = TRUE;
1208

1209
    if (!vshConnectionUsability(ctl, ctl->conn))
1210 1211
        return FALSE;

J
Jim Meyering 已提交
1212
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1213
        return FALSE;
1214 1215

    if (virDomainSuspend(dom) == 0) {
1216
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1217
    } else {
1218
        vshError(ctl, _("Failed to suspend domain %s"), name);
1219 1220
        ret = FALSE;
    }
1221

1222 1223 1224 1225
    virDomainFree(dom);
    return ret;
}

1226 1227 1228
/*
 * "create" command
 */
1229
static const vshCmdInfo info_create[] = {
1230 1231
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1232 1233 1234
    {NULL, NULL}
};

1235
static const vshCmdOptDef opts_create[] = {
1236
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1237
#ifndef WIN32
1238
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1239
#endif
1240
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1241 1242 1243 1244
    {NULL, 0, 0, NULL}
};

static int
1245
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1246 1247
{
    virDomainPtr dom;
1248
    const char *from = NULL;
1249
    int ret = TRUE;
1250
    char *buffer;
1251
#ifndef WIN32
1252
    int console = vshCommandOptBool(cmd, "console");
1253
#endif
1254
    unsigned int flags = VIR_DOMAIN_NONE;
1255

1256
    if (!vshConnectionUsability(ctl, ctl->conn))
1257 1258
        return FALSE;

1259
    if (vshCommandOptString(cmd, "file", &from) <= 0)
1260 1261
        return FALSE;

1262 1263
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
1264

1265 1266 1267 1268
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1269
    VIR_FREE(buffer);
1270

1271
    if (dom != NULL) {
1272
        vshPrint(ctl, _("Domain %s created from %s\n"),
1273
                 virDomainGetName(dom), from);
1274
#ifndef WIN32
1275
        if (console)
1276
            cmdRunConsole(ctl, dom, NULL);
1277
#endif
1278
        virDomainFree(dom);
1279
    } else {
1280
        vshError(ctl, _("Failed to create domain from %s"), from);
1281 1282 1283 1284 1285
        ret = FALSE;
    }
    return ret;
}

1286 1287 1288
/*
 * "define" command
 */
1289
static const vshCmdInfo info_define[] = {
1290 1291
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1292 1293 1294
    {NULL, NULL}
};

1295
static const vshCmdOptDef opts_define[] = {
1296
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1297 1298 1299 1300
    {NULL, 0, 0, NULL}
};

static int
1301
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1302 1303
{
    virDomainPtr dom;
1304
    const char *from = NULL;
1305
    int ret = TRUE;
1306
    char *buffer;
1307

1308
    if (!vshConnectionUsability(ctl, ctl->conn))
1309 1310
        return FALSE;

1311
    if (vshCommandOptString(cmd, "file", &from) <= 0)
1312 1313
        return FALSE;

1314 1315
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
1316 1317

    dom = virDomainDefineXML(ctl->conn, buffer);
1318
    VIR_FREE(buffer);
1319

1320
    if (dom != NULL) {
1321
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1322
                 virDomainGetName(dom), from);
1323
        virDomainFree(dom);
1324
    } else {
1325
        vshError(ctl, _("Failed to define domain from %s"), from);
1326 1327 1328 1329 1330 1331 1332 1333
        ret = FALSE;
    }
    return ret;
}

/*
 * "undefine" command
 */
1334
static const vshCmdInfo info_undefine[] = {
1335 1336
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1337 1338 1339
    {NULL, NULL}
};

1340
static const vshCmdOptDef opts_undefine[] = {
1341
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1342 1343 1344 1345
    {NULL, 0, 0, NULL}
};

static int
1346
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1347 1348 1349
{
    virDomainPtr dom;
    int ret = TRUE;
1350
    const char *name = NULL;
1351
    int id;
1352

1353
    if (!vshConnectionUsability(ctl, ctl->conn))
1354 1355
        return FALSE;

1356
    if (vshCommandOptString(cmd, "domain", &name) <= 0)
1357 1358 1359 1360
        return FALSE;

    if (name && virStrToLong_i(name, NULL, 10, &id) == 0
        && id >= 0 && (dom = virDomainLookupByID(ctl->conn, id))) {
1361 1362 1363 1364 1365
        vshError(ctl,
                 _("a running domain like %s cannot be undefined;\n"
                   "to undefine, first shutdown then undefine"
                   " using its name or UUID"),
                 name);
1366 1367 1368
        virDomainFree(dom);
        return FALSE;
    }
J
Jim Meyering 已提交
1369
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
1370
                                      VSH_BYNAME|VSH_BYUUID)))
1371 1372 1373
        return FALSE;

    if (virDomainUndefine(dom) == 0) {
1374
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1375
    } else {
1376
        vshError(ctl, _("Failed to undefine domain %s"), name);
1377 1378 1379
        ret = FALSE;
    }

1380
    virDomainFree(dom);
1381 1382 1383 1384 1385 1386 1387
    return ret;
}


/*
 * "start" command
 */
1388
static const vshCmdInfo info_start[] = {
1389
    {"help", N_("start a (previously defined) inactive domain")},
1390 1391 1392
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1393 1394 1395
    {NULL, NULL}
};

1396
static const vshCmdOptDef opts_start[] = {
1397
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1398
#ifndef WIN32
1399
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1400
#endif
E
Eric Blake 已提交
1401
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1402 1403 1404 1405
    {NULL, 0, 0, NULL}
};

static int
1406
cmdStart(vshControl *ctl, const vshCmd *cmd)
1407 1408 1409
{
    virDomainPtr dom;
    int ret = TRUE;
1410
#ifndef WIN32
1411
    int console = vshCommandOptBool(cmd, "console");
1412
#endif
E
Eric Blake 已提交
1413
    unsigned int flags = VIR_DOMAIN_NONE;
1414

1415
    if (!vshConnectionUsability(ctl, ctl->conn))
1416 1417
        return FALSE;

1418 1419
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
1420 1421 1422
        return FALSE;

    if (virDomainGetID(dom) != (unsigned int)-1) {
1423
        vshError(ctl, "%s", _("Domain is already active"));
1424
        virDomainFree(dom);
1425 1426 1427
        return FALSE;
    }

E
Eric Blake 已提交
1428 1429 1430 1431 1432 1433
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;

    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
         : virDomainCreate(dom)) == 0) {
1434
        vshPrint(ctl, _("Domain %s started\n"),
1435
                 virDomainGetName(dom));
1436
#ifndef WIN32
1437
        if (console)
1438
            cmdRunConsole(ctl, dom, NULL);
1439
#endif
1440
    } else {
1441
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
1442 1443
        ret = FALSE;
    }
1444
    virDomainFree(dom);
1445 1446 1447
    return ret;
}

1448 1449 1450
/*
 * "save" command
 */
1451
static const vshCmdInfo info_save[] = {
1452 1453
    {"help", N_("save a domain state to a file")},
    {"desc", N_("Save a running domain.")},
1454
    {NULL, NULL}
1455 1456
};

1457
static const vshCmdOptDef opts_save[] = {
1458 1459
    {"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")},
1460
    {NULL, 0, 0, NULL}
1461 1462 1463
};

static int
1464
cmdSave(vshControl *ctl, const vshCmd *cmd)
1465
{
1466
    virDomainPtr dom;
1467 1468
    const char *name = NULL;
    const char *to = NULL;
1469
    int ret = TRUE;
1470

1471
    if (!vshConnectionUsability(ctl, ctl->conn))
1472 1473
        return FALSE;

1474
    if (vshCommandOptString(cmd, "file", &to) <= 0)
1475
        return FALSE;
1476

J
Jim Meyering 已提交
1477
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1478
        return FALSE;
1479 1480

    if (virDomainSave(dom, to) == 0) {
1481
        vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
1482
    } else {
1483
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
1484 1485
        ret = FALSE;
    }
1486

1487 1488 1489 1490
    virDomainFree(dom);
    return ret;
}

1491 1492 1493 1494 1495
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1496 1497 1498 1499
    {"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.")},
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
    {NULL, NULL}
};

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

static int
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1512
    const char *name;
1513 1514
    int ret = TRUE;

1515
    if (!vshConnectionUsability(ctl, ctl->conn))
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531
        return FALSE;

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
        return FALSE;

    if (virDomainManagedSave(dom, 0) == 0) {
        vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    } else {
        vshError(ctl, _("Failed to save domain %s state"), name);
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
/*
 * "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}
};

static int
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1550
    const char *name;
1551 1552 1553
    int ret = FALSE;
    int hassave;

1554
    if (!vshConnectionUsability(ctl, ctl->conn))
1555 1556 1557 1558 1559 1560 1561
        return FALSE;

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
        return FALSE;

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1562
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
        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);

    ret = TRUE;

cleanup:
    virDomainFree(dom);
    return ret;
}

1586 1587 1588
/*
 * "schedinfo" command
 */
1589
static const vshCmdInfo info_schedinfo[] = {
1590 1591
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1592 1593 1594
    {NULL, NULL}
};

1595
static const vshCmdOptDef opts_schedinfo[] = {
1596 1597 1598 1599
    {"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")},
1600 1601 1602 1603
    {NULL, 0, 0, NULL}
};

static int
1604 1605
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
                   virSchedParameterPtr param)
1606
{
1607
    const char *data = NULL;
1608 1609 1610 1611 1612 1613

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
        param->type == VIR_DOMAIN_SCHED_FIELD_UINT &&
        vshCommandOptBool(cmd, "weight")) {
        int val;
1614
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
1615
            vshError(ctl, "%s", _("Invalid value of weight"));
1616
            return -1;
1617
        } else {
1618
            param->value.ui = val;
1619
        }
1620
        return 1;
1621 1622
    }

1623 1624 1625 1626 1627
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
        param->type == VIR_DOMAIN_SCHED_FIELD_UINT &&
        vshCommandOptBool(cmd, "cap")) {
        int val;
1628
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
1629
            vshError(ctl, "%s", _("Invalid value of cap"));
1630
            return -1;
1631
        } else {
1632
            param->value.ui = val;
1633
        }
1634
        return 1;
1635
    }
1636

1637
    if (vshCommandOptString(cmd, "set", &data) > 0) {
1638 1639 1640
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
1641
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
1642
            return -1;
1643
        }
1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
        case VIR_DOMAIN_SCHED_FIELD_INT:
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
1655
                vshError(ctl, "%s",
1656 1657 1658 1659 1660 1661
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_UINT:
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
1662
                vshError(ctl, "%s",
1663 1664 1665 1666 1667 1668
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_LLONG:
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
1669
                vshError(ctl, "%s",
J
Jim Meyering 已提交
1670
                         _("Invalid value for parameter, expecting a long long"));
1671 1672 1673 1674 1675
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_ULLONG:
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
1676
                vshError(ctl, "%s",
1677 1678 1679 1680 1681 1682
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_DOUBLE:
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
1683
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
1684 1685 1686 1687 1688
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_BOOLEAN:
            param->value.b = STREQ(val, "0") ? 0 : 1;
1689
        }
1690
        return 1;
1691
    }
1692

1693 1694
    return 0;
}
1695

1696

1697 1698 1699 1700 1701 1702 1703 1704 1705 1706
static int
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
    virSchedParameterPtr params = NULL;
    int nparams = 0;
    int update = 0;
    int i, ret;
    int ret_val = FALSE;
1707

1708
    if (!vshConnectionUsability(ctl, ctl->conn))
1709
        return FALSE;
1710

1711 1712
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;
1713 1714 1715 1716

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
    if (schedulertype!= NULL){
1717
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
1718
             schedulertype);
1719
        VIR_FREE(schedulertype);
1720
    } else {
1721
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
1722
        goto cleanup;
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
    if (nparams) {
        params = vshMalloc(ctl, sizeof(virSchedParameter)* nparams);

        memset(params, 0, sizeof(virSchedParameter)* nparams);
        ret = virDomainGetSchedulerParameters(dom, params, &nparams);
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
        for (i = 0; i < nparams; i++){
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
            ret = virDomainSetSchedulerParameters(dom, params, nparams);
            if (ret == -1)
                goto cleanup;

            ret = virDomainGetSchedulerParameters(dom, params, &nparams);
            if (ret == -1)
                goto cleanup;
1752 1753 1754 1755
        } 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.  */
1756 1757
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
1758 1759 1760 1761
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
1762 1763 1764
        }

        ret_val = TRUE;
1765 1766 1767
        for (i = 0; i < nparams; i++){
            switch (params[i].type) {
            case VIR_DOMAIN_SCHED_FIELD_INT:
1768
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1769 1770
                 break;
            case VIR_DOMAIN_SCHED_FIELD_UINT:
1771
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1772 1773
                 break;
            case VIR_DOMAIN_SCHED_FIELD_LLONG:
1774
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1775 1776
                 break;
            case VIR_DOMAIN_SCHED_FIELD_ULLONG:
1777
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1778 1779
                 break;
            case VIR_DOMAIN_SCHED_FIELD_DOUBLE:
1780
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1781 1782
                 break;
            case VIR_DOMAIN_SCHED_FIELD_BOOLEAN:
1783
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
1784 1785
                 break;
            default:
1786
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
1787 1788 1789
            }
        }
    }
1790

1791
 cleanup:
1792
    VIR_FREE(params);
1793
    virDomainFree(dom);
1794
    return ret_val;
1795 1796
}

1797 1798 1799
/*
 * "restore" command
 */
1800
static const vshCmdInfo info_restore[] = {
1801 1802
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
1803
    {NULL, NULL}
1804 1805
};

1806
static const vshCmdOptDef opts_restore[] = {
1807
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
1808
    {NULL, 0, 0, NULL}
1809 1810 1811
};

static int
1812
cmdRestore(vshControl *ctl, const vshCmd *cmd)
1813
{
1814
    const char *from = NULL;
1815
    int ret = TRUE;
1816

1817
    if (!vshConnectionUsability(ctl, ctl->conn))
1818 1819
        return FALSE;

1820
    if (vshCommandOptString(cmd, "file", &from) <= 0)
1821
        return FALSE;
1822 1823

    if (virDomainRestore(ctl->conn, from) == 0) {
1824
        vshPrint(ctl, _("Domain restored from %s\n"), from);
1825
    } else {
1826
        vshError(ctl, _("Failed to restore domain from %s"), from);
1827 1828 1829 1830 1831
        ret = FALSE;
    }
    return ret;
}

D
Daniel Veillard 已提交
1832 1833 1834
/*
 * "dump" command
 */
1835
static const vshCmdInfo info_dump[] = {
1836 1837
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
1838 1839 1840
    {NULL, NULL}
};

1841
static const vshCmdOptDef opts_dump[] = {
1842 1843 1844 1845
    {"live", VSH_OT_BOOL, 0, N_("perform a live core dump if supported")},
    {"crash", VSH_OT_BOOL, 0, N_("crash the domain after core dump")},
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("where to dump the core")},
D
Daniel Veillard 已提交
1846 1847 1848 1849
    {NULL, 0, 0, NULL}
};

static int
1850
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
1851 1852
{
    virDomainPtr dom;
1853 1854
    const char *name = NULL;
    const char *to = NULL;
D
Daniel Veillard 已提交
1855
    int ret = TRUE;
1856
    int flags = 0;
D
Daniel Veillard 已提交
1857

1858
    if (!vshConnectionUsability(ctl, ctl->conn))
D
Daniel Veillard 已提交
1859 1860
        return FALSE;

1861
    if (vshCommandOptString(cmd, "file", &to) <= 0)
D
Daniel Veillard 已提交
1862 1863
        return FALSE;

J
Jim Meyering 已提交
1864
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
D
Daniel Veillard 已提交
1865 1866
        return FALSE;

P
Paolo Bonzini 已提交
1867 1868
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
1869 1870 1871 1872
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;

    if (virDomainCoreDump(dom, to, flags) == 0) {
1873
        vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
D
Daniel Veillard 已提交
1874
    } else {
1875
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
D
Daniel Veillard 已提交
1876 1877 1878 1879 1880 1881 1882
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

1883 1884 1885
/*
 * "resume" command
 */
1886
static const vshCmdInfo info_resume[] = {
1887 1888
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
1889
    {NULL, NULL}
1890 1891
};

1892
static const vshCmdOptDef opts_resume[] = {
1893
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1894
    {NULL, 0, 0, NULL}
1895 1896 1897
};

static int
1898
cmdResume(vshControl *ctl, const vshCmd *cmd)
1899
{
1900
    virDomainPtr dom;
K
Karel Zak 已提交
1901
    int ret = TRUE;
1902
    const char *name;
1903

1904
    if (!vshConnectionUsability(ctl, ctl->conn))
1905 1906
        return FALSE;

J
Jim Meyering 已提交
1907
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1908
        return FALSE;
1909 1910

    if (virDomainResume(dom) == 0) {
1911
        vshPrint(ctl, _("Domain %s resumed\n"), name);
1912
    } else {
1913
        vshError(ctl, _("Failed to resume domain %s"), name);
1914 1915
        ret = FALSE;
    }
1916

1917 1918 1919 1920
    virDomainFree(dom);
    return ret;
}

1921 1922 1923
/*
 * "shutdown" command
 */
1924
static const vshCmdInfo info_shutdown[] = {
1925 1926
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
1927
    {NULL, NULL}
1928 1929
};

1930
static const vshCmdOptDef opts_shutdown[] = {
1931
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1932
    {NULL, 0, 0, NULL}
1933 1934 1935
};

static int
1936
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
1937
{
1938 1939
    virDomainPtr dom;
    int ret = TRUE;
1940
    const char *name;
1941

1942
    if (!vshConnectionUsability(ctl, ctl->conn))
1943 1944
        return FALSE;

J
Jim Meyering 已提交
1945
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1946
        return FALSE;
1947 1948

    if (virDomainShutdown(dom) == 0) {
1949
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
1950
    } else {
1951
        vshError(ctl, _("Failed to shutdown domain %s"), name);
1952 1953
        ret = FALSE;
    }
1954

1955 1956 1957 1958
    virDomainFree(dom);
    return ret;
}

1959 1960 1961
/*
 * "reboot" command
 */
1962
static const vshCmdInfo info_reboot[] = {
1963 1964
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
1965 1966 1967
    {NULL, NULL}
};

1968
static const vshCmdOptDef opts_reboot[] = {
1969
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1970 1971 1972 1973
    {NULL, 0, 0, NULL}
};

static int
1974
cmdReboot(vshControl *ctl, const vshCmd *cmd)
1975 1976 1977
{
    virDomainPtr dom;
    int ret = TRUE;
1978
    const char *name;
1979

1980
    if (!vshConnectionUsability(ctl, ctl->conn))
1981 1982
        return FALSE;

J
Jim Meyering 已提交
1983
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1984 1985 1986
        return FALSE;

    if (virDomainReboot(dom, 0) == 0) {
1987
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
1988
    } else {
1989
        vshError(ctl, _("Failed to reboot domain %s"), name);
1990 1991 1992 1993 1994 1995 1996
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

1997 1998 1999
/*
 * "destroy" command
 */
2000
static const vshCmdInfo info_destroy[] = {
2001 2002
    {"help", N_("destroy a domain")},
    {"desc", N_("Destroy a given domain.")},
2003
    {NULL, NULL}
2004 2005
};

2006
static const vshCmdOptDef opts_destroy[] = {
2007
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2008
    {NULL, 0, 0, NULL}
2009 2010 2011
};

static int
2012
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2013
{
2014
    virDomainPtr dom;
K
Karel Zak 已提交
2015
    int ret = TRUE;
2016
    const char *name;
2017

2018
    if (!vshConnectionUsability(ctl, ctl->conn))
2019 2020
        return FALSE;

J
Jim Meyering 已提交
2021
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
2022
        return FALSE;
2023 2024

    if (virDomainDestroy(dom) == 0) {
2025
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2026
    } else {
2027
        vshError(ctl, _("Failed to destroy domain %s"), name);
2028 2029
        ret = FALSE;
    }
2030

2031
    virDomainFree(dom);
K
Karel Zak 已提交
2032 2033 2034 2035
    return ret;
}

/*
2036
 * "dominfo" command
K
Karel Zak 已提交
2037
 */
2038
static const vshCmdInfo info_dominfo[] = {
2039 2040
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2041
    {NULL, NULL}
K
Karel Zak 已提交
2042 2043
};

2044
static const vshCmdOptDef opts_dominfo[] = {
2045
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2046
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2047 2048 2049
};

static int
2050
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2051
{
K
Karel Zak 已提交
2052 2053
    virDomainInfo info;
    virDomainPtr dom;
2054 2055
    virSecurityModel secmodel;
    virSecurityLabel seclabel;
2056
    int persistent = 0;
2057
    int ret = TRUE, autostart;
2058
    unsigned int id;
2059
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2060

2061
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
2062 2063
        return FALSE;

J
Jim Meyering 已提交
2064
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
K
Karel Zak 已提交
2065
        return FALSE;
2066

2067 2068
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2069
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2070
    else
2071
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2072 2073
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2074
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2075
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2076 2077

    if ((str = virDomainGetOSType(dom))) {
2078
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2079
        VIR_FREE(str);
2080 2081 2082
    }

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

2086
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2087 2088

        if (info.cpuTime != 0) {
2089
            double cpuUsed = info.cpuTime;
2090

2091
            cpuUsed /= 1000000000.0;
2092

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

2096 2097
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2098
                 info.maxMem);
2099
        else
2100
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2101 2102
                 _("no limit"));

2103
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2104 2105
                 info.memory);

K
Karel Zak 已提交
2106 2107 2108
    } else {
        ret = FALSE;
    }
2109

2110 2111 2112 2113 2114 2115 2116 2117 2118
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
    vshDebug(ctl, 5, "Domain persistent flag value: %d\n", persistent);
    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 */
2119
    if (!virDomainGetAutostart(dom, &autostart)) {
2120
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2121 2122 2123
                 autostart ? _("enable") : _("disable") );
    }

2124 2125 2126
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2127 2128 2129
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
            return FALSE;
2130 2131 2132
        } else {
            virFreeError(last_error);
            last_error = NULL;
2133
        }
2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151
    } 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 */
            memset(&seclabel, 0, sizeof seclabel);
            if (virDomainGetSecurityLabel(dom, &seclabel) == -1) {
                virDomainFree(dom);
                return FALSE;
            } else {
                if (seclabel.label[0] != '\0')
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
                             seclabel.label, seclabel.enforcing ? "enforcing" : "permissive");
            }
        }
    }
2152
    virDomainFree(dom);
K
Karel Zak 已提交
2153 2154 2155
    return ret;
}

2156 2157 2158 2159
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2160 2161
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2162 2163 2164 2165
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2166
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2167 2168 2169 2170 2171 2172 2173 2174 2175
    {NULL, 0, 0, NULL}
};


static int
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
L
Laine Stump 已提交
2176
    int ret = TRUE;
2177

2178
    if (!vshConnectionUsability(ctl, ctl->conn))
2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208
        return FALSE;

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

    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 已提交
2209
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2210
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2211
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2212
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2213
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2214 2215 2216
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2217
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2218
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2219
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2220
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2221
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2222 2223 2224
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2225
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2226
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2227
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2228
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2229
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2230 2231 2232 2233 2234 2235 2236 2237 2238
        }
    } else {
        ret = FALSE;
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2239 2240 2241 2242
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2243 2244
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2245 2246 2247 2248
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2249
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2250 2251 2252 2253 2254 2255 2256 2257 2258
    {NULL, 0, 0, NULL}
};

static int
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int ret = TRUE;

2259
    if (!vshConnectionUsability(ctl, ctl->conn))
2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271
        return FALSE;

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

    if (virDomainAbortJob(dom) < 0)
        ret = FALSE;

    virDomainFree(dom);
    return ret;
}

2272 2273 2274
/*
 * "freecell" command
 */
2275
static const vshCmdInfo info_freecell[] = {
2276 2277
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2278 2279 2280
    {NULL, NULL}
};

2281
static const vshCmdOptDef opts_freecell[] = {
2282
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2283
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
2284 2285 2286 2287
    {NULL, 0, 0, NULL}
};

static int
2288
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2289
{
2290
    int func_ret = FALSE;
2291
    int ret;
2292
    int cell = -1, cell_given;
2293
    unsigned long long memory;
2294 2295 2296 2297
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
2298
    int all_given;
2299 2300 2301 2302
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
2303

2304

2305
    if (!vshConnectionUsability(ctl, ctl->conn))
2306 2307
        return FALSE;

2308 2309 2310 2311
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
2312 2313 2314 2315 2316 2317 2318 2319 2320
    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) {
2321 2322 2323
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2324 2325 2326
            goto cleanup;
        }

2327 2328 2329
        xml = xmlReadDoc((const xmlChar *) cap_xml, "node.xml", NULL,
                          XML_PARSE_NOENT | XML_PARSE_NONET |
                          XML_PARSE_NOWARNING);
2330

2331 2332
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2333 2334 2335
            goto cleanup;
        }

2336 2337 2338 2339 2340
        ctxt = xmlXPathNewContext(xml);
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
2341
            vshError(ctl, "%s", _("could not get information about "
2342
                                  "NUMA topology"));
2343 2344 2345
            goto cleanup;
        }

2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366
        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;
            }
        }

2367
        memory = 0;
2368 2369 2370 2371
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
2372 2373 2374 2375
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
2376
    } else {
2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390
        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));
2391 2392
    }

2393
    func_ret = TRUE;
2394

2395
cleanup:
2396 2397 2398
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
2399
    VIR_FREE(nodes);
2400 2401 2402
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
2403
    return func_ret;
2404 2405
}

E
Eric Blake 已提交
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422
/*
 * "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}
};

static int
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
2423
    const char *type = NULL;
E
Eric Blake 已提交
2424 2425
    int vcpus;

2426 2427
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
2428
        return FALSE;
2429
    }
E
Eric Blake 已提交
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

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

    vcpus = virConnectGetMaxVcpus(ctl->conn, type);
    if (vcpus < 0)
        return FALSE;
    vshPrint(ctl, "%d\n", vcpus);

    return TRUE;
}

/*
 * "vcpucount" command
 */
static const vshCmdInfo info_vcpucount[] = {
    {"help", N_("domain vcpu counts")},
    {"desc", N_("Returns the number of virtual CPUs used by the domain.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_vcpucount[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"maximum", VSH_OT_BOOL, 0, N_("get maximum cap on vcpus")},
    {"current", VSH_OT_BOOL, 0, N_("get current vcpu usage")},
    {"config", VSH_OT_BOOL, 0, N_("get value to be used on next boot")},
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
    {NULL, 0, 0, NULL}
};

static int
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int ret = TRUE;
    int maximum = vshCommandOptBool(cmd, "maximum");
    int current = vshCommandOptBool(cmd, "current");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    bool all = maximum + current + config + live == 0;
    int count;

    if (maximum && current) {
        vshError(ctl, "%s",
                 _("--maximum and --current cannot both be specified"));
        return FALSE;
    }
    if (config && live) {
        vshError(ctl, "%s",
                 _("--config and --live cannot both be specified"));
        return FALSE;
    }
    /* We want one of each pair of mutually exclusive options; that
     * is, use of flags requires exactly two options.  */
    if (maximum + current + config + live == 1) {
        vshError(ctl,
                 _("when using --%s, either --%s or --%s must be specified"),
                 (maximum ? "maximum" : current ? "current"
                  : config ? "config" : "live"),
                 maximum + current ? "config" : "maximum",
                 maximum + current ? "live" : "current");
        return FALSE;
    }

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

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

    /* In all cases, try the new API first; if it fails because we are
     * talking to an older client, try a fallback API before giving
     * up.  */
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
                                             VIR_DOMAIN_VCPU_CONFIG));
        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;
            }
2515 2516
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
            ret = FALSE;
        } 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 |
                                             VIR_DOMAIN_VCPU_LIVE));
        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);
            ret = FALSE;
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    if (all || (current && config)) {
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_VCPU_CONFIG);
        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);
            ret = FALSE;
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    if (all || (current && live)) {
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_VCPU_LIVE);
        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);
            ret = FALSE;
        } 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;
}

2617 2618 2619
/*
 * "vcpuinfo" command
 */
2620
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
2621
    {"help", N_("detailed domain vcpu information")},
2622
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
2623 2624 2625
    {NULL, NULL}
};

2626
static const vshCmdOptDef opts_vcpuinfo[] = {
2627
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2628 2629 2630 2631
    {NULL, 0, 0, NULL}
};

static int
2632
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
2633 2634 2635 2636 2637 2638 2639 2640 2641 2642
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
    unsigned char *cpumap;
    int ncpus;
    size_t cpumaplen;
    int ret = TRUE;

2643
    if (!vshConnectionUsability(ctl, ctl->conn))
2644 2645
        return FALSE;

J
Jim Meyering 已提交
2646
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2647 2648 2649 2650
        return FALSE;

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
2651
        return FALSE;
2652 2653 2654 2655 2656 2657 2658
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
        return FALSE;
    }

2659
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
2660
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2661
    cpumap = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
2662

2663 2664 2665
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
                                   cpumap, cpumaplen)) >= 0) {
2666
        int n;
2667 2668 2669 2670 2671
        for (n = 0 ; n < ncpus ; n++) {
            unsigned int m;
            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 已提交
2672
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688
            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:"));
            for (m = 0 ; m < VIR_NODEINFO_MAXCPUS(nodeinfo) ; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumap, cpumaplen, n, m) ? 'y' : '-');
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
2689
    } else {
2690
        if (info.state == VIR_DOMAIN_SHUTOFF) {
2691 2692
            vshError(ctl, "%s",
                     _("Domain shut off, virtual CPUs not present."));
2693
        }
2694 2695 2696
        ret = FALSE;
    }

2697 2698
    VIR_FREE(cpumap);
    VIR_FREE(cpuinfo);
2699 2700 2701 2702 2703 2704 2705
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
2706
static const vshCmdInfo info_vcpupin[] = {
2707 2708
    {"help", N_("control domain vcpu affinity")},
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
2709 2710 2711
    {NULL, NULL}
};

2712
static const vshCmdOptDef opts_vcpupin[] = {
2713
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2714
    {"vcpu", VSH_OT_INT, VSH_OFLAG_REQ, N_("vcpu number")},
2715
    {"cpulist", VSH_OT_DATA, VSH_OFLAG_REQ, N_("host cpu number(s) (comma separated)")},
2716 2717 2718 2719
    {NULL, 0, 0, NULL}
};

static int
2720
cmdVcpupin(vshControl *ctl, const vshCmd *cmd)
2721 2722 2723 2724 2725
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    int vcpu;
2726
    const char *cpulist = NULL;
2727 2728 2729
    int ret = TRUE;
    unsigned char *cpumap;
    int cpumaplen;
2730 2731
    int i;
    enum { expect_num, expect_num_or_comma } state;
2732

2733
    if (!vshConnectionUsability(ctl, ctl->conn))
2734 2735
        return FALSE;

J
Jim Meyering 已提交
2736
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2737 2738
        return FALSE;

2739
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) <= 0) {
2740
        vshError(ctl, "%s", _("vcpupin: Invalid or missing vCPU number."));
2741 2742 2743 2744
        virDomainFree(dom);
        return FALSE;
    }

2745
    if (vshCommandOptString(cmd, "cpulist", &cpulist) <= 0) {
2746 2747 2748
        virDomainFree(dom);
        return FALSE;
    }
2749

2750 2751 2752 2753 2754 2755
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
        return FALSE;
    }

    if (virDomainGetInfo(dom, &info) != 0) {
2756
        vshError(ctl, "%s", _("vcpupin: failed to get domain informations."));
2757 2758 2759 2760 2761
        virDomainFree(dom);
        return FALSE;
    }

    if (vcpu >= info.nrVirtCpu) {
2762
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
2763 2764 2765 2766
        virDomainFree(dom);
        return FALSE;
    }

2767 2768 2769 2770
    /* Check that the cpulist parameter is a comma-separated list of
     * numbers and give an intelligent error message if not.
     */
    if (cpulist[0] == '\0') {
2771
        vshError(ctl, "%s", _("cpulist: Invalid format. Empty string."));
2772 2773 2774 2775 2776 2777 2778 2779
        virDomainFree (dom);
        return FALSE;
    }

    state = expect_num;
    for (i = 0; cpulist[i]; i++) {
        switch (state) {
        case expect_num:
2780
          if (!c_isdigit (cpulist[i])) {
2781 2782 2783
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2784 2785 2786 2787 2788 2789 2790 2791
                virDomainFree (dom);
                return FALSE;
            }
            state = expect_num_or_comma;
            break;
        case expect_num_or_comma:
            if (cpulist[i] == ',')
                state = expect_num;
2792
            else if (!c_isdigit (cpulist[i])) {
2793 2794 2795
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit or comma at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2796 2797 2798 2799 2800 2801
                virDomainFree (dom);
                return FALSE;
            }
        }
    }
    if (state == expect_num) {
2802 2803 2804
        vshError(ctl, _("cpulist: %s: Invalid format. Trailing comma "
                        "at position %d."),
                 cpulist, i);
2805 2806 2807 2808
        virDomainFree (dom);
        return FALSE;
    }

2809
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2810
    cpumap = vshCalloc(ctl, 1, cpumaplen);
2811 2812 2813 2814 2815 2816

    do {
        unsigned int cpu = atoi(cpulist);

        if (cpu < VIR_NODEINFO_MAXCPUS(nodeinfo)) {
            VIR_USE_CPU(cpumap, cpu);
2817
        } else {
2818
            vshError(ctl, _("Physical CPU %d doesn't exist."), cpu);
2819
            VIR_FREE(cpumap);
2820 2821
            virDomainFree(dom);
            return FALSE;
2822
        }
2823
        cpulist = strchr(cpulist, ',');
2824 2825 2826 2827 2828 2829 2830 2831
        if (cpulist)
            cpulist++;
    } while (cpulist);

    if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
        ret = FALSE;
    }

2832
    VIR_FREE(cpumap);
2833 2834 2835 2836
    virDomainFree(dom);
    return ret;
}

2837 2838 2839
/*
 * "setvcpus" command
 */
2840
static const vshCmdInfo info_setvcpus[] = {
2841 2842
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
2843 2844 2845
    {NULL, NULL}
};

2846
static const vshCmdOptDef opts_setvcpus[] = {
2847
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2848
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
2849 2850 2851
    {"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")},
2852 2853 2854 2855
    {NULL, 0, 0, NULL}
};

static int
2856
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
2857 2858 2859 2860
{
    virDomainPtr dom;
    int count;
    int ret = TRUE;
E
Eric Blake 已提交
2861 2862 2863 2864 2865 2866
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int flags = ((maximum ? VIR_DOMAIN_VCPU_MAXIMUM : 0) |
                 (config ? VIR_DOMAIN_VCPU_CONFIG : 0) |
                 (live ? VIR_DOMAIN_VCPU_LIVE : 0));
2867

2868
    if (!vshConnectionUsability(ctl, ctl->conn))
2869 2870
        return FALSE;

J
Jim Meyering 已提交
2871
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2872 2873
        return FALSE;

2874 2875 2876 2877
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
2878

E
Eric Blake 已提交
2879 2880 2881 2882 2883
    if (!flags) {
        if (virDomainSetVcpus(dom, count) != 0) {
            ret = FALSE;
        }
    } else {
2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
            vshDebug(ctl, 5, "--maximum flag was given\n");

            /* 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"));
                ret = FALSE;
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
2903 2904 2905
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
            ret = FALSE;
        }
2906 2907
    }

2908
  cleanup:
2909 2910 2911 2912 2913 2914 2915
    virDomainFree(dom);
    return ret;
}

/*
 * "setmemory" command
 */
2916
static const vshCmdInfo info_setmem[] = {
2917 2918
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
2919 2920 2921
    {NULL, NULL}
};

2922
static const vshCmdOptDef opts_setmem[] = {
2923
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2924
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
2925 2926
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
2927 2928 2929 2930
    {NULL, 0, 0, NULL}
};

static int
2931
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
2932 2933
{
    virDomainPtr dom;
2934
    virDomainInfo info;
2935
    unsigned long kilobytes = 0;
2936
    int ret = TRUE;
2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int flags = 0;

    /* Need to use flags if config was specified, but prefer older api
     * for live-only behavior otherwise */
    if (config) {
        flags = VIR_DOMAIN_MEM_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_MEM_LIVE;
    }
2948

2949
    if (!vshConnectionUsability(ctl, ctl->conn))
2950 2951
        return FALSE;

J
Jim Meyering 已提交
2952
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2953 2954
        return FALSE;

2955 2956 2957 2958 2959
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
        return FALSE;
    }

2960
    if (kilobytes <= 0) {
2961
        virDomainFree(dom);
2962
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
2963 2964 2965
        return FALSE;
    }

2966 2967
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
2968
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
2969 2970 2971 2972 2973
        return FALSE;
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
2974
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
2975
                 kilobytes, info.maxMem);
2976 2977 2978
        return FALSE;
    }

2979 2980 2981 2982 2983 2984 2985 2986
    if (!flags) {
        if (virDomainSetMemory(dom, kilobytes) != 0) {
            ret = FALSE;
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            ret = FALSE;
        }
2987 2988 2989 2990 2991 2992 2993 2994 2995
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
2996
static const vshCmdInfo info_setmaxmem[] = {
2997 2998
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
2999 3000 3001
    {NULL, NULL}
};

3002
static const vshCmdOptDef opts_setmaxmem[] = {
3003
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3004
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
3005 3006 3007 3008
    {NULL, 0, 0, NULL}
};

static int
3009
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
3010 3011
{
    virDomainPtr dom;
3012
    virDomainInfo info;
3013
    int kilobytes = 0;
3014 3015
    int ret = TRUE;

3016
    if (!vshConnectionUsability(ctl, ctl->conn))
3017 3018
        return FALSE;

J
Jim Meyering 已提交
3019
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
3020 3021
        return FALSE;

3022 3023 3024 3025 3026
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
        return FALSE;
    }

3027
    if (kilobytes <= 0) {
3028
        virDomainFree(dom);
3029
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
3030 3031 3032
        return FALSE;
    }

3033 3034
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
3035
        vshError(ctl, "%s", _("Unable to verify current MemorySize"));
3036 3037 3038
        return FALSE;
    }

3039 3040 3041 3042 3043 3044
    if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
        vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
        virDomainFree(dom);
        return FALSE;
    }

3045 3046
    if (kilobytes < info.memory) {
        if (virDomainSetMemory(dom, kilobytes) != 0) {
3047
            vshError(ctl, "%s", _("Unable to shrink current MemorySize"));
3048
            ret = FALSE;
3049 3050 3051
        }
    }

3052 3053 3054 3055
    virDomainFree(dom);
    return ret;
}

3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185
/*
 * "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]")},
    {NULL, 0, 0, NULL}
};

static int
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
    unsigned int i = 0;
    virBlkioParameterPtr params = NULL, temp = NULL;
    int ret = FALSE;

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

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

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

    if (weight) {
        nparams++;
        if (weight < 0) {
            virDomainFree(dom);
            vshError(ctl, _("Invalid value of %d for I/O weight"), weight);
            goto cleanup;
        }
    }

    if (nparams == 0) {
        /* get the number of blkio parameters */
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, 0) != 0) {
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
            ret = TRUE;
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
        if (virDomainGetBlkioParameters(dom, params, &nparams, 0) != 0) {
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
                case VIR_DOMAIN_BLKIO_PARAM_INT:
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_UINT:
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_LLONG:
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_ULLONG:
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_DOUBLE:
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
                case VIR_DOMAIN_BLKIO_PARAM_BOOLEAN:
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

        ret = TRUE;
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
            temp->type = VIR_DOMAIN_BLKIO_PARAM_UINT;

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
        if (virDomainSetBlkioParameters(dom, params, nparams, 0) != 0)
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
            ret = TRUE;
    }

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

3186 3187 3188 3189
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
3190 3191 3192
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
3193 3194 3195 3196 3197 3198 3199
                "    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")},
3200
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3201
     N_("Max memory in kilobytes")},
3202
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3203
     N_("Memory during contention in kilobytes")},
3204
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3205
     N_("Max swap in kilobytes")},
3206
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
3207
     N_("Min guaranteed memory in kilobytes")},
3208 3209 3210 3211 3212 3213 3214
    {NULL, 0, 0, NULL}
};

static int
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
3215 3216
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227
    int nparams = 0;
    unsigned int i = 0;
    virMemoryParameterPtr params = NULL, temp = NULL;
    int ret = FALSE;

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

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

3228 3229 3230 3231 3232 3233 3234 3235 3236
    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;
    }

3237 3238 3239 3240 3241 3242 3243 3244 3245
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

3246 3247 3248
    if (min_guarantee)
        nparams++;

3249 3250
    if (nparams == 0) {
        /* get the number of memory parameters */
3251
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, 0) != 0) {
3252 3253 3254 3255 3256
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

3257 3258 3259 3260 3261 3262
        if (nparams == 0) {
            /* nothing to output */
            ret = TRUE;
            goto cleanup;
        }

3263
        /* now go get all the memory parameters */
E
Eric Blake 已提交
3264
        params = vshCalloc(ctl, nparams, sizeof(*params));
3265
        if (virDomainGetMemoryParameters(dom, params, &nparams, 0) != 0) {
3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
                case VIR_DOMAIN_MEMORY_PARAM_INT:
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
                case VIR_DOMAIN_MEMORY_PARAM_UINT:
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
                case VIR_DOMAIN_MEMORY_PARAM_LLONG:
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
                case VIR_DOMAIN_MEMORY_PARAM_ULLONG:
3285 3286 3287 3288 3289
                    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);
3290 3291 3292 3293 3294 3295 3296 3297 3298 3299
                    break;
                case VIR_DOMAIN_MEMORY_PARAM_DOUBLE:
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
                case VIR_DOMAIN_MEMORY_PARAM_BOOLEAN:
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
3300
                    vshPrint(ctl, "unimplemented memory parameter type\n");
3301 3302 3303 3304 3305 3306
            }
        }

        ret = TRUE;
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
3307
        params = vshCalloc(ctl, nparams, sizeof(*params));
3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
            temp->type = VIR_DOMAIN_MEMORY_PARAM_ULLONG;

            /*
             * 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;
3331
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
3332 3333
                        sizeof(temp->field));
                swap_hard_limit = 0;
3334 3335 3336 3337 3338
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
3339
            }
3340 3341 3342 3343

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
3344 3345
        }
        if (virDomainSetMemoryParameters(dom, params, nparams, 0) != 0)
3346
            vshError(ctl, "%s", _("Unable to change memory parameters"));
3347 3348 3349 3350 3351
        else
            ret = TRUE;
    }

  cleanup:
E
Eric Blake 已提交
3352
    VIR_FREE(params);
3353 3354 3355 3356
    virDomainFree(dom);
    return ret;
}

3357 3358 3359
/*
 * "nodeinfo" command
 */
3360
static const vshCmdInfo info_nodeinfo[] = {
3361 3362
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
3363 3364 3365 3366
    {NULL, NULL}
};

static int
3367
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3368 3369
{
    virNodeInfo info;
3370

3371
    if (!vshConnectionUsability(ctl, ctl->conn))
3372 3373 3374
        return FALSE;

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
3375
        vshError(ctl, "%s", _("failed to get node information"));
3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386
        return FALSE;
    }
    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);

3387 3388 3389
    return TRUE;
}

3390 3391 3392
/*
 * "capabilities" command
 */
3393
static const vshCmdInfo info_capabilities[] = {
3394 3395
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
3396 3397 3398 3399
    {NULL, NULL}
};

static int
3400
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3401 3402 3403
{
    char *caps;

3404
    if (!vshConnectionUsability(ctl, ctl->conn))
3405 3406 3407
        return FALSE;

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
3408
        vshError(ctl, "%s", _("failed to get capabilities"));
3409 3410 3411
        return FALSE;
    }
    vshPrint (ctl, "%s\n", caps);
3412
    VIR_FREE(caps);
3413 3414 3415 3416

    return TRUE;
}

3417 3418 3419
/*
 * "dumpxml" command
 */
3420
static const vshCmdInfo info_dumpxml[] = {
3421 3422
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
3423
    {NULL, NULL}
3424 3425
};

3426
static const vshCmdOptDef opts_dumpxml[] = {
3427 3428 3429
    {"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")},
3430
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
3431
    {NULL, 0, 0, NULL}
3432 3433 3434
};

static int
3435
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
3436
{
3437
    virDomainPtr dom;
K
Karel Zak 已提交
3438
    int ret = TRUE;
3439
    char *dump;
3440 3441 3442
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
3443
    int update = vshCommandOptBool(cmd, "update-cpu");
3444 3445 3446 3447 3448

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
3449 3450
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
3451

3452
    if (!vshConnectionUsability(ctl, ctl->conn))
3453 3454
        return FALSE;

J
Jim Meyering 已提交
3455
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
3456
        return FALSE;
3457

3458
    dump = virDomainGetXMLDesc(dom, flags);
3459
    if (dump != NULL) {
3460
        vshPrint(ctl, "%s", dump);
3461
        VIR_FREE(dump);
3462 3463 3464
    } else {
        ret = FALSE;
    }
3465

3466 3467 3468 3469
    virDomainFree(dom);
    return ret;
}

3470 3471 3472 3473
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
3474 3475
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
3476 3477 3478 3479
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
3480 3481
    {"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")},
3482 3483 3484 3485 3486 3487 3488
    {NULL, 0, 0, NULL}
};

static int
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
    int ret = TRUE;
3489 3490
    const char *format = NULL;
    const char *configFile = NULL;
3491 3492 3493 3494
    char *configData;
    char *xmlData;
    int flags = 0;

3495
    if (!vshConnectionUsability(ctl, ctl->conn))
3496 3497
        return FALSE;

3498 3499 3500
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
        return FALSE;
3501

3502
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
3503 3504 3505 3506
        return FALSE;

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
3507
        vshPrint(ctl, "%s", xmlData);
3508
        VIR_FREE(xmlData);
3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519
    } else {
        ret = FALSE;
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
3520 3521
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
3522 3523 3524 3525
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
3526 3527
    {"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")},
3528 3529 3530 3531 3532 3533 3534
    {NULL, 0, 0, NULL}
};

static int
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
    int ret = TRUE;
3535 3536
    const char *format = NULL;
    const char *xmlFile = NULL;
3537 3538 3539 3540
    char *configData;
    char *xmlData;
    int flags = 0;

3541
    if (!vshConnectionUsability(ctl, ctl->conn))
3542 3543
        return FALSE;

3544 3545 3546
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
        return FALSE;
3547

3548
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
3549 3550 3551 3552
        return FALSE;

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
3553
        vshPrint(ctl, "%s", configData);
3554
        VIR_FREE(configData);
3555 3556 3557 3558 3559 3560 3561
    } else {
        ret = FALSE;
    }

    return ret;
}

K
Karel Zak 已提交
3562
/*
K
Karel Zak 已提交
3563
 * "domname" command
K
Karel Zak 已提交
3564
 */
3565
static const vshCmdInfo info_domname[] = {
3566
    {"help", N_("convert a domain id or UUID to domain name")},
3567
    {"desc", ""},
3568
    {NULL, NULL}
K
Karel Zak 已提交
3569 3570
};

3571
static const vshCmdOptDef opts_domname[] = {
3572
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
3573
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3574 3575 3576
};

static int
3577
cmdDomname(vshControl *ctl, const vshCmd *cmd)
3578
{
K
Karel Zak 已提交
3579 3580
    virDomainPtr dom;

3581
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3582
        return FALSE;
J
Jim Meyering 已提交
3583
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3584
                                      VSH_BYID|VSH_BYUUID)))
K
Karel Zak 已提交
3585
        return FALSE;
3586

K
Karel Zak 已提交
3587 3588
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
K
Karel Zak 已提交
3589 3590 3591 3592
    return TRUE;
}

/*
K
Karel Zak 已提交
3593
 * "domid" command
K
Karel Zak 已提交
3594
 */
3595
static const vshCmdInfo info_domid[] = {
3596
    {"help", N_("convert a domain name or UUID to domain id")},
3597
    {"desc", ""},
3598
    {NULL, NULL}
K
Karel Zak 已提交
3599 3600
};

3601
static const vshCmdOptDef opts_domid[] = {
3602
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
3603
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3604 3605 3606
};

static int
3607
cmdDomid(vshControl *ctl, const vshCmd *cmd)
3608
{
3609
    virDomainPtr dom;
3610
    unsigned int id;
K
Karel Zak 已提交
3611

3612
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3613
        return FALSE;
J
Jim Meyering 已提交
3614
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3615
                                      VSH_BYNAME|VSH_BYUUID)))
K
Karel Zak 已提交
3616
        return FALSE;
3617

3618 3619
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3620
        vshPrint(ctl, "%s\n", "-");
3621
    else
3622
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
3623 3624 3625
    virDomainFree(dom);
    return TRUE;
}
3626

K
Karel Zak 已提交
3627 3628 3629
/*
 * "domuuid" command
 */
3630
static const vshCmdInfo info_domuuid[] = {
3631
    {"help", N_("convert a domain name or id to domain UUID")},
3632
    {"desc", ""},
K
Karel Zak 已提交
3633 3634 3635
    {NULL, NULL}
};

3636
static const vshCmdOptDef opts_domuuid[] = {
3637
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
3638 3639 3640 3641
    {NULL, 0, 0, NULL}
};

static int
3642
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
3643 3644
{
    virDomainPtr dom;
3645
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
3646

3647
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3648
        return FALSE;
J
Jim Meyering 已提交
3649
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3650
                                      VSH_BYNAME|VSH_BYID)))
K
Karel Zak 已提交
3651
        return FALSE;
3652

K
Karel Zak 已提交
3653 3654 3655
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
3656
        vshError(ctl, "%s", _("failed to get domain UUID"));
3657

3658
    virDomainFree(dom);
K
Karel Zak 已提交
3659 3660 3661
    return TRUE;
}

3662 3663 3664
/*
 * "migrate" command
 */
3665
static const vshCmdInfo info_migrate[] = {
3666 3667
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
3668 3669 3670
    {NULL, NULL}
};

3671
static const vshCmdOptDef opts_migrate[] = {
3672 3673 3674 3675 3676 3677 3678
    {"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")},
3679 3680
    {"copy-storage-all", VSH_OT_BOOL, 0, N_("migration with non-shared storage with full disk copy")},
    {"copy-storage-inc", VSH_OT_BOOL, 0, N_("migration with non-shared storage with incremental copy (same base image shared between source and destination)")},
W
Wen Congyang 已提交
3681
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
3682
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3683
    {"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)")},
3684 3685
    {"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 已提交
3686
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
3687 3688 3689
    {NULL, 0, 0, NULL}
};

3690 3691 3692 3693 3694 3695 3696 3697
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
3698
{
3699
    char ret = '1';
3700
    virDomainPtr dom = NULL;
3701 3702 3703 3704
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
    int flags = 0;
3705 3706 3707
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
3708 3709
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;
3710 3711 3712 3713 3714

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
    if (pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask) < 0)
        goto out_sig;
3715
#endif
3716

3717
    if (!vshConnectionUsability (ctl, ctl->conn))
3718
        goto out;
3719

J
Jim Meyering 已提交
3720
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
3721
        goto out;
3722

3723 3724
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
3725 3726
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
3727
        goto out;
3728
    }
3729 3730 3731

    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
3732 3733
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
3734 3735 3736
    if (vshCommandOptBool (cmd, "tunnelled"))
        flags |= VIR_MIGRATE_TUNNELLED;

C
Chris Lalancette 已提交
3737 3738 3739 3740 3741
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

3742 3743 3744
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

3745 3746 3747 3748 3749 3750
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

3751 3752 3753 3754
    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. */
3755

3756
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
3757
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
3758
            goto out;
3759
        }
3760

3761
        if (virDomainMigrateToURI (dom, desturi, flags, dname, 0) == 0)
3762
            ret = '0';
3763 3764 3765 3766 3767 3768
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
3769
        if (!dconn) goto out;
3770 3771 3772 3773

        ddom = virDomainMigrate (dom, dconn, flags, dname, migrateuri, 0);
        if (ddom) {
            virDomainFree(ddom);
3774
            ret = '0';
3775 3776 3777
        }
        virConnectClose (dconn);
    }
3778

3779
out:
3780
#if HAVE_PTHREAD_SIGMASK
3781 3782
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
3783
#endif
3784
    if (dom) virDomainFree (dom);
3785 3786 3787
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811
static void
print_job_progress(unsigned long long remaining, unsigned long long total)
{
    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;
        }
    }

    fprintf(stderr, "\rMigration: [%3d %%]", progress);
}

3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822
static int
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
3823 3824
    virDomainJobInfo jobinfo;
    bool verbose = false;
3825
    int timeout = 0;
W
Wen Congyang 已提交
3826 3827
    struct timeval start, curr;
    bool live_flag = false;
3828
    vshCtrlData data;
3829 3830 3831 3832 3833 3834
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
#endif
3835 3836 3837 3838

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

W
Wen Congyang 已提交
3839 3840 3841
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
3842 3843
    if (vshCommandOptBool (cmd, "live"))
        live_flag = TRUE;
3844
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861
        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;
        }
    }

3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884
    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 已提交
3885
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
3886
    while (1) {
3887
repoll:
W
Wen Congyang 已提交
3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
                    ret = TRUE;
                    if (verbose) {
                        /* print [100 %] */
                        print_job_progress(0, 1);
                    }
                } else
                    ret = FALSE;
3899
            } else
W
Wen Congyang 已提交
3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915
                ret = FALSE;
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    ret = FALSE;
                    intCaught = 0;
                } else
                    goto repoll;
            }
            break;
        }

W
Wen Congyang 已提交
3916 3917 3918 3919 3920 3921 3922 3923 3924
        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. */
            vshDebug(ctl, 5, "suspend the domain when migration timeouts\n");
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
3925
        if (verbose) {
3926
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
3927
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
3928
#endif
W
Wen Congyang 已提交
3929
            ret = virDomainGetJobInfo(dom, &jobinfo);
3930
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
3931
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
3932
#endif
W
Wen Congyang 已提交
3933 3934
            if (ret == 0)
                print_job_progress(jobinfo.dataRemaining, jobinfo.dataTotal);
3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
3946 3947 3948
    return ret;
}

3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959
/*
 * "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")},
3960
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
3961 3962 3963 3964 3965 3966 3967
    {NULL, 0, 0, NULL}
};

static int
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
3968
    long long downtime = 0;
3969 3970
    int ret = FALSE;

3971
    if (!vshConnectionUsability(ctl, ctl->conn))
3972 3973 3974 3975 3976
        return FALSE;

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

3977 3978
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

    ret = TRUE;

done:
    virDomainFree(dom);
    return ret;
}

3993 3994 3995
/*
 * "net-autostart" command
 */
3996
static const vshCmdInfo info_network_autostart[] = {
3997
    {"help", N_("autostart a network")},
3998
    {"desc",
3999
     N_("Configure a network to be automatically started at boot.")},
4000 4001 4002
    {NULL, NULL}
};

4003
static const vshCmdOptDef opts_network_autostart[] = {
4004 4005
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4006 4007 4008 4009
    {NULL, 0, 0, NULL}
};

static int
4010
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
4011 4012
{
    virNetworkPtr network;
4013
    const char *name;
4014 4015
    int autostart;

4016
    if (!vshConnectionUsability(ctl, ctl->conn))
4017 4018
        return FALSE;

J
Jim Meyering 已提交
4019
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
4020 4021 4022 4023 4024
        return FALSE;

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
4025
        if (autostart)
4026
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
4027
        else
4028
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
4029 4030 4031 4032
        virNetworkFree(network);
        return FALSE;
    }

4033
    if (autostart)
4034
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
4035
    else
4036
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
4037

L
Laine Stump 已提交
4038
    virNetworkFree(network);
4039 4040
    return TRUE;
}
K
Karel Zak 已提交
4041

4042 4043 4044
/*
 * "net-create" command
 */
4045
static const vshCmdInfo info_network_create[] = {
4046 4047
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
4048 4049 4050
    {NULL, NULL}
};

4051
static const vshCmdOptDef opts_network_create[] = {
4052
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4053 4054 4055 4056
    {NULL, 0, 0, NULL}
};

static int
4057
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
4058 4059
{
    virNetworkPtr network;
4060
    const char *from = NULL;
4061
    int ret = TRUE;
4062
    char *buffer;
4063

4064
    if (!vshConnectionUsability(ctl, ctl->conn))
4065 4066
        return FALSE;

4067
    if (vshCommandOptString(cmd, "file", &from) <= 0)
4068 4069
        return FALSE;

4070 4071
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
4072 4073

    network = virNetworkCreateXML(ctl->conn, buffer);
4074
    VIR_FREE(buffer);
4075

4076 4077 4078
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4079
        virNetworkFree(network);
4080
    } else {
4081
        vshError(ctl, _("Failed to create network from %s"), from);
4082 4083 4084 4085 4086 4087 4088 4089 4090
        ret = FALSE;
    }
    return ret;
}


/*
 * "net-define" command
 */
4091
static const vshCmdInfo info_network_define[] = {
4092 4093
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
4094 4095 4096
    {NULL, NULL}
};

4097
static const vshCmdOptDef opts_network_define[] = {
4098
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4099 4100 4101 4102
    {NULL, 0, 0, NULL}
};

static int
4103
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
4104 4105
{
    virNetworkPtr network;
4106
    const char *from = NULL;
4107
    int ret = TRUE;
4108
    char *buffer;
4109

4110
    if (!vshConnectionUsability(ctl, ctl->conn))
4111 4112
        return FALSE;

4113
    if (vshCommandOptString(cmd, "file", &from) <= 0)
4114 4115
        return FALSE;

4116 4117
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
4118 4119

    network = virNetworkDefineXML(ctl->conn, buffer);
4120
    VIR_FREE(buffer);
4121

4122 4123 4124
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4125
        virNetworkFree(network);
4126
    } else {
4127
        vshError(ctl, _("Failed to define network from %s"), from);
4128 4129 4130 4131 4132 4133 4134 4135 4136
        ret = FALSE;
    }
    return ret;
}


/*
 * "net-destroy" command
 */
4137
static const vshCmdInfo info_network_destroy[] = {
4138 4139
    {"help", N_("destroy a network")},
    {"desc", N_("Destroy a given network.")},
4140 4141 4142
    {NULL, NULL}
};

4143
static const vshCmdOptDef opts_network_destroy[] = {
4144
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4145 4146 4147 4148
    {NULL, 0, 0, NULL}
};

static int
4149
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
4150 4151 4152
{
    virNetworkPtr network;
    int ret = TRUE;
4153
    const char *name;
4154

4155
    if (!vshConnectionUsability(ctl, ctl->conn))
4156 4157
        return FALSE;

J
Jim Meyering 已提交
4158
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
4159 4160 4161 4162 4163
        return FALSE;

    if (virNetworkDestroy(network) == 0) {
        vshPrint(ctl, _("Network %s destroyed\n"), name);
    } else {
4164
        vshError(ctl, _("Failed to destroy network %s"), name);
4165 4166 4167
        ret = FALSE;
    }

4168
    virNetworkFree(network);
4169 4170 4171 4172 4173 4174 4175
    return ret;
}


/*
 * "net-dumpxml" command
 */
4176
static const vshCmdInfo info_network_dumpxml[] = {
4177 4178
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
4179 4180 4181
    {NULL, NULL}
};

4182
static const vshCmdOptDef opts_network_dumpxml[] = {
4183
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4184 4185 4186 4187
    {NULL, 0, 0, NULL}
};

static int
4188
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
4189 4190 4191 4192 4193
{
    virNetworkPtr network;
    int ret = TRUE;
    char *dump;

4194
    if (!vshConnectionUsability(ctl, ctl->conn))
4195 4196
        return FALSE;

J
Jim Meyering 已提交
4197
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
4198 4199 4200 4201
        return FALSE;

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
4202
        vshPrint(ctl, "%s", dump);
4203
        VIR_FREE(dump);
4204 4205 4206 4207 4208 4209 4210 4211
    } else {
        ret = FALSE;
    }

    virNetworkFree(network);
    return ret;
}

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

static int
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))
        return FALSE;

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
        return FALSE;

    vshPrint(ctl, "%-15s %s\n", _("Name"), virNetworkGetName(network));

    if (virNetworkGetUUIDString(network, uuid) == 0)
        vshPrint(ctl, "%-15s %s\n", _("UUID"), uuid);

    active = virNetworkIsActive(network);
    if (active >= 0)
        vshPrint(ctl, "%-15s %s\n", _("Active:"), active? _("yes") : _("no"));

    persistent = virNetworkIsPersistent(network);
    if (persistent < 0)
        vshPrint(ctl, "%-15s %s\n", _("Persistent:"), _("unknown"));
    else
        vshPrint(ctl, "%-15s %s\n", _("Persistent:"), persistent ? _("yes") : _("no"));

    if (virNetworkGetAutostart(network, &autostart) < 0)
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
    else
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

    bridge = virNetworkGetBridgeName(network);
    if (bridge)
        vshPrint(ctl, "%-15s %s\n", _("Bridge:"), bridge);

    virNetworkFree(network);
    return TRUE;
}
4270

4271 4272 4273 4274
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
4275 4276
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
4277 4278 4279 4280
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
4281
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
    int ret = FALSE;
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
4294
    int flags = VIR_INTERFACE_XML_INACTIVE;
4295

4296
    if (!vshConnectionUsability(ctl, ctl->conn))
4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335
        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));
        ret = TRUE;
        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)) {
4336 4337
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355
        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));

    ret = TRUE;

cleanup:
    if (iface)
        virInterfaceFree (iface);

4356 4357 4358
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
4359 4360 4361

    if (tmp) {
        unlink (tmp);
4362
        VIR_FREE(tmp);
4363 4364 4365 4366 4367
    }

    return ret;
}

4368 4369 4370
/*
 * "net-list" command
 */
4371
static const vshCmdInfo info_network_list[] = {
4372 4373
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
4374 4375 4376
    {NULL, NULL}
};

4377
static const vshCmdOptDef opts_network_list[] = {
4378 4379
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
4380 4381 4382 4383
    {NULL, 0, 0, NULL}
};

static int
4384
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4385 4386 4387 4388 4389
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
4390
    char **activeNames = NULL, **inactiveNames = NULL;
4391 4392
    inactive |= all;

4393
    if (!vshConnectionUsability(ctl, ctl->conn))
4394 4395 4396
        return FALSE;

    if (active) {
4397 4398
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
4399
            vshError(ctl, "%s", _("Failed to list active networks"));
4400
            return FALSE;
4401
        }
4402
        if (maxactive) {
4403
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
4404

4405
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
4406
                                                    maxactive)) < 0) {
4407
                vshError(ctl, "%s", _("Failed to list active networks"));
4408
                VIR_FREE(activeNames);
4409 4410
                return FALSE;
            }
4411

4412
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
4413
        }
4414 4415
    }
    if (inactive) {
4416 4417
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
4418
            vshError(ctl, "%s", _("Failed to list inactive networks"));
4419
            VIR_FREE(activeNames);
4420
            return FALSE;
4421
        }
4422 4423 4424
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4425 4426 4427
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
4428
                vshError(ctl, "%s", _("Failed to list inactive networks"));
4429 4430
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
4431 4432
                return FALSE;
            }
4433

4434 4435
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
4436
    }
4437 4438
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
4439
    vshPrintExtra(ctl, "-----------------------------------------\n");
4440 4441

    for (i = 0; i < maxactive; i++) {
4442 4443
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
4444 4445
        const char *autostartStr;
        int autostart = 0;
4446 4447 4448

        /* this kind of work with networks is not atomic operation */
        if (!network) {
4449
            VIR_FREE(activeNames[i]);
4450
            continue;
4451
        }
4452

4453 4454 4455
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
4456
            autostartStr = autostart ? _("yes") : _("no");
4457 4458 4459 4460 4461

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
4462
        virNetworkFree(network);
4463
        VIR_FREE(activeNames[i]);
4464 4465 4466
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
4467 4468
        const char *autostartStr;
        int autostart = 0;
4469 4470 4471

        /* this kind of work with networks is not atomic operation */
        if (!network) {
4472
            VIR_FREE(inactiveNames[i]);
4473
            continue;
4474
        }
4475

4476 4477 4478
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
4479
            autostartStr = autostart ? _("yes") : _("no");
4480

4481
        vshPrint(ctl, "%-20s %-10s %-10s\n",
4482 4483 4484
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
4485 4486

        virNetworkFree(network);
4487
        VIR_FREE(inactiveNames[i]);
4488
    }
4489 4490
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
4491 4492 4493 4494 4495 4496 4497
    return TRUE;
}


/*
 * "net-name" command
 */
4498
static const vshCmdInfo info_network_name[] = {
4499
    {"help", N_("convert a network UUID to network name")},
4500
    {"desc", ""},
4501 4502 4503
    {NULL, NULL}
};

4504
static const vshCmdOptDef opts_network_name[] = {
4505
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
4506 4507 4508 4509
    {NULL, 0, 0, NULL}
};

static int
4510
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
4511 4512 4513
{
    virNetworkPtr network;

4514
    if (!vshConnectionUsability(ctl, ctl->conn))
4515
        return FALSE;
J
Jim Meyering 已提交
4516
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4517
                                           VSH_BYUUID)))
4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528
        return FALSE;

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
    return TRUE;
}


/*
 * "net-start" command
 */
4529
static const vshCmdInfo info_network_start[] = {
4530 4531
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
4532 4533 4534
    {NULL, NULL}
};

4535
static const vshCmdOptDef opts_network_start[] = {
4536
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
4537 4538 4539 4540
    {NULL, 0, 0, NULL}
};

static int
4541
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
4542 4543 4544 4545
{
    virNetworkPtr network;
    int ret = TRUE;

4546
    if (!vshConnectionUsability(ctl, ctl->conn))
4547 4548
        return FALSE;

J
Jim Meyering 已提交
4549
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
4550
         return FALSE;
4551 4552 4553

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
4554
                 virNetworkGetName(network));
4555
    } else {
4556
        vshError(ctl, _("Failed to start network %s"),
4557
                 virNetworkGetName(network));
4558 4559
        ret = FALSE;
    }
L
Laine Stump 已提交
4560
    virNetworkFree(network);
4561 4562 4563 4564 4565 4566 4567
    return ret;
}


/*
 * "net-undefine" command
 */
4568
static const vshCmdInfo info_network_undefine[] = {
4569 4570
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
4571 4572 4573
    {NULL, NULL}
};

4574
static const vshCmdOptDef opts_network_undefine[] = {
4575
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4576 4577 4578 4579
    {NULL, 0, 0, NULL}
};

static int
4580
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
4581 4582 4583
{
    virNetworkPtr network;
    int ret = TRUE;
4584
    const char *name;
4585

4586
    if (!vshConnectionUsability(ctl, ctl->conn))
4587 4588
        return FALSE;

J
Jim Meyering 已提交
4589
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
4590 4591 4592 4593 4594
        return FALSE;

    if (virNetworkUndefine(network) == 0) {
        vshPrint(ctl, _("Network %s has been undefined\n"), name);
    } else {
4595
        vshError(ctl, _("Failed to undefine network %s"), name);
4596 4597 4598
        ret = FALSE;
    }

L
Laine Stump 已提交
4599
    virNetworkFree(network);
4600 4601 4602 4603 4604 4605 4606
    return ret;
}


/*
 * "net-uuid" command
 */
4607
static const vshCmdInfo info_network_uuid[] = {
4608
    {"help", N_("convert a network name to network UUID")},
4609
    {"desc", ""},
4610 4611 4612
    {NULL, NULL}
};

4613
static const vshCmdOptDef opts_network_uuid[] = {
4614
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
4615 4616 4617 4618
    {NULL, 0, 0, NULL}
};

static int
4619
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
4620 4621 4622 4623
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

4624
    if (!vshConnectionUsability(ctl, ctl->conn))
4625 4626
        return FALSE;

J
Jim Meyering 已提交
4627
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4628
                                           VSH_BYNAME)))
4629 4630 4631 4632 4633
        return FALSE;

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

L
Laine Stump 已提交
4636
    virNetworkFree(network);
4637 4638 4639 4640
    return TRUE;
}


4641 4642 4643 4644 4645
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
4646 4647
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
4648 4649 4650 4651
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
4652 4653
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665
    {NULL, 0, 0, NULL}
};
static int
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;

4666
    if (!vshConnectionUsability(ctl, ctl->conn))
4667 4668 4669 4670 4671
        return FALSE;

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
4672
            vshError(ctl, "%s", _("Failed to list active interfaces"));
4673 4674 4675 4676 4677 4678 4679
            return FALSE;
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
4680
                vshError(ctl, "%s", _("Failed to list active interfaces"));
4681
                VIR_FREE(activeNames);
4682 4683 4684 4685 4686 4687 4688 4689 4690
                return FALSE;
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
4691
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4692
            VIR_FREE(activeNames);
4693 4694 4695 4696 4697
            return FALSE;
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4698 4699 4700
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
4701
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4702 4703
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
4704 4705 4706 4707 4708 4709
                return FALSE;
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
4710 4711
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
4712 4713 4714
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
4715 4716
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
4717 4718 4719

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4720
            VIR_FREE(activeNames[i]);
4721 4722 4723 4724 4725 4726 4727 4728
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4729
        VIR_FREE(activeNames[i]);
4730 4731
    }
    for (i = 0; i < maxinactive; i++) {
4732 4733
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
4734 4735 4736

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4737
            VIR_FREE(inactiveNames[i]);
4738 4739 4740 4741 4742 4743 4744 4745
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4746
        VIR_FREE(inactiveNames[i]);
4747
    }
4748 4749
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
4750 4751 4752 4753 4754 4755 4756 4757
    return TRUE;

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
4758
    {"help", N_("convert an interface MAC address to interface name")},
4759 4760 4761 4762 4763
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
4764
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
4765 4766 4767 4768 4769 4770 4771 4772
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

4773
    if (!vshConnectionUsability(ctl, ctl->conn))
4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787
        return FALSE;
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
        return FALSE;

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
    return TRUE;
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
4788
    {"help", N_("convert an interface name to interface MAC address")},
4789 4790 4791 4792 4793
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
4794
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
4795 4796 4797 4798 4799 4800 4801 4802
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

4803
    if (!vshConnectionUsability(ctl, ctl->conn))
4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817
        return FALSE;
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
        return FALSE;

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
    return TRUE;
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
4818 4819
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
4820 4821 4822 4823
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
4824 4825
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
4826 4827 4828 4829 4830 4831 4832 4833 4834
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
    int ret = TRUE;
    char *dump;
4835 4836 4837 4838 4839
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
4840

4841
    if (!vshConnectionUsability(ctl, ctl->conn))
4842 4843 4844 4845 4846
        return FALSE;

    if (!(iface = vshCommandOptInterface(ctl, cmd, NULL)))
        return FALSE;

4847
    dump = virInterfaceGetXMLDesc(iface, flags);
4848
    if (dump != NULL) {
4849
        vshPrint(ctl, "%s", dump);
4850
        VIR_FREE(dump);
4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862
    } else {
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
4863 4864
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
4865 4866 4867 4868
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
4869
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
4870 4871 4872 4873 4874 4875
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
4876
    virInterfacePtr iface;
4877
    const char *from = NULL;
4878 4879 4880
    int ret = TRUE;
    char *buffer;

4881
    if (!vshConnectionUsability(ctl, ctl->conn))
4882 4883
        return FALSE;

4884
    if (vshCommandOptString(cmd, "file", &from) <= 0)
4885 4886 4887 4888 4889
        return FALSE;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;

4890
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
4891
    VIR_FREE(buffer);
4892

4893
    if (iface != NULL) {
4894
        vshPrint(ctl, _("Interface %s defined from %s\n"),
4895
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
4896
        virInterfaceFree (iface);
4897
    } else {
4898
        vshError(ctl, _("Failed to define interface from %s"), from);
4899 4900 4901 4902 4903 4904 4905 4906 4907
        ret = FALSE;
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
4908 4909
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
4910 4911 4912 4913
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
4914
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4915 4916 4917 4918 4919 4920 4921 4922
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
    int ret = TRUE;
4923
    const char *name;
4924

4925
    if (!vshConnectionUsability(ctl, ctl->conn))
4926 4927 4928 4929 4930 4931 4932 4933
        return FALSE;

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
        return FALSE;

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
4934
        vshError(ctl, _("Failed to undefine interface %s"), name);
4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
4946 4947
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
4948 4949 4950 4951
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
4952
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4953 4954 4955 4956 4957 4958 4959 4960
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
    int ret = TRUE;
4961
    const char *name;
4962

4963
    if (!vshConnectionUsability(ctl, ctl->conn))
4964 4965 4966 4967 4968 4969 4970 4971
        return FALSE;

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
        return FALSE;

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
4972
        vshError(ctl, _("Failed to start interface %s"), name);
4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
4984 4985
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
    {"desc", N_("destroy a physical host interface.")},
4986 4987 4988 4989
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
4990
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4991 4992 4993 4994 4995 4996 4997 4998
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
    int ret = TRUE;
4999
    const char *name;
5000

5001
    if (!vshConnectionUsability(ctl, ctl->conn))
5002 5003 5004 5005 5006 5007 5008 5009
        return FALSE;

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
        return FALSE;

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
5010
        vshError(ctl, _("Failed to destroy interface %s"), name);
5011 5012 5013 5014 5015 5016 5017
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036

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

static int
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
5037
    const char *from = NULL;
5038 5039 5040
    int ret = TRUE;
    char *buffer;

5041
    if (!vshConnectionUsability(ctl, ctl->conn))
5042 5043
        return FALSE;

5044
    if (vshCommandOptString(cmd, "file", &from) <= 0)
5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083
        return FALSE;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;

    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);
        ret = FALSE;
    }
    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}
};

static int
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
    int ret = TRUE;
5084
    const char *name;
5085

5086
    if (!vshConnectionUsability(ctl, ctl->conn))
5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124
        return FALSE;

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
        return FALSE;

    if (virNWFilterUndefine(nwfilter) == 0) {
        vshPrint(ctl, _("Network filter %s undefined\n"), name);
    } else {
        vshError(ctl, _("Failed to undefine network filter %s"), name);
        ret = FALSE;
    }

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

static int
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
    int ret = TRUE;
    char *dump;

5125
    if (!vshConnectionUsability(ctl, ctl->conn))
5126 5127 5128 5129 5130 5131 5132
        return FALSE;

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
        return FALSE;

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
5133
        vshPrint(ctl, "%s", dump);
5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162
        VIR_FREE(dump);
    } else {
        ret = FALSE;
    }

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

static int
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

5163
    if (!vshConnectionUsability(ctl, ctl->conn))
5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233
        return FALSE;

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
        return FALSE;
    }

    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);
        return FALSE;
    }

    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);
    return TRUE;
}


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

static int
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
    int ret = FALSE;
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

5234
    if (!vshConnectionUsability(ctl, ctl->conn))
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 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
        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));
        ret = TRUE;
        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));

    ret = TRUE;

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


5307
/**************************************************************************/
5308
/*
5309
 * "pool-autostart" command
5310
 */
5311
static const vshCmdInfo info_pool_autostart[] = {
5312
    {"help", N_("autostart a pool")},
5313
    {"desc",
5314
     N_("Configure a pool to be automatically started at boot.")},
5315
    {NULL, NULL}
5316 5317
};

5318
static const vshCmdOptDef opts_pool_autostart[] = {
5319 5320
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5321 5322
    {NULL, 0, 0, NULL}
};
5323 5324

static int
5325
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
5326
{
5327
    virStoragePoolPtr pool;
5328
    const char *name;
5329
    int autostart;
5330

5331
    if (!vshConnectionUsability(ctl, ctl->conn))
5332
        return FALSE;
5333

5334
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
5335 5336
        return FALSE;

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

5339 5340
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
5341
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
5342
        else
5343
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
5344
        virStoragePoolFree(pool);
5345 5346 5347
        return FALSE;
    }

5348
    if (autostart)
5349
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
5350
    else
5351
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
5352

L
Laine Stump 已提交
5353
    virStoragePoolFree(pool);
5354 5355 5356
    return TRUE;
}

5357
/*
5358
 * "pool-create" command
5359
 */
5360
static const vshCmdInfo info_pool_create[] = {
5361 5362
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
5363 5364 5365
    {NULL, NULL}
};

5366
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
5367
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
5368
     N_("file containing an XML pool description")},
5369 5370 5371
    {NULL, 0, 0, NULL}
};

5372
static int
5373
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
5374
{
5375
    virStoragePoolPtr pool;
5376
    const char *from = NULL;
5377 5378
    int ret = TRUE;
    char *buffer;
5379

5380
    if (!vshConnectionUsability(ctl, ctl->conn))
5381 5382
        return FALSE;

5383
    if (vshCommandOptString(cmd, "file", &from) <= 0)
5384 5385
        return FALSE;

5386 5387
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
5388

5389
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
5390
    VIR_FREE(buffer);
5391 5392 5393 5394

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5395
        virStoragePoolFree(pool);
5396
    } else {
5397
        vshError(ctl, _("Failed to create pool from %s"), from);
5398 5399 5400
        ret = FALSE;
    }
    return ret;
5401 5402
}

5403

5404 5405 5406 5407
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
5408
    {"help", N_("create a device defined "
5409
                          "by an XML file on the node")},
5410
    {"desc", N_("Create a device on the node.  Note that this "
5411 5412 5413 5414 5415 5416 5417
                          "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,
5418
     N_("file containing an XML description of the device")},
5419 5420 5421 5422 5423 5424 5425
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
5426
    const char *from = NULL;
5427 5428 5429
    int ret = TRUE;
    char *buffer;

5430
    if (!vshConnectionUsability(ctl, ctl->conn))
5431 5432
        return FALSE;

5433
    if (vshCommandOptString(cmd, "file", &from) <= 0)
5434 5435
        return FALSE;

5436
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
5437 5438 5439
        return FALSE;

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
5440
    VIR_FREE(buffer);
5441 5442 5443 5444

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
5445
        virNodeDeviceFree(dev);
5446
    } else {
5447
        vshError(ctl, _("Failed to create node device from %s"), from);
5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458
        ret = FALSE;
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
5459 5460
    {"help", N_("destroy a device on the node")},
    {"desc", N_("Destroy a device on the node.  Note that this "
5461 5462 5463 5464 5465 5466
                          "command destroys devices on the physical host ")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
5467
     N_("name of the device to be destroyed")},
5468 5469 5470 5471 5472 5473 5474 5475
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
    int ret = TRUE;
5476
    const char *name = NULL;
5477

5478
    if (!vshConnectionUsability(ctl, ctl->conn)) {
5479 5480 5481
        return FALSE;
    }

5482
    if (vshCommandOptString(cmd, "name", &name) <= 0)
5483 5484 5485 5486 5487 5488 5489
        return FALSE;

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
5490
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
5491 5492 5493 5494 5495 5496 5497 5498
        ret = FALSE;
    }

    virNodeDeviceFree(dev);
    return ret;
}


5499
/*
5500
 * XML Building helper for pool-define-as and pool-create-as
5501
 */
5502
static const vshCmdOptDef opts_pool_X_as[] = {
5503 5504 5505 5506 5507 5508 5509 5510
    {"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")},
5511
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
5512 5513 5514
    {NULL, 0, 0, NULL}
};

5515
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
5516

5517 5518
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
5519
    virBuffer buf = VIR_BUFFER_INITIALIZER;
5520

5521
    if (vshCommandOptString(cmd, "name", &name) <= 0)
5522
        goto cleanup;
5523
    if (vshCommandOptString(cmd, "type", &type) <= 0)
5524 5525
        goto cleanup;

5526 5527 5528 5529 5530
    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 ||
5531 5532
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
5533
        goto cleanup;
5534
    }
5535

5536 5537
    virBufferVSprintf(&buf, "<pool type='%s'>\n", type);
    virBufferVSprintf(&buf, "  <name>%s</name>\n", name);
5538
    if (srcHost || srcPath || srcDev) {
5539
        virBufferAddLit(&buf, "  <source>\n");
5540

5541 5542
        if (srcHost)
            virBufferVSprintf(&buf, "    <host name='%s'/>\n", srcHost);
5543 5544 5545 5546
        if (srcPath)
            virBufferVSprintf(&buf, "    <dir path='%s'/>\n", srcPath);
        if (srcDev)
            virBufferVSprintf(&buf, "    <device path='%s'/>\n", srcDev);
5547 5548
        if (srcFormat)
            virBufferVSprintf(&buf, "    <format type='%s'/>\n", srcFormat);
5549 5550
        if (srcName)
            virBufferVSprintf(&buf, "    <name>%s</name>\n", srcName);
5551 5552

        virBufferAddLit(&buf, "  </source>\n");
5553 5554
    }
    if (target) {
5555 5556 5557
        virBufferAddLit(&buf, "  <target>\n");
        virBufferVSprintf(&buf, "    <path>%s</path>\n", target);
        virBufferAddLit(&buf, "  </target>\n");
5558
    }
5559 5560 5561 5562 5563 5564
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
    }
5565 5566 5567 5568 5569 5570

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
    return TRUE;

cleanup:
5571
    virBufferFreeAndReset(&buf);
5572 5573 5574 5575 5576 5577 5578
    return FALSE;
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
5579 5580
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
5581 5582 5583 5584 5585 5586 5587
    {NULL, NULL}
};

static int
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
5588 5589
    const char *name;
    char *xml;
5590
    int printXML = vshCommandOptBool(cmd, "print-xml");
5591

5592
    if (!vshConnectionUsability(ctl, ctl->conn))
5593 5594 5595 5596
        return FALSE;

    if (!buildPoolXML(cmd, &name, &xml))
        return FALSE;
5597

5598
    if (printXML) {
5599
        vshPrint(ctl, "%s", xml);
5600
        VIR_FREE(xml);
5601
    } else {
5602
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
5603
        VIR_FREE(xml);
5604

5605 5606 5607 5608
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
5609
            vshError(ctl, _("Failed to create pool %s"), name);
5610 5611 5612 5613
            return FALSE;
        }
    }
    return TRUE;
5614 5615
}

5616

5617
/*
5618
 * "pool-define" command
5619
 */
5620
static const vshCmdInfo info_pool_define[] = {
5621 5622
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
5623 5624 5625
    {NULL, NULL}
};

5626
static const vshCmdOptDef opts_pool_define[] = {
5627
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
5628 5629 5630
    {NULL, 0, 0, NULL}
};

5631
static int
5632
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
5633
{
5634
    virStoragePoolPtr pool;
5635
    const char *from = NULL;
5636 5637
    int ret = TRUE;
    char *buffer;
5638

5639
    if (!vshConnectionUsability(ctl, ctl->conn))
5640 5641
        return FALSE;

5642
    if (vshCommandOptString(cmd, "file", &from) <= 0)
5643 5644
        return FALSE;

5645 5646
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
5647

5648
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
5649
    VIR_FREE(buffer);
5650 5651 5652 5653

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5654
        virStoragePoolFree(pool);
5655
    } else {
5656
        vshError(ctl, _("Failed to define pool from %s"), from);
5657 5658 5659
        ret = FALSE;
    }
    return ret;
5660 5661
}

5662

5663 5664 5665
/*
 * "pool-define-as" command
 */
5666
static const vshCmdInfo info_pool_define_as[] = {
5667 5668
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
5669 5670 5671 5672
    {NULL, NULL}
};

static int
5673
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
5674 5675
{
    virStoragePoolPtr pool;
5676 5677
    const char *name;
    char *xml;
5678
    int printXML = vshCommandOptBool(cmd, "print-xml");
5679

5680
    if (!vshConnectionUsability(ctl, ctl->conn))
5681 5682
        return FALSE;

5683
    if (!buildPoolXML(cmd, &name, &xml))
5684 5685
        return FALSE;

5686
    if (printXML) {
5687
        vshPrint(ctl, "%s", xml);
5688
        VIR_FREE(xml);
5689
    } else {
5690
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
5691
        VIR_FREE(xml);
5692

5693 5694 5695 5696
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
5697
            vshError(ctl, _("Failed to define pool %s"), name);
5698 5699 5700 5701
            return FALSE;
        }
    }
    return TRUE;
5702 5703 5704
}


5705
/*
5706
 * "pool-build" command
5707
 */
5708
static const vshCmdInfo info_pool_build[] = {
5709 5710
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
5711 5712 5713
    {NULL, NULL}
};

5714
static const vshCmdOptDef opts_pool_build[] = {
5715
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5716 5717 5718 5719
    {NULL, 0, 0, NULL}
};

static int
5720
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
5721
{
5722 5723
    virStoragePoolPtr pool;
    int ret = TRUE;
5724
    const char *name;
5725

5726
    if (!vshConnectionUsability(ctl, ctl->conn))
5727 5728
        return FALSE;

5729
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
5730 5731
        return FALSE;

5732
    if (virStoragePoolBuild(pool, 0) == 0) {
5733
        vshPrint(ctl, _("Pool %s built\n"), name);
5734
    } else {
5735
        vshError(ctl, _("Failed to build pool %s"), name);
5736
        ret = FALSE;
5737 5738
    }

5739 5740
    virStoragePoolFree(pool);

5741 5742 5743
    return ret;
}

5744

5745
/*
5746
 * "pool-destroy" command
5747
 */
5748
static const vshCmdInfo info_pool_destroy[] = {
5749 5750
    {"help", N_("destroy a pool")},
    {"desc", N_("Destroy a given pool.")},
5751 5752 5753
    {NULL, NULL}
};

5754
static const vshCmdOptDef opts_pool_destroy[] = {
5755
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5756 5757 5758 5759
    {NULL, 0, 0, NULL}
};

static int
5760
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
5761
{
5762 5763
    virStoragePoolPtr pool;
    int ret = TRUE;
5764
    const char *name;
5765

5766
    if (!vshConnectionUsability(ctl, ctl->conn))
5767 5768
        return FALSE;

5769
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
5770 5771
        return FALSE;

5772 5773 5774
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
5775
        vshError(ctl, _("Failed to destroy pool %s"), name);
5776
        ret = FALSE;
5777 5778
    }

5779
    virStoragePoolFree(pool);
5780 5781 5782
    return ret;
}

5783

5784
/*
5785 5786
 * "pool-delete" command
 */
5787
static const vshCmdInfo info_pool_delete[] = {
5788 5789
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
5790 5791 5792
    {NULL, NULL}
};

5793
static const vshCmdOptDef opts_pool_delete[] = {
5794
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5795 5796 5797 5798
    {NULL, 0, 0, NULL}
};

static int
5799
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
5800 5801 5802
{
    virStoragePoolPtr pool;
    int ret = TRUE;
5803
    const char *name;
5804

5805
    if (!vshConnectionUsability(ctl, ctl->conn))
5806 5807 5808 5809 5810 5811
        return FALSE;

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
        return FALSE;

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
5812
        vshPrint(ctl, _("Pool %s deleted\n"), name);
5813
    } else {
5814
        vshError(ctl, _("Failed to delete pool %s"), name);
5815 5816 5817
        ret = FALSE;
    }

L
Laine Stump 已提交
5818
    virStoragePoolFree(pool);
5819 5820 5821 5822 5823 5824 5825
    return ret;
}


/*
 * "pool-refresh" command
 */
5826
static const vshCmdInfo info_pool_refresh[] = {
5827 5828
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
5829 5830 5831
    {NULL, NULL}
};

5832
static const vshCmdOptDef opts_pool_refresh[] = {
5833
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5834 5835 5836 5837
    {NULL, 0, 0, NULL}
};

static int
5838
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
5839 5840 5841
{
    virStoragePoolPtr pool;
    int ret = TRUE;
5842
    const char *name;
5843

5844
    if (!vshConnectionUsability(ctl, ctl->conn))
5845 5846 5847 5848 5849 5850 5851 5852
        return FALSE;

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
        return FALSE;

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
5853
        vshError(ctl, _("Failed to refresh pool %s"), name);
5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864
        ret = FALSE;
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
5865
static const vshCmdInfo info_pool_dumpxml[] = {
5866 5867
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
5868 5869 5870
    {NULL, NULL}
};

5871
static const vshCmdOptDef opts_pool_dumpxml[] = {
5872
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5873 5874 5875 5876
    {NULL, 0, 0, NULL}
};

static int
5877
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
5878 5879 5880 5881 5882
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *dump;

5883
    if (!vshConnectionUsability(ctl, ctl->conn))
5884 5885 5886 5887 5888 5889 5890
        return FALSE;

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
        return FALSE;

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
5891
        vshPrint(ctl, "%s", dump);
5892
        VIR_FREE(dump);
5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904
    } else {
        ret = FALSE;
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
5905
static const vshCmdInfo info_pool_list[] = {
5906 5907
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
5908 5909 5910
    {NULL, NULL}
};

5911
static const vshCmdOptDef opts_pool_list[] = {
5912 5913
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
5914
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
5915 5916 5917 5918
    {NULL, 0, 0, NULL}
};

static int
5919
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5920
{
5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939
    virStoragePoolInfo info;
    char **poolNames = NULL;
    int i, functionReturn, ret;
    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 */
5940
    int all = vshCommandOptBool(cmd, "all");
5941 5942
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
5943 5944 5945
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

5946
    /* Check the connection to libvirtd daemon is still working */
5947
    if (!vshConnectionUsability(ctl, ctl->conn))
5948 5949
        return FALSE;

5950
    /* Retrieve the number of active storage pools */
5951
    if (active) {
5952 5953
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
5954
            vshError(ctl, "%s", _("Failed to list active pools"));
5955 5956 5957
            return FALSE;
        }
    }
5958 5959

    /* Retrieve the number of inactive storage pools */
5960
    if (inactive) {
5961 5962
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
5963
            vshError(ctl, "%s", _("Failed to list inactive pools"));
5964 5965
            return FALSE;
        }
5966
    }
5967

5968 5969
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
5970

5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983
    /* 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);
            return FALSE;
5984 5985 5986
        }
    }

5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997
    /* 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);
            return FALSE;
        }
    }
5998

5999 6000 6001 6002 6003 6004 6005 6006 6007 6008
    /* 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]);
6009
        if (!pool) {
6010
            VIR_FREE(poolNames[i]);
6011 6012 6013
            continue;
        }

6014
        /* Retrieve the autostart status of the pool */
6015
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
6016
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
6017
        else
6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
            vshDebug(ctl, 5, "Persistent flag value: %d\n", persistent);
            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;
        }
6036

6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148
        /* 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 */
6149 6150 6151
        virStoragePoolFree(pool);
    }

6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169
    /* 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);
6170 6171
        }

6172 6173 6174 6175
        /* Cleanup and return */
        functionReturn = TRUE;
        goto cleanup;
    }
6176

6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286
    /* 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. */
    vshDebug(ctl, 5, "Longest name string = %lu chars\n",
             (unsigned long) nameStrLength);
    vshDebug(ctl, 5, "Longest state string = %lu chars\n",
             (unsigned long) stateStrLength);
    vshDebug(ctl, 5, "Longest autostart string = %lu chars\n",
             (unsigned long) autostartStrLength);
    vshDebug(ctl, 5, "Longest persistent string = %lu chars\n",
             (unsigned long) persistStrLength);
    vshDebug(ctl, 5, "Longest capacity string = %lu chars\n",
             (unsigned long) capStrLength);
    vshDebug(ctl, 5, "Longest allocation string = %lu chars\n",
             (unsigned long) allocStrLength);
    vshDebug(ctl, 5, "Longest available string = %lu chars\n",
             (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 */
    functionReturn = TRUE;
    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);
    }
    functionReturn = FALSE;
6287

6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299
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]);
6300
    }
6301 6302 6303 6304 6305 6306 6307

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

    /* Return the desired value */
    return functionReturn;
6308 6309
}

6310 6311 6312 6313
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
6314 6315
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6316 6317 6318 6319 6320
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6321 6322 6323
     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")},
6324
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
6325 6326 6327 6328 6329 6330
    {NULL, 0, 0, NULL}
};

static int
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6331
    const char *type = NULL, *host = NULL;
6332 6333
    char *srcSpec = NULL;
    char *srcList;
6334
    const char *initiator = NULL;
6335

6336 6337
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
6338 6339
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
6340
        return FALSE;
6341
    }
6342

6343
    if (!vshConnectionUsability(ctl, ctl->conn))
6344 6345 6346
        return FALSE;

    if (host) {
6347
        const char *port = NULL;
6348
        virBuffer buf = VIR_BUFFER_INITIALIZER;
6349 6350 6351 6352 6353 6354

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
            return FALSE;
        }
6355
        virBufferAddLit(&buf, "<source>\n");
6356
        virBufferVSprintf(&buf, "  <host name='%s'", host);
6357 6358 6359
        if (port)
            virBufferVSprintf(&buf, " port='%s'", port);
        virBufferAddLit(&buf, "/>\n");
6360 6361 6362 6363 6364
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
            virBufferVSprintf(&buf, "    <iqn name='%s'/>\n", initiator);
            virBufferAddLit(&buf, "  </initiator>\n");
        }
6365 6366 6367
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
6368 6369
            return FALSE;
        }
6370
        srcSpec = virBufferContentAndReset(&buf);
6371 6372 6373
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6374
    VIR_FREE(srcSpec);
6375
    if (srcList == NULL) {
6376
        vshError(ctl, _("Failed to find any %s pool sources"), type);
6377 6378 6379
        return FALSE;
    }
    vshPrint(ctl, "%s", srcList);
6380
    VIR_FREE(srcList);
6381 6382 6383 6384 6385 6386 6387 6388 6389

    return TRUE;
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
6390 6391
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6392 6393 6394 6395 6396
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6397
     N_("type of storage pool sources to discover")},
6398
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
6399
     N_("optional file of source xml to query for pools")},
6400 6401 6402 6403 6404 6405
    {NULL, 0, 0, NULL}
};

static int
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6406
    const char *type = NULL, *srcSpecFile = NULL;
6407
    char *srcSpec = NULL, *srcList;
6408

6409 6410 6411
    if (vshCommandOptString(cmd, "type", &type) <= 0)
        return FALSE;

6412 6413
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
6414
        return FALSE;
6415
    }
6416

6417
    if (!vshConnectionUsability(ctl, ctl->conn))
6418 6419 6420 6421 6422 6423
        return FALSE;

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
        return FALSE;

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6424
    VIR_FREE(srcSpec);
6425
    if (srcList == NULL) {
6426
        vshError(ctl, _("Failed to find any %s pool sources"), type);
6427 6428 6429
        return FALSE;
    }
    vshPrint(ctl, "%s", srcList);
6430
    VIR_FREE(srcList);
6431 6432 6433 6434 6435

    return TRUE;
}


6436 6437 6438
/*
 * "pool-info" command
 */
6439
static const vshCmdInfo info_pool_info[] = {
6440 6441
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
6442 6443 6444
    {NULL, NULL}
};

6445
static const vshCmdOptDef opts_pool_info[] = {
6446
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6447 6448 6449 6450
    {NULL, 0, 0, NULL}
};

static int
6451
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
6452 6453 6454
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
6455 6456
    int autostart = 0;
    int persistent = 0;
6457 6458 6459
    int ret = TRUE;
    char uuid[VIR_UUID_STRING_BUFLEN];

6460
    if (!vshConnectionUsability(ctl, ctl->conn))
6461 6462 6463 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
        return FALSE;

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
        return FALSE;

    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;
6491 6492 6493 6494
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
6495 6496
        }

6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
        vshDebug(ctl, 5, "Pool persistent flag value: %d\n", persistent);
        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);
        vshDebug(ctl, 5, "Pool autostart flag value: %d\n", autostart);
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535
        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 {
        ret = FALSE;
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
6536
static const vshCmdInfo info_pool_name[] = {
6537
    {"help", N_("convert a pool UUID to pool name")},
6538
    {"desc", ""},
6539 6540 6541
    {NULL, NULL}
};

6542
static const vshCmdOptDef opts_pool_name[] = {
6543
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
6544 6545 6546 6547
    {NULL, 0, 0, NULL}
};

static int
6548
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
6549 6550 6551
{
    virStoragePoolPtr pool;

6552
    if (!vshConnectionUsability(ctl, ctl->conn))
6553 6554
        return FALSE;
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6555
                                           VSH_BYUUID)))
6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566
        return FALSE;

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
    return TRUE;
}


/*
 * "pool-start" command
 */
6567
static const vshCmdInfo info_pool_start[] = {
6568 6569
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
6570 6571 6572
    {NULL, NULL}
};

6573
static const vshCmdOptDef opts_pool_start[] = {
6574
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
6575 6576 6577 6578
    {NULL, 0, 0, NULL}
};

static int
6579
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
6580 6581 6582 6583
{
    virStoragePoolPtr pool;
    int ret = TRUE;

6584
    if (!vshConnectionUsability(ctl, ctl->conn))
6585 6586
        return FALSE;

6587
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
6588 6589 6590 6591 6592 6593
         return FALSE;

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
6594
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
6595 6596
        ret = FALSE;
    }
L
Laine Stump 已提交
6597 6598

    virStoragePoolFree(pool);
6599 6600 6601 6602
    return ret;
}


6603 6604 6605
/*
 * "vol-create-as" command
 */
6606
static const vshCmdInfo info_vol_create_as[] = {
6607 6608
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
6609 6610 6611
    {NULL, NULL}
};

6612
static const vshCmdOptDef opts_vol_create_as[] = {
6613 6614 6615 6616 6617
    {"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")},
6618 6619
    {"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")},
6620 6621 6622 6623 6624 6625 6626 6627 6628 6629
    {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 已提交
6630
        /* Deliberate fallthrough cases here :-) */
6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651
        switch (*end) {
        case 'T':
            *val *= 1024;
        case 'G':
            *val *= 1024;
        case 'M':
            *val *= 1024;
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

static int
6652
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
6653 6654 6655
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
6656
    char *xml;
6657 6658
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
6659
    unsigned long long capacity, allocation = 0;
6660
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6661

6662
    if (!vshConnectionUsability(ctl, ctl->conn))
6663 6664 6665 6666 6667 6668
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
                                     VSH_BYNAME)))
        return FALSE;

6669
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6670 6671
        goto cleanup;

6672
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
6673 6674
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
6675
        vshError(ctl, _("Malformed size %s"), capacityStr);
6676

6677 6678
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
6679
        vshError(ctl, _("Malformed size %s"), allocationStr);
6680

6681 6682 6683 6684 6685 6686 6687
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

6688

6689 6690 6691 6692 6693
    virBufferAddLit(&buf, "<volume>\n");
    virBufferVSprintf(&buf, "  <name>%s</name>\n", name);
    virBufferVSprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
    if (allocationStr)
        virBufferVSprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
6694 6695

    if (format) {
6696
        virBufferAddLit(&buf, "  <target>\n");
6697
        virBufferVSprintf(&buf, "    <format type='%s'/>\n",format);
6698
        virBufferAddLit(&buf, "  </target>\n");
6699
    }
6700

6701 6702 6703 6704 6705 6706 6707 6708 6709 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 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
        vshDebug(ctl, 5, "%s: Look up backing store volume '%s' as name\n",
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
                vshDebug(ctl, 5, "%s: Backing store volume found using '%s' as name\n",
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
            vshDebug(ctl, 5, "%s: Look up backing store volume '%s' as key\n",
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
                vshDebug(ctl, 5, "%s: Backing store volume found using '%s' as key\n",
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
            vshDebug(ctl, 5, "%s: Look up backing store volume '%s' as path\n",
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
                vshDebug(ctl, 5, "%s: Backing store volume found using '%s' as path\n",
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
            return FALSE;
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
            return FALSE;
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
        virBufferVSprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
        if (snapshotStrFormat)
            virBufferVSprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

6757 6758 6759 6760 6761 6762
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
6763
    VIR_FREE(xml);
6764 6765 6766 6767 6768 6769 6770
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
        return TRUE;
    } else {
6771
        vshError(ctl, _("Failed to create vol %s"), name);
6772 6773 6774 6775
        return FALSE;
    }

 cleanup:
6776
    virBufferFreeAndReset(&buf);
6777 6778 6779 6780 6781
    virStoragePoolFree(pool);
    return FALSE;
}


6782 6783 6784
/*
 * "pool-undefine" command
 */
6785
static const vshCmdInfo info_pool_undefine[] = {
6786 6787
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
6788 6789 6790
    {NULL, NULL}
};

6791
static const vshCmdOptDef opts_pool_undefine[] = {
6792
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6793 6794 6795 6796
    {NULL, 0, 0, NULL}
};

static int
6797
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
6798 6799 6800
{
    virStoragePoolPtr pool;
    int ret = TRUE;
6801
    const char *name;
6802

6803
    if (!vshConnectionUsability(ctl, ctl->conn))
6804 6805 6806 6807 6808 6809 6810 6811
        return FALSE;

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
        return FALSE;

    if (virStoragePoolUndefine(pool) == 0) {
        vshPrint(ctl, _("Pool %s has been undefined\n"), name);
    } else {
6812
        vshError(ctl, _("Failed to undefine pool %s"), name);
6813 6814 6815
        ret = FALSE;
    }

L
Laine Stump 已提交
6816
    virStoragePoolFree(pool);
6817 6818 6819 6820 6821 6822 6823
    return ret;
}


/*
 * "pool-uuid" command
 */
6824
static const vshCmdInfo info_pool_uuid[] = {
6825
    {"help", N_("convert a pool name to pool UUID")},
6826
    {"desc", ""},
6827 6828 6829
    {NULL, NULL}
};

6830
static const vshCmdOptDef opts_pool_uuid[] = {
6831
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
6832 6833 6834 6835
    {NULL, 0, 0, NULL}
};

static int
6836
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
6837 6838 6839 6840
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

6841
    if (!vshConnectionUsability(ctl, ctl->conn))
6842 6843 6844
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6845
                                           VSH_BYNAME)))
6846 6847 6848 6849 6850
        return FALSE;

    if (virStoragePoolGetUUIDString(pool, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
6851
        vshError(ctl, "%s", _("failed to get pool UUID"));
6852

L
Laine Stump 已提交
6853
    virStoragePoolFree(pool);
6854 6855 6856 6857 6858 6859 6860
    return TRUE;
}


/*
 * "vol-create" command
 */
6861
static const vshCmdInfo info_vol_create[] = {
6862 6863
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
6864 6865 6866
    {NULL, NULL}
};

6867
static const vshCmdOptDef opts_vol_create[] = {
6868 6869
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
6870 6871 6872 6873
    {NULL, 0, 0, NULL}
};

static int
6874
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
6875 6876 6877
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
6878
    const char *from = NULL;
6879 6880 6881
    int ret = TRUE;
    char *buffer;

6882
    if (!vshConnectionUsability(ctl, ctl->conn))
6883 6884 6885
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6886
                                           VSH_BYNAME)))
6887 6888
        return FALSE;

6889
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
6890 6891 6892 6893 6894
        virStoragePoolFree(pool);
        return FALSE;
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
6895
        virshReportError(ctl);
6896 6897 6898 6899 6900
        virStoragePoolFree(pool);
        return FALSE;
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
6901
    VIR_FREE(buffer);
6902 6903 6904 6905 6906 6907 6908
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
6909
        vshError(ctl, _("Failed to create vol from %s"), from);
6910 6911 6912 6913 6914
        ret = FALSE;
    }
    return ret;
}

6915 6916 6917 6918
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
6919 6920
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
6921 6922 6923 6924
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
6925 6926 6927 6928
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("input vol name or key")},
6929 6930 6931 6932 6933 6934 6935 6936
    {NULL, 0, 0, NULL}
};

static int
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
6937
    const char *from = NULL;
6938 6939 6940
    int ret = FALSE;
    char *buffer = NULL;

6941
    if (!vshConnectionUsability(ctl, ctl->conn))
6942 6943 6944 6945 6946
        goto cleanup;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
        goto cleanup;

6947
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
6948 6949 6950 6951 6952 6953 6954
        goto cleanup;
    }

    if (!(inputvol = vshCommandOptVol(ctl, cmd, "vol", "inputpool", NULL)))
        goto cleanup;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
6955
        virshReportError(ctl);
6956 6957 6958 6959 6960 6961 6962 6963 6964
        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 {
6965
        vshError(ctl, _("Failed to create vol from %s"), from);
6966 6967 6968 6969 6970
        goto cleanup;
    }

    ret = TRUE;
cleanup:
6971
    VIR_FREE(buffer);
6972 6973 6974 6975
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
6976 6977
    if (newvol)
        virStorageVolFree(newvol);
6978 6979 6980 6981
    return ret;
}

static xmlChar *
6982
makeCloneXML(const char *origxml, const char *newname) {
6983

6984 6985 6986
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016
    xmlChar *newxml = NULL;
    int size;

    doc = xmlReadDoc((const xmlChar *) origxml, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET | XML_PARSE_NOWARNING);
    if (!doc)
        goto cleanup;
    ctxt = xmlXPathNewContext(doc);
    if (!ctxt)
        goto cleanup;

    obj = xmlXPathEval(BAD_CAST "/volume/name", ctxt);
    if ((obj == NULL) || (obj->nodesetval == NULL) ||
        (obj->nodesetval->nodeTab == NULL))
        goto cleanup;

    xmlNodeSetContent(obj->nodesetval->nodeTab[0], (const xmlChar *)newname);
    xmlDocDumpMemory(doc, &newxml, &size);

cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(doc);
    return newxml;
}

/*
 * "vol-clone" command
 */
static const vshCmdInfo info_vol_clone[] = {
7017 7018
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
7019 7020 7021 7022
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
7023 7024 7025
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("orig vol name or key")},
    {"newname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("clone name")},
7026 7027 7028 7029 7030 7031 7032 7033
    {NULL, 0, 0, NULL}
};

static int
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
7034
    const char *name = NULL;
7035
    char *origxml = NULL;
7036 7037 7038
    xmlChar *newxml = NULL;
    int ret = FALSE;

7039
    if (!vshConnectionUsability(ctl, ctl->conn))
7040 7041 7042 7043 7044 7045 7046
        goto cleanup;

    if (!(origvol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        goto cleanup;

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
7047
        vshError(ctl, "%s", _("failed to get parent pool"));
7048 7049 7050
        goto cleanup;
    }

7051
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069
        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 {
7070
        vshError(ctl, _("Failed to clone vol from %s"),
7071 7072 7073 7074 7075 7076 7077
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

    ret = TRUE;

cleanup:
7078
    VIR_FREE(origxml);
7079 7080 7081
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
7082 7083
    if (newvol)
        virStorageVolFree(newvol);
7084 7085 7086 7087 7088
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295

/*
 * "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[] = {
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file")},
    {"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);
}

static int
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
    int ret = FALSE;
    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"));
        return FALSE;
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
        return FALSE;
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
        return FALSE;
    }

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

    ret = TRUE;

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[] = {
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file")},
    {"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}
};


static int
cmdVolDownloadSink(virStreamPtr st ATTRIBUTE_UNUSED,
                   const char *bytes, size_t nbytes, void *opaque)
{
    int *fd = opaque;

    return safewrite(*fd, bytes, nbytes);
}

static int
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
    int ret = FALSE;
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
    bool created = true;

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

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
        return FALSE;
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
        return FALSE;
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
        return FALSE;

    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) {
        created = false;
        if (errno != EEXIST ||
            (fd = open(file, O_WRONLY|O_TRUNC, 0666)) < 0) {
            vshError(ctl, _("cannot create %s"), file);
            goto cleanup;
        }
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

    if (virStreamRecvAll(st, cmdVolDownloadSink, &fd) < 0) {
        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;
    }

    ret = TRUE;

cleanup:
    if (ret == FALSE && created)
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    VIR_FORCE_CLOSE(fd);
    return ret;
}


7296 7297 7298
/*
 * "vol-delete" command
 */
7299
static const vshCmdInfo info_vol_delete[] = {
7300 7301
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
7302 7303 7304
    {NULL, NULL}
};

7305
static const vshCmdOptDef opts_vol_delete[] = {
7306 7307
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
7308 7309 7310 7311
    {NULL, 0, 0, NULL}
};

static int
7312
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
7313 7314 7315
{
    virStorageVolPtr vol;
    int ret = TRUE;
7316
    const char *name;
7317

7318
    if (!vshConnectionUsability(ctl, ctl->conn))
7319 7320 7321 7322 7323 7324 7325
        return FALSE;

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
        return FALSE;
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
7326
        vshPrint(ctl, _("Vol %s deleted\n"), name);
7327
    } else {
7328
        vshError(ctl, _("Failed to delete vol %s"), name);
7329 7330 7331
        ret = FALSE;
    }

L
Laine Stump 已提交
7332
    virStorageVolFree(vol);
7333 7334 7335 7336
    return ret;
}


D
David Allan 已提交
7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356
/*
 * "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[] = {
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
    {NULL, 0, 0, NULL}
};

static int
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
    int ret = TRUE;
7357
    const char *name;
D
David Allan 已提交
7358

7359
    if (!vshConnectionUsability(ctl, ctl->conn))
D
David Allan 已提交
7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377
        return FALSE;

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
        return FALSE;
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
        ret = FALSE;
    }

    virStorageVolFree(vol);
    return ret;
}


7378 7379 7380
/*
 * "vol-info" command
 */
7381
static const vshCmdInfo info_vol_info[] = {
7382 7383
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
7384 7385 7386
    {NULL, NULL}
};

7387
static const vshCmdOptDef opts_vol_info[] = {
7388 7389
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
7390 7391 7392 7393
    {NULL, 0, 0, NULL}
};

static int
7394
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
7395 7396 7397 7398 7399
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
    int ret = TRUE;

7400
    if (!vshConnectionUsability(ctl, ctl->conn))
7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431
        return FALSE;

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        return FALSE;

    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 {
        ret = FALSE;
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
7432
static const vshCmdInfo info_vol_dumpxml[] = {
7433 7434
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
7435 7436 7437
    {NULL, NULL}
};

7438
static const vshCmdOptDef opts_vol_dumpxml[] = {
7439 7440
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
7441 7442 7443 7444
    {NULL, 0, 0, NULL}
};

static int
7445
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
7446 7447 7448 7449 7450
{
    virStorageVolPtr vol;
    int ret = TRUE;
    char *dump;

7451
    if (!vshConnectionUsability(ctl, ctl->conn))
7452 7453 7454 7455 7456 7457 7458
        return FALSE;

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        return FALSE;

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
7459
        vshPrint(ctl, "%s", dump);
7460
        VIR_FREE(dump);
7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472
    } else {
        ret = FALSE;
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
7473
static const vshCmdInfo info_vol_list[] = {
7474 7475
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
7476 7477 7478
    {NULL, NULL}
};

7479
static const vshCmdOptDef opts_vol_list[] = {
7480
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7481
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
7482 7483 7484 7485
    {NULL, 0, 0, NULL}
};

static int
7486
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7487
{
7488
    virStorageVolInfo volumeInfo;
7489 7490
    virStoragePoolPtr pool;
    char **activeNames = NULL;
7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
    int ret, functionReturn;
    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;
7508

7509
    /* Check the connection to libvirtd daemon is still working */
7510
    if (!vshConnectionUsability(ctl, ctl->conn))
7511 7512
        return FALSE;

7513
    /* Look up the pool information given to us by the user */
7514 7515 7516
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
        return FALSE;

7517 7518
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
7519

7520 7521 7522 7523 7524 7525
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
        return FALSE;
    }

7526 7527 7528 7529 7530
    /* 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) {
7531
            vshError(ctl, "%s", _("Failed to list active vols"));
7532
            VIR_FREE(activeNames);
7533 7534 7535 7536
            virStoragePoolFree(pool);
            return FALSE;
        }

7537 7538 7539 7540 7541
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

        /* Set aside memory for volume information pointers */
        volInfoTexts = vshCalloc(ctl, numVolumes, sizeof(*volInfoTexts));
7542 7543
    }

7544 7545 7546 7547 7548
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
7549

7550 7551 7552 7553
        /* 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"));
7554 7555
        }

7556 7557 7558 7559 7560 7561 7562 7563 7564
        /* 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 */
7565

7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 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
                /* Volume type */
                if (volumeInfo.type == VIR_STORAGE_VOL_FILE)
                    volInfoTexts[i].type = vshStrdup(ctl, _("file"));
                else
                    volInfoTexts[i].type = vshStrdup(ctl, _("block"));

                /* Create the capacity output string */
                val = prettyCapacity(volumeInfo.capacity, &unit);
                ret = virAsprintf(&volInfoTexts[i].capacity,
                                  "%.2lf %s", val, unit);
                if (ret < 0) {
                    /* An error occurred creating the string, return */
                    goto asprintf_failure;
                }

                /* Create the allocation output string */
                val = prettyCapacity(volumeInfo.allocation, &unit);
                ret = virAsprintf(&volInfoTexts[i].allocation,
                                  "%.2lf %s", val, unit);
                if (ret < 0) {
                    /* An error occurred creating the string, return */
                    goto asprintf_failure;
                }
            }

            /* Remember the largest length for each output string.
             * This lets us displaying header and volume information rows
             * using a single, properly sized, printf style output string.
             */

            /* Keep the length of name string if longest so far */
            stringLength = strlen(activeNames[i]);
            if (stringLength > nameStrLength)
                nameStrLength = stringLength;

            /* Keep the length of path string if longest so far */
            stringLength = strlen(volInfoTexts[i].path);
            if (stringLength > pathStrLength)
                pathStrLength = stringLength;

            /* Keep the length of type string if longest so far */
            stringLength = strlen(volInfoTexts[i].type);
            if (stringLength > typeStrLength)
                typeStrLength = stringLength;

            /* Keep the length of capacity string if longest so far */
            stringLength = strlen(volInfoTexts[i].capacity);
            if (stringLength > capStrLength)
                capStrLength = stringLength;

            /* Keep the length of allocation string if longest so far */
            stringLength = strlen(volInfoTexts[i].allocation);
            if (stringLength > allocStrLength)
                allocStrLength = stringLength;
        }
7621

7622
        /* Cleanup memory allocation */
7623
        virStorageVolFree(vol);
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
    }

    /* 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 */
        functionReturn = TRUE;
        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 */
C
Chris Lalancette 已提交
7674 7675 7676 7677 7678
    vshDebug(ctl, 5, "Longest name string = %zu chars\n", nameStrLength);
    vshDebug(ctl, 5, "Longest path string = %zu chars\n", pathStrLength);
    vshDebug(ctl, 5, "Longest type string = %zu chars\n", typeStrLength);
    vshDebug(ctl, 5, "Longest capacity string = %zu chars\n", capStrLength);
    vshDebug(ctl, 5, "Longest allocation string = %zu chars\n", allocStrLength);
7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738

    /* 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 */
    functionReturn = TRUE;
    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);
    }
    functionReturn = FALSE;

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);
7739
        VIR_FREE(activeNames[i]);
7740
    }
7741 7742 7743 7744

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
7745
    VIR_FREE(activeNames);
7746
    virStoragePoolFree(pool);
7747 7748 7749

    /* Return the desired value */
    return functionReturn;
7750 7751 7752 7753 7754 7755
}


/*
 * "vol-name" command
 */
7756
static const vshCmdInfo info_vol_name[] = {
7757
    {"help", N_("returns the volume name for a given volume key or path")},
7758
    {"desc", ""},
7759 7760 7761
    {NULL, NULL}
};

7762
static const vshCmdOptDef opts_vol_name[] = {
7763
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
7764 7765 7766 7767
    {NULL, 0, 0, NULL}
};

static int
7768
cmdVolName(vshControl *ctl, const vshCmd *cmd)
7769 7770 7771
{
    virStorageVolPtr vol;

7772
    if (!vshConnectionUsability(ctl, ctl->conn))
7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784
        return FALSE;

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
        return FALSE;

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
    return TRUE;
}


J
Justin Clift 已提交
7785 7786 7787 7788 7789 7790 7791 7792 7793 7794
/*
 * "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[] = {
7795
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
7796 7797 7798 7799 7800 7801 7802 7803 7804
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

static int
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7805
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
7806 7807

    /* Check the connection to libvirtd daemon is still working */
7808
    if (!vshConnectionUsability(ctl, ctl->conn))
J
Justin Clift 已提交
7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824
        return FALSE;

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
        return FALSE;
    }

    /* 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);
        return FALSE;
    }

7825 7826 7827 7828 7829 7830 7831 7832 7833
    /* 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 已提交
7834 7835 7836 7837 7838 7839 7840

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
    return TRUE;
}

7841 7842 7843 7844

/*
 * "vol-key" command
 */
7845
static const vshCmdInfo info_vol_key[] = {
7846
    {"help", N_("returns the volume key for a given volume name or path")},
7847
    {"desc", ""},
7848 7849 7850
    {NULL, NULL}
};

7851
static const vshCmdOptDef opts_vol_key[] = {
7852
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7853
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
7854 7855 7856 7857
    {NULL, 0, 0, NULL}
};

static int
7858
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
7859 7860 7861
{
    virStorageVolPtr vol;

7862
    if (!vshConnectionUsability(ctl, ctl->conn))
7863 7864
        return FALSE;

7865
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877
        return FALSE;

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
    return TRUE;
}



/*
 * "vol-path" command
 */
7878
static const vshCmdInfo info_vol_path[] = {
7879
    {"help", N_("returns the volume path for a given volume name or key")},
7880
    {"desc", ""},
7881 7882 7883
    {NULL, NULL}
};

7884
static const vshCmdOptDef opts_vol_path[] = {
7885
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7886
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
7887 7888 7889 7890
    {NULL, 0, 0, NULL}
};

static int
7891
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
7892 7893
{
    virStorageVolPtr vol;
7894
    const char *name = NULL;
7895

7896
    if (!vshConnectionUsability(ctl, ctl->conn))
7897
        return FALSE;
7898 7899

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
7900
        return FALSE;
7901
    }
7902 7903 7904 7905 7906 7907 7908

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
    return TRUE;
}


7909 7910 7911 7912
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
7913 7914
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
7915 7916
    {NULL, NULL}
};
7917

7918
static const vshCmdOptDef opts_secret_define[] = {
7919
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
7920 7921
    {NULL, 0, 0, NULL}
};
7922

7923 7924 7925
static int
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
7926
    const char *from = NULL;
7927
    char *buffer;
7928
    virSecretPtr res;
7929
    char uuid[VIR_UUID_STRING_BUFLEN];
7930

7931
    if (!vshConnectionUsability(ctl, ctl->conn))
7932 7933
        return FALSE;

7934
    if (vshCommandOptString(cmd, "file", &from) <= 0)
7935 7936 7937 7938 7939 7940
        return FALSE;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;

    res = virSecretDefineXML(ctl->conn, buffer, 0);
7941
    VIR_FREE(buffer);
7942 7943

    if (res == NULL) {
7944
        vshError(ctl, _("Failed to set attributes from %s"), from);
7945 7946
        return FALSE;
    }
7947
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
7948
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960
        virSecretFree(res);
        return FALSE;
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
    return TRUE;
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
7961 7962
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
7963 7964 7965 7966
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
7967
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7968 7969 7970 7971 7972 7973 7974 7975 7976 7977
    {NULL, 0, 0, NULL}
};

static int
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    int ret = FALSE;
    char *xml;

7978
    if (!vshConnectionUsability(ctl, ctl->conn))
7979 7980 7981 7982 7983 7984 7985 7986 7987
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
        return FALSE;

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
7988
    vshPrint(ctl, "%s", xml);
7989
    VIR_FREE(xml);
7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
8001 8002
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
8003 8004 8005 8006
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
8007 8008
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
8009 8010 8011 8012 8013 8014 8015 8016
    {NULL, 0, 0, NULL}
};

static int
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
8017
    const char *base64 = NULL;
8018
    char *value;
8019
    int res, ret = FALSE;
8020

8021
    if (!vshConnectionUsability(ctl, ctl->conn))
8022 8023 8024 8025 8026 8027
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
        return FALSE;

8028
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
8029 8030 8031
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
8032
        vshError(ctl, "%s", _("Invalid base64 data"));
8033 8034 8035
        goto cleanup;
    }
    if (value == NULL) {
8036
        vshError(ctl, "%s", _("Failed to allocate memory"));
8037 8038 8039 8040 8041
        return FALSE;
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
8042
    VIR_FREE(value);
8043 8044

    if (res != 0) {
8045
        vshError(ctl, "%s", _("Failed to set secret value"));
8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
8060 8061
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
8062 8063 8064 8065
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
8066
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078
    {NULL, 0, 0, NULL}
};

static int
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
    int ret = FALSE;

8079
    if (!vshConnectionUsability(ctl, ctl->conn))
8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
        return FALSE;

    value = virSecretGetValue(secret, &value_size, 0);
    if (value == NULL)
        goto cleanup;

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
8092
    VIR_FREE(value);
8093 8094

    if (base64 == NULL) {
8095
        vshError(ctl, "%s", _("Failed to allocate memory"));
8096 8097
        goto cleanup;
    }
8098
    vshPrint(ctl, "%s", base64);
8099
    memset(base64, 0, strlen(base64));
8100
    VIR_FREE(base64);
8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
8112 8113
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
8114 8115 8116 8117
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
8118
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8119 8120 8121 8122 8123 8124 8125 8126
    {NULL, 0, 0, NULL}
};

static int
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    int ret = FALSE;
8127
    const char *uuid;
8128

8129
    if (!vshConnectionUsability(ctl, ctl->conn))
8130 8131 8132 8133 8134 8135 8136
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
        return FALSE;

    if (virSecretUndefine(secret) < 0) {
8137
        vshError(ctl, _("Failed to delete secret %s"), uuid);
8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
8152 8153
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
8154 8155 8156 8157 8158 8159 8160 8161 8162
    {NULL, NULL}
};

static int
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

8163
    if (!vshConnectionUsability(ctl, ctl->conn))
8164 8165 8166 8167
        return FALSE;

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
8168
        vshError(ctl, "%s", _("Failed to list secrets"));
8169 8170 8171 8172 8173 8174
        return FALSE;
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
8175
        vshError(ctl, "%s", _("Failed to list secrets"));
8176
        VIR_FREE(uuids);
8177 8178 8179 8180 8181
        return FALSE;
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

8182 8183
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
8184 8185

    for (i = 0; i < maxuuids; i++) {
8186 8187 8188 8189
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
8190
            VIR_FREE(uuids[i]);
8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208
            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);
8209
        VIR_FREE(uuids[i]);
8210
    }
8211
    VIR_FREE(uuids);
8212 8213
    return TRUE;
}
8214 8215 8216 8217 8218


/*
 * "version" command
 */
8219
static const vshCmdInfo info_version[] = {
8220 8221
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
8222 8223 8224 8225 8226
    {NULL, NULL}
};


static int
8227
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

8239
    if (!vshConnectionUsability(ctl, ctl->conn))
8240 8241 8242 8243
        return FALSE;

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
8244
        vshError(ctl, "%s", _("failed to get hypervisor type"));
8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257
        return FALSE;
    }

    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) {
8258
        vshError(ctl, "%s", _("failed to get the library version"));
8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276
        return FALSE;
    }
    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) {
8277
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294
        return FALSE;
    }
    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);
    }
    return TRUE;
}

8295 8296 8297 8298
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
8299
    {"help", N_("enumerate devices on this host")},
8300
    {"desc", ""},
8301 8302 8303 8304
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
8305 8306
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
8307 8308 8309
    {NULL, 0, 0, NULL}
};

8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331
#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] = '-';
8332 8333
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
8334 8335 8336
    }

    /* Print this device */
8337
    vshPrint(ctl, "%s", indentBuf);
8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360
    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) {
8361
        vshPrint(ctl, "%s", indentBuf);
8362
        vshPrint(ctl, " |\n");
8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384
    }

    /* 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) {
8385
        vshPrint(ctl, "%s", indentBuf);
8386 8387 8388 8389
        vshPrint(ctl, "\n");
    }
}

8390 8391 8392
static int
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
8393
    const char *cap = NULL;
8394
    char **devices;
8395
    int num_devices, i;
8396
    int tree = vshCommandOptBool(cmd, "tree");
8397

8398
    if (!vshConnectionUsability(ctl, ctl->conn))
8399 8400
        return FALSE;

8401
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
8402 8403 8404 8405
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
8406
        vshError(ctl, "%s", _("Failed to count node devices"));
8407 8408 8409 8410 8411 8412 8413 8414 8415
        return FALSE;
    } else if (num_devices == 0) {
        return TRUE;
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
8416
        vshError(ctl, "%s", _("Failed to list node devices"));
8417
        VIR_FREE(devices);
8418 8419
        return FALSE;
    }
8420
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
8421 8422 8423 8424 8425 8426 8427
    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 已提交
8428
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447
            } 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++) {
8448 8449
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
8450
        }
8451
        VIR_FREE(parents);
8452 8453 8454
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
8455
            VIR_FREE(devices[i]);
8456
        }
8457
    }
8458
    VIR_FREE(devices);
8459 8460 8461 8462 8463 8464 8465
    return TRUE;
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
8466 8467
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
8468 8469 8470 8471 8472
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
8473
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8474 8475 8476 8477 8478 8479
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
8480
    const char *name = NULL;
8481
    virNodeDevicePtr device;
L
Laine Stump 已提交
8482
    char *xml;
8483

8484
    if (!vshConnectionUsability(ctl, ctl->conn))
8485
        return FALSE;
8486
    if (vshCommandOptString(cmd, "device", &name) <= 0)
8487 8488
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8489
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
8490 8491 8492
        return FALSE;
    }

L
Laine Stump 已提交
8493 8494 8495 8496 8497 8498 8499
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
        return FALSE;
    }

    vshPrint(ctl, "%s\n", xml);
8500
    VIR_FREE(xml);
8501 8502 8503 8504
    virNodeDeviceFree(device);
    return TRUE;
}

8505 8506 8507 8508
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
8509 8510
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
8511 8512 8513 8514 8515
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
8516
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8517 8518 8519 8520 8521 8522
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
8523
    const char *name = NULL;
8524 8525 8526
    virNodeDevicePtr device;
    int ret = TRUE;

8527
    if (!vshConnectionUsability(ctl, ctl->conn))
8528
        return FALSE;
8529
    if (vshCommandOptString(cmd, "device", &name) <= 0)
8530 8531
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8532
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
8533 8534 8535 8536 8537 8538
        return FALSE;
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
8539
        vshError(ctl, _("Failed to dettach device %s"), name);
8540 8541 8542 8543 8544 8545 8546 8547 8548 8549
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
8550 8551
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
8552 8553 8554 8555 8556
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
8557
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8558 8559 8560 8561 8562 8563
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
8564
    const char *name = NULL;
8565 8566 8567
    virNodeDevicePtr device;
    int ret = TRUE;

8568
    if (!vshConnectionUsability(ctl, ctl->conn))
8569
        return FALSE;
8570
    if (vshCommandOptString(cmd, "device", &name) <= 0)
8571 8572
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8573
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
8574 8575 8576 8577 8578 8579
        return FALSE;
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
8580
        vshError(ctl, _("Failed to re-attach device %s"), name);
8581 8582 8583 8584 8585 8586 8587 8588 8589 8590
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
8591 8592
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
8593 8594 8595 8596 8597
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
8598
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8599 8600 8601 8602 8603 8604
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
8605
    const char *name = NULL;
8606 8607 8608
    virNodeDevicePtr device;
    int ret = TRUE;

8609
    if (!vshConnectionUsability(ctl, ctl->conn))
8610
        return FALSE;
8611
    if (vshCommandOptString(cmd, "device", &name) <= 0)
8612 8613
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8614
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
8615 8616 8617 8618 8619 8620
        return FALSE;
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
8621
        vshError(ctl, _("Failed to reset device %s"), name);
8622 8623 8624 8625 8626 8627
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

8628
/*
E
Eric Blake 已提交
8629
 * "hostname" command
8630
 */
8631
static const vshCmdInfo info_hostname[] = {
8632
    {"help", N_("print the hypervisor hostname")},
8633
    {"desc", ""},
8634 8635 8636 8637
    {NULL, NULL}
};

static int
8638
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8639 8640 8641
{
    char *hostname;

8642
    if (!vshConnectionUsability(ctl, ctl->conn))
8643 8644 8645 8646
        return FALSE;

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
8647
        vshError(ctl, "%s", _("failed to get hostname"));
8648 8649 8650 8651
        return FALSE;
    }

    vshPrint (ctl, "%s\n", hostname);
8652
    VIR_FREE(hostname);
8653 8654 8655 8656 8657 8658 8659

    return TRUE;
}

/*
 * "uri" command
 */
8660
static const vshCmdInfo info_uri[] = {
8661
    {"help", N_("print the hypervisor canonical URI")},
8662
    {"desc", ""},
8663 8664 8665 8666
    {NULL, NULL}
};

static int
8667
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8668 8669 8670
{
    char *uri;

8671
    if (!vshConnectionUsability(ctl, ctl->conn))
8672 8673 8674 8675
        return FALSE;

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
8676
        vshError(ctl, "%s", _("failed to get URI"));
8677 8678 8679 8680
        return FALSE;
    }

    vshPrint (ctl, "%s\n", uri);
8681
    VIR_FREE(uri);
8682 8683 8684 8685

    return TRUE;
}

E
Eric Blake 已提交
8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715
/*
 * "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}
};

static int
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

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

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
        return FALSE;
    }

    vshPrint (ctl, "%s", sysinfo);
    VIR_FREE(sysinfo);

    return TRUE;
}

8716 8717 8718
/*
 * "vncdisplay" command
 */
8719
static const vshCmdInfo info_vncdisplay[] = {
8720 8721
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
8722 8723 8724
    {NULL, NULL}
};

8725
static const vshCmdOptDef opts_vncdisplay[] = {
8726
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8727 8728 8729 8730
    {NULL, 0, 0, NULL}
};

static int
8731
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
8732 8733 8734 8735 8736 8737 8738 8739 8740
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    int ret = FALSE;
    int port = 0;
    char *doc;

8741
    if (!vshConnectionUsability(ctl, ctl->conn))
8742 8743
        return FALSE;

J
Jim Meyering 已提交
8744
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8745 8746 8747 8748 8749 8750 8751 8752 8753
        return FALSE;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
8754
    VIR_FREE(doc);
8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        goto cleanup;

    obj = xmlXPathEval(BAD_CAST "string(/domain/devices/graphics[@type='vnc']/@port)", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_STRING) ||
        (obj->stringval == NULL) || (obj->stringval[0] == 0)) {
        goto cleanup;
    }
    if (virStrToLong_i((const char *)obj->stringval, NULL, 10, &port) || port < 0)
        goto cleanup;
    xmlXPathFreeObject(obj);

    obj = xmlXPathEval(BAD_CAST "string(/domain/devices/graphics[@type='vnc']/@listen)", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_STRING) ||
        (obj->stringval == NULL) || (obj->stringval[0] == 0) ||
8773
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793
        vshPrint(ctl, ":%d\n", port-5900);
    } else {
        vshPrint(ctl, "%s:%d\n", (const char *)obj->stringval, port-5900);
    }
    xmlXPathFreeObject(obj);
    obj = NULL;
    ret = TRUE;

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

/*
 * "ttyconsole" command
 */
8794
static const vshCmdInfo info_ttyconsole[] = {
8795 8796
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
8797 8798 8799
    {NULL, NULL}
};

8800
static const vshCmdOptDef opts_ttyconsole[] = {
8801
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8802 8803 8804 8805
    {NULL, 0, 0, NULL}
};

static int
8806
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
8807 8808 8809 8810 8811 8812 8813 8814
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    int ret = FALSE;
    char *doc;

8815
    if (!vshConnectionUsability(ctl, ctl->conn))
8816 8817
        return FALSE;

J
Jim Meyering 已提交
8818
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8819 8820 8821 8822 8823 8824 8825 8826 8827
        return FALSE;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
8828
    VIR_FREE(doc);
8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        goto cleanup;

    obj = xmlXPathEval(BAD_CAST "string(/domain/devices/console/@tty)", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_STRING) ||
        (obj->stringval == NULL) || (obj->stringval[0] == 0)) {
        goto cleanup;
    }
    vshPrint(ctl, "%s\n", (const char *)obj->stringval);
8841
    ret = TRUE;
8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853

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

/*
 * "attach-device" command
8854
 */
8855
static const vshCmdInfo info_attach_device[] = {
8856 8857
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
8858 8859 8860
    {NULL, NULL}
};

8861
static const vshCmdOptDef opts_attach_device[] = {
8862 8863 8864
    {"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")},
8865 8866 8867 8868
    {NULL, 0, 0, NULL}
};

static int
8869
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
8870 8871
{
    virDomainPtr dom;
8872
    const char *from = NULL;
8873 8874
    char *buffer;
    int ret = TRUE;
J
Jim Fehlig 已提交
8875
    unsigned int flags;
8876

8877
    if (!vshConnectionUsability(ctl, ctl->conn))
8878 8879
        return FALSE;

J
Jim Meyering 已提交
8880
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8881 8882
        return FALSE;

8883
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8884 8885 8886 8887
        virDomainFree(dom);
        return FALSE;
    }

8888
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8889
        virshReportError(ctl);
8890
        virDomainFree(dom);
8891
        return FALSE;
8892
    }
8893

J
Jim Fehlig 已提交
8894 8895 8896 8897 8898 8899 8900 8901
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
           flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
8902
    VIR_FREE(buffer);
8903 8904

    if (ret < 0) {
8905
        vshError(ctl, _("Failed to attach device from %s"), from);
8906 8907
        virDomainFree(dom);
        return FALSE;
8908
    } else {
J
Jim Meyering 已提交
8909
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
8910 8911 8912 8913 8914 8915 8916 8917 8918 8919
    }

    virDomainFree(dom);
    return TRUE;
}


/*
 * "detach-device" command
 */
8920
static const vshCmdInfo info_detach_device[] = {
8921 8922
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
8923 8924 8925
    {NULL, NULL}
};

8926
static const vshCmdOptDef opts_detach_device[] = {
8927 8928 8929
    {"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")},
8930 8931 8932 8933
    {NULL, 0, 0, NULL}
};

static int
8934
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
8935 8936
{
    virDomainPtr dom;
8937
    const char *from = NULL;
8938 8939
    char *buffer;
    int ret = TRUE;
J
Jim Fehlig 已提交
8940
    unsigned int flags;
8941

8942
    if (!vshConnectionUsability(ctl, ctl->conn))
8943 8944
        return FALSE;

J
Jim Meyering 已提交
8945
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8946 8947
        return FALSE;

8948
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8949 8950 8951 8952
        virDomainFree(dom);
        return FALSE;
    }

8953
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8954
        virshReportError(ctl);
8955
        virDomainFree(dom);
8956
        return FALSE;
8957
    }
8958

J
Jim Fehlig 已提交
8959 8960 8961 8962 8963 8964 8965 8966
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
           flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
8967
    VIR_FREE(buffer);
8968 8969

    if (ret < 0) {
8970
        vshError(ctl, _("Failed to detach device from %s"), from);
8971 8972
        virDomainFree(dom);
        return FALSE;
8973
    } else {
J
Jim Meyering 已提交
8974
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
8975 8976 8977 8978 8979 8980
    }

    virDomainFree(dom);
    return TRUE;
}

8981

8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994
/*
 * "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")},
8995
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
8996 8997 8998 8999 9000 9001 9002
    {NULL, 0, 0, NULL}
};

static int
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
9003
    const char *from = NULL;
9004 9005 9006 9007
    char *buffer;
    int ret = TRUE;
    unsigned int flags;

9008
    if (!vshConnectionUsability(ctl, ctl->conn))
9009 9010 9011 9012 9013
        return FALSE;

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

9014
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9015 9016 9017 9018 9019
        virDomainFree(dom);
        return FALSE;
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9020
        virshReportError(ctl);
9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031
        virDomainFree(dom);
        return FALSE;
    }

    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
           flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
    } else {
        flags = VIR_DOMAIN_DEVICE_MODIFY_LIVE;
    }
9032 9033 9034 9035

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051
    ret = virDomainUpdateDeviceFlags(dom, buffer, flags);
    VIR_FREE(buffer);

    if (ret < 0) {
        vshError(ctl, _("Failed to update device from %s"), from);
        virDomainFree(dom);
        return FALSE;
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
    return TRUE;
}


9052 9053 9054
/*
 * "attach-interface" command
 */
9055
static const vshCmdInfo info_attach_interface[] = {
9056 9057
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
9058 9059 9060
    {NULL, NULL}
};

9061
static const vshCmdOptDef opts_attach_interface[] = {
9062 9063 9064 9065 9066 9067
    {"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")},
9068
    {"model", VSH_OT_DATA, 0, N_("model type")},
9069
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
9070 9071 9072 9073
    {NULL, 0, 0, NULL}
};

static int
9074
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
9075 9076
{
    virDomainPtr dom = NULL;
9077 9078
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
9079
    int typ, ret = FALSE;
J
Jim Fehlig 已提交
9080
    unsigned int flags;
9081 9082
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9083

9084
    if (!vshConnectionUsability(ctl, ctl->conn))
9085 9086
        goto cleanup;

J
Jim Meyering 已提交
9087
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9088 9089
        goto cleanup;

9090
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9091 9092
        goto cleanup;

9093 9094 9095 9096
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
9097 9098
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
9099
        goto cleanup;
9100
    }
9101 9102

    /* check interface type */
9103
    if (STREQ(type, "network")) {
9104
        typ = 1;
9105
    } else if (STREQ(type, "bridge")) {
9106 9107
        typ = 2;
    } else {
E
Eric Blake 已提交
9108 9109
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
9110 9111 9112 9113
        goto cleanup;
    }

    /* Make XML of interface */
9114
    virBufferVSprintf(&buf, "<interface type='%s'>\n", type);
9115

9116 9117 9118 9119
    if (typ == 1)
        virBufferVSprintf(&buf, "  <source network='%s'/>\n", source);
    else if (typ == 2)
        virBufferVSprintf(&buf, "  <source bridge='%s'/>\n", source);
9120

9121 9122 9123 9124 9125 9126
    if (target != NULL)
        virBufferVSprintf(&buf, "  <target dev='%s'/>\n", target);
    if (mac != NULL)
        virBufferVSprintf(&buf, "  <mac address='%s'/>\n", mac);
    if (script != NULL)
        virBufferVSprintf(&buf, "  <script path='%s'/>\n", script);
9127 9128
    if (model != NULL)
        virBufferVSprintf(&buf, "  <model type='%s'/>\n", model);
9129

9130
    virBufferAddLit(&buf, "</interface>\n");
9131

9132 9133 9134
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
9135 9136
    }

9137
    xml = virBufferContentAndReset(&buf);
9138

J
Jim Fehlig 已提交
9139 9140 9141 9142
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9143
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
9144
    } else {
9145
        ret = virDomainAttachDevice(dom, xml);
9146
    }
9147

9148 9149
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9150
    if (ret != 0) {
L
Laine Stump 已提交
9151
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
9152 9153 9154 9155 9156
        ret = FALSE;
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
        ret = TRUE;
    }
9157 9158 9159 9160

 cleanup:
    if (dom)
        virDomainFree(dom);
9161
    virBufferFreeAndReset(&buf);
9162 9163 9164 9165 9166 9167
    return ret;
}

/*
 * "detach-interface" command
 */
9168
static const vshCmdInfo info_detach_interface[] = {
9169 9170
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
9171 9172 9173
    {NULL, NULL}
};

9174
static const vshCmdOptDef opts_detach_interface[] = {
9175 9176 9177 9178
    {"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")},
9179 9180 9181 9182
    {NULL, 0, 0, NULL}
};

static int
9183
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
9184 9185 9186 9187 9188 9189 9190
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
9191
    const char *mac =NULL, *type = NULL;
9192
    char *doc;
9193 9194
    char buf[64];
    int i = 0, diff_mac, ret = FALSE;
J
Jim Fehlig 已提交
9195
    unsigned int flags;
9196

9197
    if (!vshConnectionUsability(ctl, ctl->conn))
9198 9199
        goto cleanup;

J
Jim Meyering 已提交
9200
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9201 9202
        goto cleanup;

9203
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9204 9205
        goto cleanup;

9206 9207
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
9208
        goto cleanup;
9209
    }
9210 9211 9212 9213 9214 9215 9216 9217

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
9218
    VIR_FREE(doc);
9219
    if (!xml) {
9220
        vshError(ctl, "%s", _("Failed to get interface information"));
9221 9222 9223 9224
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9225
        vshError(ctl, "%s", _("Failed to get interface information"));
9226 9227 9228
        goto cleanup;
    }

E
Eric Blake 已提交
9229
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
9230 9231 9232
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9233
        vshError(ctl, _("No found interface whose type is %s"), type);
9234 9235 9236
        goto cleanup;
    }

9237 9238 9239 9240 9241 9242
    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;
    }

9243 9244 9245 9246 9247 9248 9249
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9250 9251 9252 9253 9254
            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);
9255 9256 9257 9258 9259 9260 9261
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9262
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
9263 9264 9265 9266 9267
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9268
        vshError(ctl, "%s", _("Failed to allocate memory"));
9269 9270 9271 9272
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
9289
        vshError(ctl, "%s", _("Failed to detach interface"));
9290
        ret = FALSE;
J
Jim Fehlig 已提交
9291
    } else {
J
Jim Meyering 已提交
9292
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
9293
        ret = TRUE;
9294
    }
9295 9296 9297 9298

 cleanup:
    if (dom)
        virDomainFree(dom);
9299
    xmlXPathFreeObject(obj);
9300
    xmlXPathFreeContext(ctxt);
9301 9302 9303 9304 9305 9306 9307 9308 9309 9310
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    return ret;
}

/*
 * "attach-disk" command
 */
9311
static const vshCmdInfo info_attach_disk[] = {
9312 9313
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
9314 9315 9316
    {NULL, NULL}
};

9317
static const vshCmdOptDef opts_attach_disk[] = {
9318 9319 9320 9321 9322 9323 9324 9325
    {"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")},
    {"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")},
9326
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
9327 9328 9329 9330
    {NULL, 0, 0, NULL}
};

static int
9331
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
9332 9333
{
    virDomainPtr dom = NULL;
9334 9335
    const char *source = NULL, *target = NULL, *driver = NULL,
                *subdriver = NULL, *type = NULL, *mode = NULL;
9336
    int isFile = 0, ret = FALSE;
J
Jim Fehlig 已提交
9337
    unsigned int flags;
9338
    const char *stype = NULL;
9339 9340
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9341

9342
    if (!vshConnectionUsability(ctl, ctl->conn))
9343 9344
        goto cleanup;

J
Jim Meyering 已提交
9345
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9346 9347
        goto cleanup;

9348
    if (vshCommandOptString(cmd, "source", &source) <= 0)
9349 9350
        goto cleanup;

9351
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9352 9353
        goto cleanup;

9354 9355 9356 9357 9358
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
9359
        vshError(ctl, "%s", _("missing option"));
9360 9361
        goto cleanup;
    }
9362

9363 9364
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
9365
            isFile = 1;
9366 9367 9368 9369 9370
    } else if (STREQ(stype, "file")) {
        isFile = 1;
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
9371 9372 9373
    }

    if (mode) {
9374
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
9375 9376
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
9377 9378 9379 9380 9381
            goto cleanup;
        }
    }

    /* Make XML of disk */
9382 9383 9384 9385 9386 9387
    virBufferVSprintf(&buf, "<disk type='%s'",
                      (isFile) ? "file" : "block");
    if (type)
        virBufferVSprintf(&buf, " device='%s'", type);
    virBufferAddLit(&buf, ">\n");

9388 9389 9390 9391 9392
    if (driver || subdriver)
        virBufferVSprintf(&buf, "  <driver");

    if (driver)
        virBufferVSprintf(&buf, " name='%s'", driver);
9393 9394
    if (subdriver)
        virBufferVSprintf(&buf, " type='%s'", subdriver);
9395 9396 9397

    if (driver || subdriver)
        virBufferAddLit(&buf, "/>\n");
9398 9399 9400 9401 9402 9403 9404 9405 9406

    virBufferVSprintf(&buf, "  <source %s='%s'/>\n",
                      (isFile) ? "file" : "dev",
                      source);
    virBufferVSprintf(&buf, "  <target dev='%s'/>\n", target);
    if (mode)
        virBufferVSprintf(&buf, "  <%s/>\n", mode);

    virBufferAddLit(&buf, "</disk>\n");
9407

9408 9409 9410
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
9411 9412
    }

9413
    xml = virBufferContentAndReset(&buf);
9414

J
Jim Fehlig 已提交
9415 9416 9417 9418
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9419
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
9420
    } else {
9421
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
9422
    }
9423

9424 9425
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9426
    if (ret != 0) {
L
Laine Stump 已提交
9427
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
9428 9429 9430 9431 9432
        ret = FALSE;
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
        ret = TRUE;
    }
9433 9434 9435 9436

 cleanup:
    if (dom)
        virDomainFree(dom);
9437
    virBufferFreeAndReset(&buf);
9438 9439 9440 9441 9442 9443
    return ret;
}

/*
 * "detach-disk" command
 */
9444
static const vshCmdInfo info_detach_disk[] = {
9445 9446
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
9447 9448 9449
    {NULL, NULL}
};

9450
static const vshCmdOptDef opts_detach_disk[] = {
9451 9452 9453
    {"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")},
9454 9455 9456 9457
    {NULL, 0, 0, NULL}
};

static int
9458
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
9459 9460 9461 9462 9463 9464 9465
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
9466
    const char *target = NULL;
9467
    char *doc;
9468
    int i = 0, diff_tgt, ret = FALSE;
J
Jim Fehlig 已提交
9469
    unsigned int flags;
9470

9471
    if (!vshConnectionUsability(ctl, ctl->conn))
9472 9473
        goto cleanup;

J
Jim Meyering 已提交
9474
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9475 9476
        goto cleanup;

9477
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9478 9479 9480 9481 9482 9483 9484 9485 9486
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
9487
    VIR_FREE(doc);
9488
    if (!xml) {
9489
        vshError(ctl, "%s", _("Failed to get disk information"));
9490 9491 9492 9493
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9494
        vshError(ctl, "%s", _("Failed to get disk information"));
9495 9496 9497 9498 9499 9500
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9501
        vshError(ctl, "%s", _("Failed to get disk information"));
9502 9503 9504 9505 9506 9507 9508
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9509 9510 9511 9512 9513
            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);
9514 9515 9516 9517 9518 9519 9520
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9521
    vshError(ctl, _("No found disk whose target is %s"), target);
9522 9523 9524 9525 9526
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9527
        vshError(ctl, "%s", _("Failed to allocate memory"));
9528 9529 9530 9531
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
9548
        vshError(ctl, "%s", _("Failed to detach disk"));
9549
        ret = FALSE;
J
Jim Fehlig 已提交
9550
    } else {
J
Jim Meyering 已提交
9551
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
9552
        ret = TRUE;
9553
    }
9554 9555

 cleanup:
9556
    xmlXPathFreeObject(obj);
9557
    xmlXPathFreeContext(ctxt);
9558 9559 9560 9561 9562 9563 9564 9565 9566
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
    return ret;
}

9567 9568 9569 9570
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
9571 9572
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
9573 9574 9575 9576
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
9577
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
9578 9579 9580 9581 9582 9583
    {NULL, 0, 0, NULL}
};

static int
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
9584
    const char *from = NULL;
9585 9586 9587 9588
    int ret = TRUE;
    char *buffer;
    int result;

9589
    if (!vshConnectionUsability(ctl, ctl->conn))
9590 9591
        return FALSE;

9592
    if (vshCommandOptString(cmd, "file", &from) <= 0)
9593 9594 9595 9596 9597 9598
        return FALSE;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
9599
    VIR_FREE(buffer);
9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
        ret = FALSE;
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
        ret = TRUE;
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
        ret = TRUE;
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
        ret = FALSE;
    }

    return ret;
}

9629 9630 9631 9632
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
9633 9634
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
9635 9636 9637 9638
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
9639
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
9640 9641 9642 9643 9644 9645
    {NULL, 0, 0, NULL}
};

static int
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
9646
    const char *from = NULL;
9647 9648 9649 9650 9651 9652
    int ret = TRUE;
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
9653
    xmlNodePtr node_list;
9654 9655 9656 9657 9658 9659
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

9660
    if (!vshConnectionUsability(ctl, ctl->conn))
9661 9662
        return FALSE;

9663
    if (vshCommandOptString(cmd, "file", &from) <= 0)
9664 9665 9666 9667 9668 9669 9670 9671 9672
        return FALSE;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;

    doc = xmlNewDoc(NULL);
    if (doc == NULL)
        goto no_memory;

L
Laine Stump 已提交
9673 9674
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
        ret = FALSE;
        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);
        ret = FALSE;
        goto cleanup;
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

    if (result)
        vshPrint(ctl, "%s", result);
    else
        ret = FALSE;

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"));
    ret = FALSE;
9742
    goto cleanup;
9743 9744
}

9745 9746 9747 9748 9749 9750 9751 9752
/* 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;

9753
    ret = vshMalloc(ctl, PATH_MAX);
9754 9755 9756

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
9757 9758
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
9759
    if (fd == -1) {
9760
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
9761
                 strerror(errno));
9762
        VIR_FREE(ret);
9763 9764 9765 9766
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
9767 9768
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
9769
        VIR_FORCE_CLOSE(fd);
9770
        unlink (ret);
9771
        VIR_FREE(ret);
9772 9773
        return NULL;
    }
S
Stefan Berger 已提交
9774
    if (VIR_CLOSE(fd) < 0) {
9775 9776
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
9777
        unlink (ret);
9778
        VIR_FREE(ret);
9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793
        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 已提交
9794 9795 9796 9797
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
9798

9799
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
9800 9801 9802 9803
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
9804

9805 9806 9807 9808 9809
    /* 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 已提交
9810 9811
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
9812
     */
E
Eric Blake 已提交
9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824
    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);
9825 9826
    }

E
Eric Blake 已提交
9827 9828 9829 9830 9831 9832 9833
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
9834
    }
E
Eric Blake 已提交
9835
    ret = 0;
9836

E
Eric Blake 已提交
9837 9838 9839
cleanup:
    virCommandFree(cmd);
    return ret;
9840 9841 9842 9843 9844 9845 9846 9847
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
9848
        vshError(ctl,
9849
                 _("%s: failed to read temporary file: %s"),
9850
                 filename, strerror(errno));
9851 9852 9853 9854 9855
        return NULL;
    }
    return ret;
}

9856 9857

#ifndef WIN32
P
Paolo Bonzini 已提交
9858 9859 9860 9861
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
9862 9863
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
9864 9865 9866 9867
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
9868
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
9869 9870 9871 9872 9873 9874
    {NULL, 0, 0, NULL}
};

static int
cmdCd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
9875
    const char *dir = NULL;
9876
    char *dir_malloced = NULL;
P
Phil Petty 已提交
9877
    int ret = TRUE;
P
Paolo Bonzini 已提交
9878 9879

    if (!ctl->imode) {
9880
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
C
Chris Lalancette 已提交
9881
        return FALSE;
P
Paolo Bonzini 已提交
9882 9883
    }

9884
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
9885
        uid_t uid = geteuid();
9886
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
9887 9888 9889 9890
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
9891
    if (chdir(dir) == -1) {
9892
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
P
Phil Petty 已提交
9893
        ret = FALSE;
P
Paolo Bonzini 已提交
9894 9895
    }

9896
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
9897
    return ret;
P
Paolo Bonzini 已提交
9898 9899
}

9900 9901 9902
#endif

#ifndef WIN32
P
Paolo Bonzini 已提交
9903 9904 9905 9906
/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
9907 9908
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930
    {NULL, NULL}
};

static int
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
    size_t path_max;
    int err = TRUE;

    path_max = (size_t) PATH_MAX + 2;
    cwd = vshMalloc (ctl, path_max);
    while (cwd) {
        err = getcwd (cwd, path_max) == NULL;
        if (!err || errno != ERANGE)
            break;

        path_max *= 2;
        cwd = vshRealloc (ctl, cwd, path_max);
    }

    if (err)
9931 9932
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
P
Paolo Bonzini 已提交
9933 9934 9935
    else
        vshPrint (ctl, _("%s\n"), cwd);

9936
    VIR_FREE(cwd);
P
Paolo Bonzini 已提交
9937 9938
    return !err;
}
9939
#endif
P
Paolo Bonzini 已提交
9940

E
Eric Blake 已提交
9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014
/*
 * "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")},
    {"", VSH_OT_ARGV, 0, N_("arguments to echo")},
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
static int
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

    while ((arg = vshCommandOptArgv(cmd, count)) != NULL) {
        bool close_quote = false;
        char *q;

        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"));
        return FALSE;
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
    return TRUE;
}

10015 10016 10017 10018
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
10019 10020
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
10021 10022 10023 10024
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
10025
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040
    {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.
 */
static int
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
    int ret = FALSE;
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
10041
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
10042

10043
    if (!vshConnectionUsability(ctl, ctl->conn))
10044 10045
        goto cleanup;

J
Jim Meyering 已提交
10046
    dom = vshCommandOptDomain (ctl, cmd, NULL);
10047 10048 10049 10050
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
10051
    doc = virDomainGetXMLDesc (dom, flags);
10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077
    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));
        ret = TRUE;
        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.
     */
10078
    doc_reread = virDomainGetXMLDesc (dom, flags);
10079 10080 10081 10082
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
10083 10084
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102
        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));

    ret = TRUE;

 cleanup:
    if (dom)
        virDomainFree (dom);

10103 10104 10105
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
10106 10107 10108

    if (tmp) {
        unlink (tmp);
10109
        VIR_FREE(tmp);
10110 10111 10112 10113 10114
    }

    return ret;
}

10115

10116 10117 10118 10119
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
10120 10121
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
10122 10123 10124 10125
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
10126
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
10127 10128 10129 10130 10131 10132 10133 10134 10135 10136
    {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[] = {
10137 10138
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
10139 10140 10141 10142
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
10143
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10144 10145 10146 10147 10148 10149
    {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 已提交
10150 10151 10152
/*
 * "quit" command
 */
10153
static const vshCmdInfo info_quit[] = {
10154
    {"help", N_("quit this interactive terminal")},
10155
    {"desc", ""},
10156
    {NULL, NULL}
K
Karel Zak 已提交
10157 10158 10159
};

static int
10160
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10161
{
K
Karel Zak 已提交
10162 10163 10164 10165
    ctl->imode = FALSE;
    return TRUE;
}

10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
    {"help", N_("Create a snapshot")},
    {"desc", N_("Snapshot create")},
    {NULL, NULL}
};

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

static int
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
10186
    const char *from = NULL;
10187 10188 10189 10190 10191 10192 10193
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

10194
    if (!vshConnectionUsability(ctl, ctl->conn))
10195 10196 10197 10198 10199 10200
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10201
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
10202
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285
    else {
        if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
            /* we have to report the error here because during cleanup
             * we'll run through virDomainFree(), which loses the
             * last error
             */
            virshReportError(ctl);
            goto cleanup;
        }
    }
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

    snapshot = virDomainSnapshotCreateXML(dom, buffer, 0);
    if (snapshot == NULL)
        goto cleanup;

    doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domainsnapshot.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        goto cleanup;

    name = virXPathString("string(/domainsnapshot/name)", ctxt);
    if (!name) {
        vshError(ctl, "%s",
                 _("Could not find 'name' element in domain snapshot XML"));
        goto cleanup;
    }

    vshPrint(ctl, _("Domain snapshot %s created"), name);
    if (from)
        vshPrint(ctl, _(" from '%s'"), from);
    vshPrint(ctl, "\n");

    ret = TRUE;

cleanup:
    VIR_FREE(name);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
    {"help", N_("Get the current snapshot")},
    {"desc", N_("Get the current snapshot")},
    {NULL, NULL}
};

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

static int
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
    int current;
    virDomainSnapshotPtr snapshot = NULL;

10286
    if (!vshConnectionUsability(ctl, ctl->conn))
10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
        char *xml;

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

        xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
        if (!xml)
            goto cleanup;

        vshPrint(ctl, "%s", xml);
        VIR_FREE(xml);
    }

    ret = TRUE;

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-list" command
 */
static const vshCmdInfo info_snapshot_list[] = {
    {"help", N_("List snapshots for a domain")},
    {"desc", N_("Snapshot List")},
    {NULL, NULL}
};

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

static int
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
    int numsnaps;
    char **names = NULL;
10342
    int actual = 0;
10343 10344 10345 10346 10347 10348 10349 10350 10351 10352
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
    long creation;
    char timestr[100];
    struct tm time_info;

10353
    if (!vshConnectionUsability(ctl, ctl->conn))
10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

10365 10366
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411

    if (numsnaps) {
        if (VIR_ALLOC_N(names, numsnaps) < 0)
            goto cleanup;

        actual = virDomainSnapshotListNames(dom, names, numsnaps, 0);
        if (actual < 0)
            goto cleanup;

        qsort(&names[0], actual, sizeof(char*), namesorter);

        for (i = 0; i < actual; i++) {
            /* free up memory from previous iterations of the loop */
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
            if (xml)
                xmlFreeDoc(xml);
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

            xml = xmlReadDoc((const xmlChar *) doc, "domainsnapshot.xml", NULL,
                             XML_PARSE_NOENT | XML_PARSE_NONET |
                             XML_PARSE_NOWARNING);
            if (!xml)
                continue;
            ctxt = xmlXPathNewContext(xml);
            if (!ctxt)
                continue;

            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
            if (virXPathLong("string(/domainsnapshot/creationTime)", ctxt,
                             &creation) < 0)
                continue;
            localtime_r(&creation, &time_info);
10412
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428

            vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
        }
    }

    ret = TRUE;

cleanup:
    /* this frees up memory from the last iteration of the loop */
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    VIR_FREE(doc);
10429 10430
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457
    VIR_FREE(names);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-dumpxml" command
 */
static const vshCmdInfo info_snapshot_dumpxml[] = {
    {"help", N_("Dump XML for a domain snapshot")},
    {"desc", N_("Snapshot Dump XML")},
    {NULL, NULL}
};

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

static int
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
10458
    const char *name = NULL;
10459 10460 10461
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

10462
    if (!vshConnectionUsability(ctl, ctl->conn))
10463 10464 10465 10466 10467 10468
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10469
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10470 10471 10472 10473 10474 10475 10476 10477 10478 10479
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

10480
    vshPrint(ctl, "%s", xml);
10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494

    ret = TRUE;

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
10495
 * "snapshot-revert" command
10496
 */
10497
static const vshCmdInfo info_snapshot_revert[] = {
10498 10499 10500 10501 10502
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

10503
static const vshCmdOptDef opts_snapshot_revert[] = {
10504 10505 10506 10507 10508 10509
    {"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 int
10510
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
10511 10512 10513
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
10514
    const char *name = NULL;
10515 10516
    virDomainSnapshotPtr snapshot = NULL;

10517
    if (!vshConnectionUsability(ctl, ctl->conn))
10518 10519 10520 10521 10522 10523
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10524
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    if (virDomainRevertToSnapshot(snapshot, 0) < 0)
        goto cleanup;

    ret = TRUE;

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

static int
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
10566
    const char *name = NULL;
10567 10568 10569
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

10570
    if (!vshConnectionUsability(ctl, ctl->conn))
10571 10572 10573 10574 10575 10576
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10577
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    if (virDomainSnapshotDelete(snapshot, flags) < 0)
        goto cleanup;

    ret = TRUE;

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
    {"help", N_("Qemu Monitor Command")},
    {"desc", N_("Qemu Monitor Command")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"cmd", VSH_OT_DATA, VSH_OFLAG_REQ, N_("command")},
10613
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
10614 10615 10616 10617 10618 10619 10620 10621
    {NULL, 0, 0, NULL}
};

static int
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
10622
    const char *monitor_cmd = NULL;
10623
    char *result = NULL;
10624
    unsigned int flags = 0;
10625 10626 10627 10628 10629 10630 10631 10632

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10633
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
10634 10635 10636 10637
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

10638 10639 10640 10641
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655
        goto cleanup;

    printf("%s\n", result);

    ret = TRUE;

cleanup:
    VIR_FREE(result);
    if (dom)
        virDomainFree(dom);

    return ret;
}

10656
static const vshCmdDef domManagementCmds[] = {
10657 10658 10659
    {"attach-device", cmdAttachDevice, opts_attach_device, info_attach_device},
    {"attach-disk", cmdAttachDisk, opts_attach_disk, info_attach_disk},
    {"attach-interface", cmdAttachInterface, opts_attach_interface, info_attach_interface},
10660
    {"autostart", cmdAutostart, opts_autostart, info_autostart},
10661
    {"blkiotune", cmdBlkiotune, opts_blkiotune, info_blkiotune},
10662
#ifndef WIN32
10663
    {"console", cmdConsole, opts_console, info_console},
10664
#endif
10665
    {"cpu-baseline", cmdCPUBaseline, opts_cpu_baseline, info_cpu_baseline},
10666
    {"cpu-compare", cmdCPUCompare, opts_cpu_compare, info_cpu_compare},
10667
    {"create", cmdCreate, opts_create, info_create},
10668
    {"define", cmdDefine, opts_define, info_define},
K
Karel Zak 已提交
10669
    {"destroy", cmdDestroy, opts_destroy, info_destroy},
10670 10671 10672
    {"detach-device", cmdDetachDevice, opts_detach_device, info_detach_device},
    {"detach-disk", cmdDetachDisk, opts_detach_disk, info_detach_disk},
    {"detach-interface", cmdDetachInterface, opts_detach_interface, info_detach_interface},
K
Karel Zak 已提交
10673
    {"domid", cmdDomid, opts_domid, info_domid},
10674
    {"domjobabort", cmdDomjobabort, opts_domjobabort, info_domjobabort},
10675
    {"domjobinfo", cmdDomjobinfo, opts_domjobinfo, info_domjobinfo},
K
Karel Zak 已提交
10676
    {"domname", cmdDomname, opts_domname, info_domname},
10677
    {"domuuid", cmdDomuuid, opts_domuuid, info_domuuid},
10678 10679
    {"domxml-from-native", cmdDomXMLFromNative, opts_domxmlfromnative, info_domxmlfromnative},
    {"domxml-to-native", cmdDomXMLToNative, opts_domxmltonative, info_domxmltonative},
10680
    {"dump", cmdDump, opts_dump, info_dump},
10681
    {"dumpxml", cmdDumpXML, opts_dumpxml, info_dumpxml},
10682
    {"edit", cmdEdit, opts_edit, info_edit},
10683 10684
    {"managedsave", cmdManagedSave, opts_managedsave, info_managedsave},
    {"managedsave-remove", cmdManagedSaveRemove, opts_managedsaveremove, info_managedsaveremove},
E
Eric Blake 已提交
10685
    {"maxvcpus", cmdMaxvcpus, opts_maxvcpus, info_maxvcpus},
10686
    {"memtune", cmdMemtune, opts_memtune, info_memtune},
10687
    {"migrate", cmdMigrate, opts_migrate, info_migrate},
10688
    {"migrate-setmaxdowntime", cmdMigrateSetMaxDowntime, opts_migrate_setmaxdowntime, info_migrate_setmaxdowntime},
10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722
    {"reboot", cmdReboot, opts_reboot, info_reboot},
    {"restore", cmdRestore, opts_restore, info_restore},
    {"resume", cmdResume, opts_resume, info_resume},
    {"save", cmdSave, opts_save, info_save},
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo},
    {"setmaxmem", cmdSetmaxmem, opts_setmaxmem, info_setmaxmem},
    {"setmem", cmdSetmem, opts_setmem, info_setmem},
    {"setvcpus", cmdSetvcpus, opts_setvcpus, info_setvcpus},
    {"shutdown", cmdShutdown, opts_shutdown, info_shutdown},
    {"start", cmdStart, opts_start, info_start},
    {"suspend", cmdSuspend, opts_suspend, info_suspend},
    {"ttyconsole", cmdTTYConsole, opts_ttyconsole, info_ttyconsole},
    {"undefine", cmdUndefine, opts_undefine, info_undefine},
    {"update-device", cmdUpdateDevice, opts_update_device, info_update_device},
    {"vcpucount", cmdVcpucount, opts_vcpucount, info_vcpucount},
    {"vcpuinfo", cmdVcpuinfo, opts_vcpuinfo, info_vcpuinfo},
    {"vcpupin", cmdVcpupin, opts_vcpupin, info_vcpupin},
    {"version", cmdVersion, NULL, info_version},
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay},
    {NULL, NULL, NULL, NULL}
};

static const vshCmdDef domMonitoringCmds[] = {
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat},
    {"domifstat", cmdDomIfstat, opts_domifstat, info_domifstat},
    {"dominfo", cmdDominfo, opts_dominfo, info_dominfo},
    {"dommemstat", cmdDomMemStat, opts_dommemstat, info_dommemstat},
    {"domstate", cmdDomstate, opts_domstate, info_domstate},
    {"list", cmdList, opts_list, info_list},
    {NULL, NULL, NULL, NULL}
};

static const vshCmdDef storagePoolCmds[] = {
10723 10724 10725 10726
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as},
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
     opts_find_storage_pool_sources, info_find_storage_pool_sources},
10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752
    {"pool-autostart", cmdPoolAutostart, opts_pool_autostart, info_pool_autostart},
    {"pool-build", cmdPoolBuild, opts_pool_build, info_pool_build},
    {"pool-create-as", cmdPoolCreateAs, opts_pool_X_as, info_pool_create_as},
    {"pool-create", cmdPoolCreate, opts_pool_create, info_pool_create},
    {"pool-define-as", cmdPoolDefineAs, opts_pool_X_as, info_pool_define_as},
    {"pool-define", cmdPoolDefine, opts_pool_define, info_pool_define},
    {"pool-delete", cmdPoolDelete, opts_pool_delete, info_pool_delete},
    {"pool-destroy", cmdPoolDestroy, opts_pool_destroy, info_pool_destroy},
    {"pool-dumpxml", cmdPoolDumpXML, opts_pool_dumpxml, info_pool_dumpxml},
    {"pool-edit", cmdPoolEdit, opts_pool_edit, info_pool_edit},
    {"pool-info", cmdPoolInfo, opts_pool_info, info_pool_info},
    {"pool-list", cmdPoolList, opts_pool_list, info_pool_list},
    {"pool-name", cmdPoolName, opts_pool_name, info_pool_name},
    {"pool-refresh", cmdPoolRefresh, opts_pool_refresh, info_pool_refresh},
    {"pool-start", cmdPoolStart, opts_pool_start, info_pool_start},
    {"pool-undefine", cmdPoolUndefine, opts_pool_undefine, info_pool_undefine},
    {"pool-uuid", cmdPoolUuid, opts_pool_uuid, info_pool_uuid},
    {NULL, NULL, NULL, NULL}
};

static const vshCmdDef storageVolCmds[] = {
    {"vol-clone", cmdVolClone, opts_vol_clone, info_vol_clone},
    {"vol-create-as", cmdVolCreateAs, opts_vol_create_as, info_vol_create_as},
    {"vol-create", cmdVolCreate, opts_vol_create, info_vol_create},
    {"vol-create-from", cmdVolCreateFrom, opts_vol_create_from, info_vol_create_from},
    {"vol-delete", cmdVolDelete, opts_vol_delete, info_vol_delete},
10753
    {"vol-download", cmdVolDownload, opts_vol_download, info_vol_download },
10754 10755 10756 10757 10758 10759 10760
    {"vol-dumpxml", cmdVolDumpXML, opts_vol_dumpxml, info_vol_dumpxml},
    {"vol-info", cmdVolInfo, opts_vol_info, info_vol_info},
    {"vol-key", cmdVolKey, opts_vol_key, info_vol_key},
    {"vol-list", cmdVolList, opts_vol_list, info_vol_list},
    {"vol-name", cmdVolName, opts_vol_name, info_vol_name},
    {"vol-path", cmdVolPath, opts_vol_path, info_vol_path},
    {"vol-pool", cmdVolPool, opts_vol_pool, info_vol_pool},
10761
    {"vol-upload", cmdVolUpload, opts_vol_upload, info_vol_upload },
10762 10763 10764
    {"vol-wipe", cmdVolWipe, opts_vol_wipe, info_vol_wipe},
    {NULL, NULL, NULL, NULL}
};
10765

10766
static const vshCmdDef networkCmds[] = {
10767
    {"net-autostart", cmdNetworkAutostart, opts_network_autostart, info_network_autostart},
10768 10769 10770 10771
    {"net-create", cmdNetworkCreate, opts_network_create, info_network_create},
    {"net-define", cmdNetworkDefine, opts_network_define, info_network_define},
    {"net-destroy", cmdNetworkDestroy, opts_network_destroy, info_network_destroy},
    {"net-dumpxml", cmdNetworkDumpXML, opts_network_dumpxml, info_network_dumpxml},
10772
    {"net-edit", cmdNetworkEdit, opts_network_edit, info_network_edit},
O
Osier Yang 已提交
10773
    {"net-info", cmdNetworkInfo, opts_network_info, info_network_info},
10774 10775 10776 10777 10778
    {"net-list", cmdNetworkList, opts_network_list, info_network_list},
    {"net-name", cmdNetworkName, opts_network_name, info_network_name},
    {"net-start", cmdNetworkStart, opts_network_start, info_network_start},
    {"net-undefine", cmdNetworkUndefine, opts_network_undefine, info_network_undefine},
    {"net-uuid", cmdNetworkUuid, opts_network_uuid, info_network_uuid},
10779 10780
    {NULL, NULL, NULL, NULL}
};
10781

10782 10783 10784
static const vshCmdDef nodedevCmds[] = {
    {"nodedev-create", cmdNodeDeviceCreate, opts_node_device_create, info_node_device_create},
    {"nodedev-destroy", cmdNodeDeviceDestroy, opts_node_device_destroy, info_node_device_destroy},
10785
    {"nodedev-dettach", cmdNodeDeviceDettach, opts_node_device_dettach, info_node_device_dettach},
10786 10787
    {"nodedev-dumpxml", cmdNodeDeviceDumpXML, opts_node_device_dumpxml, info_node_device_dumpxml},
    {"nodedev-list", cmdNodeListDevices, opts_node_list_devices, info_node_list_devices},
10788 10789
    {"nodedev-reattach", cmdNodeDeviceReAttach, opts_node_device_reattach, info_node_device_reattach},
    {"nodedev-reset", cmdNodeDeviceReset, opts_node_device_reset, info_node_device_reset},
10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804
    {NULL, NULL, NULL, NULL}
};

static const vshCmdDef ifaceCmds[] = {
    {"iface-define", cmdInterfaceDefine, opts_interface_define, info_interface_define},
    {"iface-destroy", cmdInterfaceDestroy, opts_interface_destroy, info_interface_destroy},
    {"iface-dumpxml", cmdInterfaceDumpXML, opts_interface_dumpxml, info_interface_dumpxml},
    {"iface-edit", cmdInterfaceEdit, opts_interface_edit, info_interface_edit},
    {"iface-list", cmdInterfaceList, opts_interface_list, info_interface_list},
    {"iface-mac", cmdInterfaceMAC, opts_interface_mac, info_interface_mac},
    {"iface-name", cmdInterfaceName, opts_interface_name, info_interface_name},
    {"iface-start", cmdInterfaceStart, opts_interface_start, info_interface_start},
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine, info_interface_undefine},
    {NULL, NULL, NULL, NULL}
};
10805

10806
static const vshCmdDef nwfilterCmds[] = {
10807 10808 10809
    {"nwfilter-define", cmdNWFilterDefine, opts_nwfilter_define, info_nwfilter_define},
    {"nwfilter-dumpxml", cmdNWFilterDumpXML, opts_nwfilter_dumpxml, info_nwfilter_dumpxml},
    {"nwfilter-edit", cmdNWFilterEdit, opts_nwfilter_edit, info_nwfilter_edit},
10810 10811 10812 10813
    {"nwfilter-list", cmdNWFilterList, opts_nwfilter_list, info_nwfilter_list},
    {"nwfilter-undefine", cmdNWFilterUndefine, opts_nwfilter_undefine, info_nwfilter_undefine},
    {NULL, NULL, NULL, NULL}
};
10814

10815
static const vshCmdDef secretCmds[] = {
10816 10817 10818 10819
    {"secret-define", cmdSecretDefine, opts_secret_define, info_secret_define},
    {"secret-dumpxml", cmdSecretDumpXML, opts_secret_dumpxml, info_secret_dumpxml},
    {"secret-get-value", cmdSecretGetValue, opts_secret_get_value, info_secret_get_value},
    {"secret-list", cmdSecretList, NULL, info_secret_list},
10820 10821 10822 10823
    {"secret-set-value", cmdSecretSetValue, opts_secret_set_value, info_secret_set_value},
    {"secret-undefine", cmdSecretUndefine, opts_secret_undefine, info_secret_undefine},
    {NULL, NULL, NULL, NULL}
};
10824

10825 10826 10827 10828 10829 10830 10831
static const vshCmdDef virshCmds[] = {
#ifndef WIN32
    {"cd", cmdCd, opts_cd, info_cd},
#endif
    {"echo", cmdEcho, opts_echo, info_echo},
    {"exit", cmdQuit, NULL, info_quit},
    {"help", cmdHelp, opts_help, info_help},
10832
#ifndef WIN32
P
Paolo Bonzini 已提交
10833
    {"pwd", cmdPwd, NULL, info_pwd},
10834
#endif
K
Karel Zak 已提交
10835
    {"quit", cmdQuit, NULL, info_quit},
10836 10837
    {NULL, NULL, NULL, NULL}
};
10838

10839
static const vshCmdDef snapshotCmds[] = {
10840 10841 10842 10843 10844
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create, info_snapshot_create},
    {"snapshot-current", cmdSnapshotCurrent, opts_snapshot_current, info_snapshot_current},
    {"snapshot-delete", cmdSnapshotDelete, opts_snapshot_delete, info_snapshot_delete},
    {"snapshot-dumpxml", cmdSnapshotDumpXML, opts_snapshot_dumpxml, info_snapshot_dumpxml},
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list, info_snapshot_list},
10845
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert, info_snapshot_revert},
10846 10847
    {NULL, NULL, NULL, NULL}
};
10848

10849 10850 10851 10852 10853
static const vshCmdDef hostAndHypervisorCmds[] = {
    {"capabilities", cmdCapabilities, NULL, info_capabilities},
    {"connect", cmdConnect, opts_connect, info_connect},
    {"freecell", cmdFreecell, opts_freecell, info_freecell},
    {"hostname", cmdHostname, NULL, info_hostname},
10854
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo},
10855
    {"qemu-monitor-command", cmdQemuMonitorCommand, opts_qemu_monitor_command, info_qemu_monitor_command},
E
Eric Blake 已提交
10856
    {"sysinfo", cmdSysinfo, NULL, info_sysinfo},
10857
    {"uri", cmdURI, NULL, info_uri},
10858
    {NULL, NULL, NULL, NULL}
K
Karel Zak 已提交
10859 10860
};

10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877
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 已提交
10878 10879 10880 10881
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
10882
static const char *
10883
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
10884
{
10885
    const vshCmdInfo *info;
10886

K
Karel Zak 已提交
10887
    for (info = cmd->info; info && info->name; info++) {
10888
        if (STREQ(info->name, name))
K
Karel Zak 已提交
10889 10890 10891 10892 10893
            return info->data;
    }
    return NULL;
}

10894 10895
static const vshCmdOptDef *
vshCmddefGetOption(const vshCmdDef * cmd, const char *name)
10896
{
10897
    const vshCmdOptDef *opt;
10898

K
Karel Zak 已提交
10899
    for (opt = cmd->opts; opt && opt->name; opt++)
10900
        if (STREQ(opt->name, name))
K
Karel Zak 已提交
10901 10902 10903 10904
            return opt;
    return NULL;
}

10905 10906
static const vshCmdOptDef *
vshCmddefGetData(const vshCmdDef * cmd, int data_ct)
10907
{
10908
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
10909

10910
    for (opt = cmd->opts; opt && opt->name; opt++) {
10911 10912
        if (opt->type >= VSH_OT_DATA ||
            (opt->type == VSH_OT_INT && (opt->flag & VSH_OFLAG_REQ))) {
10913
            if (data_ct == 0 || opt->type == VSH_OT_ARGV)
10914 10915 10916 10917 10918
                return opt;
            else
                data_ct--;
        }
    }
K
Karel Zak 已提交
10919 10920 10921
    return NULL;
}

10922 10923 10924
/*
 * Checks for required options
 */
10925
static int
10926
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd)
10927
{
10928 10929
    const vshCmdDef *def = cmd->def;
    const vshCmdOptDef *d;
10930
    int err = 0;
10931 10932 10933 10934

    for (d = def->opts; d && d->name; d++) {
        if (d->flag & VSH_OFLAG_REQ) {
            vshCmdOpt *o = cmd->opts;
10935 10936 10937
            int ok = 0;

            while (o && ok == 0) {
10938
                if (o->def == d)
10939
                    ok = 1;
10940 10941 10942
                o = o->next;
            }
            if (!ok) {
10943
                vshError(ctl,
10944
                         d->type == VSH_OT_DATA ?
10945
                         _("command '%s' requires <%s> option") :
10946
                         _("command '%s' requires --%s option"),
10947
                         def->name, d->name);
10948 10949
                err = 1;
            }
10950

10951 10952 10953 10954 10955
        }
    }
    return !err;
}

10956
static const vshCmdDef *
10957 10958
vshCmddefSearch(const char *cmdname)
{
10959
    const vshCmdGrp *g;
10960
    const vshCmdDef *c;
10961

10962 10963 10964 10965 10966 10967 10968
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
            if(STREQ(c->name, cmdname))
                return c;
        }
    }

K
Karel Zak 已提交
10969 10970 10971
    return NULL;
}

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
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
        if(STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
            return g;
    }

    return NULL;
}

static int
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);
        return FALSE;
    } 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")));
        }
    }

    return TRUE;
}

K
Karel Zak 已提交
11007
static int
11008
vshCmddefHelp(vshControl *ctl, const char *cmdname)
11009
{
11010
    const vshCmdDef *def = vshCmddefSearch(cmdname);
11011

K
Karel Zak 已提交
11012
    if (!def) {
11013
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
11014 11015
        return FALSE;
    } else {
E
Eric Blake 已提交
11016 11017
        const char *desc = _(vshCmddefGetInfo(def, "desc"));
        const char *help = _(vshCmddefGetInfo(def, "help"));
11018
        char buf[256];
K
Karel Zak 已提交
11019

11020
        fputs(_("  NAME\n"), stdout);
11021 11022
        fprintf(stdout, "    %s - %s\n", def->name, help);

11023 11024 11025 11026 11027 11028
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
                const char *fmt;
11029 11030
                switch (opt->type) {
                case VSH_OT_BOOL:
11031
                    fmt = "[--%s]";
11032 11033
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
11034
                    /* xgettext:c-format */
11035 11036
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
11037 11038
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
11039 11040
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
11041 11042
                    break;
                case VSH_OT_DATA:
11043
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
11044 11045 11046 11047 11048 11049
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
                    fmt = _("[<string>]...");
                    break;
                default:
11050
                    assert(0);
11051
                }
11052
                fputc(' ', stdout);
E
Eric Blake 已提交
11053
                fprintf(stdout, fmt, opt->name);
11054
            }
K
Karel Zak 已提交
11055
        }
11056 11057 11058
        fputc('\n', stdout);

        if (desc[0]) {
11059
            /* Print the description only if it's not empty.  */
11060
            fputs(_("\n  DESCRIPTION\n"), stdout);
K
Karel Zak 已提交
11061 11062
            fprintf(stdout, "    %s\n", desc);
        }
11063

K
Karel Zak 已提交
11064
        if (def->opts) {
11065
            const vshCmdOptDef *opt;
11066
            fputs(_("\n  OPTIONS\n"), stdout);
11067
            for (opt = def->opts; opt->name; opt++) {
11068 11069
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
11070
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
11071 11072
                    break;
                case VSH_OT_INT:
11073 11074 11075
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
11076 11077
                    break;
                case VSH_OT_STRING:
11078
                    /* OT_STRING should never be VSH_OFLAG_REQ */
11079
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
11080 11081
                    break;
                case VSH_OT_DATA:
11082 11083
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
11084 11085 11086 11087 11088 11089 11090
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
                    continue;
                default:
                    assert(0);
                }
11091

E
Eric Blake 已提交
11092
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
11093
            }
K
Karel Zak 已提交
11094 11095 11096 11097 11098 11099 11100 11101 11102 11103
        }
        fputc('\n', stdout);
    }
    return TRUE;
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
11104 11105 11106
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
11107 11108
    vshCmdOpt *a = arg;

11109
    while (a) {
K
Karel Zak 已提交
11110
        vshCmdOpt *tmp = a;
11111

K
Karel Zak 已提交
11112 11113
        a = a->next;

11114 11115
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
11116 11117 11118 11119
    }
}

static void
11120
vshCommandFree(vshCmd *cmd)
11121
{
K
Karel Zak 已提交
11122 11123
    vshCmd *c = cmd;

11124
    while (c) {
K
Karel Zak 已提交
11125
        vshCmd *tmp = c;
11126

K
Karel Zak 已提交
11127 11128 11129 11130
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
11131
        VIR_FREE(tmp);
K
Karel Zak 已提交
11132 11133 11134 11135 11136 11137 11138
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
11139
vshCommandOpt(const vshCmd *cmd, const char *name)
11140
{
K
Karel Zak 已提交
11141
    vshCmdOpt *opt = cmd->opts;
11142 11143

    while (opt) {
11144
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
11145 11146 11147 11148 11149 11150 11151
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
11152 11153 11154 11155 11156 11157 11158 11159 11160
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Convert option to int
 * Return value:
 * >0 if option found and valid (@value updated)
 * 0 in case option not found (@value untouched)
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
11161 11162
 */
static int
11163
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
11164
{
K
Karel Zak 已提交
11165
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11166
    int ret = 0, num;
11167
    char *end_p = NULL;
11168

11169
    if ((arg != NULL) && (arg->data != NULL)) {
11170 11171 11172 11173 11174 11175
        num = strtol(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11176
    }
11177
    return ret;
K
Karel Zak 已提交
11178 11179
}

11180 11181 11182 11183 11184 11185
/*
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
11186 11187
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11188 11189
    int ret = 0;
    unsigned long num;
11190 11191 11192
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
11193 11194 11195 11196 11197 11198
        num = strtoul(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11199
    }
11200
    return ret;
11201 11202
}

K
Karel Zak 已提交
11203 11204
/*
 * Returns option as STRING
11205
 * See vshCommandOptInt()
K
Karel Zak 已提交
11206
 */
11207 11208
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
11209
{
K
Karel Zak 已提交
11210
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11211 11212 11213
    int ret = 0;

    if (arg && arg->data) {
E
Eric Blake 已提交
11214 11215 11216 11217
        if (*arg->data
            || (arg->def && (arg->def->flag & VSH_OFLAG_EMPTY_OK))) {
            *value = arg->data;
            ret = 1;
11218 11219
        } else if (arg->def && ((arg->def->flag) & VSH_OFLAG_REQ)) {
            vshError(NULL, _("Missing required option '%s'"), name);
E
Eric Blake 已提交
11220 11221 11222 11223
            ret = -1;
        } else {
            /* Treat "--option ''" as if option had not been specified. */
            ret = 0;
11224 11225
        }
    }
11226

11227
    return ret;
K
Karel Zak 已提交
11228 11229
}

11230 11231
/*
 * Returns option as long long
11232
 * See vshCommandOptInt()
11233
 */
11234 11235 11236
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
11237 11238
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11239 11240
    int ret = 0;
    long long num;
11241 11242
    char *end_p = NULL;

11243 11244 11245 11246 11247 11248 11249 11250 11251
    if ((arg != NULL) && (arg->data != NULL)) {
        num = strtoll(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
    }
    return ret;
11252 11253
}

11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
    int ret = 0;
    unsigned long long num;
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
        num = strtoull(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
    }
    return ret;
}


K
Karel Zak 已提交
11275 11276 11277 11278
/*
 * Returns TRUE/FALSE if the option exists
 */
static int
11279
vshCommandOptBool(const vshCmd *cmd, const char *name)
11280
{
K
Karel Zak 已提交
11281 11282 11283
    return vshCommandOpt(cmd, name) ? TRUE : FALSE;
}

11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304
/*
 * Returns the COUNT argv argument, or NULL after last argument.
 *
 * Requires that a VSH_OT_ARGV option with the name "" be last in the
 * list of supported options in CMD->def->opts.
 */
static char *
vshCommandOptArgv(const vshCmd *cmd, int count)
{
    vshCmdOpt *opt = cmd->opts;

    while (opt) {
        if (opt->def && opt->def->type == VSH_OT_ARGV) {
            if (count-- == 0)
                return opt->data;
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322
/* 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)
11323
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
11324 11325 11326
                 cmd->def->name, optname);
    return found;
}
11327

K
Karel Zak 已提交
11328
static virDomainPtr
J
Jim Meyering 已提交
11329
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
11330
                      const char **name, int flag)
11331
{
K
Karel Zak 已提交
11332
    virDomainPtr dom = NULL;
11333
    const char *n = NULL;
K
Karel Zak 已提交
11334
    int id;
J
Jim Meyering 已提交
11335 11336 11337
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11338

11339
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11340 11341
        return NULL;

K
Karel Zak 已提交
11342
    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
11343 11344
             cmd->def->name, optname, n);

K
Karel Zak 已提交
11345 11346
    if (name)
        *name = n;
11347

K
Karel Zak 已提交
11348
    /* try it by ID */
11349
    if (flag & VSH_BYID) {
11350
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
11351 11352 11353 11354
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
11355
    }
K
Karel Zak 已提交
11356
    /* try it by UUID */
11357
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
11358
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
11359
                 cmd->def->name, optname);
K
Karel Zak 已提交
11360
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
11361
    }
K
Karel Zak 已提交
11362
    /* try it by NAME */
11363
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11364
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
11365
                 cmd->def->name, optname);
K
Karel Zak 已提交
11366
        dom = virDomainLookupByName(ctl->conn, n);
11367
    }
K
Karel Zak 已提交
11368

11369
    if (!dom)
11370
        vshError(ctl, _("failed to get domain '%s'"), n);
11371

K
Karel Zak 已提交
11372 11373 11374
    return dom;
}

11375
static virNetworkPtr
J
Jim Meyering 已提交
11376
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
11377
                       const char **name, int flag)
11378 11379
{
    virNetworkPtr network = NULL;
11380
    const char *n = NULL;
J
Jim Meyering 已提交
11381 11382 11383
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11384

11385
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11386 11387 11388 11389 11390 11391 11392 11393 11394
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
11395
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
11396
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
11397
                 cmd->def->name, optname);
11398 11399 11400 11401
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11402
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
11403 11404 11405 11406 11407
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
11408
        vshError(ctl, _("failed to get network '%s'"), n);
11409 11410 11411 11412

    return network;
}

11413 11414 11415

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
11416
                        const char **name, int flag)
11417 11418
{
    virNWFilterPtr nwfilter = NULL;
11419
    const char *n = NULL;
11420 11421 11422 11423
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11424
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
        vshDebug(ctl, 5, "%s: <%s> trying as nwfilter UUID\n",
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
        vshDebug(ctl, 5, "%s: <%s> trying as nwfilter NAME\n",
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

11452 11453
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
11454
                         const char **name, int flag)
11455 11456
{
    virInterfacePtr iface = NULL;
11457
    const char *n = NULL;
11458 11459 11460 11461
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11462
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11463 11464 11465 11466 11467 11468 11469 11470 11471
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
11472
    if ((flag & VSH_BYNAME)) {
11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484
        vshDebug(ctl, 5, "%s: <%s> trying as interface NAME\n",
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
        vshDebug(ctl, 5, "%s: <%s> trying as interface MAC\n",
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
11485
        vshError(ctl, _("failed to get interface '%s'"), n);
11486 11487 11488 11489

    return iface;
}

11490
static virStoragePoolPtr
11491
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
11492
                    const char **name, int flag)
11493 11494
{
    virStoragePoolPtr pool = NULL;
11495
    const char *n = NULL;
11496

11497
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11498 11499 11500 11501 11502 11503 11504 11505 11506
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
11507
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
11508
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
11509
                 cmd->def->name, optname);
11510 11511 11512
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
11513
    if (pool == NULL && (flag & VSH_BYNAME)) {
11514 11515 11516 11517 11518 11519
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
11520
        vshError(ctl, _("failed to get pool '%s'"), n);
11521 11522 11523 11524 11525

    return pool;
}

static virStorageVolPtr
11526
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
11527 11528
                   const char *optname,
                   const char *pooloptname,
11529
                   const char **name, int flag)
11530 11531 11532
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
11533
    const char *n = NULL, *p = NULL;
11534

11535
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11536 11537
        return NULL;

11538 11539
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
11540
        return NULL;
11541
    }
11542 11543 11544 11545 11546 11547 11548 11549 11550 11551

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

11552
    /* try it by name */
11553
    if (pool && (flag & VSH_BYNAME)) {
11554
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
11555 11556 11557
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
11558
    /* try it by key */
11559 11560 11561 11562 11563
    if (vol == NULL && (flag & VSH_BYUUID)) {
        vshDebug(ctl, 5, "%s: <%s> trying as vol key\n",
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
11564
    /* try it by path */
11565 11566 11567 11568 11569 11570 11571
    if (vol == NULL && (flag & VSH_BYUUID)) {
        vshDebug(ctl, 5, "%s: <%s> trying as vol path\n",
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
11572
        vshError(ctl, _("failed to get vol '%s'"), n);
11573 11574 11575 11576 11577 11578 11579

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

11580
static virSecretPtr
11581
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
11582 11583
{
    virSecretPtr secret = NULL;
11584
    const char *n = NULL;
11585 11586 11587 11588 11589
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11590
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11591 11592 11593 11594 11595 11596 11597 11598 11599 11600
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n", cmd->def->name, optname, n);

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
11601
        vshError(ctl, _("failed to get secret '%s'"), n);
11602 11603 11604 11605

    return secret;
}

K
Karel Zak 已提交
11606 11607 11608 11609
/*
 * Executes command(s) and returns return code from last command
 */
static int
11610
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
11611
{
K
Karel Zak 已提交
11612
    int ret = TRUE;
11613 11614

    while (cmd) {
K
Karel Zak 已提交
11615
        struct timeval before, after;
11616
        bool enable_timing = ctl->timing;
11617

11618 11619 11620
        if ((ctl->conn == NULL) || (disconnected != 0))
            vshReconnect(ctl);

11621
        if (enable_timing)
K
Karel Zak 已提交
11622
            GETTIMEOFDAY(&before);
11623

K
Karel Zak 已提交
11624 11625
        ret = cmd->def->handler(ctl, cmd);

11626
        if (enable_timing)
K
Karel Zak 已提交
11627
            GETTIMEOFDAY(&after);
11628

J
John Levon 已提交
11629 11630 11631
        if (ret == FALSE)
            virshReportError(ctl);

11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642
        /* try to automatically catch disconnections */
        if ((ret == FALSE) &&
            ((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);

11643
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
11644 11645
            return ret;

11646
        if (enable_timing)
11647
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
11648 11649
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
11650
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
11651 11652 11653 11654 11655 11656
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
11657
 * Command parsing
K
Karel Zak 已提交
11658 11659 11660
 * ---------------
 */

11661 11662 11663 11664 11665 11666 11667 11668 11669 11670
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 已提交
11671
    /* vshCommandStringGetArg() */
11672
    char *pos;
L
Lai Jiangshan 已提交
11673 11674 11675
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
11676 11677
} vshCommandParser;

K
Karel Zak 已提交
11678
static int
11679
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
11680
{
K
Karel Zak 已提交
11681 11682 11683
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
11684

K
Karel Zak 已提交
11685 11686 11687 11688
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
11689

11690
    while (1) {
K
Karel Zak 已提交
11691
        vshCmdOpt *last = NULL;
11692
        const vshCmdDef *cmd = NULL;
11693
        vshCommandToken tk;
L
Lai Jiangshan 已提交
11694
        bool data_only = false;
11695
        int data_ct = 0;
11696

K
Karel Zak 已提交
11697
        first = NULL;
11698

11699
        while (1) {
11700
            const vshCmdOptDef *opt = NULL;
11701

K
Karel Zak 已提交
11702
            tkdata = NULL;
11703
            tk = parser->getNextArg(ctl, parser, &tkdata);
11704 11705

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
11706
                goto syntaxError;
H
Hu Tao 已提交
11707 11708
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
11709
                break;
H
Hu Tao 已提交
11710
            }
11711 11712

            if (cmd == NULL) {
K
Karel Zak 已提交
11713 11714
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
11715
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
11716
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
11717
                }
11718
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
11719 11720 11721 11722
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
11723 11724 11725 11726 11727 11728
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
                if (!(opt = vshCmddefGetOption(cmd, tkdata + 2))) {
11729
                    vshError(ctl,
11730
                             _("command '%s' doesn't support option --%s"),
11731 11732
                             cmd->name, tkdata + 2);
                    VIR_FREE(optstr);
K
Karel Zak 已提交
11733 11734
                    goto syntaxError;
                }
11735
                VIR_FREE(tkdata);
K
Karel Zak 已提交
11736 11737 11738

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
11739 11740 11741
                    if (optstr)
                        tkdata = optstr;
                    else
11742
                        tk = parser->getNextArg(ctl, parser, &tkdata);
11743
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
11744
                        goto syntaxError;
11745
                    if (tk != VSH_TK_ARG) {
11746
                        vshError(ctl,
11747
                                 _("expected syntax: --%s <%s>"),
11748 11749
                                 opt->name,
                                 opt->type ==
11750
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
11751 11752
                        goto syntaxError;
                    }
11753 11754 11755 11756 11757 11758 11759 11760
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
11761
                }
L
Lai Jiangshan 已提交
11762 11763 11764 11765
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
11766
            } else {
L
Lai Jiangshan 已提交
11767
get_data:
11768
                if (!(opt = vshCmddefGetData(cmd, data_ct++))) {
11769
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
11770 11771 11772 11773 11774
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
11775
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
11776

K
Karel Zak 已提交
11777 11778 11779 11780
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
11781

K
Karel Zak 已提交
11782 11783 11784 11785 11786
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
11787

K
Karel Zak 已提交
11788
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
11789 11790
                         cmd->name,
                         opt->name,
11791 11792
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
11793 11794
            }
        }
11795

D
Daniel Veillard 已提交
11796
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
11797
        if (cmd) {
11798
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
11799

K
Karel Zak 已提交
11800 11801 11802 11803
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

11804
            if (!vshCommandCheckOpts(ctl, c)) {
11805
                VIR_FREE(c);
11806
                goto syntaxError;
11807
            }
11808

K
Karel Zak 已提交
11809 11810 11811 11812 11813 11814
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
11815 11816 11817

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
11818
    }
11819

K
Karel Zak 已提交
11820 11821
    return TRUE;

11822
 syntaxError:
11823
    if (ctl->cmd) {
K
Karel Zak 已提交
11824
        vshCommandFree(ctl->cmd);
11825 11826
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
11827 11828
    if (first)
        vshCommandOptFree(first);
11829
    VIR_FREE(tkdata);
11830
    return FALSE;
K
Karel Zak 已提交
11831 11832
}

11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940
/* --------------------
 * 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;
}

static int vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
{
    vshCommandParser parser;

    if (nargs <= 0)
        return FALSE;

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

static int vshCommandStringParse(vshControl *ctl, char *cmdstr)
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
        return FALSE;

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
11941
/* ---------------
11942
 * Misc utils
K
Karel Zak 已提交
11943 11944
 * ---------------
 */
K
Karel Zak 已提交
11945
static const char *
11946 11947
vshDomainStateToString(int state)
{
K
Karel Zak 已提交
11948
    switch (state) {
11949
    case VIR_DOMAIN_RUNNING:
11950
        return N_("running");
11951
    case VIR_DOMAIN_BLOCKED:
11952
        return N_("idle");
11953
    case VIR_DOMAIN_PAUSED:
11954
        return N_("paused");
11955
    case VIR_DOMAIN_SHUTDOWN:
11956
        return N_("in shutdown");
11957
    case VIR_DOMAIN_SHUTOFF:
11958
        return N_("shut off");
11959
    case VIR_DOMAIN_CRASHED:
11960
        return N_("crashed");
11961
    default:
11962
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
11963
    }
11964
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
11965 11966
}

11967 11968 11969 11970
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
11971
    case VIR_VCPU_OFFLINE:
11972
        return N_("offline");
11973
    case VIR_VCPU_BLOCKED:
11974
        return N_("idle");
11975
    case VIR_VCPU_RUNNING:
11976
        return N_("running");
11977
    default:
11978
        ;/*FALLTHROUGH*/
11979
    }
11980
    return N_("no state");
11981 11982
}

K
Karel Zak 已提交
11983
static int
11984
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
11985
{
11986 11987
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
11988 11989
     */
    if (!conn) {
11990
        vshError(ctl, "%s", _("no valid connection"));
K
Karel Zak 已提交
11991 11992 11993 11994 11995
        return FALSE;
    }
    return TRUE;
}

K
Karel Zak 已提交
11996
static void
11997
vshDebug(vshControl *ctl, int level, const char *format, ...)
11998
{
K
Karel Zak 已提交
11999 12000
    va_list ap;

12001 12002 12003 12004
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
12005 12006 12007 12008 12009 12010
    if (level > ctl->debug)
        return;

    va_start(ap, format);
    vfprintf(stdout, format, ap);
    va_end(ap);
K
Karel Zak 已提交
12011 12012 12013
}

static void
12014
vshPrintExtra(vshControl *ctl, const char *format, ...)
12015
{
K
Karel Zak 已提交
12016
    va_list ap;
12017
    char *str;
12018

12019
    if (ctl && ctl->quiet == TRUE)
K
Karel Zak 已提交
12020
        return;
12021

K
Karel Zak 已提交
12022
    va_start(ap, format);
12023 12024 12025 12026 12027
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
12028
    va_end(ap);
12029 12030
    fprintf(stdout, "%s", str);
    VIR_FREE(str);
K
Karel Zak 已提交
12031 12032
}

K
Karel Zak 已提交
12033

K
Karel Zak 已提交
12034
static void
12035
vshError(vshControl *ctl, const char *format, ...)
12036
{
K
Karel Zak 已提交
12037
    va_list ap;
12038
    char *str;
12039

12040 12041 12042 12043 12044
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
12045

12046
    fputs(_("error: "), stderr);
12047

K
Karel Zak 已提交
12048
    va_start(ap, format);
12049 12050 12051
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
12052 12053
    va_end(ap);

12054 12055
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
12056 12057 12058
}

/*
12059
 * Initialize connection.
K
Karel Zak 已提交
12060 12061
 */
static int
12062
vshInit(vshControl *ctl)
12063
{
K
Karel Zak 已提交
12064 12065 12066
    if (ctl->conn)
        return FALSE;

12067 12068
    vshOpenLogFile(ctl);

12069 12070
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
12071

12072 12073 12074
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

12075 12076
    if (virEventRegisterDefaultImpl() < 0)
        return FALSE;
12077

12078 12079 12080 12081
    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

12082

12083 12084 12085 12086
    /* This is not necessarily fatal.  All the individual commands check
     * vshConnectionUsability, except ones which don't need a connection
     * such as "help".
     */
12087
    if (!ctl->conn) {
12088
        virshReportError(ctl);
12089
        vshError(ctl, "%s", _("failed to connect to the hypervisor"));
12090 12091
        return FALSE;
    }
K
Karel Zak 已提交
12092 12093 12094 12095

    return TRUE;
}

12096 12097
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116
/**
 * 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:
12117
                vshError(ctl, "%s",
J
Jim Meyering 已提交
12118
                         _("failed to get the log file information"));
12119
                exit(EXIT_FAILURE);
12120 12121 12122
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
12123 12124
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
12125 12126 12127 12128
        }
    }

    /* log file open */
12129
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
12130
        vshError(ctl, "%s",
J
Jim Meyering 已提交
12131
                 _("failed to open the log file. check the log file path"));
12132
        exit(EXIT_FAILURE);
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
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format, va_list ap)
{
    char msg_buf[MSG_BUFFER];
    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);
    snprintf(msg_buf, sizeof(msg_buf),
             "[%d.%02d.%02d %02d:%02d:%02d ",
             (1900 + stTm->tm_year),
             (1 + stTm->tm_mon),
             (stTm->tm_mday),
             (stTm->tm_hour),
             (stTm->tm_min),
             (stTm->tm_sec));
    snprintf(msg_buf + strlen(msg_buf), sizeof(msg_buf) - strlen(msg_buf),
             "%s] ", SIGN_NAME);
    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;
    }
    snprintf(msg_buf + strlen(msg_buf), sizeof(msg_buf) - strlen(msg_buf),
             "%s ", lvl);
    vsnprintf(msg_buf + strlen(msg_buf), sizeof(msg_buf) - strlen(msg_buf),
              msg_format, ap);

    if (msg_buf[strlen(msg_buf) - 1] != '\n')
        snprintf(msg_buf + strlen(msg_buf), sizeof(msg_buf) - strlen(msg_buf), "\n");

    /* write log */
12198
    if (safewrite(ctl->log_fd, msg_buf, strlen(msg_buf)) < 0) {
12199
        vshCloseLogFile(ctl);
12200
        vshError(ctl, "%s", _("failed to write the log file"));
12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212
    }
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
12213 12214 12215
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
12216 12217 12218
    }

    if (ctl->logfile) {
12219
        VIR_FREE(ctl->logfile);
12220 12221 12222 12223
        ctl->logfile = NULL;
    }
}

12224
#ifdef USE_READLINE
12225

K
Karel Zak 已提交
12226 12227 12228 12229 12230
/* -----------------
 * Readline stuff
 * -----------------
 */

12231
/*
K
Karel Zak 已提交
12232 12233
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
12234
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
12235 12236
 */
static char *
12237 12238
vshReadlineCommandGenerator(const char *text, int state)
{
12239
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
12240
    const char *name;
12241 12242
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
12243 12244

    if (!state) {
12245 12246
        grp_list_index = 0;
        cmd_list_index = 0;
12247
        len = strlen(text);
K
Karel Zak 已提交
12248 12249
    }

12250 12251
    grp = cmdGroups;

K
Karel Zak 已提交
12252
    /* Return the next name which partially matches from the
12253
     * command list.
K
Karel Zak 已提交
12254
     */
12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268
    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 已提交
12269 12270 12271 12272 12273 12274 12275
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
12276 12277
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
12278
    static int list_index, len;
12279
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
12280
    const char *name;
K
Karel Zak 已提交
12281 12282 12283 12284 12285 12286 12287 12288 12289

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

12290
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
12291
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
12292 12293 12294

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
12295
        len = strlen(text);
12296
        VIR_FREE(cmdname);
K
Karel Zak 已提交
12297 12298 12299 12300
    }

    if (!cmd)
        return NULL;
12301

12302 12303 12304
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
12305
    while ((name = cmd->opts[list_index].name)) {
12306
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
12307
        char *res;
12308

K
Karel Zak 已提交
12309
        list_index++;
12310

K
Karel Zak 已提交
12311
        if (opt->type == VSH_OT_DATA)
K
Karel Zak 已提交
12312 12313
            /* ignore non --option */
            continue;
12314

K
Karel Zak 已提交
12315
        if (len > 2) {
12316
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
12317 12318
                continue;
        }
12319
        res = vshMalloc(NULL, strlen(name) + 3);
12320
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
12321 12322 12323 12324 12325 12326 12327 12328
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
12329 12330 12331
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
12332 12333
    char **matches = (char **) NULL;

12334
    if (start == 0)
K
Karel Zak 已提交
12335
        /* command name generator */
12336
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
12337 12338
    else
        /* commands options */
12339
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
12340 12341 12342 12343
    return matches;
}


12344 12345
static int
vshReadlineInit(vshControl *ctl)
12346
{
12347 12348
    char *userdir = NULL;

K
Karel Zak 已提交
12349 12350 12351 12352 12353
    /* 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;
12354 12355 12356

    /* Limit the total size of the history buffer */
    stifle_history(500);
12357 12358

    /* Prepare to read/write history from/to the ~/.virsh/history file */
12359
    userdir = virGetUserDirectory(getuid());
12360 12361 12362 12363 12364 12365

    if (userdir == NULL)
        return -1;

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12366
        VIR_FREE(userdir);
12367 12368 12369 12370 12371
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12372
        VIR_FREE(userdir);
12373 12374 12375
        return -1;
    }

12376
    VIR_FREE(userdir);
12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394

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

12395 12396
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
12397 12398
}

12399 12400 12401 12402 12403 12404
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

12405
#else /* !USE_READLINE */
12406

12407 12408 12409 12410 12411 12412 12413
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

12414
static void
12415
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438
{
    /* 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);
}

12439
#endif /* !USE_READLINE */
12440

K
Karel Zak 已提交
12441
/*
J
Jim Meyering 已提交
12442
 * Deinitialize virsh
K
Karel Zak 已提交
12443 12444
 */
static int
12445
vshDeinit(vshControl *ctl)
12446
{
12447
    vshReadlineDeinit(ctl);
12448
    vshCloseLogFile(ctl);
12449
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
12450
    if (ctl->conn) {
12451 12452 12453
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
12454 12455
        }
    }
D
Daniel P. Berrange 已提交
12456 12457
    virResetLastError();

K
Karel Zak 已提交
12458 12459
    return TRUE;
}
12460

K
Karel Zak 已提交
12461 12462 12463 12464
/*
 * Print usage
 */
static void
12465
vshUsage(void)
12466
{
12467
    const vshCmdGrp *grp;
12468
    const vshCmdDef *cmd;
12469

L
Lai Jiangshan 已提交
12470 12471
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
12472 12473 12474 12475 12476 12477 12478 12479
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
                      "    -d | --debug <num>      debug level [0-5]\n"
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
12480
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
12481
                      "    -V | --version=long     version and full options\n\n"
12482
                      "  commands (non interactive mode):\n\n"), progname, progname);
12483

12484 12485
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
12486

12487 12488 12489 12490 12491 12492 12493 12494 12495
        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"));
12496 12497 12498
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
12499 12500
}

12501 12502 12503 12504 12505 12506 12507 12508 12509 12510
/*
 * 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 已提交
12511 12512
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547
#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 已提交
12548
    vshPrint(ctl, "%s", _(" Networking:"));
12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574
#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 已提交
12575
    vshPrint(ctl, "%s", _(" Storage:"));
12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598
#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 已提交
12599
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
12600
#ifdef WITH_SECDRIVER_APPARMOR
12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623
    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 已提交
12624 12625 12626 12627 12628
/*
 * argv[]:  virsh [options] [command]
 *
 */
static int
12629
vshParseArgv(vshControl *ctl, int argc, char **argv)
12630
{
12631 12632
    bool help = false;
    int arg;
K
Karel Zak 已提交
12633
    struct option opt[] = {
E
Eric Blake 已提交
12634 12635 12636 12637 12638 12639 12640 12641 12642
        {"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}
12643 12644
    };

12645 12646 12647
    /* 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. */
12648
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
12649
        switch (arg) {
12650
        case 'd':
D
Daniel Veillard 已提交
12651
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
12652
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
12653 12654
                exit(EXIT_FAILURE);
            }
12655 12656
            break;
        case 'h':
12657
            help = true;
12658 12659 12660 12661 12662 12663 12664 12665 12666 12667
            break;
        case 'q':
            ctl->quiet = TRUE;
            break;
        case 't':
            ctl->timing = TRUE;
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
12668 12669 12670 12671 12672 12673
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
12674 12675 12676
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
12677 12678 12679
        case 'r':
            ctl->readonly = TRUE;
            break;
12680 12681 12682
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
12683
        default:
12684 12685
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
12686 12687 12688 12689
        }
    }

    if (help) {
12690 12691
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
12692 12693
            exit(EXIT_FAILURE);
        }
12694 12695 12696

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
12697
        exit(EXIT_SUCCESS);
12698 12699
    }

12700
    if (argc > optind) {
K
Karel Zak 已提交
12701 12702
        /* parse command */
        ctl->imode = FALSE;
12703 12704 12705
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
12706
        } else {
12707
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
12708 12709 12710 12711 12712
        }
    }
    return TRUE;
}

12713 12714 12715 12716
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
12717
    char *defaultConn;
K
Karel Zak 已提交
12718 12719
    int ret = TRUE;

12720 12721
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
12722
        /* failure to setup locale is not fatal */
12723
    }
12724
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
12725
        perror("bindtextdomain");
E
Eric Blake 已提交
12726
        return EXIT_FAILURE;
12727
    }
12728
    if (!textdomain(PACKAGE)) {
12729
        perror("textdomain");
E
Eric Blake 已提交
12730
        return EXIT_FAILURE;
12731 12732
    }

12733
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
12734 12735 12736
        progname = argv[0];
    else
        progname++;
12737

K
Karel Zak 已提交
12738
    memset(ctl, 0, sizeof(vshControl));
12739
    ctl->imode = TRUE;          /* default is interactive mode */
12740
    ctl->log_fd = -1;           /* Initialize log file descriptor */
K
Karel Zak 已提交
12741

12742
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
12743
        ctl->name = vshStrdup(ctl, defaultConn);
12744 12745
    }

D
Daniel P. Berrange 已提交
12746 12747
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
12748
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
12749
    }
12750

D
Daniel P. Berrange 已提交
12751 12752
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
12753
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
12754
    }
12755

K
Karel Zak 已提交
12756
    if (!ctl->imode) {
12757
        ret = vshCommandRun(ctl, ctl->cmd);
12758
    } else {
K
Karel Zak 已提交
12759 12760
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
12761
            vshPrint(ctl,
12762
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
12763
                     progname);
J
Jim Meyering 已提交
12764
            vshPrint(ctl, "%s",
12765
                     _("Type:  'help' for help with commands\n"
12766
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
12767
        }
12768 12769 12770 12771 12772 12773

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
12774
        do {
12775
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
12776
            ctl->cmdstr =
12777
                vshReadline(ctl, prompt);
12778 12779
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
12780
            if (*ctl->cmdstr) {
12781
#if USE_READLINE
K
Karel Zak 已提交
12782
                add_history(ctl->cmdstr);
12783
#endif
12784
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
12785 12786
                    vshCommandRun(ctl, ctl->cmd);
            }
12787
            VIR_FREE(ctl->cmdstr);
12788
        } while (ctl->imode);
K
Karel Zak 已提交
12789

12790 12791
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
12792
    }
12793

K
Karel Zak 已提交
12794 12795
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
12796
}