virsh.c 328.9 KB
Newer Older
1
/*
2
 * virsh.c: a shell to exercise the libvirt API
3
 *
J
Jim Meyering 已提交
4
 * Copyright (C) 2005, 2007-2010 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>
K
Karel Zak 已提交
34

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

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

45
#include "internal.h"
46
#include "virterror_internal.h"
47
#include "base64.h"
48
#include "buf.h"
49
#include "console.h"
50
#include "util.h"
51
#include "memory.h"
52
#include "xml.h"
53
#include "libvirt/libvirt-qemu.h"
54
#include "files.h"
55
#include "../daemon/event.h"
56
#include "configmake.h"
K
Karel Zak 已提交
57 58 59 60

static char *progname;

#ifndef TRUE
61 62
# define TRUE 1
# define FALSE 0
K
Karel Zak 已提交
63 64
#endif

65 66
#define VIRSH_MAX_XML_FILE 10*1024*1024

K
Karel Zak 已提交
67 68 69 70 71 72 73 74
#define VSH_PROMPT_RW    "virsh # "
#define VSH_PROMPT_RO    "virsh > "

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

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

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

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

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

/*
 * Command Option Flags
 */
136 137
#define VSH_OFLAG_NONE    0     /* without flags */
#define VSH_OFLAG_REQ    (1 << 1)       /* option required */
K
Karel Zak 已提交
138 139 140 141 142 143 144 145

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

/*
 * vshCmdInfo -- information about command
 */
146 147 148
typedef struct {
    const char *name;           /* name of information */
    const char *data;           /* information */
K
Karel Zak 已提交
149 150 151 152 153
} vshCmdInfo;

/*
 * vshCmdOptDef - command option definition
 */
154 155 156 157 158
typedef struct {
    const char *name;           /* the name of option */
    vshCmdOptType type;         /* option type */
    int flag;                   /* flags */
    const char *help;           /* help string */
K
Karel Zak 已提交
159 160 161 162 163 164
} vshCmdOptDef;

/*
 * vshCmdOpt - command options
 */
typedef struct vshCmdOpt {
165
    const vshCmdOptDef *def;    /* pointer to relevant option */
166 167
    char *data;                 /* allocated data */
    struct vshCmdOpt *next;
K
Karel Zak 已提交
168 169 170 171 172
} vshCmdOpt;

/*
 * vshCmdDef - command definition
 */
173 174
typedef struct {
    const char *name;
175
    int (*handler) (vshControl *, const vshCmd *);    /* command handler */
176 177
    const vshCmdOptDef *opts;   /* definition of command options */
    const vshCmdInfo *info;     /* details about command */
K
Karel Zak 已提交
178 179 180 181 182 183
} vshCmdDef;

/*
 * vshCmd - parsed command
 */
typedef struct __vshCmd {
184
    const vshCmdDef *def;       /* command definition */
185 186
    vshCmdOpt *opts;            /* list of command arguments */
    struct __vshCmd *next;      /* next command */
K
Karel Zak 已提交
187 188 189 190 191 192
} __vshCmd;

/*
 * vshControl
 */
typedef struct __vshControl {
K
Karel Zak 已提交
193
    char *name;                 /* connection name */
194
    virConnectPtr conn;         /* connection to hypervisor (MAY BE NULL) */
195 196 197 198 199 200
    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? */
201 202 203
    int readonly;               /* connect readonly (first time only, not
                                 * during explicit connect command)
                                 */
204 205
    char *logfile;              /* log file name */
    int log_fd;                 /* log file descriptor */
206 207
    char *historydir;           /* readline history directory name */
    char *historyfile;          /* readline history file name */
K
Karel Zak 已提交
208
} __vshControl;
209

210

211
static const vshCmdDef commands[];
K
Karel Zak 已提交
212

213 214
static void vshError(vshControl *ctl, const char *format, ...)
    ATTRIBUTE_FMT_PRINTF(2, 3);
215 216
static int vshInit(vshControl *ctl);
static int vshDeinit(vshControl *ctl);
217
static void vshUsage(void);
218 219 220
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 已提交
221

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

224
static const char *vshCmddefGetInfo(const vshCmdDef *cmd, const char *info);
225
static const vshCmdDef *vshCmddefSearch(const char *cmdname);
226
static int vshCmddefHelp(vshControl *ctl, const char *name);
K
Karel Zak 已提交
227

228 229
static vshCmdOpt *vshCommandOpt(const vshCmd *cmd, const char *name);
static int vshCommandOptInt(const vshCmd *cmd, const char *name, int *found);
230 231
static unsigned long vshCommandOptUL(const vshCmd *cmd, const char *name,
                                     int *found);
232
static char *vshCommandOptString(const vshCmd *cmd, const char *name,
233
                                 int *found);
234 235
static long long vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                                       int *found);
236
static int vshCommandOptBool(const vshCmd *cmd, const char *name);
237
static char *vshCommandOptArgv(const vshCmd *cmd, int count);
K
Karel Zak 已提交
238

239 240 241
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
242
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
243

244
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
J
Jim Meyering 已提交
245
                                          char **name, int flag);
K
Karel Zak 已提交
246 247

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

251
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
J
Jim Meyering 已提交
252
                                            char **name, int flag);
253 254

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
255 256
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
257 258
                           VSH_BYUUID|VSH_BYNAME)

259 260 261 262 263 264 265 266
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
                                                  char **name, int flag);

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

267 268 269 270 271 272 273 274
static virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
                                                char **name, int flag);

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

275
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
276 277 278 279 280 281 282
                            const char *optname, char **name, int flag);

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

283
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
284 285 286 287 288 289 290 291 292
                                           const char *optname,
                                           const char *pooloptname,
                                           char **name, int flag);

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

293 294 295
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
                                        char **name);

296
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
297
    ATTRIBUTE_FMT_PRINTF(2, 3);
298
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
299
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
300 301

/* XXX: add batch support */
K
Karel Zak 已提交
302
#define vshPrint(_ctl, ...)   fprintf(stdout, __VA_ARGS__)
K
Karel Zak 已提交
303

K
Karel Zak 已提交
304
static const char *vshDomainStateToString(int state);
305
static const char *vshDomainVcpuStateToString(int state);
306
static int vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
K
Karel Zak 已提交
307

308 309 310 311
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

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

321
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
322 323
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
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
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401

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;

  return strcasecmp(*sa, *sb);
}

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
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 已提交
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
static 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)
{
449 450 451 452 453 454 455 456
    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)
457
            goto out;
458
    }
J
John Levon 已提交
459 460

    if (last_error->code == VIR_ERR_OK) {
461
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
462 463 464
        goto out;
    }

465
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
466 467 468 469 470 471

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

472 473 474 475 476
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

477
#ifdef SIGPIPE
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
/*
 * 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
 */
static void vshCatchDisconnect(int sig, siginfo_t * siginfo,
                               void* context ATTRIBUTE_UNUSED) {
    if ((sig == SIGPIPE) || (siginfo->si_signo == SIGPIPE))
        disconnected++;
}

/*
 * vshSetupSignals:
 *
 * Catch SIGPIPE signals which may arise when disconnection
 * from libvirtd occurs
 */
L
Laine Stump 已提交
496
static void
497 498 499 500 501 502 503 504 505
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);
}
506 507 508 509
#else
static void
vshSetupSignals(void) {}
#endif
510 511 512 513

/*
 * vshReconnect:
 *
L
Laine Stump 已提交
514
 * Reconnect after a disconnect from libvirtd
515 516
 *
 */
L
Laine Stump 已提交
517
static void
518 519 520 521 522 523 524 525 526 527 528 529 530
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;
}
531

K
Karel Zak 已提交
532 533 534 535 536 537
/* ---------------
 * Commands
 * ---------------
 */

/*
538
 * "help" command
K
Karel Zak 已提交
539
 */
540
static const vshCmdInfo info_help[] = {
541 542
    {"help", N_("print help")},
    {"desc", N_("Prints global help or command specific help.")},
543

544
    {NULL, NULL}
K
Karel Zak 已提交
545 546
};

547
static const vshCmdOptDef opts_help[] = {
548
    {"command", VSH_OT_DATA, 0, N_("name of command")},
549
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
550 551 552
};

static int
553
cmdHelp(vshControl *ctl, const vshCmd *cmd)
554
{
K
Karel Zak 已提交
555
    const char *cmdname = vshCommandOptString(cmd, "command", NULL);
K
Karel Zak 已提交
556 557

    if (!cmdname) {
558
        const vshCmdDef *def;
559

J
Jim Meyering 已提交
560
        vshPrint(ctl, "%s", _("Commands:\n\n"));
561
        for (def = commands; def->name; def++)
K
Karel Zak 已提交
562
            vshPrint(ctl, "    %-15s %s\n", def->name,
E
Eric Blake 已提交
563
                     _(vshCmddefGetInfo(def, "help")));
K
Karel Zak 已提交
564 565
        return TRUE;
    }
566
    return vshCmddefHelp(ctl, cmdname);
K
Karel Zak 已提交
567 568
}

569 570 571
/*
 * "autostart" command
 */
572
static const vshCmdInfo info_autostart[] = {
573
    {"help", N_("autostart a domain")},
574
    {"desc",
575
     N_("Configure a domain to be automatically started at boot.")},
576 577 578
    {NULL, NULL}
};

579
static const vshCmdOptDef opts_autostart[] = {
580 581
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
582 583 584 585
    {NULL, 0, 0, NULL}
};

static int
586
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
587 588 589 590 591
{
    virDomainPtr dom;
    char *name;
    int autostart;

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

J
Jim Meyering 已提交
595
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
596 597 598 599 600
        return FALSE;

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
601
        if (autostart)
602
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
603
        else
604
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
605 606 607 608
        virDomainFree(dom);
        return FALSE;
    }

609
    if (autostart)
610
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
611
    else
612
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
613

614
    virDomainFree(dom);
615 616 617
    return TRUE;
}

K
Karel Zak 已提交
618
/*
619
 * "connect" command
K
Karel Zak 已提交
620
 */
621
static const vshCmdInfo info_connect[] = {
622
    {"help", N_("(re)connect to hypervisor")},
623
    {"desc",
624
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
625
    {NULL, NULL}
K
Karel Zak 已提交
626 627
};

628
static const vshCmdOptDef opts_connect[] = {
629 630
    {"name",     VSH_OT_DATA, 0, N_("hypervisor connection URI")},
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
631
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
632 633 634
};

static int
635
cmdConnect(vshControl *ctl, const vshCmd *cmd)
636
{
K
Karel Zak 已提交
637
    int ro = vshCommandOptBool(cmd, "readonly");
638
    char *name;
639

K
Karel Zak 已提交
640
    if (ctl->conn) {
641 642 643
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
644 645 646 647
            return FALSE;
        }
        ctl->conn = NULL;
    }
648

649
    VIR_FREE(ctl->name);
650 651 652 653
    name = vshCommandOptString(cmd, "name", NULL);
    if (!name)
        return FALSE;
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
654

655 656 657 658 659
    if (!ro) {
        ctl->readonly = 0;
    } else {
        ctl->readonly = 1;
    }
K
Karel Zak 已提交
660

661 662 663
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

K
Karel Zak 已提交
667 668 669
    return ctl->conn ? TRUE : FALSE;
}

670 671
#ifndef WIN32

672
/*
673
 * "console" command
674
 */
675
static const vshCmdInfo info_console[] = {
676
    {"help", N_("connect to the guest console")},
677
    {"desc",
678
     N_("Connect the virtual serial console for the guest")},
679 680 681
    {NULL, NULL}
};

682
static const vshCmdOptDef opts_console[] = {
683
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
684
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
685 686 687 688
    {NULL, 0, 0, NULL}
};

static int
689
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *devname)
690 691
{
    int ret = FALSE;
692
    virDomainInfo dominfo;
693

694 695 696 697 698 699 700 701 702 703
    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;
    }

704 705 706 707
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
    vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
    if (vshRunConsole(dom, devname) == 0)
        ret = TRUE;
708 709

 cleanup:
710

711 712 713
    return ret;
}

714 715 716 717 718
static int
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int ret;
719
    const char *devname;
720

721
    if (!vshConnectionUsability(ctl, ctl->conn))
722 723 724 725 726
        return FALSE;

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

727 728 729
    devname = vshCommandOptString(cmd, "devname", NULL);

    ret = cmdRunConsole(ctl, dom, devname);
730 731 732 733 734

    virDomainFree(dom);
    return ret;
}

735 736 737
#endif /* WIN32 */


K
Karel Zak 已提交
738 739 740
/*
 * "list" command
 */
741
static const vshCmdInfo info_list[] = {
742 743
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
744
    {NULL, NULL}
K
Karel Zak 已提交
745 746
};

747
static const vshCmdOptDef opts_list[] = {
748 749
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
750 751 752
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
753 754

static int
755
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
756
{
757 758 759 760
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
761
    char **names = NULL;
762 763
    int maxname = 0;
    inactive |= all;
K
Karel Zak 已提交
764

765
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
766
        return FALSE;
767

768
    if (active) {
769 770
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
771
            vshError(ctl, "%s", _("Failed to list active domains"));
772 773 774 775 776 777
            return FALSE;
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
778
                vshError(ctl, "%s", _("Failed to list active domains"));
779
                VIR_FREE(ids);
780 781 782
                return FALSE;
            }

783
            qsort(&ids[0], maxid, sizeof(int), idsorter);
784
        }
785 786
    }
    if (inactive) {
787 788
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
789
            vshError(ctl, "%s", _("Failed to list inactive domains"));
790
            VIR_FREE(ids);
791
            return FALSE;
792
        }
793 794 795 796
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
797
                vshError(ctl, "%s", _("Failed to list inactive domains"));
798 799
                VIR_FREE(ids);
                VIR_FREE(names);
800 801
                return FALSE;
            }
802

803
            qsort(&names[0], maxname, sizeof(char*), namesorter);
804
        }
805
    }
806
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
807
    vshPrintExtra(ctl, "----------------------------------\n");
808 809

    for (i = 0; i < maxid; i++) {
K
Karel Zak 已提交
810 811
        virDomainInfo info;
        virDomainPtr dom = virDomainLookupByID(ctl->conn, ids[i]);
812
        const char *state;
813 814

        /* this kind of work with domains is not atomic operation */
K
Karel Zak 已提交
815 816
        if (!dom)
            continue;
817 818 819 820

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

K
Karel Zak 已提交
823
        vshPrint(ctl, "%3d %-20s %s\n",
824 825
                 virDomainGetID(dom),
                 virDomainGetName(dom),
826
                 state);
827
        virDomainFree(dom);
K
Karel Zak 已提交
828
    }
829 830 831
    for (i = 0; i < maxname; i++) {
        virDomainInfo info;
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);
832
        const char *state;
833 834

        /* this kind of work with domains is not atomic operation */
835
        if (!dom) {
836
            VIR_FREE(names[i]);
837
            continue;
838
        }
839 840 841 842

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

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

847
        virDomainFree(dom);
848
        VIR_FREE(names[i]);
849
    }
850 851
    VIR_FREE(ids);
    VIR_FREE(names);
K
Karel Zak 已提交
852 853 854 855
    return TRUE;
}

/*
K
Karel Zak 已提交
856
 * "domstate" command
K
Karel Zak 已提交
857
 */
858
static const vshCmdInfo info_domstate[] = {
859 860
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
861
    {NULL, NULL}
K
Karel Zak 已提交
862 863
};

864
static const vshCmdOptDef opts_domstate[] = {
865
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
866
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
867 868 869
};

static int
870
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
871
{
872
    virDomainInfo info;
K
Karel Zak 已提交
873
    virDomainPtr dom;
K
Karel Zak 已提交
874
    int ret = TRUE;
875

876
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
877
        return FALSE;
878

J
Jim Meyering 已提交
879
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
K
Karel Zak 已提交
880
        return FALSE;
881 882

    if (virDomainGetInfo(dom, &info) == 0)
K
Karel Zak 已提交
883
        vshPrint(ctl, "%s\n",
E
Eric Blake 已提交
884
                 _(vshDomainStateToString(info.state)));
K
Karel Zak 已提交
885 886
    else
        ret = FALSE;
887

888 889 890 891
    virDomainFree(dom);
    return ret;
}

892 893
/* "domblkstat" command
 */
894
static const vshCmdInfo info_domblkstat[] = {
895 896
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
897 898 899
    {NULL,NULL}
};

900
static const vshCmdOptDef opts_domblkstat[] = {
901 902
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
903 904 905 906
    {NULL, 0, 0, NULL}
};

static int
907
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
908 909 910 911 912
{
    virDomainPtr dom;
    char *name, *device;
    struct _virDomainBlockStats stats;

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

J
Jim Meyering 已提交
916
    if (!(dom = vshCommandOptDomain (ctl, cmd, &name)))
917 918
        return FALSE;

L
Laine Stump 已提交
919 920
    if (!(device = vshCommandOptString (cmd, "device", NULL))) {
        virDomainFree(dom);
921
        return FALSE;
L
Laine Stump 已提交
922
    }
923 924

    if (virDomainBlockStats (dom, device, &stats, sizeof stats) == -1) {
925
        vshError(ctl, _("Failed to get block stats %s %s"), name, device);
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
        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
 */
951
static const vshCmdInfo info_domifstat[] = {
952 953
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
954 955 956
    {NULL,NULL}
};

957
static const vshCmdOptDef opts_domifstat[] = {
958 959
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
960 961 962 963
    {NULL, 0, 0, NULL}
};

static int
964
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
965 966 967 968 969
{
    virDomainPtr dom;
    char *name, *device;
    struct _virDomainInterfaceStats stats;

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

J
Jim Meyering 已提交
973
    if (!(dom = vshCommandOptDomain (ctl, cmd, &name)))
974 975
        return FALSE;

L
Laine Stump 已提交
976 977
    if (!(device = vshCommandOptString (cmd, "interface", NULL))) {
        virDomainFree(dom);
978
        return FALSE;
L
Laine Stump 已提交
979
    }
980 981

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
982
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
        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;
}

1015 1016 1017
/*
 * "dommemstats" command
 */
1018
static const vshCmdInfo info_dommemstat[] = {
1019 1020
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1021 1022 1023
    {NULL,NULL}
};

1024
static const vshCmdOptDef opts_dommemstat[] = {
1025
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1026 1027 1028 1029
    {NULL, 0, 0, NULL}
};

static int
1030
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1031 1032 1033 1034 1035 1036
{
    virDomainPtr dom;
    char *name;
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1037
    if (!vshConnectionUsability(ctl, ctl->conn))
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
        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;
}

1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
/*
 * "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;
    const char *device;

1092
    if (!vshConnectionUsability(ctl, ctl->conn))
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
        return FALSE;

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

    if (!(device = vshCommandOptString (cmd, "device", NULL))) {
        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;
}

1116 1117 1118
/*
 * "suspend" command
 */
1119
static const vshCmdInfo info_suspend[] = {
1120 1121
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1122
    {NULL, NULL}
1123 1124
};

1125
static const vshCmdOptDef opts_suspend[] = {
1126
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1127
    {NULL, 0, 0, NULL}
1128 1129 1130
};

static int
1131
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1132
{
1133
    virDomainPtr dom;
K
Karel Zak 已提交
1134 1135
    char *name;
    int ret = TRUE;
1136

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

J
Jim Meyering 已提交
1140
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1141
        return FALSE;
1142 1143

    if (virDomainSuspend(dom) == 0) {
1144
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1145
    } else {
1146
        vshError(ctl, _("Failed to suspend domain %s"), name);
1147 1148
        ret = FALSE;
    }
1149

1150 1151 1152 1153
    virDomainFree(dom);
    return ret;
}

1154 1155 1156
/*
 * "create" command
 */
1157
static const vshCmdInfo info_create[] = {
1158 1159
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1160 1161 1162
    {NULL, NULL}
};

1163
static const vshCmdOptDef opts_create[] = {
1164
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1165
#ifndef WIN32
1166
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1167
#endif
1168
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1169 1170 1171 1172
    {NULL, 0, 0, NULL}
};

static int
1173
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1174 1175 1176 1177 1178
{
    virDomainPtr dom;
    char *from;
    int found;
    int ret = TRUE;
1179
    char *buffer;
1180
#ifndef WIN32
1181
    int console = vshCommandOptBool(cmd, "console");
1182
#endif
1183
    unsigned int flags = VIR_DOMAIN_NONE;
1184

1185
    if (!vshConnectionUsability(ctl, ctl->conn))
1186 1187 1188 1189 1190 1191
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found)
        return FALSE;

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

1195 1196 1197 1198
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1199
    VIR_FREE(buffer);
1200

1201
    if (dom != NULL) {
1202
        vshPrint(ctl, _("Domain %s created from %s\n"),
1203
                 virDomainGetName(dom), from);
1204
#ifndef WIN32
1205
        if (console)
1206
            cmdRunConsole(ctl, dom, NULL);
1207
#endif
1208
        virDomainFree(dom);
1209
    } else {
1210
        vshError(ctl, _("Failed to create domain from %s"), from);
1211 1212 1213 1214 1215
        ret = FALSE;
    }
    return ret;
}

1216 1217 1218
/*
 * "define" command
 */
1219
static const vshCmdInfo info_define[] = {
1220 1221
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1222 1223 1224
    {NULL, NULL}
};

1225
static const vshCmdOptDef opts_define[] = {
1226
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1227 1228 1229 1230
    {NULL, 0, 0, NULL}
};

static int
1231
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1232 1233 1234 1235 1236
{
    virDomainPtr dom;
    char *from;
    int found;
    int ret = TRUE;
1237
    char *buffer;
1238

1239
    if (!vshConnectionUsability(ctl, ctl->conn))
1240 1241 1242 1243 1244 1245
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found)
        return FALSE;

1246 1247
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
1248 1249

    dom = virDomainDefineXML(ctl->conn, buffer);
1250
    VIR_FREE(buffer);
1251

1252
    if (dom != NULL) {
1253
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1254
                 virDomainGetName(dom), from);
1255
        virDomainFree(dom);
1256
    } else {
1257
        vshError(ctl, _("Failed to define domain from %s"), from);
1258 1259 1260 1261 1262 1263 1264 1265
        ret = FALSE;
    }
    return ret;
}

/*
 * "undefine" command
 */
1266
static const vshCmdInfo info_undefine[] = {
1267 1268
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1269 1270 1271
    {NULL, NULL}
};

1272
static const vshCmdOptDef opts_undefine[] = {
1273
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1274 1275 1276 1277
    {NULL, 0, 0, NULL}
};

static int
1278
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1279 1280 1281 1282
{
    virDomainPtr dom;
    int ret = TRUE;
    char *name;
1283 1284
    int found;
    int id;
1285

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

1289 1290 1291 1292 1293 1294
    name = vshCommandOptString(cmd, "domain", &found);
    if (!found)
        return FALSE;

    if (name && virStrToLong_i(name, NULL, 10, &id) == 0
        && id >= 0 && (dom = virDomainLookupByID(ctl->conn, id))) {
1295 1296 1297 1298 1299
        vshError(ctl,
                 _("a running domain like %s cannot be undefined;\n"
                   "to undefine, first shutdown then undefine"
                   " using its name or UUID"),
                 name);
1300 1301 1302
        virDomainFree(dom);
        return FALSE;
    }
J
Jim Meyering 已提交
1303
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
1304
                                      VSH_BYNAME|VSH_BYUUID)))
1305 1306 1307
        return FALSE;

    if (virDomainUndefine(dom) == 0) {
1308
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1309
    } else {
1310
        vshError(ctl, _("Failed to undefine domain %s"), name);
1311 1312 1313
        ret = FALSE;
    }

1314
    virDomainFree(dom);
1315 1316 1317 1318 1319 1320 1321
    return ret;
}


/*
 * "start" command
 */
1322
static const vshCmdInfo info_start[] = {
1323
    {"help", N_("start a (previously defined) inactive domain")},
1324 1325 1326
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1327 1328 1329
    {NULL, NULL}
};

1330
static const vshCmdOptDef opts_start[] = {
1331
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1332
#ifndef WIN32
1333
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1334
#endif
E
Eric Blake 已提交
1335
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1336 1337 1338 1339
    {NULL, 0, 0, NULL}
};

static int
1340
cmdStart(vshControl *ctl, const vshCmd *cmd)
1341 1342 1343
{
    virDomainPtr dom;
    int ret = TRUE;
1344
#ifndef WIN32
1345
    int console = vshCommandOptBool(cmd, "console");
1346
#endif
E
Eric Blake 已提交
1347
    unsigned int flags = VIR_DOMAIN_NONE;
1348

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

J
Jim Meyering 已提交
1352
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL, VSH_BYNAME)))
1353 1354 1355
        return FALSE;

    if (virDomainGetID(dom) != (unsigned int)-1) {
1356
        vshError(ctl, "%s", _("Domain is already active"));
1357
        virDomainFree(dom);
1358 1359 1360
        return FALSE;
    }

E
Eric Blake 已提交
1361 1362 1363 1364 1365 1366
    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) {
1367
        vshPrint(ctl, _("Domain %s started\n"),
1368
                 virDomainGetName(dom));
1369
#ifndef WIN32
1370
        if (console)
1371
            cmdRunConsole(ctl, dom, NULL);
1372
#endif
1373
    } else {
1374
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
1375 1376
        ret = FALSE;
    }
1377
    virDomainFree(dom);
1378 1379 1380
    return ret;
}

1381 1382 1383
/*
 * "save" command
 */
1384
static const vshCmdInfo info_save[] = {
1385 1386
    {"help", N_("save a domain state to a file")},
    {"desc", N_("Save a running domain.")},
1387
    {NULL, NULL}
1388 1389
};

1390
static const vshCmdOptDef opts_save[] = {
1391 1392
    {"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")},
1393
    {NULL, 0, 0, NULL}
1394 1395 1396
};

static int
1397
cmdSave(vshControl *ctl, const vshCmd *cmd)
1398
{
1399 1400 1401 1402
    virDomainPtr dom;
    char *name;
    char *to;
    int ret = TRUE;
1403

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

1407
    if (!(to = vshCommandOptString(cmd, "file", NULL)))
1408
        return FALSE;
1409

J
Jim Meyering 已提交
1410
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1411
        return FALSE;
1412 1413

    if (virDomainSave(dom, to) == 0) {
1414
        vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
1415
    } else {
1416
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
1417 1418
        ret = FALSE;
    }
1419

1420 1421 1422 1423
    virDomainFree(dom);
    return ret;
}

1424 1425 1426 1427 1428
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1429 1430 1431 1432
    {"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.")},
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447
    {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;
    char *name;
    int ret = TRUE;

1448
    if (!vshConnectionUsability(ctl, ctl->conn))
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464
        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;
}

1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486
/*
 * "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;
    char *name;
    int ret = FALSE;
    int hassave;

1487
    if (!vshConnectionUsability(ctl, ctl->conn))
1488 1489 1490 1491 1492 1493 1494
        return FALSE;

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

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1495
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
        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;
}

1519 1520 1521
/*
 * "schedinfo" command
 */
1522
static const vshCmdInfo info_schedinfo[] = {
1523 1524
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1525 1526 1527
    {NULL, NULL}
};

1528
static const vshCmdOptDef opts_schedinfo[] = {
1529 1530 1531 1532
    {"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")},
1533 1534 1535 1536
    {NULL, 0, 0, NULL}
};

static int
1537 1538
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
                   virSchedParameterPtr param)
1539
{
1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
    int found;
    char *data;

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
        param->type == VIR_DOMAIN_SCHED_FIELD_UINT &&
        vshCommandOptBool(cmd, "weight")) {
        int val;
        val = vshCommandOptInt(cmd, "weight", &found);
        if (!found) {
1550
            vshError(ctl, "%s", _("Invalid value of weight"));
1551
            return -1;
1552
        } else {
1553
            param->value.ui = val;
1554
        }
1555
        return 1;
1556 1557
    }

1558 1559 1560 1561 1562 1563 1564
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
        param->type == VIR_DOMAIN_SCHED_FIELD_UINT &&
        vshCommandOptBool(cmd, "cap")) {
        int val;
        val = vshCommandOptInt(cmd, "cap", &found);
        if (!found) {
1565
            vshError(ctl, "%s", _("Invalid value of cap"));
1566
            return -1;
1567
        } else {
1568
            param->value.ui = val;
1569
        }
1570
        return 1;
1571
    }
1572

1573 1574 1575 1576
    if ((data = vshCommandOptString(cmd, "set", NULL))) {
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
1577
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
1578
            return -1;
1579
        }
1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
        *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) {
1591
                vshError(ctl, "%s",
1592 1593 1594 1595 1596 1597
                         _("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) {
1598
                vshError(ctl, "%s",
1599 1600 1601 1602 1603 1604
                         _("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) {
1605
                vshError(ctl, "%s",
J
Jim Meyering 已提交
1606
                         _("Invalid value for parameter, expecting a long long"));
1607 1608 1609 1610 1611
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_ULLONG:
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
1612
                vshError(ctl, "%s",
1613 1614 1615 1616 1617 1618
                         _("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) {
1619
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
1620 1621 1622 1623 1624
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_BOOLEAN:
            param->value.b = STREQ(val, "0") ? 0 : 1;
1625
        }
1626
        return 1;
1627
    }
1628

1629 1630
    return 0;
}
1631

1632

1633 1634 1635 1636 1637 1638 1639 1640 1641 1642
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;
1643

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

1647 1648
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;
1649 1650 1651 1652

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
    if (schedulertype!= NULL){
1653
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
1654
             schedulertype);
1655
        VIR_FREE(schedulertype);
1656
    } else {
1657
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
1658
        goto cleanup;
1659 1660
    }

1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
    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;
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
        } 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.  */
            char *var_value_pair = vshCommandOptString(cmd, "set", NULL);
            if (var_value_pair) {
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
1698 1699 1700
        }

        ret_val = TRUE;
1701 1702 1703
        for (i = 0; i < nparams; i++){
            switch (params[i].type) {
            case VIR_DOMAIN_SCHED_FIELD_INT:
1704
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1705 1706
                 break;
            case VIR_DOMAIN_SCHED_FIELD_UINT:
1707
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1708 1709
                 break;
            case VIR_DOMAIN_SCHED_FIELD_LLONG:
1710
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1711 1712
                 break;
            case VIR_DOMAIN_SCHED_FIELD_ULLONG:
1713
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1714 1715
                 break;
            case VIR_DOMAIN_SCHED_FIELD_DOUBLE:
1716
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1717 1718
                 break;
            case VIR_DOMAIN_SCHED_FIELD_BOOLEAN:
1719
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
1720 1721
                 break;
            default:
1722
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
1723 1724 1725
            }
        }
    }
1726

1727
 cleanup:
1728
    VIR_FREE(params);
1729
    virDomainFree(dom);
1730
    return ret_val;
1731 1732
}

1733 1734 1735
/*
 * "restore" command
 */
1736
static const vshCmdInfo info_restore[] = {
1737 1738
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
1739
    {NULL, NULL}
1740 1741
};

1742
static const vshCmdOptDef opts_restore[] = {
1743
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
1744
    {NULL, 0, 0, NULL}
1745 1746 1747
};

static int
1748
cmdRestore(vshControl *ctl, const vshCmd *cmd)
1749
{
1750 1751 1752
    char *from;
    int found;
    int ret = TRUE;
1753

1754
    if (!vshConnectionUsability(ctl, ctl->conn))
1755 1756 1757 1758 1759
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found)
        return FALSE;
1760 1761

    if (virDomainRestore(ctl->conn, from) == 0) {
1762
        vshPrint(ctl, _("Domain restored from %s\n"), from);
1763
    } else {
1764
        vshError(ctl, _("Failed to restore domain from %s"), from);
1765 1766 1767 1768 1769
        ret = FALSE;
    }
    return ret;
}

D
Daniel Veillard 已提交
1770 1771 1772
/*
 * "dump" command
 */
1773
static const vshCmdInfo info_dump[] = {
1774 1775
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
1776 1777 1778
    {NULL, NULL}
};

1779
static const vshCmdOptDef opts_dump[] = {
1780 1781 1782 1783
    {"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 已提交
1784 1785 1786 1787
    {NULL, 0, 0, NULL}
};

static int
1788
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
1789 1790 1791 1792 1793
{
    virDomainPtr dom;
    char *name;
    char *to;
    int ret = TRUE;
1794
    int flags = 0;
D
Daniel Veillard 已提交
1795

1796
    if (!vshConnectionUsability(ctl, ctl->conn))
D
Daniel Veillard 已提交
1797 1798 1799 1800 1801
        return FALSE;

    if (!(to = vshCommandOptString(cmd, "file", NULL)))
        return FALSE;

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

P
Paolo Bonzini 已提交
1805 1806
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
1807 1808 1809 1810
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;

    if (virDomainCoreDump(dom, to, flags) == 0) {
1811
        vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
D
Daniel Veillard 已提交
1812
    } else {
1813
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
D
Daniel Veillard 已提交
1814 1815 1816 1817 1818 1819 1820
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

1821 1822 1823
/*
 * "resume" command
 */
1824
static const vshCmdInfo info_resume[] = {
1825 1826
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
1827
    {NULL, NULL}
1828 1829
};

1830
static const vshCmdOptDef opts_resume[] = {
1831
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1832
    {NULL, 0, 0, NULL}
1833 1834 1835
};

static int
1836
cmdResume(vshControl *ctl, const vshCmd *cmd)
1837
{
1838
    virDomainPtr dom;
K
Karel Zak 已提交
1839 1840
    int ret = TRUE;
    char *name;
1841

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

J
Jim Meyering 已提交
1845
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1846
        return FALSE;
1847 1848

    if (virDomainResume(dom) == 0) {
1849
        vshPrint(ctl, _("Domain %s resumed\n"), name);
1850
    } else {
1851
        vshError(ctl, _("Failed to resume domain %s"), name);
1852 1853
        ret = FALSE;
    }
1854

1855 1856 1857 1858
    virDomainFree(dom);
    return ret;
}

1859 1860 1861
/*
 * "shutdown" command
 */
1862
static const vshCmdInfo info_shutdown[] = {
1863 1864
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
1865
    {NULL, NULL}
1866 1867
};

1868
static const vshCmdOptDef opts_shutdown[] = {
1869
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1870
    {NULL, 0, 0, NULL}
1871 1872 1873
};

static int
1874
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
1875
{
1876 1877 1878
    virDomainPtr dom;
    int ret = TRUE;
    char *name;
1879

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

J
Jim Meyering 已提交
1883
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1884
        return FALSE;
1885 1886

    if (virDomainShutdown(dom) == 0) {
1887
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
1888
    } else {
1889
        vshError(ctl, _("Failed to shutdown domain %s"), name);
1890 1891
        ret = FALSE;
    }
1892

1893 1894 1895 1896
    virDomainFree(dom);
    return ret;
}

1897 1898 1899
/*
 * "reboot" command
 */
1900
static const vshCmdInfo info_reboot[] = {
1901 1902
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
1903 1904 1905
    {NULL, NULL}
};

1906
static const vshCmdOptDef opts_reboot[] = {
1907
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1908 1909 1910 1911
    {NULL, 0, 0, NULL}
};

static int
1912
cmdReboot(vshControl *ctl, const vshCmd *cmd)
1913 1914 1915 1916 1917
{
    virDomainPtr dom;
    int ret = TRUE;
    char *name;

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

J
Jim Meyering 已提交
1921
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1922 1923 1924
        return FALSE;

    if (virDomainReboot(dom, 0) == 0) {
1925
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
1926
    } else {
1927
        vshError(ctl, _("Failed to reboot domain %s"), name);
1928 1929 1930 1931 1932 1933 1934
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

1935 1936 1937
/*
 * "destroy" command
 */
1938
static const vshCmdInfo info_destroy[] = {
1939 1940
    {"help", N_("destroy a domain")},
    {"desc", N_("Destroy a given domain.")},
1941
    {NULL, NULL}
1942 1943
};

1944
static const vshCmdOptDef opts_destroy[] = {
1945
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1946
    {NULL, 0, 0, NULL}
1947 1948 1949
};

static int
1950
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
1951
{
1952
    virDomainPtr dom;
K
Karel Zak 已提交
1953 1954
    int ret = TRUE;
    char *name;
1955

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

J
Jim Meyering 已提交
1959
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1960
        return FALSE;
1961 1962

    if (virDomainDestroy(dom) == 0) {
1963
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
1964
    } else {
1965
        vshError(ctl, _("Failed to destroy domain %s"), name);
1966 1967
        ret = FALSE;
    }
1968

1969
    virDomainFree(dom);
K
Karel Zak 已提交
1970 1971 1972 1973
    return ret;
}

/*
1974
 * "dominfo" command
K
Karel Zak 已提交
1975
 */
1976
static const vshCmdInfo info_dominfo[] = {
1977 1978
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
1979
    {NULL, NULL}
K
Karel Zak 已提交
1980 1981
};

1982
static const vshCmdOptDef opts_dominfo[] = {
1983
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1984
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
1985 1986 1987
};

static int
1988
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
1989
{
K
Karel Zak 已提交
1990 1991
    virDomainInfo info;
    virDomainPtr dom;
1992 1993
    virSecurityModel secmodel;
    virSecurityLabel seclabel;
1994
    int persistent = 0;
1995
    int ret = TRUE, autostart;
1996
    unsigned int id;
1997
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
1998

1999
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
2000 2001
        return FALSE;

J
Jim Meyering 已提交
2002
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
K
Karel Zak 已提交
2003
        return FALSE;
2004

2005 2006
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2007
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2008
    else
2009
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2010 2011
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2012
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2013
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2014 2015

    if ((str = virDomainGetOSType(dom))) {
2016
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2017
        VIR_FREE(str);
2018 2019 2020
    }

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

2024
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2025 2026

        if (info.cpuTime != 0) {
2027
            double cpuUsed = info.cpuTime;
2028

2029
            cpuUsed /= 1000000000.0;
2030

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

2034 2035
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2036
                 info.maxMem);
2037
        else
2038
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2039 2040
                 _("no limit"));

2041
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2042 2043
                 info.memory);

K
Karel Zak 已提交
2044 2045 2046
    } else {
        ret = FALSE;
    }
2047

2048 2049 2050 2051 2052 2053 2054 2055 2056
    /* 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 */
2057
    if (!virDomainGetAutostart(dom, &autostart)) {
2058
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2059 2060 2061
                 autostart ? _("enable") : _("disable") );
    }

2062 2063 2064
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2065 2066 2067 2068
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
            return FALSE;
        }
2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086
    } 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");
            }
        }
    }
2087
    virDomainFree(dom);
K
Karel Zak 已提交
2088 2089 2090
    return ret;
}

2091 2092 2093 2094
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2095 2096
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2097 2098 2099 2100
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2101
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2102 2103 2104 2105 2106 2107 2108 2109 2110
    {NULL, 0, 0, NULL}
};


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

2113
    if (!vshConnectionUsability(ctl, ctl->conn))
2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143
        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 已提交
2144
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2145
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2146
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2147
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2148
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2149 2150 2151
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2152
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2153
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2154
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2155
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2156
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2157 2158 2159
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2160
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2161
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2162
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2163
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2164
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2165 2166 2167 2168 2169 2170 2171 2172 2173
        }
    } else {
        ret = FALSE;
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2174 2175 2176 2177
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2178 2179
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2180 2181 2182 2183
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2184
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2185 2186 2187 2188 2189 2190 2191 2192 2193
    {NULL, 0, 0, NULL}
};

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

2194
    if (!vshConnectionUsability(ctl, ctl->conn))
2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206
        return FALSE;

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

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

    virDomainFree(dom);
    return ret;
}

2207 2208 2209
/*
 * "freecell" command
 */
2210
static const vshCmdInfo info_freecell[] = {
2211 2212
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2213 2214 2215
    {NULL, NULL}
};

2216
static const vshCmdOptDef opts_freecell[] = {
2217
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2218 2219 2220 2221
    {NULL, 0, 0, NULL}
};

static int
2222
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2223 2224 2225 2226 2227
{
    int ret;
    int cell, cell_given;
    unsigned long long memory;

2228
    if (!vshConnectionUsability(ctl, ctl->conn))
2229 2230 2231 2232
        return FALSE;

    cell = vshCommandOptInt(cmd, "cellno", &cell_given);
    if (!cell_given) {
2233
        memory = virNodeGetFreeMemory(ctl->conn);
D
Daniel P. Berrange 已提交
2234 2235
        if (memory == 0)
            return FALSE;
2236
    } else {
2237 2238 2239
        ret = virNodeGetCellsFreeMemory(ctl->conn, &memory, cell, 1);
        if (ret != 1)
            return FALSE;
2240 2241 2242
    }

    if (cell == -1)
D
Daniel P. Berrange 已提交
2243
        vshPrint(ctl, "%s: %llu kB\n", _("Total"), (memory/1024));
2244
    else
D
Daniel P. Berrange 已提交
2245
        vshPrint(ctl, "%d: %llu kB\n", cell, (memory/1024));
2246 2247 2248 2249

    return TRUE;
}

E
Eric Blake 已提交
2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455
/*
 * "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)
{
    char *type;
    int vcpus;

    type = vshCommandOptString(cmd, "type", NULL);

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

2456 2457 2458
/*
 * "vcpuinfo" command
 */
2459
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
2460
    {"help", N_("detailed domain vcpu information")},
2461
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
2462 2463 2464
    {NULL, NULL}
};

2465
static const vshCmdOptDef opts_vcpuinfo[] = {
2466
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2467 2468 2469 2470
    {NULL, 0, 0, NULL}
};

static int
2471
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
2472 2473 2474 2475 2476 2477 2478 2479 2480 2481
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
    unsigned char *cpumap;
    int ncpus;
    size_t cpumaplen;
    int ret = TRUE;

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

J
Jim Meyering 已提交
2485
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2486 2487 2488 2489
        return FALSE;

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
2490
        return FALSE;
2491 2492 2493 2494 2495 2496 2497
    }

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

2498
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
2499
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2500
    cpumap = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
2501

2502 2503 2504
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
                                   cpumap, cpumaplen)) >= 0) {
2505
        int n;
2506 2507 2508 2509 2510
        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 已提交
2511
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527
            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");
            }
        }
2528
    } else {
2529
        if (info.state == VIR_DOMAIN_SHUTOFF) {
2530 2531
            vshError(ctl, "%s",
                     _("Domain shut off, virtual CPUs not present."));
2532
        }
2533 2534 2535
        ret = FALSE;
    }

2536 2537
    VIR_FREE(cpumap);
    VIR_FREE(cpuinfo);
2538 2539 2540 2541 2542 2543 2544
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
2545
static const vshCmdInfo info_vcpupin[] = {
2546 2547
    {"help", N_("control domain vcpu affinity")},
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
2548 2549 2550
    {NULL, NULL}
};

2551
static const vshCmdOptDef opts_vcpupin[] = {
2552
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2553
    {"vcpu", VSH_OT_INT, VSH_OFLAG_REQ, N_("vcpu number")},
2554
    {"cpulist", VSH_OT_DATA, VSH_OFLAG_REQ, N_("host cpu number(s) (comma separated)")},
2555 2556 2557 2558
    {NULL, 0, 0, NULL}
};

static int
2559
cmdVcpupin(vshControl *ctl, const vshCmd *cmd)
2560 2561 2562 2563 2564 2565 2566 2567 2568 2569
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    int vcpu;
    char *cpulist;
    int ret = TRUE;
    int vcpufound = 0;
    unsigned char *cpumap;
    int cpumaplen;
2570 2571
    int i;
    enum { expect_num, expect_num_or_comma } state;
2572

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

J
Jim Meyering 已提交
2576
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2577 2578 2579 2580
        return FALSE;

    vcpu = vshCommandOptInt(cmd, "vcpu", &vcpufound);
    if (!vcpufound) {
2581
        vshError(ctl, "%s", _("vcpupin: Invalid or missing vCPU number."));
2582 2583 2584 2585 2586 2587 2588 2589
        virDomainFree(dom);
        return FALSE;
    }

    if (!(cpulist = vshCommandOptString(cmd, "cpulist", NULL))) {
        virDomainFree(dom);
        return FALSE;
    }
2590

2591 2592 2593 2594 2595 2596
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
        return FALSE;
    }

    if (virDomainGetInfo(dom, &info) != 0) {
2597
        vshError(ctl, "%s", _("vcpupin: failed to get domain informations."));
2598 2599 2600 2601 2602
        virDomainFree(dom);
        return FALSE;
    }

    if (vcpu >= info.nrVirtCpu) {
2603
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
2604 2605 2606 2607
        virDomainFree(dom);
        return FALSE;
    }

2608 2609 2610 2611
    /* Check that the cpulist parameter is a comma-separated list of
     * numbers and give an intelligent error message if not.
     */
    if (cpulist[0] == '\0') {
2612
        vshError(ctl, "%s", _("cpulist: Invalid format. Empty string."));
2613 2614 2615 2616 2617 2618 2619 2620
        virDomainFree (dom);
        return FALSE;
    }

    state = expect_num;
    for (i = 0; cpulist[i]; i++) {
        switch (state) {
        case expect_num:
2621
          if (!c_isdigit (cpulist[i])) {
2622 2623 2624
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2625 2626 2627 2628 2629 2630 2631 2632
                virDomainFree (dom);
                return FALSE;
            }
            state = expect_num_or_comma;
            break;
        case expect_num_or_comma:
            if (cpulist[i] == ',')
                state = expect_num;
2633
            else if (!c_isdigit (cpulist[i])) {
2634 2635 2636
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit or comma at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2637 2638 2639 2640 2641 2642
                virDomainFree (dom);
                return FALSE;
            }
        }
    }
    if (state == expect_num) {
2643 2644 2645
        vshError(ctl, _("cpulist: %s: Invalid format. Trailing comma "
                        "at position %d."),
                 cpulist, i);
2646 2647 2648 2649
        virDomainFree (dom);
        return FALSE;
    }

2650
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2651
    cpumap = vshCalloc(ctl, 1, cpumaplen);
2652 2653 2654 2655 2656 2657

    do {
        unsigned int cpu = atoi(cpulist);

        if (cpu < VIR_NODEINFO_MAXCPUS(nodeinfo)) {
            VIR_USE_CPU(cpumap, cpu);
2658
        } else {
2659
            vshError(ctl, _("Physical CPU %d doesn't exist."), cpu);
2660
            VIR_FREE(cpumap);
2661 2662
            virDomainFree(dom);
            return FALSE;
2663
        }
2664
        cpulist = strchr(cpulist, ',');
2665 2666 2667 2668 2669 2670 2671 2672
        if (cpulist)
            cpulist++;
    } while (cpulist);

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

2673
    VIR_FREE(cpumap);
2674 2675 2676 2677
    virDomainFree(dom);
    return ret;
}

2678 2679 2680
/*
 * "setvcpus" command
 */
2681
static const vshCmdInfo info_setvcpus[] = {
2682 2683
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
2684 2685 2686
    {NULL, NULL}
};

2687
static const vshCmdOptDef opts_setvcpus[] = {
2688
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2689
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
2690 2691 2692
    {"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")},
2693 2694 2695 2696
    {NULL, 0, 0, NULL}
};

static int
2697
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
2698 2699 2700 2701
{
    virDomainPtr dom;
    int count;
    int ret = TRUE;
E
Eric Blake 已提交
2702 2703 2704 2705 2706 2707
    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));
2708

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

J
Jim Meyering 已提交
2712
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2713 2714 2715
        return FALSE;

    count = vshCommandOptInt(cmd, "count", &count);
2716

E
Eric Blake 已提交
2717 2718 2719 2720 2721 2722 2723 2724
    if (!flags) {
        if (virDomainSetVcpus(dom, count) != 0) {
            ret = FALSE;
        }
    } else {
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
            ret = FALSE;
        }
2725 2726 2727 2728 2729 2730 2731 2732 2733
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmemory" command
 */
2734
static const vshCmdInfo info_setmem[] = {
2735 2736
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
2737 2738 2739
    {NULL, NULL}
};

2740
static const vshCmdOptDef opts_setmem[] = {
2741
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2742
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
2743 2744 2745 2746
    {NULL, 0, 0, NULL}
};

static int
2747
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
2748 2749
{
    virDomainPtr dom;
2750
    virDomainInfo info;
2751
    unsigned long kilobytes;
2752 2753
    int ret = TRUE;

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

J
Jim Meyering 已提交
2757
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2758 2759
        return FALSE;

2760
    kilobytes = vshCommandOptUL(cmd, "kilobytes", NULL);
2761
    if (kilobytes <= 0) {
2762
        virDomainFree(dom);
2763
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
2764 2765 2766
        return FALSE;
    }

2767 2768
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
2769
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
2770 2771 2772 2773 2774
        return FALSE;
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
2775
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
2776
                 kilobytes, info.maxMem);
2777 2778 2779
        return FALSE;
    }

2780
    if (virDomainSetMemory(dom, kilobytes) != 0) {
2781 2782 2783 2784 2785 2786 2787 2788 2789 2790
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
2791
static const vshCmdInfo info_setmaxmem[] = {
2792 2793
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
2794 2795 2796
    {NULL, NULL}
};

2797
static const vshCmdOptDef opts_setmaxmem[] = {
2798
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2799
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
2800 2801 2802 2803
    {NULL, 0, 0, NULL}
};

static int
2804
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
2805 2806
{
    virDomainPtr dom;
2807
    virDomainInfo info;
2808
    int kilobytes;
2809 2810
    int ret = TRUE;

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

J
Jim Meyering 已提交
2814
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2815 2816
        return FALSE;

2817 2818
    kilobytes = vshCommandOptInt(cmd, "kilobytes", &kilobytes);
    if (kilobytes <= 0) {
2819
        virDomainFree(dom);
2820
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
2821 2822 2823
        return FALSE;
    }

2824 2825
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
2826
        vshError(ctl, "%s", _("Unable to verify current MemorySize"));
2827 2828 2829
        return FALSE;
    }

2830 2831 2832 2833 2834 2835
    if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
        vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
        virDomainFree(dom);
        return FALSE;
    }

2836 2837
    if (kilobytes < info.memory) {
        if (virDomainSetMemory(dom, kilobytes) != 0) {
2838
            vshError(ctl, "%s", _("Unable to shrink current MemorySize"));
2839
            ret = FALSE;
2840 2841 2842
        }
    }

2843 2844 2845 2846
    virDomainFree(dom);
    return ret;
}

2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
    {"help", N_("Get/Set memory paramters")},
    {"desc", N_("Get/Set the current memory paramters for the guest domain.\n" \
                "    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")},
2860
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
2861
     N_("Max memory in kilobytes")},
2862
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
2863
     N_("Memory during contention in kilobytes")},
2864
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
2865
     N_("Max swap in kilobytes")},
2866
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
2867
     N_("Min guaranteed memory in kilobytes")},
2868 2869 2870 2871 2872 2873 2874
    {NULL, 0, 0, NULL}
};

static int
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2875
    long long hard_limit, soft_limit, swap_hard_limit, min_guarantee;
2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887
    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;

    hard_limit =
2888
        vshCommandOptLongLong(cmd, "hard-limit", NULL);
2889 2890 2891 2892
    if (hard_limit)
        nparams++;

    soft_limit =
2893
        vshCommandOptLongLong(cmd, "soft-limit", NULL);
2894 2895 2896 2897
    if (soft_limit)
        nparams++;

    swap_hard_limit =
2898
        vshCommandOptLongLong(cmd, "swap-hard-limit", NULL);
2899 2900 2901
    if (swap_hard_limit)
        nparams++;

2902
    min_guarantee =
2903
        vshCommandOptLongLong(cmd, "min-guarantee", NULL);
2904 2905 2906
    if (min_guarantee)
        nparams++;

2907 2908
    if (nparams == 0) {
        /* get the number of memory parameters */
2909
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, 0) != 0) {
2910 2911 2912 2913 2914
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

2915 2916 2917 2918 2919 2920
        if (nparams == 0) {
            /* nothing to output */
            ret = TRUE;
            goto cleanup;
        }

2921
        /* now go get all the memory parameters */
E
Eric Blake 已提交
2922
        params = vshCalloc(ctl, nparams, sizeof(*params));
2923
        if (virDomainGetMemoryParameters(dom, params, &nparams, 0) != 0) {
2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954
            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:
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                             params[i].value.ul);
                    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:
2955
                    vshPrint(ctl, "unimplemented memory parameter type\n");
2956 2957 2958 2959 2960 2961
            }
        }

        ret = TRUE;
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
2962
        params = vshCalloc(ctl, nparams, sizeof(*params));
2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985

        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;
2986
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
2987 2988
                        sizeof(temp->field));
                swap_hard_limit = 0;
2989 2990 2991 2992 2993
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
2994 2995 2996
            }
        }
        if (virDomainSetMemoryParameters(dom, params, nparams, 0) != 0)
2997
            vshError(ctl, "%s", _("Unable to change memory parameters"));
2998 2999 3000 3001 3002
        else
            ret = TRUE;
    }

  cleanup:
E
Eric Blake 已提交
3003
    VIR_FREE(params);
3004 3005 3006 3007
    virDomainFree(dom);
    return ret;
}

3008 3009 3010
/*
 * "nodeinfo" command
 */
3011
static const vshCmdInfo info_nodeinfo[] = {
3012 3013
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
3014 3015 3016 3017
    {NULL, NULL}
};

static int
3018
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3019 3020
{
    virNodeInfo info;
3021

3022
    if (!vshConnectionUsability(ctl, ctl->conn))
3023 3024 3025
        return FALSE;

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
3026
        vshError(ctl, "%s", _("failed to get node information"));
3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037
        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);

3038 3039 3040
    return TRUE;
}

3041 3042 3043
/*
 * "capabilities" command
 */
3044
static const vshCmdInfo info_capabilities[] = {
3045 3046
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
3047 3048 3049 3050
    {NULL, NULL}
};

static int
3051
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3052 3053 3054
{
    char *caps;

3055
    if (!vshConnectionUsability(ctl, ctl->conn))
3056 3057 3058
        return FALSE;

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
3059
        vshError(ctl, "%s", _("failed to get capabilities"));
3060 3061 3062
        return FALSE;
    }
    vshPrint (ctl, "%s\n", caps);
3063
    VIR_FREE(caps);
3064 3065 3066 3067

    return TRUE;
}

3068 3069 3070
/*
 * "dumpxml" command
 */
3071
static const vshCmdInfo info_dumpxml[] = {
3072 3073
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
3074
    {NULL, NULL}
3075 3076
};

3077
static const vshCmdOptDef opts_dumpxml[] = {
3078 3079 3080
    {"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")},
3081
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
3082
    {NULL, 0, 0, NULL}
3083 3084 3085
};

static int
3086
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
3087
{
3088
    virDomainPtr dom;
K
Karel Zak 已提交
3089
    int ret = TRUE;
3090
    char *dump;
3091 3092 3093
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
3094
    int update = vshCommandOptBool(cmd, "update-cpu");
3095 3096 3097 3098 3099

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
3100 3101
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
3102

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

J
Jim Meyering 已提交
3106
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
3107
        return FALSE;
3108

3109
    dump = virDomainGetXMLDesc(dom, flags);
3110
    if (dump != NULL) {
3111
        vshPrint(ctl, "%s", dump);
3112
        VIR_FREE(dump);
3113 3114 3115
    } else {
        ret = FALSE;
    }
3116

3117 3118 3119 3120
    virDomainFree(dom);
    return ret;
}

3121 3122 3123 3124
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
3125 3126
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
3127 3128 3129 3130
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
3131 3132
    {"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")},
3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145
    {NULL, 0, 0, NULL}
};

static int
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
    int ret = TRUE;
    char *format;
    char *configFile;
    char *configData;
    char *xmlData;
    int flags = 0;

3146
    if (!vshConnectionUsability(ctl, ctl->conn))
3147 3148 3149 3150 3151
        return FALSE;

    format = vshCommandOptString(cmd, "format", NULL);
    configFile = vshCommandOptString(cmd, "config", NULL);

3152
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
3153 3154 3155 3156
        return FALSE;

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
3157
        vshPrint(ctl, "%s", xmlData);
3158
        VIR_FREE(xmlData);
3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169
    } else {
        ret = FALSE;
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
3170 3171
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
3172 3173 3174 3175
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
3176 3177
    {"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")},
3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190
    {NULL, 0, 0, NULL}
};

static int
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
    int ret = TRUE;
    char *format;
    char *xmlFile;
    char *configData;
    char *xmlData;
    int flags = 0;

3191
    if (!vshConnectionUsability(ctl, ctl->conn))
3192 3193 3194 3195 3196
        return FALSE;

    format = vshCommandOptString(cmd, "format", NULL);
    xmlFile = vshCommandOptString(cmd, "xml", NULL);

3197
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
3198 3199 3200 3201
        return FALSE;

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
3202
        vshPrint(ctl, "%s", configData);
3203
        VIR_FREE(configData);
3204 3205 3206 3207 3208 3209 3210
    } else {
        ret = FALSE;
    }

    return ret;
}

K
Karel Zak 已提交
3211
/*
K
Karel Zak 已提交
3212
 * "domname" command
K
Karel Zak 已提交
3213
 */
3214
static const vshCmdInfo info_domname[] = {
3215
    {"help", N_("convert a domain id or UUID to domain name")},
3216
    {"desc", ""},
3217
    {NULL, NULL}
K
Karel Zak 已提交
3218 3219
};

3220
static const vshCmdOptDef opts_domname[] = {
3221
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
3222
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3223 3224 3225
};

static int
3226
cmdDomname(vshControl *ctl, const vshCmd *cmd)
3227
{
K
Karel Zak 已提交
3228 3229
    virDomainPtr dom;

3230
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3231
        return FALSE;
J
Jim Meyering 已提交
3232
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3233
                                      VSH_BYID|VSH_BYUUID)))
K
Karel Zak 已提交
3234
        return FALSE;
3235

K
Karel Zak 已提交
3236 3237
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
K
Karel Zak 已提交
3238 3239 3240 3241
    return TRUE;
}

/*
K
Karel Zak 已提交
3242
 * "domid" command
K
Karel Zak 已提交
3243
 */
3244
static const vshCmdInfo info_domid[] = {
3245
    {"help", N_("convert a domain name or UUID to domain id")},
3246
    {"desc", ""},
3247
    {NULL, NULL}
K
Karel Zak 已提交
3248 3249
};

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

static int
3256
cmdDomid(vshControl *ctl, const vshCmd *cmd)
3257
{
3258
    virDomainPtr dom;
3259
    unsigned int id;
K
Karel Zak 已提交
3260

3261
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3262
        return FALSE;
J
Jim Meyering 已提交
3263
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3264
                                      VSH_BYNAME|VSH_BYUUID)))
K
Karel Zak 已提交
3265
        return FALSE;
3266

3267 3268
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3269
        vshPrint(ctl, "%s\n", "-");
3270
    else
3271
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
3272 3273 3274
    virDomainFree(dom);
    return TRUE;
}
3275

K
Karel Zak 已提交
3276 3277 3278
/*
 * "domuuid" command
 */
3279
static const vshCmdInfo info_domuuid[] = {
3280
    {"help", N_("convert a domain name or id to domain UUID")},
3281
    {"desc", ""},
K
Karel Zak 已提交
3282 3283 3284
    {NULL, NULL}
};

3285
static const vshCmdOptDef opts_domuuid[] = {
3286
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
3287 3288 3289 3290
    {NULL, 0, 0, NULL}
};

static int
3291
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
3292 3293
{
    virDomainPtr dom;
3294
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
3295

3296
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3297
        return FALSE;
J
Jim Meyering 已提交
3298
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3299
                                      VSH_BYNAME|VSH_BYID)))
K
Karel Zak 已提交
3300
        return FALSE;
3301

K
Karel Zak 已提交
3302 3303 3304
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
3305
        vshError(ctl, "%s", _("failed to get domain UUID"));
3306

3307
    virDomainFree(dom);
K
Karel Zak 已提交
3308 3309 3310
    return TRUE;
}

3311 3312 3313
/*
 * "migrate" command
 */
3314
static const vshCmdInfo info_migrate[] = {
3315 3316
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
3317 3318 3319
    {NULL, NULL}
};

3320
static const vshCmdOptDef opts_migrate[] = {
3321 3322 3323 3324 3325 3326 3327
    {"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")},
3328 3329
    {"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)")},
3330 3331 3332 3333
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"desturi", VSH_OT_DATA, VSH_OFLAG_REQ, N_("connection URI of the destination host")},
    {"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)")},
3334 3335 3336 3337
    {NULL, 0, 0, NULL}
};

static int
3338
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
3339 3340 3341 3342
{
    virDomainPtr dom = NULL;
    const char *desturi;
    const char *migrateuri;
D
Daniel Veillard 已提交
3343
    const char *dname;
3344 3345
    int flags = 0, found, ret = FALSE;

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

J
Jim Meyering 已提交
3349
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
3350 3351 3352
        return FALSE;

    desturi = vshCommandOptString (cmd, "desturi", &found);
3353
    if (!found)
3354 3355
        goto done;

3356
    migrateuri = vshCommandOptString (cmd, "migrateuri", NULL);
3357

3358
    dname = vshCommandOptString (cmd, "dname", NULL);
D
Daniel Veillard 已提交
3359

3360 3361
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
3362 3363
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
3364 3365 3366
    if (vshCommandOptBool (cmd, "tunnelled"))
        flags |= VIR_MIGRATE_TUNNELLED;

C
Chris Lalancette 已提交
3367 3368 3369 3370 3371
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

3372 3373 3374
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

3375 3376 3377 3378 3379 3380
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

3381 3382 3383 3384
    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. */
3385

3386
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
3387
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
3388 3389
            goto done;
        }
3390

3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407
        if (virDomainMigrateToURI (dom, desturi, flags, dname, 0) == 0)
            ret = TRUE;
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
        if (!dconn) goto done;

        ddom = virDomainMigrate (dom, dconn, flags, dname, migrateuri, 0);
        if (ddom) {
            virDomainFree(ddom);
            ret = TRUE;
        }
        virConnectClose (dconn);
    }
3408 3409 3410 3411 3412 3413

 done:
    if (dom) virDomainFree (dom);
    return ret;
}

3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424
/*
 * "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")},
3425
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436
    {NULL, 0, 0, NULL}
};

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

3437
    if (!vshConnectionUsability(ctl, ctl->conn))
3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458
        return FALSE;

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

    downtime = vshCommandOptLongLong(cmd, "downtime", &found);
    if (!found || downtime < 1) {
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

    ret = TRUE;

done:
    virDomainFree(dom);
    return ret;
}

3459 3460 3461
/*
 * "net-autostart" command
 */
3462
static const vshCmdInfo info_network_autostart[] = {
3463
    {"help", N_("autostart a network")},
3464
    {"desc",
3465
     N_("Configure a network to be automatically started at boot.")},
3466 3467 3468
    {NULL, NULL}
};

3469
static const vshCmdOptDef opts_network_autostart[] = {
3470 3471
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
3472 3473 3474 3475
    {NULL, 0, 0, NULL}
};

static int
3476
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
3477 3478 3479 3480 3481
{
    virNetworkPtr network;
    char *name;
    int autostart;

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

J
Jim Meyering 已提交
3485
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
3486 3487 3488 3489 3490
        return FALSE;

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
3491
        if (autostart)
3492
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
3493
        else
3494
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
3495 3496 3497 3498
        virNetworkFree(network);
        return FALSE;
    }

3499
    if (autostart)
3500
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
3501
    else
3502
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
3503

L
Laine Stump 已提交
3504
    virNetworkFree(network);
3505 3506
    return TRUE;
}
K
Karel Zak 已提交
3507

3508 3509 3510
/*
 * "net-create" command
 */
3511
static const vshCmdInfo info_network_create[] = {
3512 3513
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
3514 3515 3516
    {NULL, NULL}
};

3517
static const vshCmdOptDef opts_network_create[] = {
3518
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
3519 3520 3521 3522
    {NULL, 0, 0, NULL}
};

static int
3523
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
3524 3525 3526 3527 3528
{
    virNetworkPtr network;
    char *from;
    int found;
    int ret = TRUE;
3529
    char *buffer;
3530

3531
    if (!vshConnectionUsability(ctl, ctl->conn))
3532 3533 3534 3535 3536 3537
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found)
        return FALSE;

3538 3539
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
3540 3541

    network = virNetworkCreateXML(ctl->conn, buffer);
3542
    VIR_FREE(buffer);
3543

3544 3545 3546
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
3547
        virNetworkFree(network);
3548
    } else {
3549
        vshError(ctl, _("Failed to create network from %s"), from);
3550 3551 3552 3553 3554 3555 3556 3557 3558
        ret = FALSE;
    }
    return ret;
}


/*
 * "net-define" command
 */
3559
static const vshCmdInfo info_network_define[] = {
3560 3561
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
3562 3563 3564
    {NULL, NULL}
};

3565
static const vshCmdOptDef opts_network_define[] = {
3566
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
3567 3568 3569 3570
    {NULL, 0, 0, NULL}
};

static int
3571
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
3572 3573 3574 3575 3576
{
    virNetworkPtr network;
    char *from;
    int found;
    int ret = TRUE;
3577
    char *buffer;
3578

3579
    if (!vshConnectionUsability(ctl, ctl->conn))
3580 3581 3582 3583 3584 3585
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found)
        return FALSE;

3586 3587
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
3588 3589

    network = virNetworkDefineXML(ctl->conn, buffer);
3590
    VIR_FREE(buffer);
3591

3592 3593 3594
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
3595
        virNetworkFree(network);
3596
    } else {
3597
        vshError(ctl, _("Failed to define network from %s"), from);
3598 3599 3600 3601 3602 3603 3604 3605 3606
        ret = FALSE;
    }
    return ret;
}


/*
 * "net-destroy" command
 */
3607
static const vshCmdInfo info_network_destroy[] = {
3608 3609
    {"help", N_("destroy a network")},
    {"desc", N_("Destroy a given network.")},
3610 3611 3612
    {NULL, NULL}
};

3613
static const vshCmdOptDef opts_network_destroy[] = {
3614
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
3615 3616 3617 3618
    {NULL, 0, 0, NULL}
};

static int
3619
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
3620 3621 3622 3623 3624
{
    virNetworkPtr network;
    int ret = TRUE;
    char *name;

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

J
Jim Meyering 已提交
3628
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
3629 3630 3631 3632 3633
        return FALSE;

    if (virNetworkDestroy(network) == 0) {
        vshPrint(ctl, _("Network %s destroyed\n"), name);
    } else {
3634
        vshError(ctl, _("Failed to destroy network %s"), name);
3635 3636 3637
        ret = FALSE;
    }

3638
    virNetworkFree(network);
3639 3640 3641 3642 3643 3644 3645
    return ret;
}


/*
 * "net-dumpxml" command
 */
3646
static const vshCmdInfo info_network_dumpxml[] = {
3647 3648
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
3649 3650 3651
    {NULL, NULL}
};

3652
static const vshCmdOptDef opts_network_dumpxml[] = {
3653
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
3654 3655 3656 3657
    {NULL, 0, 0, NULL}
};

static int
3658
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
3659 3660 3661 3662 3663
{
    virNetworkPtr network;
    int ret = TRUE;
    char *dump;

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

J
Jim Meyering 已提交
3667
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
3668 3669 3670 3671
        return FALSE;

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
3672
        vshPrint(ctl, "%s", dump);
3673
        VIR_FREE(dump);
3674 3675 3676 3677 3678 3679 3680 3681
    } else {
        ret = FALSE;
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739
/*
 * "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;
}
3740

3741 3742 3743 3744
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
3745 3746
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
3747 3748 3749 3750
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
3751
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763
    {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;
3764
    int flags = VIR_INTERFACE_XML_INACTIVE;
3765

3766
    if (!vshConnectionUsability(ctl, ctl->conn))
3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805
        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)) {
3806 3807
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825
        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);

3826 3827 3828
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
3829 3830 3831

    if (tmp) {
        unlink (tmp);
3832
        VIR_FREE(tmp);
3833 3834 3835 3836 3837
    }

    return ret;
}

3838 3839 3840
/*
 * "net-list" command
 */
3841
static const vshCmdInfo info_network_list[] = {
3842 3843
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
3844 3845 3846
    {NULL, NULL}
};

3847
static const vshCmdOptDef opts_network_list[] = {
3848 3849
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
3850 3851 3852 3853
    {NULL, 0, 0, NULL}
};

static int
3854
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3855 3856 3857 3858 3859
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
3860
    char **activeNames = NULL, **inactiveNames = NULL;
3861 3862
    inactive |= all;

3863
    if (!vshConnectionUsability(ctl, ctl->conn))
3864 3865 3866
        return FALSE;

    if (active) {
3867 3868
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
3869
            vshError(ctl, "%s", _("Failed to list active networks"));
3870
            return FALSE;
3871
        }
3872
        if (maxactive) {
3873
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
3874

3875
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
3876
                                                    maxactive)) < 0) {
3877
                vshError(ctl, "%s", _("Failed to list active networks"));
3878
                VIR_FREE(activeNames);
3879 3880
                return FALSE;
            }
3881

3882
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
3883
        }
3884 3885
    }
    if (inactive) {
3886 3887
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
3888
            vshError(ctl, "%s", _("Failed to list inactive networks"));
3889
            VIR_FREE(activeNames);
3890
            return FALSE;
3891
        }
3892 3893 3894
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

3895 3896 3897
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
3898
                vshError(ctl, "%s", _("Failed to list inactive networks"));
3899 3900
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
3901 3902
                return FALSE;
            }
3903

3904 3905
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
3906
    }
3907 3908
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
3909
    vshPrintExtra(ctl, "-----------------------------------------\n");
3910 3911

    for (i = 0; i < maxactive; i++) {
3912 3913
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
3914 3915
        const char *autostartStr;
        int autostart = 0;
3916 3917 3918

        /* this kind of work with networks is not atomic operation */
        if (!network) {
3919
            VIR_FREE(activeNames[i]);
3920
            continue;
3921
        }
3922

3923 3924 3925
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
3926
            autostartStr = autostart ? _("yes") : _("no");
3927 3928 3929 3930 3931

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
3932
        virNetworkFree(network);
3933
        VIR_FREE(activeNames[i]);
3934 3935 3936
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
3937 3938
        const char *autostartStr;
        int autostart = 0;
3939 3940 3941

        /* this kind of work with networks is not atomic operation */
        if (!network) {
3942
            VIR_FREE(inactiveNames[i]);
3943
            continue;
3944
        }
3945

3946 3947 3948
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
3949
            autostartStr = autostart ? _("yes") : _("no");
3950

3951
        vshPrint(ctl, "%-20s %-10s %-10s\n",
3952 3953 3954
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
3955 3956

        virNetworkFree(network);
3957
        VIR_FREE(inactiveNames[i]);
3958
    }
3959 3960
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
3961 3962 3963 3964 3965 3966 3967
    return TRUE;
}


/*
 * "net-name" command
 */
3968
static const vshCmdInfo info_network_name[] = {
3969
    {"help", N_("convert a network UUID to network name")},
3970
    {"desc", ""},
3971 3972 3973
    {NULL, NULL}
};

3974
static const vshCmdOptDef opts_network_name[] = {
3975
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
3976 3977 3978 3979
    {NULL, 0, 0, NULL}
};

static int
3980
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
3981 3982 3983
{
    virNetworkPtr network;

3984
    if (!vshConnectionUsability(ctl, ctl->conn))
3985
        return FALSE;
J
Jim Meyering 已提交
3986
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
3987
                                           VSH_BYUUID)))
3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998
        return FALSE;

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


/*
 * "net-start" command
 */
3999
static const vshCmdInfo info_network_start[] = {
4000 4001
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
4002 4003 4004
    {NULL, NULL}
};

4005
static const vshCmdOptDef opts_network_start[] = {
4006
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
4007 4008 4009 4010
    {NULL, 0, 0, NULL}
};

static int
4011
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
4012 4013 4014 4015
{
    virNetworkPtr network;
    int ret = TRUE;

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

J
Jim Meyering 已提交
4019
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
4020
         return FALSE;
4021 4022 4023

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
4024
                 virNetworkGetName(network));
4025
    } else {
4026
        vshError(ctl, _("Failed to start network %s"),
4027
                 virNetworkGetName(network));
4028 4029
        ret = FALSE;
    }
L
Laine Stump 已提交
4030
    virNetworkFree(network);
4031 4032 4033 4034 4035 4036 4037
    return ret;
}


/*
 * "net-undefine" command
 */
4038
static const vshCmdInfo info_network_undefine[] = {
4039 4040
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
4041 4042 4043
    {NULL, NULL}
};

4044
static const vshCmdOptDef opts_network_undefine[] = {
4045
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4046 4047 4048 4049
    {NULL, 0, 0, NULL}
};

static int
4050
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
4051 4052 4053 4054 4055
{
    virNetworkPtr network;
    int ret = TRUE;
    char *name;

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

J
Jim Meyering 已提交
4059
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
4060 4061 4062 4063 4064
        return FALSE;

    if (virNetworkUndefine(network) == 0) {
        vshPrint(ctl, _("Network %s has been undefined\n"), name);
    } else {
4065
        vshError(ctl, _("Failed to undefine network %s"), name);
4066 4067 4068
        ret = FALSE;
    }

L
Laine Stump 已提交
4069
    virNetworkFree(network);
4070 4071 4072 4073 4074 4075 4076
    return ret;
}


/*
 * "net-uuid" command
 */
4077
static const vshCmdInfo info_network_uuid[] = {
4078
    {"help", N_("convert a network name to network UUID")},
4079
    {"desc", ""},
4080 4081 4082
    {NULL, NULL}
};

4083
static const vshCmdOptDef opts_network_uuid[] = {
4084
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
4085 4086 4087 4088
    {NULL, 0, 0, NULL}
};

static int
4089
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
4090 4091 4092 4093
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

J
Jim Meyering 已提交
4097
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4098
                                           VSH_BYNAME)))
4099 4100 4101 4102 4103
        return FALSE;

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

L
Laine Stump 已提交
4106
    virNetworkFree(network);
4107 4108 4109 4110
    return TRUE;
}


4111 4112 4113 4114 4115
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
4116 4117
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
4118 4119 4120 4121
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
4122 4123
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135
    {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;

4136
    if (!vshConnectionUsability(ctl, ctl->conn))
4137 4138 4139 4140 4141
        return FALSE;

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
4142
            vshError(ctl, "%s", _("Failed to list active interfaces"));
4143 4144 4145 4146 4147 4148 4149
            return FALSE;
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
4150
                vshError(ctl, "%s", _("Failed to list active interfaces"));
4151
                VIR_FREE(activeNames);
4152 4153 4154 4155 4156 4157 4158 4159 4160
                return FALSE;
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
4161
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4162
            VIR_FREE(activeNames);
4163 4164 4165 4166 4167
            return FALSE;
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4168 4169 4170
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
4171
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4172 4173
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
4174 4175 4176 4177 4178 4179
                return FALSE;
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
4180 4181
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
4182 4183 4184
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
4185 4186
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
4187 4188 4189

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4190
            VIR_FREE(activeNames[i]);
4191 4192 4193 4194 4195 4196 4197 4198
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4199
        VIR_FREE(activeNames[i]);
4200 4201
    }
    for (i = 0; i < maxinactive; i++) {
4202 4203
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
4204 4205 4206

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4207
            VIR_FREE(inactiveNames[i]);
4208 4209 4210 4211 4212 4213 4214 4215
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4216
        VIR_FREE(inactiveNames[i]);
4217
    }
4218 4219
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
4220 4221 4222 4223 4224 4225 4226 4227
    return TRUE;

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
4228
    {"help", N_("convert an interface MAC address to interface name")},
4229 4230 4231 4232 4233
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
4234
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
4235 4236 4237 4238 4239 4240 4241 4242
    {NULL, 0, 0, NULL}
};

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

4243
    if (!vshConnectionUsability(ctl, ctl->conn))
4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257
        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[] = {
4258
    {"help", N_("convert an interface name to interface MAC address")},
4259 4260 4261 4262 4263
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
4264
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
4265 4266 4267 4268 4269 4270 4271 4272
    {NULL, 0, 0, NULL}
};

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

4273
    if (!vshConnectionUsability(ctl, ctl->conn))
4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287
        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[] = {
4288 4289
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
4290 4291 4292 4293
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
4294 4295
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
4296 4297 4298 4299 4300 4301 4302 4303 4304
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
    int ret = TRUE;
    char *dump;
4305 4306 4307 4308 4309
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
4310

4311
    if (!vshConnectionUsability(ctl, ctl->conn))
4312 4313 4314 4315 4316
        return FALSE;

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

4317
    dump = virInterfaceGetXMLDesc(iface, flags);
4318
    if (dump != NULL) {
4319
        vshPrint(ctl, "%s", dump);
4320
        VIR_FREE(dump);
4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332
    } else {
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
4333 4334
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
4335 4336 4337 4338
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
4339
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
4340 4341 4342 4343 4344 4345
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
4346
    virInterfacePtr iface;
4347 4348 4349 4350 4351
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;

4352
    if (!vshConnectionUsability(ctl, ctl->conn))
4353 4354 4355 4356 4357 4358 4359 4360 4361
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found)
        return FALSE;

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

4362
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
4363
    VIR_FREE(buffer);
4364

4365
    if (iface != NULL) {
4366
        vshPrint(ctl, _("Interface %s defined from %s\n"),
4367
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
4368
        virInterfaceFree (iface);
4369
    } else {
4370
        vshError(ctl, _("Failed to define interface from %s"), from);
4371 4372 4373 4374 4375 4376 4377 4378 4379
        ret = FALSE;
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
4380 4381
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
4382 4383 4384 4385
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
4386
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4387 4388 4389 4390 4391 4392 4393 4394 4395 4396
    {NULL, 0, 0, NULL}
};

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

4397
    if (!vshConnectionUsability(ctl, ctl->conn))
4398 4399 4400 4401 4402 4403 4404 4405
        return FALSE;

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

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
4406
        vshError(ctl, _("Failed to undefine interface %s"), name);
4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
4418 4419
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
4420 4421 4422 4423
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
4424
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4425 4426 4427 4428 4429 4430 4431 4432 4433 4434
    {NULL, 0, 0, NULL}
};

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

4435
    if (!vshConnectionUsability(ctl, ctl->conn))
4436 4437 4438 4439 4440 4441 4442 4443
        return FALSE;

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

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
4444
        vshError(ctl, _("Failed to start interface %s"), name);
4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
4456 4457
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
    {"desc", N_("destroy a physical host interface.")},
4458 4459 4460 4461
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
4462
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4463 4464 4465 4466 4467 4468 4469 4470 4471 4472
    {NULL, 0, 0, NULL}
};

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

4473
    if (!vshConnectionUsability(ctl, ctl->conn))
4474 4475 4476 4477 4478 4479 4480 4481
        return FALSE;

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

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
4482
        vshError(ctl, _("Failed to destroy interface %s"), name);
4483 4484 4485 4486 4487 4488 4489
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513

/*
 * "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;
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;

4514
    if (!vshConnectionUsability(ctl, ctl->conn))
4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found)
        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;
    char *name;

4560
    if (!vshConnectionUsability(ctl, ctl->conn))
4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598
        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;

4599
    if (!vshConnectionUsability(ctl, ctl->conn))
4600 4601 4602 4603 4604 4605 4606
        return FALSE;

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

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
4607
        vshPrint(ctl, "%s", dump);
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636
        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];

4637
    if (!vshConnectionUsability(ctl, ctl->conn))
4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707
        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;

4708
    if (!vshConnectionUsability(ctl, ctl->conn))
4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780
        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;
}


4781
/**************************************************************************/
4782
/*
4783
 * "pool-autostart" command
4784
 */
4785
static const vshCmdInfo info_pool_autostart[] = {
4786
    {"help", N_("autostart a pool")},
4787
    {"desc",
4788
     N_("Configure a pool to be automatically started at boot.")},
4789
    {NULL, NULL}
4790 4791
};

4792
static const vshCmdOptDef opts_pool_autostart[] = {
4793 4794
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4795 4796
    {NULL, 0, 0, NULL}
};
4797 4798

static int
4799
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
4800
{
4801 4802 4803
    virStoragePoolPtr pool;
    char *name;
    int autostart;
4804

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

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

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

4813 4814
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
4815
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
4816
        else
4817
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
4818
        virStoragePoolFree(pool);
4819 4820 4821
        return FALSE;
    }

4822
    if (autostart)
4823
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
4824
    else
4825
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
4826

L
Laine Stump 已提交
4827
    virStoragePoolFree(pool);
4828 4829 4830
    return TRUE;
}

4831
/*
4832
 * "pool-create" command
4833
 */
4834
static const vshCmdInfo info_pool_create[] = {
4835 4836
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
4837 4838 4839
    {NULL, NULL}
};

4840
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
4841
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
4842
     N_("file containing an XML pool description")},
4843 4844 4845
    {NULL, 0, 0, NULL}
};

4846
static int
4847
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
4848
{
4849 4850 4851 4852 4853
    virStoragePoolPtr pool;
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;
4854

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

4858 4859
    from = vshCommandOptString(cmd, "file", &found);
    if (!found)
4860 4861
        return FALSE;

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

4865
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
4866
    VIR_FREE(buffer);
4867 4868 4869 4870

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
4871
        virStoragePoolFree(pool);
4872
    } else {
4873
        vshError(ctl, _("Failed to create pool from %s"), from);
4874 4875 4876
        ret = FALSE;
    }
    return ret;
4877 4878
}

4879

4880 4881 4882 4883
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
4884
    {"help", N_("create a device defined "
4885
                          "by an XML file on the node")},
4886
    {"desc", N_("Create a device on the node.  Note that this "
4887 4888 4889 4890 4891 4892 4893
                          "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,
4894
     N_("file containing an XML description of the device")},
4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
    char *from;
    int found = 0;
    int ret = TRUE;
    char *buffer;

4907
    if (!vshConnectionUsability(ctl, ctl->conn))
4908 4909 4910 4911 4912 4913 4914
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found) {
        return FALSE;
    }

4915
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
4916 4917 4918
        return FALSE;

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
4919
    VIR_FREE(buffer);
4920 4921 4922 4923

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
4924
        virNodeDeviceFree(dev);
4925
    } else {
4926
        vshError(ctl, _("Failed to create node device from %s"), from);
4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937
        ret = FALSE;
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
4938 4939
    {"help", N_("destroy a device on the node")},
    {"desc", N_("Destroy a device on the node.  Note that this "
4940 4941 4942 4943 4944 4945
                          "command destroys devices on the physical host ")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
4946
     N_("name of the device to be destroyed")},
4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957
    {NULL, 0, 0, NULL}
};

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

4958
    if (!vshConnectionUsability(ctl, ctl->conn)) {
4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971
        return FALSE;
    }

    name = vshCommandOptString(cmd, "name", &found);
    if (!found) {
        return FALSE;
    }

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
4972
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
4973 4974 4975 4976 4977 4978 4979 4980
        ret = FALSE;
    }

    virNodeDeviceFree(dev);
    return ret;
}


4981
/*
4982
 * XML Building helper for pool-define-as and pool-create-as
4983
 */
4984
static const vshCmdOptDef opts_pool_X_as[] = {
4985 4986 4987 4988 4989 4990 4991 4992
    {"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")},
4993
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
4994 4995 4996
    {NULL, 0, 0, NULL}
};

4997
static int buildPoolXML(const vshCmd *cmd, char **retname, char **xml) {
4998 4999

    int found;
5000
    char *name, *type, *srcHost, *srcPath, *srcDev, *srcName, *srcFormat, *target;
5001
    virBuffer buf = VIR_BUFFER_INITIALIZER;
5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012

    name = vshCommandOptString(cmd, "name", &found);
    if (!found)
        goto cleanup;
    type = vshCommandOptString(cmd, "type", &found);
    if (!found)
        goto cleanup;

    srcHost = vshCommandOptString(cmd, "source-host", &found);
    srcPath = vshCommandOptString(cmd, "source-path", &found);
    srcDev = vshCommandOptString(cmd, "source-dev", &found);
5013
    srcName = vshCommandOptString(cmd, "source-name", &found);
5014
    srcFormat = vshCommandOptString(cmd, "source-format", &found);
5015 5016
    target = vshCommandOptString(cmd, "target", &found);

5017 5018
    virBufferVSprintf(&buf, "<pool type='%s'>\n", type);
    virBufferVSprintf(&buf, "  <name>%s</name>\n", name);
5019
    if (srcHost || srcPath || srcDev) {
5020
        virBufferAddLit(&buf, "  <source>\n");
5021

5022 5023
        if (srcHost)
            virBufferVSprintf(&buf, "    <host name='%s'/>\n", srcHost);
5024 5025 5026 5027
        if (srcPath)
            virBufferVSprintf(&buf, "    <dir path='%s'/>\n", srcPath);
        if (srcDev)
            virBufferVSprintf(&buf, "    <device path='%s'/>\n", srcDev);
5028 5029
        if (srcFormat)
            virBufferVSprintf(&buf, "    <format type='%s'/>\n", srcFormat);
5030 5031
        if (srcName)
            virBufferVSprintf(&buf, "    <name>%s</name>\n", srcName);
5032 5033

        virBufferAddLit(&buf, "  </source>\n");
5034 5035
    }
    if (target) {
5036 5037 5038
        virBufferAddLit(&buf, "  <target>\n");
        virBufferVSprintf(&buf, "    <path>%s</path>\n", target);
        virBufferAddLit(&buf, "  </target>\n");
5039
    }
5040 5041 5042 5043 5044 5045
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
    }
5046 5047 5048 5049 5050 5051

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

cleanup:
5052
    virBufferFreeAndReset(&buf);
5053 5054 5055 5056 5057 5058 5059
    return FALSE;
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
5060 5061
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
5062 5063 5064 5065 5066 5067 5068 5069
    {NULL, NULL}
};

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

5072
    if (!vshConnectionUsability(ctl, ctl->conn))
5073 5074 5075 5076
        return FALSE;

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

5078
    if (printXML) {
5079
        vshPrint(ctl, "%s", xml);
5080
        VIR_FREE(xml);
5081
    } else {
5082
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
5083
        VIR_FREE(xml);
5084

5085 5086 5087 5088
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
5089
            vshError(ctl, _("Failed to create pool %s"), name);
5090 5091 5092 5093
            return FALSE;
        }
    }
    return TRUE;
5094 5095
}

5096

5097
/*
5098
 * "pool-define" command
5099
 */
5100
static const vshCmdInfo info_pool_define[] = {
5101 5102
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
5103 5104 5105
    {NULL, NULL}
};

5106
static const vshCmdOptDef opts_pool_define[] = {
5107
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
5108 5109 5110
    {NULL, 0, 0, NULL}
};

5111
static int
5112
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
5113
{
5114 5115 5116 5117 5118
    virStoragePoolPtr pool;
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;
5119

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

5123 5124
    from = vshCommandOptString(cmd, "file", &found);
    if (!found)
5125 5126
        return FALSE;

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

5130
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
5131
    VIR_FREE(buffer);
5132 5133 5134 5135

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5136
        virStoragePoolFree(pool);
5137
    } else {
5138
        vshError(ctl, _("Failed to define pool from %s"), from);
5139 5140 5141
        ret = FALSE;
    }
    return ret;
5142 5143
}

5144

5145 5146 5147
/*
 * "pool-define-as" command
 */
5148
static const vshCmdInfo info_pool_define_as[] = {
5149 5150
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
5151 5152 5153 5154
    {NULL, NULL}
};

static int
5155
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
5156 5157
{
    virStoragePoolPtr pool;
5158
    char *xml, *name;
5159
    int printXML = vshCommandOptBool(cmd, "print-xml");
5160

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

5164
    if (!buildPoolXML(cmd, &name, &xml))
5165 5166
        return FALSE;

5167
    if (printXML) {
5168
        vshPrint(ctl, "%s", xml);
5169
        VIR_FREE(xml);
5170
    } else {
5171
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
5172
        VIR_FREE(xml);
5173

5174 5175 5176 5177
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
5178
            vshError(ctl, _("Failed to define pool %s"), name);
5179 5180 5181 5182
            return FALSE;
        }
    }
    return TRUE;
5183 5184 5185
}


5186
/*
5187
 * "pool-build" command
5188
 */
5189
static const vshCmdInfo info_pool_build[] = {
5190 5191
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
5192 5193 5194
    {NULL, NULL}
};

5195
static const vshCmdOptDef opts_pool_build[] = {
5196
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5197 5198 5199 5200
    {NULL, 0, 0, NULL}
};

static int
5201
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
5202
{
5203 5204 5205
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;
5206

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

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

5213
    if (virStoragePoolBuild(pool, 0) == 0) {
5214
        vshPrint(ctl, _("Pool %s built\n"), name);
5215
    } else {
5216
        vshError(ctl, _("Failed to build pool %s"), name);
5217
        ret = FALSE;
5218 5219
    }

5220 5221
    virStoragePoolFree(pool);

5222 5223 5224
    return ret;
}

5225

5226
/*
5227
 * "pool-destroy" command
5228
 */
5229
static const vshCmdInfo info_pool_destroy[] = {
5230 5231
    {"help", N_("destroy a pool")},
    {"desc", N_("Destroy a given pool.")},
5232 5233 5234
    {NULL, NULL}
};

5235
static const vshCmdOptDef opts_pool_destroy[] = {
5236
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5237 5238 5239 5240
    {NULL, 0, 0, NULL}
};

static int
5241
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
5242
{
5243 5244 5245
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;
5246

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

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

5253 5254 5255
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
5256
        vshError(ctl, _("Failed to destroy pool %s"), name);
5257
        ret = FALSE;
5258 5259
    }

5260
    virStoragePoolFree(pool);
5261 5262 5263
    return ret;
}

5264

5265
/*
5266 5267
 * "pool-delete" command
 */
5268
static const vshCmdInfo info_pool_delete[] = {
5269 5270
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
5271 5272 5273
    {NULL, NULL}
};

5274
static const vshCmdOptDef opts_pool_delete[] = {
5275
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5276 5277 5278 5279
    {NULL, 0, 0, NULL}
};

static int
5280
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
5281 5282 5283 5284 5285
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;

5286
    if (!vshConnectionUsability(ctl, ctl->conn))
5287 5288 5289 5290 5291 5292
        return FALSE;

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

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
5293
        vshPrint(ctl, _("Pool %s deleted\n"), name);
5294
    } else {
5295
        vshError(ctl, _("Failed to delete pool %s"), name);
5296 5297 5298
        ret = FALSE;
    }

L
Laine Stump 已提交
5299
    virStoragePoolFree(pool);
5300 5301 5302 5303 5304 5305 5306
    return ret;
}


/*
 * "pool-refresh" command
 */
5307
static const vshCmdInfo info_pool_refresh[] = {
5308 5309
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
5310 5311 5312
    {NULL, NULL}
};

5313
static const vshCmdOptDef opts_pool_refresh[] = {
5314
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5315 5316 5317 5318
    {NULL, 0, 0, NULL}
};

static int
5319
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
5320 5321 5322 5323 5324
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;

5325
    if (!vshConnectionUsability(ctl, ctl->conn))
5326 5327 5328 5329 5330 5331 5332 5333
        return FALSE;

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

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
5334
        vshError(ctl, _("Failed to refresh pool %s"), name);
5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345
        ret = FALSE;
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
5346
static const vshCmdInfo info_pool_dumpxml[] = {
5347 5348
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
5349 5350 5351
    {NULL, NULL}
};

5352
static const vshCmdOptDef opts_pool_dumpxml[] = {
5353
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5354 5355 5356 5357
    {NULL, 0, 0, NULL}
};

static int
5358
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
5359 5360 5361 5362 5363
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *dump;

5364
    if (!vshConnectionUsability(ctl, ctl->conn))
5365 5366 5367 5368 5369 5370 5371
        return FALSE;

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

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
5372
        vshPrint(ctl, "%s", dump);
5373
        VIR_FREE(dump);
5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385
    } else {
        ret = FALSE;
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
5386
static const vshCmdInfo info_pool_list[] = {
5387 5388
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
5389 5390 5391
    {NULL, NULL}
};

5392
static const vshCmdOptDef opts_pool_list[] = {
5393 5394
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
5395
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
5396 5397 5398 5399
    {NULL, 0, 0, NULL}
};

static int
5400
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5401
{
5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420
    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 */
5421
    int all = vshCommandOptBool(cmd, "all");
5422 5423
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
5424 5425 5426
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

5427
    /* Check the connection to libvirtd daemon is still working */
5428
    if (!vshConnectionUsability(ctl, ctl->conn))
5429 5430
        return FALSE;

5431
    /* Retrieve the number of active storage pools */
5432
    if (active) {
5433 5434
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
5435
            vshError(ctl, "%s", _("Failed to list active pools"));
5436 5437 5438
            return FALSE;
        }
    }
5439 5440

    /* Retrieve the number of inactive storage pools */
5441
    if (inactive) {
5442 5443
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
5444
            vshError(ctl, "%s", _("Failed to list inactive pools"));
5445 5446
            return FALSE;
        }
5447
    }
5448

5449 5450
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
5451

5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464
    /* 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;
5465 5466 5467
        }
    }

5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478
    /* 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;
        }
    }
5479

5480 5481 5482 5483 5484 5485 5486 5487 5488 5489
    /* 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]);
5490
        if (!pool) {
5491
            VIR_FREE(poolNames[i]);
5492 5493 5494
            continue;
        }

5495
        /* Retrieve the autostart status of the pool */
5496
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
5497
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
5498
        else
5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516
            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;
        }
5517

5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629
        /* 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 */
5630 5631 5632
        virStoragePoolFree(pool);
    }

5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650
    /* 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);
5651 5652
        }

5653 5654 5655 5656
        /* Cleanup and return */
        functionReturn = TRUE;
        goto cleanup;
    }
5657

5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767
    /* 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;
5768

5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780
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]);
5781
    }
5782 5783 5784 5785 5786 5787 5788

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

    /* Return the desired value */
    return functionReturn;
5789 5790
}

5791 5792 5793 5794
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
5795 5796
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
5797 5798 5799 5800 5801
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
5802 5803 5804
     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")},
5805
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
5806 5807 5808 5809 5810 5811 5812 5813 5814
    {NULL, 0, 0, NULL}
};

static int
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
    char *type, *host;
    char *srcSpec = NULL;
    char *srcList;
5815
    char *initiator;
5816 5817 5818 5819 5820 5821 5822 5823
    int found;

    type = vshCommandOptString(cmd, "type", &found);
    if (!found)
        return FALSE;
    host = vshCommandOptString(cmd, "host", &found);
    if (!found)
        host = NULL;
5824 5825 5826
    initiator = vshCommandOptString(cmd, "initiator", &found);
    if (!found)
        initiator = NULL;
5827

5828
    if (!vshConnectionUsability(ctl, ctl->conn))
5829 5830 5831 5832
        return FALSE;

    if (host) {
        char *port = vshCommandOptString(cmd, "port", &found);
5833 5834
        if (!found)
            port = NULL;
5835 5836
        virBuffer buf = VIR_BUFFER_INITIALIZER;
        virBufferAddLit(&buf, "<source>\n");
5837
        virBufferVSprintf(&buf, "  <host name='%s'", host);
5838 5839 5840
        if (port)
            virBufferVSprintf(&buf, " port='%s'", port);
        virBufferAddLit(&buf, "/>\n");
5841 5842 5843 5844 5845
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
            virBufferVSprintf(&buf, "    <iqn name='%s'/>\n", initiator);
            virBufferAddLit(&buf, "  </initiator>\n");
        }
5846 5847 5848
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
5849 5850
            return FALSE;
        }
5851
        srcSpec = virBufferContentAndReset(&buf);
5852 5853 5854
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
5855
    VIR_FREE(srcSpec);
5856
    if (srcList == NULL) {
5857
        vshError(ctl, _("Failed to find any %s pool sources"), type);
5858 5859 5860
        return FALSE;
    }
    vshPrint(ctl, "%s", srcList);
5861
    VIR_FREE(srcList);
5862 5863 5864 5865 5866 5867 5868 5869 5870

    return TRUE;
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
5871 5872
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
5873 5874 5875 5876 5877
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
5878
     N_("type of storage pool sources to discover")},
5879
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
5880
     N_("optional file of source xml to query for pools")},
5881 5882 5883 5884 5885 5886
    {NULL, 0, 0, NULL}
};

static int
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
5887 5888
    char *type, *srcSpecFile, *srcList;
    char *srcSpec = NULL;
5889 5890 5891 5892 5893 5894
    int found;

    type = vshCommandOptString(cmd, "type", &found);
    if (!found)
        return FALSE;
    srcSpecFile = vshCommandOptString(cmd, "srcSpec", &found);
5895
    if (!found)
5896 5897
        srcSpecFile = NULL;

5898
    if (!vshConnectionUsability(ctl, ctl->conn))
5899 5900 5901 5902 5903 5904
        return FALSE;

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

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
5905
    VIR_FREE(srcSpec);
5906
    if (srcList == NULL) {
5907
        vshError(ctl, _("Failed to find any %s pool sources"), type);
5908 5909 5910
        return FALSE;
    }
    vshPrint(ctl, "%s", srcList);
5911
    VIR_FREE(srcList);
5912 5913 5914 5915 5916

    return TRUE;
}


5917 5918 5919
/*
 * "pool-info" command
 */
5920
static const vshCmdInfo info_pool_info[] = {
5921 5922
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
5923 5924 5925
    {NULL, NULL}
};

5926
static const vshCmdOptDef opts_pool_info[] = {
5927
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5928 5929 5930 5931
    {NULL, 0, 0, NULL}
};

static int
5932
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
5933 5934 5935
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
5936 5937
    int autostart = 0;
    int persistent = 0;
5938 5939 5940
    int ret = TRUE;
    char uuid[VIR_UUID_STRING_BUFLEN];

5941
    if (!vshConnectionUsability(ctl, ctl->conn))
5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971
        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;
5972 5973 5974 5975
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
5976 5977
        }

5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993
        /* 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"));

5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016
        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
 */
6017
static const vshCmdInfo info_pool_name[] = {
6018
    {"help", N_("convert a pool UUID to pool name")},
6019
    {"desc", ""},
6020 6021 6022
    {NULL, NULL}
};

6023
static const vshCmdOptDef opts_pool_name[] = {
6024
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
6025 6026 6027 6028
    {NULL, 0, 0, NULL}
};

static int
6029
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
6030 6031 6032
{
    virStoragePoolPtr pool;

6033
    if (!vshConnectionUsability(ctl, ctl->conn))
6034 6035
        return FALSE;
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6036
                                           VSH_BYUUID)))
6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047
        return FALSE;

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
    return TRUE;
}


/*
 * "pool-start" command
 */
6048
static const vshCmdInfo info_pool_start[] = {
6049 6050
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
6051 6052 6053
    {NULL, NULL}
};

6054
static const vshCmdOptDef opts_pool_start[] = {
6055
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
6056 6057 6058 6059
    {NULL, 0, 0, NULL}
};

static int
6060
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
6061 6062 6063 6064
{
    virStoragePoolPtr pool;
    int ret = TRUE;

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

6068
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
6069 6070 6071 6072 6073 6074
         return FALSE;

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
6075
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
6076 6077
        ret = FALSE;
    }
L
Laine Stump 已提交
6078 6079

    virStoragePoolFree(pool);
6080 6081 6082 6083
    return ret;
}


6084 6085 6086
/*
 * "vol-create-as" command
 */
6087
static const vshCmdInfo info_vol_create_as[] = {
6088 6089
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
6090 6091 6092
    {NULL, NULL}
};

6093
static const vshCmdOptDef opts_vol_create_as[] = {
6094 6095 6096 6097 6098
    {"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")},
6099 6100
    {"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")},
6101 6102 6103 6104 6105 6106 6107 6108 6109 6110
    {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 已提交
6111
        /* Deliberate fallthrough cases here :-) */
6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132
        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
6133
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
6134 6135 6136 6137
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
    int found;
6138
    char *xml;
6139
    char *name, *capacityStr, *allocationStr, *format;
6140
    char *snapshotStrVol, *snapshotStrFormat;
6141
    unsigned long long capacity, allocation = 0;
6142
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6143

6144
    if (!vshConnectionUsability(ctl, ctl->conn))
6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158
        return FALSE;

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

    name = vshCommandOptString(cmd, "name", &found);
    if (!found)
        goto cleanup;

    capacityStr = vshCommandOptString(cmd, "capacity", &found);
    if (!found)
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
6159
        vshError(ctl, _("Malformed size %s"), capacityStr);
6160 6161 6162 6163

    allocationStr = vshCommandOptString(cmd, "allocation", &found);
    if (allocationStr &&
        cmdVolSize(allocationStr, &allocation) < 0)
6164
        vshError(ctl, _("Malformed size %s"), allocationStr);
6165 6166

    format = vshCommandOptString(cmd, "format", &found);
6167 6168
    snapshotStrVol = vshCommandOptString(cmd, "backing-vol", &found);
    snapshotStrFormat = vshCommandOptString(cmd, "backing-vol-format", &found);
6169

6170 6171 6172 6173 6174
    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);
6175 6176

    if (format) {
6177
        virBufferAddLit(&buf, "  <target>\n");
6178
        virBufferVSprintf(&buf, "    <format type='%s'/>\n",format);
6179
        virBufferAddLit(&buf, "  </target>\n");
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
    /* 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");
6237

6238 6239 6240 6241 6242 6243
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
6244
    VIR_FREE(xml);
6245 6246 6247 6248 6249 6250 6251
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
        return TRUE;
    } else {
6252
        vshError(ctl, _("Failed to create vol %s"), name);
6253 6254 6255 6256
        return FALSE;
    }

 cleanup:
6257
    virBufferFreeAndReset(&buf);
6258 6259 6260 6261 6262
    virStoragePoolFree(pool);
    return FALSE;
}


6263 6264 6265
/*
 * "pool-undefine" command
 */
6266
static const vshCmdInfo info_pool_undefine[] = {
6267 6268
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
6269 6270 6271
    {NULL, NULL}
};

6272
static const vshCmdOptDef opts_pool_undefine[] = {
6273
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6274 6275 6276 6277
    {NULL, 0, 0, NULL}
};

static int
6278
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
6279 6280 6281 6282 6283
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;

6284
    if (!vshConnectionUsability(ctl, ctl->conn))
6285 6286 6287 6288 6289 6290 6291 6292
        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 {
6293
        vshError(ctl, _("Failed to undefine pool %s"), name);
6294 6295 6296
        ret = FALSE;
    }

L
Laine Stump 已提交
6297
    virStoragePoolFree(pool);
6298 6299 6300 6301 6302 6303 6304
    return ret;
}


/*
 * "pool-uuid" command
 */
6305
static const vshCmdInfo info_pool_uuid[] = {
6306
    {"help", N_("convert a pool name to pool UUID")},
6307
    {"desc", ""},
6308 6309 6310
    {NULL, NULL}
};

6311
static const vshCmdOptDef opts_pool_uuid[] = {
6312
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
6313 6314 6315 6316
    {NULL, 0, 0, NULL}
};

static int
6317
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
6318 6319 6320 6321
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

6322
    if (!vshConnectionUsability(ctl, ctl->conn))
6323 6324 6325
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6326
                                           VSH_BYNAME)))
6327 6328 6329 6330 6331
        return FALSE;

    if (virStoragePoolGetUUIDString(pool, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
6332
        vshError(ctl, "%s", _("failed to get pool UUID"));
6333

L
Laine Stump 已提交
6334
    virStoragePoolFree(pool);
6335 6336 6337 6338 6339 6340 6341
    return TRUE;
}


/*
 * "vol-create" command
 */
6342
static const vshCmdInfo info_vol_create[] = {
6343 6344
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
6345 6346 6347
    {NULL, NULL}
};

6348
static const vshCmdOptDef opts_vol_create[] = {
6349 6350
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
6351 6352 6353 6354
    {NULL, 0, 0, NULL}
};

static int
6355
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
6356 6357 6358 6359 6360 6361 6362 6363
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;

6364
    if (!vshConnectionUsability(ctl, ctl->conn))
6365 6366 6367
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6368
                                           VSH_BYNAME)))
6369 6370 6371 6372 6373 6374 6375 6376 6377
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found) {
        virStoragePoolFree(pool);
        return FALSE;
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
6378
        virshReportError(ctl);
6379 6380 6381 6382 6383
        virStoragePoolFree(pool);
        return FALSE;
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
6384
    VIR_FREE(buffer);
6385 6386 6387 6388 6389 6390 6391
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
6392
        vshError(ctl, _("Failed to create vol from %s"), from);
6393 6394 6395 6396 6397
        ret = FALSE;
    }
    return ret;
}

6398 6399 6400 6401
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
6402 6403
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
6404 6405 6406 6407
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
6408 6409 6410 6411
    {"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")},
6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424
    {NULL, 0, 0, NULL}
};

static int
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
    char *from;
    int found;
    int ret = FALSE;
    char *buffer = NULL;

6425
    if (!vshConnectionUsability(ctl, ctl->conn))
6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439
        goto cleanup;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
        goto cleanup;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found) {
        goto cleanup;
    }

    if (!(inputvol = vshCommandOptVol(ctl, cmd, "vol", "inputpool", NULL)))
        goto cleanup;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
6440
        virshReportError(ctl);
6441 6442 6443 6444 6445 6446 6447 6448 6449
        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 {
6450
        vshError(ctl, _("Failed to create vol from %s"), from);
6451 6452 6453 6454 6455
        goto cleanup;
    }

    ret = TRUE;
cleanup:
6456
    VIR_FREE(buffer);
6457 6458 6459 6460
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
6461 6462
    if (newvol)
        virStorageVolFree(newvol);
6463 6464 6465 6466 6467 6468
    return ret;
}

static xmlChar *
makeCloneXML(char *origxml, char *newname) {

6469 6470 6471
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501
    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[] = {
6502 6503
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
6504 6505 6506 6507
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
6508 6509 6510
    {"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")},
6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523
    {NULL, 0, 0, NULL}
};

static int
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
    char *name, *origxml = NULL;
    xmlChar *newxml = NULL;
    int found;
    int ret = FALSE;

6524
    if (!vshConnectionUsability(ctl, ctl->conn))
6525 6526 6527 6528 6529 6530 6531
        goto cleanup;

    if (!(origvol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        goto cleanup;

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
6532
        vshError(ctl, "%s", _("failed to get parent pool"));
6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555
        goto cleanup;
    }

    name = vshCommandOptString(cmd, "newname", &found);
    if (!found)
        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 {
6556
        vshError(ctl, _("Failed to clone vol from %s"),
6557 6558 6559 6560 6561 6562 6563
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

    ret = TRUE;

cleanup:
6564
    VIR_FREE(origxml);
6565 6566 6567
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
6568 6569
    if (newvol)
        virStorageVolFree(newvol);
6570 6571 6572 6573 6574
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

6575 6576 6577
/*
 * "vol-delete" command
 */
6578
static const vshCmdInfo info_vol_delete[] = {
6579 6580
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
6581 6582 6583
    {NULL, NULL}
};

6584
static const vshCmdOptDef opts_vol_delete[] = {
6585 6586
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
6587 6588 6589 6590
    {NULL, 0, 0, NULL}
};

static int
6591
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
6592 6593 6594 6595 6596
{
    virStorageVolPtr vol;
    int ret = TRUE;
    char *name;

6597
    if (!vshConnectionUsability(ctl, ctl->conn))
6598 6599 6600 6601 6602 6603 6604
        return FALSE;

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
        return FALSE;
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
6605
        vshPrint(ctl, _("Vol %s deleted\n"), name);
6606
    } else {
6607
        vshError(ctl, _("Failed to delete vol %s"), name);
6608 6609 6610
        ret = FALSE;
    }

L
Laine Stump 已提交
6611
    virStorageVolFree(vol);
6612 6613 6614 6615
    return ret;
}


D
David Allan 已提交
6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637
/*
 * "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;
    char *name;

6638
    if (!vshConnectionUsability(ctl, ctl->conn))
D
David Allan 已提交
6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656
        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;
}


6657 6658 6659
/*
 * "vol-info" command
 */
6660
static const vshCmdInfo info_vol_info[] = {
6661 6662
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
6663 6664 6665
    {NULL, NULL}
};

6666
static const vshCmdOptDef opts_vol_info[] = {
6667 6668
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
6669 6670 6671 6672
    {NULL, 0, 0, NULL}
};

static int
6673
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
6674 6675 6676 6677 6678
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
    int ret = TRUE;

6679
    if (!vshConnectionUsability(ctl, ctl->conn))
6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710
        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
 */
6711
static const vshCmdInfo info_vol_dumpxml[] = {
6712 6713
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
6714 6715 6716
    {NULL, NULL}
};

6717
static const vshCmdOptDef opts_vol_dumpxml[] = {
6718 6719
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
6720 6721 6722 6723
    {NULL, 0, 0, NULL}
};

static int
6724
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
6725 6726 6727 6728 6729
{
    virStorageVolPtr vol;
    int ret = TRUE;
    char *dump;

6730
    if (!vshConnectionUsability(ctl, ctl->conn))
6731 6732 6733 6734 6735 6736 6737
        return FALSE;

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

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
6738
        vshPrint(ctl, "%s", dump);
6739
        VIR_FREE(dump);
6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751
    } else {
        ret = FALSE;
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
6752
static const vshCmdInfo info_vol_list[] = {
6753 6754
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
6755 6756 6757
    {NULL, NULL}
};

6758
static const vshCmdOptDef opts_vol_list[] = {
6759
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6760
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
6761 6762 6763 6764
    {NULL, 0, 0, NULL}
};

static int
6765
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6766
{
6767
    virStorageVolInfo volumeInfo;
6768 6769
    virStoragePoolPtr pool;
    char **activeNames = NULL;
6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786
    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;
6787

6788
    /* Check the connection to libvirtd daemon is still working */
6789
    if (!vshConnectionUsability(ctl, ctl->conn))
6790 6791
        return FALSE;

6792
    /* Look up the pool information given to us by the user */
6793 6794 6795
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
        return FALSE;

6796 6797
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
6798

6799 6800 6801 6802 6803
    /* 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) {
6804
            vshError(ctl, "%s", _("Failed to list active vols"));
6805
            VIR_FREE(activeNames);
6806 6807 6808 6809
            virStoragePoolFree(pool);
            return FALSE;
        }

6810 6811 6812 6813 6814
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

        /* Set aside memory for volume information pointers */
        volInfoTexts = vshCalloc(ctl, numVolumes, sizeof(*volInfoTexts));
6815 6816
    }

6817 6818 6819 6820 6821
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
6822

6823 6824 6825 6826
        /* 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"));
6827 6828
        }

6829 6830 6831 6832 6833 6834 6835 6836 6837
        /* 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 */
6838

6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893
                /* 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;
        }
6894

6895
        /* Cleanup memory allocation */
6896
        virStorageVolFree(vol);
6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946
    }

    /* 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 已提交
6947 6948 6949 6950 6951
    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);
6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 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

    /* 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);
7012
        VIR_FREE(activeNames[i]);
7013
    }
7014 7015 7016 7017

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
7018
    VIR_FREE(activeNames);
7019
    virStoragePoolFree(pool);
7020 7021 7022

    /* Return the desired value */
    return functionReturn;
7023 7024 7025 7026 7027 7028
}


/*
 * "vol-name" command
 */
7029
static const vshCmdInfo info_vol_name[] = {
7030
    {"help", N_("returns the volume name for a given volume key or path")},
7031
    {"desc", ""},
7032 7033 7034
    {NULL, NULL}
};

7035
static const vshCmdOptDef opts_vol_name[] = {
7036
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
7037 7038 7039 7040
    {NULL, 0, 0, NULL}
};

static int
7041
cmdVolName(vshControl *ctl, const vshCmd *cmd)
7042 7043 7044
{
    virStorageVolPtr vol;

7045
    if (!vshConnectionUsability(ctl, ctl->conn))
7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057
        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 已提交
7058 7059 7060 7061 7062 7063 7064 7065 7066 7067
/*
 * "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[] = {
7068
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
7069 7070 7071 7072 7073 7074 7075 7076 7077
    {"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;
7078
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
7079 7080

    /* Check the connection to libvirtd daemon is still working */
7081
    if (!vshConnectionUsability(ctl, ctl->conn))
J
Justin Clift 已提交
7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097
        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;
    }

7098 7099 7100 7101 7102 7103 7104 7105 7106
    /* 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 已提交
7107 7108 7109 7110 7111 7112 7113

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
    return TRUE;
}

7114 7115 7116 7117

/*
 * "vol-key" command
 */
7118
static const vshCmdInfo info_vol_key[] = {
7119
    {"help", N_("returns the volume key for a given volume name or path")},
7120
    {"desc", ""},
7121 7122 7123
    {NULL, NULL}
};

7124
static const vshCmdOptDef opts_vol_key[] = {
7125
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7126
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
7127 7128 7129 7130
    {NULL, 0, 0, NULL}
};

static int
7131
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
7132 7133 7134
{
    virStorageVolPtr vol;

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

7138
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150
        return FALSE;

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
    return TRUE;
}



/*
 * "vol-path" command
 */
7151
static const vshCmdInfo info_vol_path[] = {
7152
    {"help", N_("returns the volume path for a given volume name or key")},
7153
    {"desc", ""},
7154 7155 7156
    {NULL, NULL}
};

7157
static const vshCmdOptDef opts_vol_path[] = {
7158
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7159
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
7160 7161 7162 7163
    {NULL, 0, 0, NULL}
};

static int
7164
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
7165 7166
{
    virStorageVolPtr vol;
7167
    char *name = NULL;
7168

7169
    if (!vshConnectionUsability(ctl, ctl->conn))
7170
        return FALSE;
7171 7172

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
7173
        return FALSE;
7174
    }
7175 7176 7177 7178 7179 7180 7181

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
    return TRUE;
}


7182 7183 7184 7185
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
7186 7187
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
7188 7189
    {NULL, NULL}
};
7190

7191
static const vshCmdOptDef opts_secret_define[] = {
7192
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
7193 7194
    {NULL, 0, 0, NULL}
};
7195

7196 7197 7198
static int
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
7199
    char *from, *buffer;
7200
    virSecretPtr res;
7201
    char uuid[VIR_UUID_STRING_BUFLEN];
7202

7203
    if (!vshConnectionUsability(ctl, ctl->conn))
7204 7205 7206 7207 7208 7209 7210 7211 7212 7213
        return FALSE;

    from = vshCommandOptString(cmd, "file", NULL);
    if (!from)
        return FALSE;

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
7214
    VIR_FREE(buffer);
7215 7216

    if (res == NULL) {
7217
        vshError(ctl, _("Failed to set attributes from %s"), from);
7218 7219
        return FALSE;
    }
7220
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
7221
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233
        virSecretFree(res);
        return FALSE;
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
    return TRUE;
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
7234 7235
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
7236 7237 7238 7239
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
7240
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7241 7242 7243 7244 7245 7246 7247 7248 7249 7250
    {NULL, 0, 0, NULL}
};

static int
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    int ret = FALSE;
    char *xml;

7251
    if (!vshConnectionUsability(ctl, ctl->conn))
7252 7253 7254 7255 7256 7257 7258 7259 7260
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
        return FALSE;

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
7261
    vshPrint(ctl, "%s", xml);
7262
    VIR_FREE(xml);
7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
7274 7275
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
7276 7277 7278 7279
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
7280 7281
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292
    {NULL, 0, 0, NULL}
};

static int
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
    char *base64, *value;
    int found, res, ret = FALSE;

7293
    if (!vshConnectionUsability(ctl, ctl->conn))
7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
        return FALSE;

    base64 = vshCommandOptString(cmd, "base64", &found);
    if (!base64)
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
7305
        vshError(ctl, "%s", _("Invalid base64 data"));
7306 7307 7308
        goto cleanup;
    }
    if (value == NULL) {
7309
        vshError(ctl, "%s", _("Failed to allocate memory"));
7310 7311 7312 7313 7314
        return FALSE;
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
7315
    VIR_FREE(value);
7316 7317

    if (res != 0) {
7318
        vshError(ctl, "%s", _("Failed to set secret value"));
7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332
        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[] = {
7333 7334
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
7335 7336 7337 7338
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
7339
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351
    {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;

7352
    if (!vshConnectionUsability(ctl, ctl->conn))
7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364
        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);
7365
    VIR_FREE(value);
7366 7367

    if (base64 == NULL) {
7368
        vshError(ctl, "%s", _("Failed to allocate memory"));
7369 7370
        goto cleanup;
    }
7371
    vshPrint(ctl, "%s", base64);
7372
    memset(base64, 0, strlen(base64));
7373
    VIR_FREE(base64);
7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
7385 7386
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
7387 7388 7389 7390
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
7391
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7392 7393 7394 7395 7396 7397 7398 7399 7400 7401
    {NULL, 0, 0, NULL}
};

static int
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    int ret = FALSE;
    char *uuid;

7402
    if (!vshConnectionUsability(ctl, ctl->conn))
7403 7404 7405 7406 7407 7408 7409
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
        return FALSE;

    if (virSecretUndefine(secret) < 0) {
7410
        vshError(ctl, _("Failed to delete secret %s"), uuid);
7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424
        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[] = {
7425 7426
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
7427 7428 7429 7430 7431 7432 7433 7434 7435
    {NULL, NULL}
};

static int
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

7436
    if (!vshConnectionUsability(ctl, ctl->conn))
7437 7438 7439 7440
        return FALSE;

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
7441
        vshError(ctl, "%s", _("Failed to list secrets"));
7442 7443 7444 7445 7446 7447
        return FALSE;
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
7448
        vshError(ctl, "%s", _("Failed to list secrets"));
7449
        VIR_FREE(uuids);
7450 7451 7452 7453 7454
        return FALSE;
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

7455 7456
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
7457 7458

    for (i = 0; i < maxuuids; i++) {
7459 7460 7461 7462
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
7463
            VIR_FREE(uuids[i]);
7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481
            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);
7482
        VIR_FREE(uuids[i]);
7483
    }
7484
    VIR_FREE(uuids);
7485 7486
    return TRUE;
}
7487 7488 7489 7490 7491


/*
 * "version" command
 */
7492
static const vshCmdInfo info_version[] = {
7493 7494
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
7495 7496 7497 7498 7499
    {NULL, NULL}
};


static int
7500
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511
{
    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;

7512
    if (!vshConnectionUsability(ctl, ctl->conn))
7513 7514 7515 7516
        return FALSE;

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
7517
        vshError(ctl, "%s", _("failed to get hypervisor type"));
7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530
        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) {
7531
        vshError(ctl, "%s", _("failed to get the library version"));
7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549
        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) {
7550
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567
        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;
}

7568 7569 7570 7571
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
7572
    {"help", N_("enumerate devices on this host")},
7573
    {"desc", ""},
7574 7575 7576 7577
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
7578 7579
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
7580 7581 7582
    {NULL, 0, 0, NULL}
};

7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604
#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] = '-';
7605 7606
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
7607 7608 7609
    }

    /* Print this device */
7610
    vshPrint(ctl, "%s", indentBuf);
7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633
    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) {
7634
        vshPrint(ctl, "%s", indentBuf);
7635
        vshPrint(ctl, " |\n");
7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657
    }

    /* 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) {
7658
        vshPrint(ctl, "%s", indentBuf);
7659 7660 7661 7662
        vshPrint(ctl, "\n");
    }
}

7663 7664 7665 7666 7667 7668
static int
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cap;
    char **devices;
    int found, num_devices, i;
7669
    int tree = vshCommandOptBool(cmd, "tree");
7670

7671
    if (!vshConnectionUsability(ctl, ctl->conn))
7672 7673 7674 7675 7676 7677 7678 7679
        return FALSE;

    cap = vshCommandOptString(cmd, "cap", &found);
    if (!found)
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
7680
        vshError(ctl, "%s", _("Failed to count node devices"));
7681 7682 7683 7684 7685 7686 7687 7688 7689
        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) {
7690
        vshError(ctl, "%s", _("Failed to list node devices"));
7691
        VIR_FREE(devices);
7692 7693
        return FALSE;
    }
7694
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
7695 7696 7697 7698 7699 7700 7701
    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 已提交
7702
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721
            } 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++) {
7722 7723
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
7724
        }
7725
        VIR_FREE(parents);
7726 7727 7728
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
7729
            VIR_FREE(devices[i]);
7730
        }
7731
    }
7732
    VIR_FREE(devices);
7733 7734 7735 7736 7737 7738 7739
    return TRUE;
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
7740 7741
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
7742 7743 7744 7745 7746
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
7747
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7748 7749 7750 7751 7752 7753 7754 7755
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
L
Laine Stump 已提交
7756
    char *xml;
7757

7758
    if (!vshConnectionUsability(ctl, ctl->conn))
7759 7760 7761 7762
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7763
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7764 7765 7766
        return FALSE;
    }

L
Laine Stump 已提交
7767 7768 7769 7770 7771 7772 7773
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
        return FALSE;
    }

    vshPrint(ctl, "%s\n", xml);
7774
    VIR_FREE(xml);
7775 7776 7777 7778
    virNodeDeviceFree(device);
    return TRUE;
}

7779 7780 7781 7782
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
7783 7784
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
7785 7786 7787 7788 7789
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
7790
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7791 7792 7793 7794 7795 7796 7797 7798 7799 7800
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
    int ret = TRUE;

7801
    if (!vshConnectionUsability(ctl, ctl->conn))
7802 7803 7804 7805
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7806
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7807 7808 7809 7810 7811 7812
        return FALSE;
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
7813
        vshError(ctl, _("Failed to dettach device %s"), name);
7814 7815 7816 7817 7818 7819 7820 7821 7822 7823
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
7824 7825
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
7826 7827 7828 7829 7830
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
7831
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7832 7833 7834 7835 7836 7837 7838 7839 7840 7841
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
    int ret = TRUE;

7842
    if (!vshConnectionUsability(ctl, ctl->conn))
7843 7844 7845 7846
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7847
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7848 7849 7850 7851 7852 7853
        return FALSE;
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
7854
        vshError(ctl, _("Failed to re-attach device %s"), name);
7855 7856 7857 7858 7859 7860 7861 7862 7863 7864
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
7865 7866
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
7867 7868 7869 7870 7871
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
7872
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7873 7874 7875 7876 7877 7878 7879 7880 7881 7882
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
    int ret = TRUE;

7883
    if (!vshConnectionUsability(ctl, ctl->conn))
7884 7885 7886 7887
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7888
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7889 7890 7891 7892 7893 7894
        return FALSE;
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
7895
        vshError(ctl, _("Failed to reset device %s"), name);
7896 7897 7898 7899 7900 7901
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

7902 7903 7904
/*
 * "hostkey" command
 */
7905
static const vshCmdInfo info_hostname[] = {
7906
    {"help", N_("print the hypervisor hostname")},
7907
    {"desc", ""},
7908 7909 7910 7911
    {NULL, NULL}
};

static int
7912
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7913 7914 7915
{
    char *hostname;

7916
    if (!vshConnectionUsability(ctl, ctl->conn))
7917 7918 7919 7920
        return FALSE;

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
7921
        vshError(ctl, "%s", _("failed to get hostname"));
7922 7923 7924 7925
        return FALSE;
    }

    vshPrint (ctl, "%s\n", hostname);
7926
    VIR_FREE(hostname);
7927 7928 7929 7930 7931 7932 7933

    return TRUE;
}

/*
 * "uri" command
 */
7934
static const vshCmdInfo info_uri[] = {
7935
    {"help", N_("print the hypervisor canonical URI")},
7936
    {"desc", ""},
7937 7938 7939 7940
    {NULL, NULL}
};

static int
7941
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7942 7943 7944
{
    char *uri;

7945
    if (!vshConnectionUsability(ctl, ctl->conn))
7946 7947 7948 7949
        return FALSE;

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
7950
        vshError(ctl, "%s", _("failed to get URI"));
7951 7952 7953 7954
        return FALSE;
    }

    vshPrint (ctl, "%s\n", uri);
7955
    VIR_FREE(uri);
7956 7957 7958 7959 7960 7961 7962

    return TRUE;
}

/*
 * "vncdisplay" command
 */
7963
static const vshCmdInfo info_vncdisplay[] = {
7964 7965
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
7966 7967 7968
    {NULL, NULL}
};

7969
static const vshCmdOptDef opts_vncdisplay[] = {
7970
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
7971 7972 7973 7974
    {NULL, 0, 0, NULL}
};

static int
7975
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
7976 7977 7978 7979 7980 7981 7982 7983 7984
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    int ret = FALSE;
    int port = 0;
    char *doc;

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

J
Jim Meyering 已提交
7988
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
7989 7990 7991 7992 7993 7994 7995 7996 7997
        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);
7998
    VIR_FREE(doc);
7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016
    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) ||
8017
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037
        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
 */
8038
static const vshCmdInfo info_ttyconsole[] = {
8039 8040
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
8041 8042 8043
    {NULL, NULL}
};

8044
static const vshCmdOptDef opts_ttyconsole[] = {
8045
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8046 8047 8048 8049
    {NULL, 0, 0, NULL}
};

static int
8050
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
8051 8052 8053 8054 8055 8056 8057 8058
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    int ret = FALSE;
    char *doc;

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

J
Jim Meyering 已提交
8062
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8063 8064 8065 8066 8067 8068 8069 8070 8071
        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);
8072
    VIR_FREE(doc);
8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084
    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);
8085
    ret = TRUE;
8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097

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

/*
 * "attach-device" command
8098
 */
8099
static const vshCmdInfo info_attach_device[] = {
8100 8101
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
8102 8103 8104
    {NULL, NULL}
};

8105
static const vshCmdOptDef opts_attach_device[] = {
8106 8107 8108
    {"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")},
8109 8110 8111 8112
    {NULL, 0, 0, NULL}
};

static int
8113
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
8114 8115 8116 8117 8118 8119
{
    virDomainPtr dom;
    char *from;
    char *buffer;
    int ret = TRUE;
    int found;
J
Jim Fehlig 已提交
8120
    unsigned int flags;
8121

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

J
Jim Meyering 已提交
8125
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8126 8127 8128 8129 8130 8131 8132 8133
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found) {
        virDomainFree(dom);
        return FALSE;
    }

8134
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8135
        virshReportError(ctl);
8136
        virDomainFree(dom);
8137
        return FALSE;
8138
    }
8139

J
Jim Fehlig 已提交
8140 8141 8142 8143 8144 8145 8146 8147
    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);
    }
8148
    VIR_FREE(buffer);
8149 8150

    if (ret < 0) {
8151
        vshError(ctl, _("Failed to attach device from %s"), from);
8152 8153
        virDomainFree(dom);
        return FALSE;
8154
    } else {
J
Jim Meyering 已提交
8155
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
8156 8157 8158 8159 8160 8161 8162 8163 8164 8165
    }

    virDomainFree(dom);
    return TRUE;
}


/*
 * "detach-device" command
 */
8166
static const vshCmdInfo info_detach_device[] = {
8167 8168
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
8169 8170 8171
    {NULL, NULL}
};

8172
static const vshCmdOptDef opts_detach_device[] = {
8173 8174 8175
    {"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")},
8176 8177 8178 8179
    {NULL, 0, 0, NULL}
};

static int
8180
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
8181 8182 8183 8184 8185 8186
{
    virDomainPtr dom;
    char *from;
    char *buffer;
    int ret = TRUE;
    int found;
J
Jim Fehlig 已提交
8187
    unsigned int flags;
8188

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

J
Jim Meyering 已提交
8192
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8193 8194 8195 8196 8197 8198 8199 8200
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found) {
        virDomainFree(dom);
        return FALSE;
    }

8201
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8202
        virshReportError(ctl);
8203
        virDomainFree(dom);
8204
        return FALSE;
8205
    }
8206

J
Jim Fehlig 已提交
8207 8208 8209 8210 8211 8212 8213 8214
    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);
    }
8215
    VIR_FREE(buffer);
8216 8217

    if (ret < 0) {
8218
        vshError(ctl, _("Failed to detach device from %s"), from);
8219 8220
        virDomainFree(dom);
        return FALSE;
8221
    } else {
J
Jim Meyering 已提交
8222
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
8223 8224 8225 8226 8227 8228
    }

    virDomainFree(dom);
    return TRUE;
}

8229

8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255
/*
 * "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")},
    {NULL, 0, 0, NULL}
};

static int
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    char *from;
    char *buffer;
    int ret = TRUE;
    int found;
    unsigned int flags;

8256
    if (!vshConnectionUsability(ctl, ctl->conn))
8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268
        return FALSE;

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

    from = vshCommandOptString(cmd, "file", &found);
    if (!found) {
        virDomainFree(dom);
        return FALSE;
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8269
        virshReportError(ctl);
8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296
        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;
    }
    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;
}


8297 8298 8299
/*
 * "attach-interface" command
 */
8300
static const vshCmdInfo info_attach_interface[] = {
8301 8302
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
8303 8304 8305
    {NULL, NULL}
};

8306
static const vshCmdOptDef opts_attach_interface[] = {
8307 8308 8309 8310 8311 8312
    {"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")},
8313
    {"model", VSH_OT_DATA, 0, N_("model type")},
8314
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
8315 8316 8317 8318
    {NULL, 0, 0, NULL}
};

static int
8319
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
8320 8321
{
    virDomainPtr dom = NULL;
8322
    char *mac, *target, *script, *type, *source, *model;
8323
    int typ, ret = FALSE;
J
Jim Fehlig 已提交
8324
    unsigned int flags;
8325 8326
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
8327

8328
    if (!vshConnectionUsability(ctl, ctl->conn))
8329 8330
        goto cleanup;

J
Jim Meyering 已提交
8331
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8332 8333 8334 8335 8336 8337 8338 8339 8340
        goto cleanup;

    if (!(type = vshCommandOptString(cmd, "type", NULL)))
        goto cleanup;

    source = vshCommandOptString(cmd, "source", NULL);
    target = vshCommandOptString(cmd, "target", NULL);
    mac = vshCommandOptString(cmd, "mac", NULL);
    script = vshCommandOptString(cmd, "script", NULL);
8341
    model = vshCommandOptString(cmd, "model", NULL);
8342 8343

    /* check interface type */
8344
    if (STREQ(type, "network")) {
8345
        typ = 1;
8346
    } else if (STREQ(type, "bridge")) {
8347 8348
        typ = 2;
    } else {
E
Eric Blake 已提交
8349 8350
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
8351 8352 8353 8354
        goto cleanup;
    }

    /* Make XML of interface */
8355
    virBufferVSprintf(&buf, "<interface type='%s'>\n", type);
8356

8357 8358 8359 8360
    if (typ == 1)
        virBufferVSprintf(&buf, "  <source network='%s'/>\n", source);
    else if (typ == 2)
        virBufferVSprintf(&buf, "  <source bridge='%s'/>\n", source);
8361

8362 8363 8364 8365 8366 8367
    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);
8368 8369
    if (model != NULL)
        virBufferVSprintf(&buf, "  <model type='%s'/>\n", model);
8370

8371
    virBufferAddLit(&buf, "</interface>\n");
8372

8373 8374 8375
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
8376 8377
    }

8378
    xml = virBufferContentAndReset(&buf);
8379

J
Jim Fehlig 已提交
8380 8381 8382 8383
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
8384
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
8385
    } else {
8386
        ret = virDomainAttachDevice(dom, xml);
8387
    }
8388

8389 8390
    VIR_FREE(xml);

J
Jim Fehlig 已提交
8391
    if (ret != 0) {
L
Laine Stump 已提交
8392
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
8393 8394 8395 8396 8397
        ret = FALSE;
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
        ret = TRUE;
    }
8398 8399 8400 8401

 cleanup:
    if (dom)
        virDomainFree(dom);
8402
    virBufferFreeAndReset(&buf);
8403 8404 8405 8406 8407 8408
    return ret;
}

/*
 * "detach-interface" command
 */
8409
static const vshCmdInfo info_detach_interface[] = {
8410 8411
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
8412 8413 8414
    {NULL, NULL}
};

8415
static const vshCmdOptDef opts_detach_interface[] = {
8416 8417 8418 8419
    {"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")},
8420 8421 8422 8423
    {NULL, 0, 0, NULL}
};

static int
8424
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlChar *tmp_mac = NULL;
    xmlBufferPtr xml_buf = NULL;
    char *doc, *mac =NULL, *type;
    char buf[64];
    int i = 0, diff_mac, ret = FALSE;
J
Jim Fehlig 已提交
8436
    unsigned int flags;
8437

8438
    if (!vshConnectionUsability(ctl, ctl->conn))
8439 8440
        goto cleanup;

J
Jim Meyering 已提交
8441
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455
        goto cleanup;

    if (!(type = vshCommandOptString(cmd, "type", NULL)))
        goto cleanup;

    mac = vshCommandOptString(cmd, "mac", NULL);

    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);
8456
    VIR_FREE(doc);
8457
    if (!xml) {
8458
        vshError(ctl, "%s", _("Failed to get interface information"));
8459 8460 8461 8462
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
8463
        vshError(ctl, "%s", _("Failed to get interface information"));
8464 8465 8466
        goto cleanup;
    }

E
Eric Blake 已提交
8467
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
8468 8469 8470
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
8471
        vshError(ctl, _("No found interface whose type is %s"), type);
8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483
        goto cleanup;
    }

    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
            if (cur->type == XML_ELEMENT_NODE && xmlStrEqual(cur->name, BAD_CAST "mac")) {
                tmp_mac = xmlGetProp(cur, BAD_CAST "address");
8484
                diff_mac = virMacAddrCompare ((char *) tmp_mac, mac);
8485 8486 8487 8488 8489 8490 8491 8492
                xmlFree(tmp_mac);
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
8493
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
8494 8495 8496 8497 8498
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
8499
        vshError(ctl, "%s", _("Failed to allocate memory"));
8500 8501 8502 8503
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519
    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 已提交
8520
        vshError(ctl, "%s", _("Failed to detach interface"));
8521
        ret = FALSE;
J
Jim Fehlig 已提交
8522
    } else {
J
Jim Meyering 已提交
8523
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
8524
        ret = TRUE;
8525
    }
8526 8527 8528 8529

 cleanup:
    if (dom)
        virDomainFree(dom);
8530
    xmlXPathFreeObject(obj);
8531
    xmlXPathFreeContext(ctxt);
8532 8533 8534 8535 8536 8537 8538 8539 8540 8541
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    return ret;
}

/*
 * "attach-disk" command
 */
8542
static const vshCmdInfo info_attach_disk[] = {
8543 8544
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
8545 8546 8547
    {NULL, NULL}
};

8548
static const vshCmdOptDef opts_attach_disk[] = {
8549 8550 8551 8552 8553 8554 8555 8556
    {"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")},
8557
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
8558 8559 8560 8561
    {NULL, 0, 0, NULL}
};

static int
8562
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
8563 8564 8565 8566
{
    virDomainPtr dom = NULL;
    char *source, *target, *driver, *subdriver, *type, *mode;
    int isFile = 0, ret = FALSE;
J
Jim Fehlig 已提交
8567
    unsigned int flags;
8568
    char *stype;
8569 8570
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
8571

8572
    if (!vshConnectionUsability(ctl, ctl->conn))
8573 8574
        goto cleanup;

J
Jim Meyering 已提交
8575
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587
        goto cleanup;

    if (!(source = vshCommandOptString(cmd, "source", NULL)))
        goto cleanup;

    if (!(target = vshCommandOptString(cmd, "target", NULL)))
        goto cleanup;

    driver = vshCommandOptString(cmd, "driver", NULL);
    subdriver = vshCommandOptString(cmd, "subdriver", NULL);
    type = vshCommandOptString(cmd, "type", NULL);
    mode = vshCommandOptString(cmd, "mode", NULL);
8588
    stype = vshCommandOptString(cmd, "sourcetype", NULL);
8589

8590 8591
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
8592
            isFile = 1;
8593 8594 8595 8596 8597
    } else if (STREQ(stype, "file")) {
        isFile = 1;
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
8598 8599 8600
    }

    if (mode) {
8601
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
8602 8603
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
8604 8605 8606 8607 8608
            goto cleanup;
        }
    }

    /* Make XML of disk */
8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628
    virBufferVSprintf(&buf, "<disk type='%s'",
                      (isFile) ? "file" : "block");
    if (type)
        virBufferVSprintf(&buf, " device='%s'", type);
    virBufferAddLit(&buf, ">\n");

    virBufferVSprintf(&buf, "  <driver name='%s'",
                      (driver) ? driver : "phy");
    if (subdriver)
        virBufferVSprintf(&buf, " type='%s'", subdriver);
    virBufferAddLit(&buf, "/>\n");

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

8630 8631 8632
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
8633 8634
    }

8635
    xml = virBufferContentAndReset(&buf);
8636

J
Jim Fehlig 已提交
8637 8638 8639 8640
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
8641
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
8642
    } else {
8643
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
8644
    }
8645

8646 8647
    VIR_FREE(xml);

J
Jim Fehlig 已提交
8648
    if (ret != 0) {
L
Laine Stump 已提交
8649
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
8650 8651 8652 8653 8654
        ret = FALSE;
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
        ret = TRUE;
    }
8655 8656 8657 8658

 cleanup:
    if (dom)
        virDomainFree(dom);
8659
    virBufferFreeAndReset(&buf);
8660 8661 8662 8663 8664 8665
    return ret;
}

/*
 * "detach-disk" command
 */
8666
static const vshCmdInfo info_detach_disk[] = {
8667 8668
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
8669 8670 8671
    {NULL, NULL}
};

8672
static const vshCmdOptDef opts_detach_disk[] = {
8673 8674 8675
    {"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")},
8676 8677 8678 8679
    {NULL, 0, 0, NULL}
};

static int
8680
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
8681 8682 8683 8684 8685 8686 8687 8688 8689 8690
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlChar *tmp_tgt = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
    char *doc, *target;
    int i = 0, diff_tgt, ret = FALSE;
J
Jim Fehlig 已提交
8691
    unsigned int flags;
8692

8693
    if (!vshConnectionUsability(ctl, ctl->conn))
8694 8695
        goto cleanup;

J
Jim Meyering 已提交
8696
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708
        goto cleanup;

    if (!(target = vshCommandOptString(cmd, "target", NULL)))
        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);
8709
    VIR_FREE(doc);
8710
    if (!xml) {
8711
        vshError(ctl, "%s", _("Failed to get disk information"));
8712 8713 8714 8715
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
8716
        vshError(ctl, "%s", _("Failed to get disk information"));
8717 8718 8719 8720 8721 8722
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
8723
        vshError(ctl, "%s", _("Failed to get disk information"));
8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
            if (cur->type == XML_ELEMENT_NODE && xmlStrEqual(cur->name, BAD_CAST "target")) {
                tmp_tgt = xmlGetProp(cur, BAD_CAST "dev");
                diff_tgt = xmlStrEqual(tmp_tgt, BAD_CAST target);
                xmlFree(tmp_tgt);
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
8742
    vshError(ctl, _("No found disk whose target is %s"), target);
8743 8744 8745 8746 8747
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
8748
        vshError(ctl, "%s", _("Failed to allocate memory"));
8749 8750 8751 8752
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768
    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 已提交
8769
        vshError(ctl, "%s", _("Failed to detach disk"));
8770
        ret = FALSE;
J
Jim Fehlig 已提交
8771
    } else {
J
Jim Meyering 已提交
8772
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
8773
        ret = TRUE;
8774
    }
8775 8776

 cleanup:
8777
    xmlXPathFreeObject(obj);
8778
    xmlXPathFreeContext(ctxt);
8779 8780 8781 8782 8783 8784 8785 8786 8787
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
    return ret;
}

8788 8789 8790 8791
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
8792 8793
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
8794 8795 8796 8797
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
8798
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810
    {NULL, 0, 0, NULL}
};

static int
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;
    int result;

8811
    if (!vshConnectionUsability(ctl, ctl->conn))
8812 8813 8814 8815 8816 8817 8818 8819 8820 8821
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found)
        return FALSE;

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
8822
    VIR_FREE(buffer);
8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851

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

8852 8853 8854 8855
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
8856 8857
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
8858 8859 8860 8861
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
8862
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876
    {NULL, 0, 0, NULL}
};

static int
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
8877
    xmlNodePtr node_list;
8878 8879 8880 8881 8882 8883
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

8884
    if (!vshConnectionUsability(ctl, ctl->conn))
8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897
        return FALSE;

    from = vshCommandOptString(cmd, "file", &found);
    if (!found)
        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 已提交
8898 8899
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966
    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;
8967
    goto cleanup;
8968 8969
}

8970 8971 8972 8973 8974 8975 8976 8977
/* 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;

8978
    ret = vshMalloc(ctl, PATH_MAX);
8979 8980 8981

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
8982 8983
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
8984
    if (fd == -1) {
8985
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
8986
                 strerror(errno));
8987
        VIR_FREE(ret);
8988 8989 8990 8991
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
8992 8993
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
8994
        VIR_FORCE_CLOSE(fd);
8995
        unlink (ret);
8996
        VIR_FREE(ret);
8997 8998
        return NULL;
    }
S
Stefan Berger 已提交
8999
    if (VIR_CLOSE(fd) < 0) {
9000 9001
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
9002
        unlink (ret);
9003
        VIR_FREE(ret);
9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021
        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;
    char *command;
    int command_ret;

9022 9023
    editor = getenv ("VISUAL");
    if (!editor) editor = getenv ("EDITOR");
9024 9025
    if (!editor) editor = "vi"; /* could be cruel & default to ed(1) here */

9026 9027 9028 9029 9030 9031
    /* 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
     * is why sudo scrubs it by default).
9032 9033
     */
    if (strspn (filename, ACCEPTED_CHARS) != strlen (filename)) {
9034 9035 9036
        vshError(ctl,
                 _("%s: temporary filename contains shell meta or other "
                   "unacceptable characters (is $TMPDIR wrong?)"),
9037 9038 9039 9040
                 filename);
        return -1;
    }

9041
    if (virAsprintf(&command, "%s %s", editor, filename) == -1) {
9042
        vshError(ctl,
9043
                 _("virAsprintf: could not create editing command: %s"),
9044
                 strerror(errno));
9045 9046 9047 9048 9049
        return -1;
    }

    command_ret = system (command);
    if (command_ret == -1) {
9050 9051
        vshError(ctl,
                 _("%s: edit command failed: %s"), command, strerror(errno));
9052
        VIR_FREE(command);
9053 9054
        return -1;
    }
9055
    if (WEXITSTATUS(command_ret) != 0) {
9056
        vshError(ctl,
9057
                 _("%s: command exited with non-zero status"), command);
9058
        VIR_FREE(command);
9059 9060
        return -1;
    }
9061
    VIR_FREE(command);
9062 9063 9064 9065 9066 9067 9068 9069 9070
    return 0;
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
9071
        vshError(ctl,
9072
                 _("%s: failed to read temporary file: %s"),
9073
                 filename, strerror(errno));
9074 9075 9076 9077 9078
        return NULL;
    }
    return ret;
}

9079 9080

#ifndef WIN32
P
Paolo Bonzini 已提交
9081 9082 9083 9084
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
9085 9086
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
9087 9088 9089 9090
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
9091
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
9092 9093 9094 9095 9096 9097 9098 9099 9100 9101
    {NULL, 0, 0, NULL}
};

static int
cmdCd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    const char *dir;
    int found;

    if (!ctl->imode) {
9102
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
C
Chris Lalancette 已提交
9103
        return FALSE;
P
Paolo Bonzini 已提交
9104 9105 9106 9107 9108
    }

    dir = vshCommandOptString(cmd, "dir", &found);
    if (!found) {
        uid_t uid = geteuid();
9109
        dir = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
9110 9111 9112 9113 9114
    }
    if (!dir)
        dir = "/";

    if (chdir (dir) == -1) {
9115
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
C
Chris Lalancette 已提交
9116
        return FALSE;
P
Paolo Bonzini 已提交
9117 9118
    }

C
Chris Lalancette 已提交
9119
    return TRUE;
P
Paolo Bonzini 已提交
9120 9121
}

9122 9123 9124
#endif

#ifndef WIN32
P
Paolo Bonzini 已提交
9125 9126 9127 9128
/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
9129 9130
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152
    {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)
9153 9154
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
P
Paolo Bonzini 已提交
9155 9156 9157
    else
        vshPrint (ctl, _("%s\n"), cwd);

9158
    VIR_FREE(cwd);
P
Paolo Bonzini 已提交
9159 9160
    return !err;
}
9161
#endif
P
Paolo Bonzini 已提交
9162

E
Eric Blake 已提交
9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236
/*
 * "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;
}

9237 9238 9239 9240
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
9241 9242
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
9243 9244 9245 9246
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
9247
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262
    {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;
9263
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
9264

9265
    if (!vshConnectionUsability(ctl, ctl->conn))
9266 9267
        goto cleanup;

J
Jim Meyering 已提交
9268
    dom = vshCommandOptDomain (ctl, cmd, NULL);
9269 9270 9271 9272
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
9273
    doc = virDomainGetXMLDesc (dom, flags);
9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299
    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.
     */
9300
    doc_reread = virDomainGetXMLDesc (dom, flags);
9301 9302 9303 9304
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
9305 9306
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324
        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);

9325 9326 9327
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
9328 9329 9330

    if (tmp) {
        unlink (tmp);
9331
        VIR_FREE(tmp);
9332 9333 9334 9335 9336 9337 9338 9339 9340
    }

    return ret;
}

/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
9341 9342
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
9343 9344 9345 9346
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
9347
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
9348 9349 9350 9351 9352 9353 9354 9355 9356 9357
    {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[] = {
9358 9359
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
9360 9361 9362 9363
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
9364
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9365 9366 9367 9368 9369 9370
    {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 已提交
9371 9372 9373
/*
 * "quit" command
 */
9374
static const vshCmdInfo info_quit[] = {
9375
    {"help", N_("quit this interactive terminal")},
9376
    {"desc", ""},
9377
    {NULL, NULL}
K
Karel Zak 已提交
9378 9379 9380
};

static int
9381
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9382
{
K
Karel Zak 已提交
9383 9384 9385 9386
    ctl->imode = FALSE;
    return TRUE;
}

9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414
/*
 * "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;
    char *from;
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

9415
    if (!vshConnectionUsability(ctl, ctl->conn))
9416 9417 9418 9419 9420 9421 9422 9423
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    from = vshCommandOptString(cmd, "xmlfile", NULL);
    if (from == NULL)
E
Eric Blake 已提交
9424
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507
    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;

9508
    if (!vshConnectionUsability(ctl, ctl->conn))
9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563
        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;
9564
    int actual = 0;
9565 9566 9567 9568 9569 9570 9571 9572 9573 9574
    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;

9575
    if (!vshConnectionUsability(ctl, ctl->conn))
9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 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 9629 9630 9631 9632 9633
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

    vshPrint(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrint(ctl, "---------------------------------------------------\n");

    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);
9634
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650

            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);
9651 9652
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683
    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;
    char *name;
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

9684
    if (!vshConnectionUsability(ctl, ctl->conn))
9685 9686 9687 9688 9689 9690 9691
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    name = vshCommandOptString(cmd, "snapshotname", NULL);
9692
    if (name == NULL)
9693 9694 9695 9696 9697 9698 9699 9700 9701 9702
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

9703
    vshPrint(ctl, "%s", xml);
9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717

    ret = TRUE;

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
9718
 * "snapshot-revert" command
9719
 */
9720
static const vshCmdInfo info_snapshot_revert[] = {
9721 9722 9723 9724 9725
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

9726
static const vshCmdOptDef opts_snapshot_revert[] = {
9727 9728 9729 9730 9731 9732
    {"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
9733
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
9734 9735 9736 9737 9738 9739
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
    char *name;
    virDomainSnapshotPtr snapshot = NULL;

9740
    if (!vshConnectionUsability(ctl, ctl->conn))
9741 9742 9743 9744 9745 9746 9747
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    name = vshCommandOptString(cmd, "snapshotname", NULL);
9748
    if (name == NULL)
9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793
        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;
    char *name;
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

9794
    if (!vshConnectionUsability(ctl, ctl->conn))
9795 9796 9797 9798 9799 9800 9801
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    name = vshCommandOptString(cmd, "snapshotname", NULL);
9802
    if (name == NULL)
9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825
        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;
}

9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877
/*
 * "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")},
    {NULL, 0, 0, NULL}
};

static int
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
    char *monitor_cmd;
    char *result = NULL;

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    monitor_cmd = vshCommandOptString(cmd, "cmd", NULL);
    if (monitor_cmd == NULL) {
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, 0) < 0)
        goto cleanup;

    printf("%s\n", result);

    ret = TRUE;

cleanup:
    VIR_FREE(result);
    if (dom)
        virDomainFree(dom);

    return ret;
}


K
Karel Zak 已提交
9878 9879 9880
/*
 * Commands
 */
9881
static const vshCmdDef commands[] = {
9882 9883 9884 9885
    {"help", cmdHelp, opts_help, info_help},
    {"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},
9886
    {"autostart", cmdAutostart, opts_autostart, info_autostart},
9887
    {"capabilities", cmdCapabilities, NULL, info_capabilities},
9888
#ifndef WIN32
P
Paolo Bonzini 已提交
9889
    {"cd", cmdCd, opts_cd, info_cd},
9890
#endif
9891
    {"connect", cmdConnect, opts_connect, info_connect},
9892
#ifndef WIN32
9893
    {"console", cmdConsole, opts_console, info_console},
9894
#endif
9895
    {"cpu-baseline", cmdCPUBaseline, opts_cpu_baseline, info_cpu_baseline},
9896
    {"cpu-compare", cmdCPUCompare, opts_cpu_compare, info_cpu_compare},
9897
    {"create", cmdCreate, opts_create, info_create},
9898
    {"start", cmdStart, opts_start, info_start},
K
Karel Zak 已提交
9899
    {"destroy", cmdDestroy, opts_destroy, info_destroy},
9900 9901 9902
    {"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},
9903
    {"define", cmdDefine, opts_define, info_define},
K
Karel Zak 已提交
9904
    {"domid", cmdDomid, opts_domid, info_domid},
K
Karel Zak 已提交
9905
    {"domuuid", cmdDomuuid, opts_domuuid, info_domuuid},
9906
    {"dominfo", cmdDominfo, opts_dominfo, info_dominfo},
9907
    {"domjobinfo", cmdDomjobinfo, opts_domjobinfo, info_domjobinfo},
9908
    {"domjobabort", cmdDomjobabort, opts_domjobabort, info_domjobabort},
K
Karel Zak 已提交
9909 9910
    {"domname", cmdDomname, opts_domname, info_domname},
    {"domstate", cmdDomstate, opts_domstate, info_domstate},
9911 9912
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat},
    {"domifstat", cmdDomIfstat, opts_domifstat, info_domifstat},
9913
    {"dommemstat", cmdDomMemStat, opts_dommemstat, info_dommemstat},
9914
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo},
9915 9916
    {"domxml-from-native", cmdDomXMLFromNative, opts_domxmlfromnative, info_domxmlfromnative},
    {"domxml-to-native", cmdDomXMLToNative, opts_domxmltonative, info_domxmltonative},
9917
    {"dumpxml", cmdDumpXML, opts_dumpxml, info_dumpxml},
E
Eric Blake 已提交
9918
    {"echo", cmdEcho, opts_echo, info_echo},
9919
    {"edit", cmdEdit, opts_edit, info_edit},
9920 9921 9922 9923
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
     opts_find_storage_pool_sources, info_find_storage_pool_sources},
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as},
9924
    {"freecell", cmdFreecell, opts_freecell, info_freecell},
9925
    {"hostname", cmdHostname, NULL, info_hostname},
9926
    {"list", cmdList, opts_list, info_list},
E
Eric Blake 已提交
9927
    {"maxvcpus", cmdMaxvcpus, opts_maxvcpus, info_maxvcpus},
9928
    {"migrate", cmdMigrate, opts_migrate, info_migrate},
9929
    {"migrate-setmaxdowntime", cmdMigrateSetMaxDowntime, opts_migrate_setmaxdowntime, info_migrate_setmaxdowntime},
9930

9931
    {"net-autostart", cmdNetworkAutostart, opts_network_autostart, info_network_autostart},
9932 9933 9934 9935
    {"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},
9936
    {"net-edit", cmdNetworkEdit, opts_network_edit, info_network_edit},
O
Osier Yang 已提交
9937
    {"net-info", cmdNetworkInfo, opts_network_info, info_network_info},
9938 9939 9940 9941 9942
    {"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},
9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953

    {"iface-list", cmdInterfaceList, opts_interface_list, info_interface_list},
    {"iface-name", cmdInterfaceName, opts_interface_name, info_interface_name},
    {"iface-mac", cmdInterfaceMAC, opts_interface_mac, info_interface_mac},
    {"iface-dumpxml", cmdInterfaceDumpXML, opts_interface_dumpxml, info_interface_dumpxml},
    {"iface-define", cmdInterfaceDefine, opts_interface_define, info_interface_define},
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine, info_interface_undefine},
    {"iface-edit", cmdInterfaceEdit, opts_interface_edit, info_interface_edit},
    {"iface-start", cmdInterfaceStart, opts_interface_start, info_interface_start},
    {"iface-destroy", cmdInterfaceDestroy, opts_interface_destroy, info_interface_destroy},

9954
    {"managedsave", cmdManagedSave, opts_managedsave, info_managedsave},
9955
    {"managedsave-remove", cmdManagedSaveRemove, opts_managedsaveremove, info_managedsaveremove},
9956

K
Karel Zak 已提交
9957
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo},
9958

9959 9960
    {"nodedev-list", cmdNodeListDevices, opts_node_list_devices, info_node_list_devices},
    {"nodedev-dumpxml", cmdNodeDeviceDumpXML, opts_node_device_dumpxml, info_node_device_dumpxml},
9961 9962 9963
    {"nodedev-dettach", cmdNodeDeviceDettach, opts_node_device_dettach, info_node_device_dettach},
    {"nodedev-reattach", cmdNodeDeviceReAttach, opts_node_device_reattach, info_node_device_reattach},
    {"nodedev-reset", cmdNodeDeviceReset, opts_node_device_reset, info_node_device_reset},
9964 9965
    {"nodedev-create", cmdNodeDeviceCreate, opts_node_device_create, info_node_device_create},
    {"nodedev-destroy", cmdNodeDeviceDestroy, opts_node_device_destroy, info_node_device_destroy},
9966

9967 9968 9969 9970 9971 9972
    {"nwfilter-define", cmdNWFilterDefine, opts_nwfilter_define, info_nwfilter_define},
    {"nwfilter-undefine", cmdNWFilterUndefine, opts_nwfilter_undefine, info_nwfilter_undefine},
    {"nwfilter-dumpxml", cmdNWFilterDumpXML, opts_nwfilter_dumpxml, info_nwfilter_dumpxml},
    {"nwfilter-list", cmdNWFilterList, opts_nwfilter_list, info_nwfilter_list},
    {"nwfilter-edit", cmdNWFilterEdit, opts_nwfilter_edit, info_nwfilter_edit},

9973 9974 9975
    {"pool-autostart", cmdPoolAutostart, opts_pool_autostart, info_pool_autostart},
    {"pool-build", cmdPoolBuild, opts_pool_build, info_pool_build},
    {"pool-create", cmdPoolCreate, opts_pool_create, info_pool_create},
9976
    {"pool-create-as", cmdPoolCreateAs, opts_pool_X_as, info_pool_create_as},
9977
    {"pool-define", cmdPoolDefine, opts_pool_define, info_pool_define},
9978
    {"pool-define-as", cmdPoolDefineAs, opts_pool_X_as, info_pool_define_as},
9979 9980 9981
    {"pool-destroy", cmdPoolDestroy, opts_pool_destroy, info_pool_destroy},
    {"pool-delete", cmdPoolDelete, opts_pool_delete, info_pool_delete},
    {"pool-dumpxml", cmdPoolDumpXML, opts_pool_dumpxml, info_pool_dumpxml},
9982
    {"pool-edit", cmdPoolEdit, opts_pool_edit, info_pool_edit},
9983 9984 9985 9986 9987 9988 9989 9990
    {"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},

9991 9992 9993 9994 9995 9996 9997 9998
    {"secret-define", cmdSecretDefine, opts_secret_define, info_secret_define},
    {"secret-dumpxml", cmdSecretDumpXML, opts_secret_dumpxml, info_secret_dumpxml},
    {"secret-set-value", cmdSecretSetValue, opts_secret_set_value, info_secret_set_value},
    {"secret-get-value", cmdSecretGetValue, opts_secret_get_value, info_secret_get_value},
    {"secret-undefine", cmdSecretUndefine, opts_secret_undefine, info_secret_undefine},
    {"secret-list", cmdSecretList, NULL, info_secret_list},


9999
#ifndef WIN32
P
Paolo Bonzini 已提交
10000
    {"pwd", cmdPwd, NULL, info_pwd},
10001
#endif
K
Karel Zak 已提交
10002
    {"quit", cmdQuit, NULL, info_quit},
10003
    {"exit", cmdQuit, NULL, info_quit},
K
Karel Zak 已提交
10004 10005
    {"reboot", cmdReboot, opts_reboot, info_reboot},
    {"restore", cmdRestore, opts_restore, info_restore},
10006 10007
    {"resume", cmdResume, opts_resume, info_resume},
    {"save", cmdSave, opts_save, info_save},
10008
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo},
D
Daniel Veillard 已提交
10009
    {"dump", cmdDump, opts_dump, info_dump},
10010
    {"shutdown", cmdShutdown, opts_shutdown, info_shutdown},
10011 10012
    {"setmem", cmdSetmem, opts_setmem, info_setmem},
    {"setmaxmem", cmdSetmaxmem, opts_setmaxmem, info_setmaxmem},
10013
    {"memtune", cmdMemtune, opts_memtune, info_memtune},
10014
    {"setvcpus", cmdSetvcpus, opts_setvcpus, info_setvcpus},
K
Karel Zak 已提交
10015
    {"suspend", cmdSuspend, opts_suspend, info_suspend},
10016
    {"ttyconsole", cmdTTYConsole, opts_ttyconsole, info_ttyconsole},
10017
    {"undefine", cmdUndefine, opts_undefine, info_undefine},
10018
    {"update-device", cmdUpdateDevice, opts_update_device, info_update_device},
10019
    {"uri", cmdURI, NULL, info_uri},
10020 10021

    {"vol-create", cmdVolCreate, opts_vol_create, info_vol_create},
10022
    {"vol-create-from", cmdVolCreateFrom, opts_vol_create_from, info_vol_create_from},
10023
    {"vol-create-as", cmdVolCreateAs, opts_vol_create_as, info_vol_create_as},
10024
    {"vol-clone", cmdVolClone, opts_vol_clone, info_vol_clone},
10025
    {"vol-delete", cmdVolDelete, opts_vol_delete, info_vol_delete},
D
David Allan 已提交
10026
    {"vol-wipe", cmdVolWipe, opts_vol_wipe, info_vol_wipe},
10027 10028 10029
    {"vol-dumpxml", cmdVolDumpXML, opts_vol_dumpxml, info_vol_dumpxml},
    {"vol-info", cmdVolInfo, opts_vol_info, info_vol_info},
    {"vol-list", cmdVolList, opts_vol_list, info_vol_list},
J
Justin Clift 已提交
10030
    {"vol-pool", cmdVolPool, opts_vol_pool, info_vol_pool},
10031 10032 10033 10034
    {"vol-path", cmdVolPath, opts_vol_path, info_vol_path},
    {"vol-name", cmdVolName, opts_vol_name, info_vol_name},
    {"vol-key", cmdVolKey, opts_vol_key, info_vol_key},

E
Eric Blake 已提交
10035
    {"vcpucount", cmdVcpucount, opts_vcpucount, info_vcpucount},
10036 10037
    {"vcpuinfo", cmdVcpuinfo, opts_vcpuinfo, info_vcpuinfo},
    {"vcpupin", cmdVcpupin, opts_vcpupin, info_vcpupin},
10038
    {"version", cmdVersion, NULL, info_version},
10039
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay},
10040 10041 10042 10043 10044 10045

    {"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},
10046
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert, info_snapshot_revert},
10047

10048 10049
    {"qemu-monitor-command", cmdQemuMonitorCommand, opts_qemu_monitor_command, info_qemu_monitor_command},

10050
    {NULL, NULL, NULL, NULL}
K
Karel Zak 已提交
10051 10052 10053 10054 10055 10056
};

/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
10057
static const char *
10058
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
10059
{
10060
    const vshCmdInfo *info;
10061

K
Karel Zak 已提交
10062
    for (info = cmd->info; info && info->name; info++) {
10063
        if (STREQ(info->name, name))
K
Karel Zak 已提交
10064 10065 10066 10067 10068
            return info->data;
    }
    return NULL;
}

10069 10070
static const vshCmdOptDef *
vshCmddefGetOption(const vshCmdDef * cmd, const char *name)
10071
{
10072
    const vshCmdOptDef *opt;
10073

K
Karel Zak 已提交
10074
    for (opt = cmd->opts; opt && opt->name; opt++)
10075
        if (STREQ(opt->name, name))
K
Karel Zak 已提交
10076 10077 10078 10079
            return opt;
    return NULL;
}

10080 10081
static const vshCmdOptDef *
vshCmddefGetData(const vshCmdDef * cmd, int data_ct)
10082
{
10083
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
10084

10085
    for (opt = cmd->opts; opt && opt->name; opt++) {
10086 10087
        if (opt->type >= VSH_OT_DATA ||
            (opt->type == VSH_OT_INT && (opt->flag & VSH_OFLAG_REQ))) {
10088
            if (data_ct == 0 || opt->type == VSH_OT_ARGV)
10089 10090 10091 10092 10093
                return opt;
            else
                data_ct--;
        }
    }
K
Karel Zak 已提交
10094 10095 10096
    return NULL;
}

10097 10098 10099
/*
 * Checks for required options
 */
10100
static int
10101
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd)
10102
{
10103 10104
    const vshCmdDef *def = cmd->def;
    const vshCmdOptDef *d;
10105
    int err = 0;
10106 10107 10108 10109

    for (d = def->opts; d && d->name; d++) {
        if (d->flag & VSH_OFLAG_REQ) {
            vshCmdOpt *o = cmd->opts;
10110 10111 10112
            int ok = 0;

            while (o && ok == 0) {
10113
                if (o->def == d)
10114
                    ok = 1;
10115 10116 10117
                o = o->next;
            }
            if (!ok) {
10118
                vshError(ctl,
10119
                         d->type == VSH_OT_DATA ?
10120
                         _("command '%s' requires <%s> option") :
10121
                         _("command '%s' requires --%s option"),
10122
                         def->name, d->name);
10123 10124
                err = 1;
            }
10125

10126 10127 10128 10129 10130
        }
    }
    return !err;
}

10131
static const vshCmdDef *
10132 10133
vshCmddefSearch(const char *cmdname)
{
10134
    const vshCmdDef *c;
10135

K
Karel Zak 已提交
10136
    for (c = commands; c->name; c++)
10137
        if (STREQ(c->name, cmdname))
K
Karel Zak 已提交
10138 10139 10140 10141 10142
            return c;
    return NULL;
}

static int
10143
vshCmddefHelp(vshControl *ctl, const char *cmdname)
10144
{
10145
    const vshCmdDef *def = vshCmddefSearch(cmdname);
10146

K
Karel Zak 已提交
10147
    if (!def) {
10148
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
10149 10150
        return FALSE;
    } else {
E
Eric Blake 已提交
10151 10152
        const char *desc = _(vshCmddefGetInfo(def, "desc"));
        const char *help = _(vshCmddefGetInfo(def, "help"));
10153
        char buf[256];
K
Karel Zak 已提交
10154

10155
        fputs(_("  NAME\n"), stdout);
10156 10157
        fprintf(stdout, "    %s - %s\n", def->name, help);

10158 10159 10160 10161 10162 10163
        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;
10164 10165
                switch (opt->type) {
                case VSH_OT_BOOL:
10166
                    fmt = "[--%s]";
10167 10168
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
10169
                    /* xgettext:c-format */
10170 10171
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
10172 10173
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
10174 10175
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
10176 10177
                    break;
                case VSH_OT_DATA:
10178
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
10179 10180 10181 10182 10183 10184
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
                    fmt = _("[<string>]...");
                    break;
                default:
10185
                    assert(0);
10186
                }
10187
                fputc(' ', stdout);
E
Eric Blake 已提交
10188
                fprintf(stdout, fmt, opt->name);
10189
            }
K
Karel Zak 已提交
10190
        }
10191 10192 10193
        fputc('\n', stdout);

        if (desc[0]) {
10194
            /* Print the description only if it's not empty.  */
10195
            fputs(_("\n  DESCRIPTION\n"), stdout);
K
Karel Zak 已提交
10196 10197
            fprintf(stdout, "    %s\n", desc);
        }
10198

K
Karel Zak 已提交
10199
        if (def->opts) {
10200
            const vshCmdOptDef *opt;
10201
            fputs(_("\n  OPTIONS\n"), stdout);
10202
            for (opt = def->opts; opt->name; opt++) {
10203 10204
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
10205
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
10206 10207
                    break;
                case VSH_OT_INT:
10208 10209 10210
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
10211 10212
                    break;
                case VSH_OT_STRING:
10213
                    /* OT_STRING should never be VSH_OFLAG_REQ */
10214
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
10215 10216
                    break;
                case VSH_OT_DATA:
10217 10218
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
10219 10220 10221 10222 10223 10224 10225
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
                    continue;
                default:
                    assert(0);
                }
10226

E
Eric Blake 已提交
10227
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
10228
            }
K
Karel Zak 已提交
10229 10230 10231 10232 10233 10234 10235 10236 10237 10238
        }
        fputc('\n', stdout);
    }
    return TRUE;
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
10239 10240 10241
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
10242 10243
    vshCmdOpt *a = arg;

10244
    while (a) {
K
Karel Zak 已提交
10245
        vshCmdOpt *tmp = a;
10246

K
Karel Zak 已提交
10247 10248
        a = a->next;

10249 10250
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
10251 10252 10253 10254
    }
}

static void
10255
vshCommandFree(vshCmd *cmd)
10256
{
K
Karel Zak 已提交
10257 10258
    vshCmd *c = cmd;

10259
    while (c) {
K
Karel Zak 已提交
10260
        vshCmd *tmp = c;
10261

K
Karel Zak 已提交
10262 10263 10264 10265
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
10266
        VIR_FREE(tmp);
K
Karel Zak 已提交
10267 10268 10269 10270 10271 10272 10273
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
10274
vshCommandOpt(const vshCmd *cmd, const char *name)
10275
{
K
Karel Zak 已提交
10276
    vshCmdOpt *opt = cmd->opts;
10277 10278

    while (opt) {
10279
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
10280 10281 10282 10283 10284 10285 10286 10287 10288 10289
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
 * Returns option as INT
 */
static int
10290
vshCommandOptInt(const vshCmd *cmd, const char *name, int *found)
10291
{
K
Karel Zak 已提交
10292
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
10293 10294
    int res = 0, num_found = FALSE;
    char *end_p = NULL;
10295

10296 10297
    if ((arg != NULL) && (arg->data != NULL)) {
        res = strtol(arg->data, &end_p, 10);
10298 10299 10300 10301
        if ((arg->data == end_p) || (*end_p!= 0))
            num_found = FALSE;
        else
            num_found = TRUE;
10302
    }
K
Karel Zak 已提交
10303
    if (found)
10304
        *found = num_found;
K
Karel Zak 已提交
10305 10306 10307
    return res;
}

10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327
static unsigned long
vshCommandOptUL(const vshCmd *cmd, const char *name, int *found)
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
    unsigned long res = 0;
    int num_found = FALSE;
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
        res = strtoul(arg->data, &end_p, 10);
        if ((arg->data == end_p) || (*end_p!= 0))
            num_found = FALSE;
        else
            num_found = TRUE;
    }
    if (found)
        *found = num_found;
    return res;
}

K
Karel Zak 已提交
10328 10329 10330 10331
/*
 * Returns option as STRING
 */
static char *
10332
vshCommandOptString(const vshCmd *cmd, const char *name, int *found)
10333
{
K
Karel Zak 已提交
10334
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
10335

K
Karel Zak 已提交
10336 10337
    if (found)
        *found = arg ? TRUE : FALSE;
10338

10339 10340 10341
    if (arg && arg->data && *arg->data)
        return arg->data;

10342
    if (arg && arg->def && ((arg->def->flag) & VSH_OFLAG_REQ))
10343 10344 10345
        vshError(NULL, _("Missing required option '%s'"), name);

    return NULL;
K
Karel Zak 已提交
10346 10347
}

10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365
/*
 * Returns option as long long
 */
static long long
vshCommandOptLongLong(const vshCmd *cmd, const char *name, int *found)
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
    int num_found = FALSE;
    long long res = 0;
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL))
        num_found = !virStrToLong_ll(arg->data, &end_p, 10, &res);
    if (found)
        *found = num_found;
    return res;
}

K
Karel Zak 已提交
10366 10367 10368 10369
/*
 * Returns TRUE/FALSE if the option exists
 */
static int
10370
vshCommandOptBool(const vshCmd *cmd, const char *name)
10371
{
K
Karel Zak 已提交
10372 10373 10374
    return vshCommandOpt(cmd, name) ? TRUE : FALSE;
}

10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395
/*
 * 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 已提交
10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413
/* 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)
10414
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
10415 10416 10417
                 cmd->def->name, optname);
    return found;
}
10418

K
Karel Zak 已提交
10419
static virDomainPtr
J
Jim Meyering 已提交
10420
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
10421
                      char **name, int flag)
10422
{
K
Karel Zak 已提交
10423
    virDomainPtr dom = NULL;
10424
    char *n;
K
Karel Zak 已提交
10425
    int id;
J
Jim Meyering 已提交
10426 10427 10428
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
10429

10430
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10431 10432
        return NULL;

K
Karel Zak 已提交
10433
    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
10434 10435
             cmd->def->name, optname, n);

K
Karel Zak 已提交
10436 10437
    if (name)
        *name = n;
10438

K
Karel Zak 已提交
10439
    /* try it by ID */
10440
    if (flag & VSH_BYID) {
10441
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
10442 10443 10444 10445
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
10446
    }
K
Karel Zak 已提交
10447
    /* try it by UUID */
10448
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
10449
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
10450
                 cmd->def->name, optname);
K
Karel Zak 已提交
10451
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
10452
    }
K
Karel Zak 已提交
10453
    /* try it by NAME */
10454
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
10455
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
10456
                 cmd->def->name, optname);
K
Karel Zak 已提交
10457
        dom = virDomainLookupByName(ctl->conn, n);
10458
    }
K
Karel Zak 已提交
10459

10460
    if (!dom)
10461
        vshError(ctl, _("failed to get domain '%s'"), n);
10462

K
Karel Zak 已提交
10463 10464 10465
    return dom;
}

10466
static virNetworkPtr
J
Jim Meyering 已提交
10467
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
10468
                       char **name, int flag)
10469 10470 10471
{
    virNetworkPtr network = NULL;
    char *n;
J
Jim Meyering 已提交
10472 10473 10474
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
10475

10476
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10477 10478 10479 10480 10481 10482 10483 10484 10485
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
10486
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
10487
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
10488
                 cmd->def->name, optname);
10489 10490 10491 10492
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
10493
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
10494 10495 10496 10497 10498
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
10499
        vshError(ctl, _("failed to get network '%s'"), n);
10500 10501 10502 10503

    return network;
}

10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
                        char **name, int flag)
{
    virNWFilterPtr nwfilter = NULL;
    char *n;
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

10515
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542
        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;
}

10543 10544 10545 10546 10547 10548 10549 10550 10551 10552
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
                         char **name, int flag)
{
    virInterfacePtr iface = NULL;
    char *n;
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

10553
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10554 10555 10556 10557 10558 10559 10560 10561 10562
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
10563
    if ((flag & VSH_BYNAME)) {
10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575
        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)
10576
        vshError(ctl, _("failed to get interface '%s'"), n);
10577 10578 10579 10580

    return iface;
}

10581
static virStoragePoolPtr
10582
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
10583 10584 10585 10586 10587
                    char **name, int flag)
{
    virStoragePoolPtr pool = NULL;
    char *n;

10588
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10589 10590 10591 10592 10593 10594 10595 10596 10597
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
10598
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
10599
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
10600
                 cmd->def->name, optname);
10601 10602 10603
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
10604
    if (pool == NULL && (flag & VSH_BYNAME)) {
10605 10606 10607 10608 10609 10610
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
10611
        vshError(ctl, _("failed to get pool '%s'"), n);
10612 10613 10614 10615 10616

    return pool;
}

static virStorageVolPtr
10617
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
10618 10619 10620 10621 10622 10623 10624 10625 10626
                   const char *optname,
                   const char *pooloptname,
                   char **name, int flag)
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
    char *n, *p;
    int found;

10627
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10628 10629
        return NULL;

10630
    if (!(p = vshCommandOptString(cmd, pooloptname, &found)) && found)
10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641
        return NULL;

    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;

10642
    /* try it by name */
10643
    if (pool && (flag & VSH_BYNAME)) {
10644
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
10645 10646 10647
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
10648
    /* try it by key */
10649 10650 10651 10652 10653
    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);
    }
10654
    /* try it by path */
10655 10656 10657 10658 10659 10660 10661
    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)
10662
        vshError(ctl, _("failed to get vol '%s'"), n);
10663 10664 10665 10666 10667 10668 10669

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680
static virSecretPtr
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, char **name)
{
    virSecretPtr secret = NULL;
    char *n;
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

    n = vshCommandOptString(cmd, optname, NULL);
10681
    if (n == NULL)
10682 10683 10684 10685 10686 10687 10688 10689 10690 10691
        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)
10692
        vshError(ctl, _("failed to get secret '%s'"), n);
10693 10694 10695 10696

    return secret;
}

K
Karel Zak 已提交
10697 10698 10699 10700
/*
 * Executes command(s) and returns return code from last command
 */
static int
10701
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
10702
{
K
Karel Zak 已提交
10703
    int ret = TRUE;
10704 10705

    while (cmd) {
K
Karel Zak 已提交
10706
        struct timeval before, after;
10707
        bool enable_timing = ctl->timing;
10708

10709 10710 10711
        if ((ctl->conn == NULL) || (disconnected != 0))
            vshReconnect(ctl);

10712
        if (enable_timing)
K
Karel Zak 已提交
10713
            GETTIMEOFDAY(&before);
10714

K
Karel Zak 已提交
10715 10716
        ret = cmd->def->handler(ctl, cmd);

10717
        if (enable_timing)
K
Karel Zak 已提交
10718
            GETTIMEOFDAY(&after);
10719

J
John Levon 已提交
10720 10721 10722
        if (ret == FALSE)
            virshReportError(ctl);

10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733
        /* 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);

10734
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
10735 10736
            return ret;

10737
        if (enable_timing)
10738
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
10739 10740
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
10741
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
10742 10743 10744 10745 10746 10747
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
10748
 * Command parsing
K
Karel Zak 已提交
10749 10750 10751
 * ---------------
 */

10752 10753 10754 10755 10756 10757 10758 10759 10760 10761
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 已提交
10762
    /* vshCommandStringGetArg() */
10763
    char *pos;
L
Lai Jiangshan 已提交
10764 10765 10766
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
10767 10768
} vshCommandParser;

K
Karel Zak 已提交
10769
static int
10770
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
10771
{
K
Karel Zak 已提交
10772 10773 10774
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
10775

K
Karel Zak 已提交
10776 10777 10778 10779
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
10780

10781
    while (1) {
K
Karel Zak 已提交
10782
        vshCmdOpt *last = NULL;
10783
        const vshCmdDef *cmd = NULL;
10784
        vshCommandToken tk;
L
Lai Jiangshan 已提交
10785
        bool data_only = false;
10786
        int data_ct = 0;
10787

K
Karel Zak 已提交
10788
        first = NULL;
10789

10790
        while (1) {
10791
            const vshCmdOptDef *opt = NULL;
10792

K
Karel Zak 已提交
10793
            tkdata = NULL;
10794
            tk = parser->getNextArg(ctl, parser, &tkdata);
10795 10796

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
10797
                goto syntaxError;
10798 10799
            if (tk != VSH_TK_ARG)
                break;
10800 10801

            if (cmd == NULL) {
K
Karel Zak 已提交
10802 10803
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
10804
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
10805
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
10806
                }
10807
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
10808 10809 10810 10811
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
10812 10813 10814 10815 10816 10817
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
                if (!(opt = vshCmddefGetOption(cmd, tkdata + 2))) {
10818
                    vshError(ctl,
10819
                             _("command '%s' doesn't support option --%s"),
10820 10821
                             cmd->name, tkdata + 2);
                    VIR_FREE(optstr);
K
Karel Zak 已提交
10822 10823
                    goto syntaxError;
                }
10824
                VIR_FREE(tkdata);
K
Karel Zak 已提交
10825 10826 10827

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
10828 10829 10830
                    if (optstr)
                        tkdata = optstr;
                    else
10831
                        tk = parser->getNextArg(ctl, parser, &tkdata);
10832
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
10833
                        goto syntaxError;
10834
                    if (tk != VSH_TK_ARG) {
10835
                        vshError(ctl,
10836
                                 _("expected syntax: --%s <%s>"),
10837 10838
                                 opt->name,
                                 opt->type ==
10839
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
10840 10841
                        goto syntaxError;
                    }
10842 10843 10844 10845 10846 10847 10848 10849
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
10850
                }
L
Lai Jiangshan 已提交
10851 10852 10853 10854
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
10855
            } else {
L
Lai Jiangshan 已提交
10856
get_data:
10857
                if (!(opt = vshCmddefGetData(cmd, data_ct++))) {
10858
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
10859 10860 10861 10862 10863
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
10864
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
10865

K
Karel Zak 已提交
10866 10867 10868 10869
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
10870

K
Karel Zak 已提交
10871 10872 10873 10874 10875
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
10876

K
Karel Zak 已提交
10877
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
10878 10879
                         cmd->name,
                         opt->name,
10880 10881
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
10882 10883
            }
        }
10884

D
Daniel Veillard 已提交
10885
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
10886
        if (cmd) {
10887
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
10888

K
Karel Zak 已提交
10889 10890 10891 10892
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

10893
            if (!vshCommandCheckOpts(ctl, c)) {
10894
                VIR_FREE(c);
10895
                goto syntaxError;
10896
            }
10897

K
Karel Zak 已提交
10898 10899 10900 10901 10902 10903
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
10904 10905 10906

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
10907
    }
10908

K
Karel Zak 已提交
10909 10910
    return TRUE;

10911
 syntaxError:
10912
    if (ctl->cmd) {
K
Karel Zak 已提交
10913
        vshCommandFree(ctl->cmd);
10914 10915
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
10916 10917
    if (first)
        vshCommandOptFree(first);
10918
    VIR_FREE(tkdata);
10919
    return FALSE;
K
Karel Zak 已提交
10920 10921
}

10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029
/* --------------------
 * 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 已提交
11030
/* ---------------
11031
 * Misc utils
K
Karel Zak 已提交
11032 11033
 * ---------------
 */
K
Karel Zak 已提交
11034
static const char *
11035 11036
vshDomainStateToString(int state)
{
K
Karel Zak 已提交
11037
    switch (state) {
11038
    case VIR_DOMAIN_RUNNING:
11039
        return N_("running");
11040
    case VIR_DOMAIN_BLOCKED:
11041
        return N_("idle");
11042
    case VIR_DOMAIN_PAUSED:
11043
        return N_("paused");
11044
    case VIR_DOMAIN_SHUTDOWN:
11045
        return N_("in shutdown");
11046
    case VIR_DOMAIN_SHUTOFF:
11047
        return N_("shut off");
11048
    case VIR_DOMAIN_CRASHED:
11049
        return N_("crashed");
11050
    default:
11051
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
11052
    }
11053
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
11054 11055
}

11056 11057 11058 11059
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
11060
    case VIR_VCPU_OFFLINE:
11061
        return N_("offline");
11062
    case VIR_VCPU_BLOCKED:
11063
        return N_("idle");
11064
    case VIR_VCPU_RUNNING:
11065
        return N_("running");
11066
    default:
11067
        ;/*FALLTHROUGH*/
11068
    }
11069
    return N_("no state");
11070 11071
}

K
Karel Zak 已提交
11072
static int
11073
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
11074
{
11075 11076
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
11077 11078
     */
    if (!conn) {
11079
        vshError(ctl, "%s", _("no valid connection"));
K
Karel Zak 已提交
11080 11081 11082 11083 11084
        return FALSE;
    }
    return TRUE;
}

K
Karel Zak 已提交
11085
static void
11086
vshDebug(vshControl *ctl, int level, const char *format, ...)
11087
{
K
Karel Zak 已提交
11088 11089
    va_list ap;

11090 11091 11092 11093
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
11094 11095 11096 11097 11098 11099
    if (level > ctl->debug)
        return;

    va_start(ap, format);
    vfprintf(stdout, format, ap);
    va_end(ap);
K
Karel Zak 已提交
11100 11101 11102
}

static void
11103
vshPrintExtra(vshControl *ctl, const char *format, ...)
11104
{
K
Karel Zak 已提交
11105
    va_list ap;
11106

K
Karel Zak 已提交
11107
    if (ctl->quiet == TRUE)
K
Karel Zak 已提交
11108
        return;
11109

K
Karel Zak 已提交
11110
    va_start(ap, format);
11111
    vfprintf(stdout, format, ap);
K
Karel Zak 已提交
11112 11113 11114
    va_end(ap);
}

K
Karel Zak 已提交
11115

K
Karel Zak 已提交
11116
static void
11117
vshError(vshControl *ctl, const char *format, ...)
11118
{
K
Karel Zak 已提交
11119
    va_list ap;
11120

11121 11122 11123 11124 11125
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
11126

11127
    fputs(_("error: "), stderr);
11128

K
Karel Zak 已提交
11129 11130 11131 11132 11133 11134 11135 11136
    va_start(ap, format);
    vfprintf(stderr, format, ap);
    va_end(ap);

    fputc('\n', stderr);
}

/*
11137
 * Initialize connection.
K
Karel Zak 已提交
11138 11139
 */
static int
11140
vshInit(vshControl *ctl)
11141
{
K
Karel Zak 已提交
11142 11143 11144
    if (ctl->conn)
        return FALSE;

11145 11146
    vshOpenLogFile(ctl);

11147 11148
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
11149

11150 11151 11152
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

11153 11154 11155 11156 11157 11158 11159 11160
    virEventRegisterImpl(virEventAddHandleImpl,
                         virEventUpdateHandleImpl,
                         virEventRemoveHandleImpl,
                         virEventAddTimeoutImpl,
                         virEventUpdateTimeoutImpl,
                         virEventRemoveTimeoutImpl);
    virEventInit();

11161 11162 11163 11164
    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

11165

11166 11167 11168 11169
    /* This is not necessarily fatal.  All the individual commands check
     * vshConnectionUsability, except ones which don't need a connection
     * such as "help".
     */
11170
    if (!ctl->conn) {
11171
        virshReportError(ctl);
11172
        vshError(ctl, "%s", _("failed to connect to the hypervisor"));
11173 11174
        return FALSE;
    }
K
Karel Zak 已提交
11175 11176 11177 11178

    return TRUE;
}

11179 11180
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199
/**
 * 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:
11200
                vshError(ctl, "%s",
J
Jim Meyering 已提交
11201
                         _("failed to get the log file information"));
11202
                exit(EXIT_FAILURE);
11203 11204 11205
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
11206 11207
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
11208 11209 11210 11211
        }
    }

    /* log file open */
11212
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
11213
        vshError(ctl, "%s",
J
Jim Meyering 已提交
11214
                 _("failed to open the log file. check the log file path"));
11215
        exit(EXIT_FAILURE);
11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280
    }
}

/**
 * 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 */
11281
    if (safewrite(ctl->log_fd, msg_buf, strlen(msg_buf)) < 0) {
11282
        vshCloseLogFile(ctl);
11283
        vshError(ctl, "%s", _("failed to write the log file"));
11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295
    }
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
11296 11297 11298
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
11299 11300 11301
    }

    if (ctl->logfile) {
11302
        VIR_FREE(ctl->logfile);
11303 11304 11305 11306
        ctl->logfile = NULL;
    }
}

11307
#ifdef USE_READLINE
11308

K
Karel Zak 已提交
11309 11310 11311 11312 11313
/* -----------------
 * Readline stuff
 * -----------------
 */

11314
/*
K
Karel Zak 已提交
11315 11316
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
11317
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
11318 11319
 */
static char *
11320 11321
vshReadlineCommandGenerator(const char *text, int state)
{
K
Karel Zak 已提交
11322
    static int list_index, len;
K
Karel Zak 已提交
11323
    const char *name;
K
Karel Zak 已提交
11324 11325 11326

    /* If this is a new word to complete, initialize now.  This
     * includes saving the length of TEXT for efficiency, and
11327
     * initializing the index variable to 0.
K
Karel Zak 已提交
11328 11329 11330
     */
    if (!state) {
        list_index = 0;
11331
        len = strlen(text);
K
Karel Zak 已提交
11332 11333 11334
    }

    /* Return the next name which partially matches from the
11335
     * command list.
K
Karel Zak 已提交
11336
     */
K
Karel Zak 已提交
11337
    while ((name = commands[list_index].name)) {
K
Karel Zak 已提交
11338
        list_index++;
11339
        if (STREQLEN(name, text, len))
11340
            return vshStrdup(NULL, name);
K
Karel Zak 已提交
11341 11342 11343 11344 11345 11346 11347
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
11348 11349
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
11350
    static int list_index, len;
11351
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
11352
    const char *name;
K
Karel Zak 已提交
11353 11354 11355 11356 11357 11358 11359 11360 11361

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

11362
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
11363
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
11364 11365 11366

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
11367
        len = strlen(text);
11368
        VIR_FREE(cmdname);
K
Karel Zak 已提交
11369 11370 11371 11372
    }

    if (!cmd)
        return NULL;
11373

11374 11375 11376
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
11377
    while ((name = cmd->opts[list_index].name)) {
11378
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
11379
        char *res;
11380

K
Karel Zak 已提交
11381
        list_index++;
11382

K
Karel Zak 已提交
11383
        if (opt->type == VSH_OT_DATA)
K
Karel Zak 已提交
11384 11385
            /* ignore non --option */
            continue;
11386

K
Karel Zak 已提交
11387
        if (len > 2) {
11388
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
11389 11390
                continue;
        }
11391
        res = vshMalloc(NULL, strlen(name) + 3);
11392
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
11393 11394 11395 11396 11397 11398 11399 11400
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
11401 11402 11403
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
11404 11405
    char **matches = (char **) NULL;

11406
    if (start == 0)
K
Karel Zak 已提交
11407
        /* command name generator */
11408
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
11409 11410
    else
        /* commands options */
11411
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
11412 11413 11414 11415
    return matches;
}


11416 11417
static int
vshReadlineInit(vshControl *ctl)
11418
{
11419 11420
    char *userdir = NULL;

K
Karel Zak 已提交
11421 11422 11423 11424 11425
    /* 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;
11426 11427 11428

    /* Limit the total size of the history buffer */
    stifle_history(500);
11429 11430

    /* Prepare to read/write history from/to the ~/.virsh/history file */
11431
    userdir = virGetUserDirectory(getuid());
11432 11433 11434 11435 11436 11437

    if (userdir == NULL)
        return -1;

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
11438
        VIR_FREE(userdir);
11439 11440 11441 11442 11443
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
11444
        VIR_FREE(userdir);
11445 11446 11447
        return -1;
    }

11448
    VIR_FREE(userdir);
11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466

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

11467 11468
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
11469 11470
}

11471 11472 11473 11474 11475 11476
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

11477
#else /* !USE_READLINE */
11478

11479 11480 11481 11482 11483 11484 11485
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

11486
static void
11487
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510
{
    /* 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);
}

11511
#endif /* !USE_READLINE */
11512

K
Karel Zak 已提交
11513
/*
J
Jim Meyering 已提交
11514
 * Deinitialize virsh
K
Karel Zak 已提交
11515 11516
 */
static int
11517
vshDeinit(vshControl *ctl)
11518
{
11519
    vshReadlineDeinit(ctl);
11520
    vshCloseLogFile(ctl);
11521
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
11522
    if (ctl->conn) {
11523 11524 11525
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
11526 11527
        }
    }
D
Daniel P. Berrange 已提交
11528 11529
    virResetLastError();

K
Karel Zak 已提交
11530 11531
    return TRUE;
}
11532

K
Karel Zak 已提交
11533 11534 11535 11536
/*
 * Print usage
 */
static void
11537
vshUsage(void)
11538
{
11539
    const vshCmdDef *cmd;
L
Lai Jiangshan 已提交
11540 11541
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
11542 11543 11544 11545 11546 11547 11548 11549
                      "  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"
E
Eric Blake 已提交
11550 11551
                      "    -v | --version[=short]  program version\n\n"
                      "    -V | --version=long     version and full options\n\n"
L
Lai Jiangshan 已提交
11552
                      "  commands (non interactive mode):\n"), progname, progname);
11553 11554 11555

    for (cmd = commands; cmd->name; cmd++)
        fprintf(stdout,
E
Eric Blake 已提交
11556
                "    %-15s %s\n", cmd->name, _(vshCmddefGetInfo(cmd, "help")));
11557 11558 11559 11560

    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
11561 11562
}

11563 11564 11565 11566 11567 11568 11569 11570 11571 11572
/*
 * 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 已提交
11573 11574
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609
#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 已提交
11610
    vshPrint(ctl, "%s", _(" Networking:"));
11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636
#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 已提交
11637
    vshPrint(ctl, "%s", _(" Storage:"));
11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660
#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 已提交
11661
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685
#ifdef ENABLE_SECDRIVER_APPARMOR
    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 已提交
11686 11687 11688 11689 11690
/*
 * argv[]:  virsh [options] [command]
 *
 */
static int
11691
vshParseArgv(vshControl *ctl, int argc, char **argv)
11692
{
11693 11694
    bool help = false;
    int arg;
K
Karel Zak 已提交
11695
    struct option opt[] = {
E
Eric Blake 已提交
11696 11697 11698 11699 11700 11701 11702 11703 11704
        {"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}
11705 11706
    };

11707 11708 11709
    /* 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. */
11710
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
11711
        switch (arg) {
11712
        case 'd':
D
Daniel Veillard 已提交
11713
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
11714
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
11715 11716
                exit(EXIT_FAILURE);
            }
11717 11718
            break;
        case 'h':
11719
            help = true;
11720 11721 11722 11723 11724 11725 11726 11727 11728 11729
            break;
        case 'q':
            ctl->quiet = TRUE;
            break;
        case 't':
            ctl->timing = TRUE;
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
11730 11731 11732 11733 11734 11735
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
11736 11737 11738
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
11739 11740 11741
        case 'r':
            ctl->readonly = TRUE;
            break;
11742 11743 11744
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
11745
        default:
11746 11747
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
11748 11749 11750 11751
        }
    }

    if (help) {
11752 11753
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
11754 11755
            exit(EXIT_FAILURE);
        }
11756 11757 11758

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
11759
        exit(EXIT_SUCCESS);
11760 11761
    }

11762
    if (argc > optind) {
K
Karel Zak 已提交
11763 11764
        /* parse command */
        ctl->imode = FALSE;
11765 11766 11767
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
11768
        } else {
11769
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
11770 11771 11772 11773 11774
        }
    }
    return TRUE;
}

11775 11776 11777 11778
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
11779
    char *defaultConn;
K
Karel Zak 已提交
11780 11781
    int ret = TRUE;

11782 11783
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
11784
        /* failure to setup locale is not fatal */
11785
    }
11786
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
11787
        perror("bindtextdomain");
E
Eric Blake 已提交
11788
        return EXIT_FAILURE;
11789
    }
11790
    if (!textdomain(PACKAGE)) {
11791
        perror("textdomain");
E
Eric Blake 已提交
11792
        return EXIT_FAILURE;
11793 11794
    }

11795
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
11796 11797 11798
        progname = argv[0];
    else
        progname++;
11799

K
Karel Zak 已提交
11800
    memset(ctl, 0, sizeof(vshControl));
11801
    ctl->imode = TRUE;          /* default is interactive mode */
11802
    ctl->log_fd = -1;           /* Initialize log file descriptor */
K
Karel Zak 已提交
11803

11804
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
11805
        ctl->name = vshStrdup(ctl, defaultConn);
11806 11807
    }

D
Daniel P. Berrange 已提交
11808 11809
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
11810
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
11811
    }
11812

D
Daniel P. Berrange 已提交
11813 11814
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
11815
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
11816
    }
11817

K
Karel Zak 已提交
11818
    if (!ctl->imode) {
11819
        ret = vshCommandRun(ctl, ctl->cmd);
11820
    } else {
K
Karel Zak 已提交
11821 11822
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
11823
            vshPrint(ctl,
11824
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
11825
                     progname);
J
Jim Meyering 已提交
11826
            vshPrint(ctl, "%s",
11827
                     _("Type:  'help' for help with commands\n"
11828
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
11829
        }
11830 11831 11832 11833 11834 11835

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
11836
        do {
11837
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
11838
            ctl->cmdstr =
11839
                vshReadline(ctl, prompt);
11840 11841
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
11842
            if (*ctl->cmdstr) {
11843
#if USE_READLINE
K
Karel Zak 已提交
11844
                add_history(ctl->cmdstr);
11845
#endif
11846
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
11847 11848
                    vshCommandRun(ctl, ctl->cmd);
            }
11849
            VIR_FREE(ctl->cmdstr);
11850
        } while (ctl->imode);
K
Karel Zak 已提交
11851

11852 11853
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
11854
    }
11855

K
Karel Zak 已提交
11856 11857
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
11858
}