virsh.c 333.8 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
} vshCmdOptType;

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

K
Karel Zak 已提交
149 150 151
/*
 * Command Option Flags
 */
152 153
#define VSH_OFLAG_NONE    0     /* without flags */
#define VSH_OFLAG_REQ    (1 << 1)       /* option required */
K
Karel Zak 已提交
154 155 156 157 158 159 160 161

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

/*
 * vshCmdInfo -- information about command
 */
162 163 164
typedef struct {
    const char *name;           /* name of information */
    const char *data;           /* information */
K
Karel Zak 已提交
165 166 167 168 169
} vshCmdInfo;

/*
 * vshCmdOptDef - command option definition
 */
170 171 172 173 174
typedef struct {
    const char *name;           /* the name of option */
    vshCmdOptType type;         /* option type */
    int flag;                   /* flags */
    const char *help;           /* help string */
K
Karel Zak 已提交
175 176 177 178 179 180
} vshCmdOptDef;

/*
 * vshCmdOpt - command options
 */
typedef struct vshCmdOpt {
181
    const vshCmdOptDef *def;    /* pointer to relevant option */
182 183
    char *data;                 /* allocated data */
    struct vshCmdOpt *next;
K
Karel Zak 已提交
184 185 186 187 188
} vshCmdOpt;

/*
 * vshCmdDef - command definition
 */
189 190
typedef struct {
    const char *name;
191
    int (*handler) (vshControl *, const vshCmd *);    /* command handler */
192 193
    const vshCmdOptDef *opts;   /* definition of command options */
    const vshCmdInfo *info;     /* details about command */
K
Karel Zak 已提交
194 195 196 197 198 199
} vshCmdDef;

/*
 * vshCmd - parsed command
 */
typedef struct __vshCmd {
200
    const vshCmdDef *def;       /* command definition */
201 202
    vshCmdOpt *opts;            /* list of command arguments */
    struct __vshCmd *next;      /* next command */
K
Karel Zak 已提交
203 204 205 206 207 208
} __vshCmd;

/*
 * vshControl
 */
typedef struct __vshControl {
K
Karel Zak 已提交
209
    char *name;                 /* connection name */
210
    virConnectPtr conn;         /* connection to hypervisor (MAY BE NULL) */
211 212 213 214 215 216
    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? */
217 218 219
    int readonly;               /* connect readonly (first time only, not
                                 * during explicit connect command)
                                 */
220 221
    char *logfile;              /* log file name */
    int log_fd;                 /* log file descriptor */
222 223
    char *historydir;           /* readline history directory name */
    char *historyfile;          /* readline history file name */
K
Karel Zak 已提交
224
} __vshControl;
225

226 227 228 229 230
typedef struct vshCmdGrp {
    const char *name;
    const char *keyword; /* help keyword */
    const vshCmdDef *commands;
} vshCmdGrp;
231

232
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
233

234 235
static void vshError(vshControl *ctl, const char *format, ...)
    ATTRIBUTE_FMT_PRINTF(2, 3);
236 237
static int vshInit(vshControl *ctl);
static int vshDeinit(vshControl *ctl);
238
static void vshUsage(void);
239 240 241
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 已提交
242

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

245
static const char *vshCmddefGetInfo(const vshCmdDef *cmd, const char *info);
246
static const vshCmdDef *vshCmddefSearch(const char *cmdname);
247
static int vshCmddefHelp(vshControl *ctl, const char *name);
248 249
static const vshCmdGrp *vshCmdGrpSearch(const char *grpname);
static int vshCmdGrpHelp(vshControl *ctl, const char *name);
K
Karel Zak 已提交
250

251 252
static vshCmdOpt *vshCommandOpt(const vshCmd *cmd, const char *name);
static int vshCommandOptInt(const vshCmd *cmd, const char *name, int *found);
253 254
static unsigned long vshCommandOptUL(const vshCmd *cmd, const char *name,
                                     int *found);
255
static char *vshCommandOptString(const vshCmd *cmd, const char *name,
256
                                 int *found);
257 258
static long long vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                                       int *found);
259
static int vshCommandOptBool(const vshCmd *cmd, const char *name);
260
static char *vshCommandOptArgv(const vshCmd *cmd, int count);
K
Karel Zak 已提交
261

262 263 264
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
265
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
266

267
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
J
Jim Meyering 已提交
268
                                          char **name, int flag);
K
Karel Zak 已提交
269 270

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

274
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
J
Jim Meyering 已提交
275
                                            char **name, int flag);
276 277

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
278 279
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
280 281
                           VSH_BYUUID|VSH_BYNAME)

282 283 284 285 286 287 288 289
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)

290 291 292 293 294 295 296 297
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)

298
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
299 300 301 302 303 304 305
                            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)

306
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
307 308 309 310 311 312 313 314 315
                                           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)

316 317 318
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
                                        char **name);

319
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
320
    ATTRIBUTE_FMT_PRINTF(2, 3);
321
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
322
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
323 324

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

K
Karel Zak 已提交
327
static const char *vshDomainStateToString(int state);
328
static const char *vshDomainVcpuStateToString(int state);
329
static int vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
K
Karel Zak 已提交
330

331 332 333 334
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

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

344
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
345 346
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
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 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
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
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424

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

425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
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 已提交
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
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)
{
472 473 474 475 476 477 478 479
    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)
480
            goto out;
481
    }
J
John Levon 已提交
482 483

    if (last_error->code == VIR_ERR_OK) {
484
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
485 486 487
        goto out;
    }

488
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
489 490 491 492 493 494

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

495 496 497 498 499
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

500
#ifdef SIGPIPE
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
/*
 * 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 已提交
519
static void
520 521 522 523 524 525 526 527 528
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);
}
529 530 531 532
#else
static void
vshSetupSignals(void) {}
#endif
533 534 535 536

/*
 * vshReconnect:
 *
L
Laine Stump 已提交
537
 * Reconnect after a disconnect from libvirtd
538 539
 *
 */
L
Laine Stump 已提交
540
static void
541 542 543 544 545 546 547 548 549 550 551 552 553
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;
}
554

K
Karel Zak 已提交
555 556 557 558 559 560
/* ---------------
 * Commands
 * ---------------
 */

/*
561
 * "help" command
K
Karel Zak 已提交
562
 */
563
static const vshCmdInfo info_help[] = {
564
    {"help", N_("print help")},
565 566
    {"desc", N_("Prints global help, command specific help, or help for a\n"
                "    group of related commands")},
567

568
    {NULL, NULL}
K
Karel Zak 已提交
569 570
};

571
static const vshCmdOptDef opts_help[] = {
572
    {"command", VSH_OT_DATA, 0, N_("Prints global help, command specific help, or help for a group of related commands")},
573
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
574 575 576
};

static int
577
cmdHelp(vshControl *ctl, const vshCmd *cmd)
578 579 580
 {
    const vshCmdDef *c;
    const vshCmdGrp *g;
581 582 583 584
    const char *name;

    name = vshCommandOptString(cmd, "command", NULL);

585 586
    if (!name) {
        const vshCmdGrp *grp;
587
        const vshCmdDef *def;
588

589 590 591 592 593 594 595 596 597 598 599 600 601
        vshPrint(ctl, "%s", _("Grouped commands:\n\n"));

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

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

            vshPrint(ctl, "\n");
        }

602 603
        return TRUE;
    }
604 605 606 607 608 609 610 611

    if ((c = vshCmddefSearch(name))) {
        return vshCmddefHelp(ctl, name);
    } else if ((g = vshCmdGrpSearch(name))) {
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
        return FALSE;
K
Karel Zak 已提交
612 613 614
    }
}

615 616 617
/*
 * "autostart" command
 */
618
static const vshCmdInfo info_autostart[] = {
619
    {"help", N_("autostart a domain")},
620
    {"desc",
621
     N_("Configure a domain to be automatically started at boot.")},
622 623 624
    {NULL, NULL}
};

625
static const vshCmdOptDef opts_autostart[] = {
626 627
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
628 629 630 631
    {NULL, 0, 0, NULL}
};

static int
632
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
633 634 635 636 637
{
    virDomainPtr dom;
    char *name;
    int autostart;

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

J
Jim Meyering 已提交
641
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
642 643 644 645 646
        return FALSE;

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
647
        if (autostart)
648
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
649
        else
650
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
651 652 653 654
        virDomainFree(dom);
        return FALSE;
    }

655
    if (autostart)
656
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
657
    else
658
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
659

660
    virDomainFree(dom);
661 662 663
    return TRUE;
}

K
Karel Zak 已提交
664
/*
665
 * "connect" command
K
Karel Zak 已提交
666
 */
667
static const vshCmdInfo info_connect[] = {
668
    {"help", N_("(re)connect to hypervisor")},
669
    {"desc",
670
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
671
    {NULL, NULL}
K
Karel Zak 已提交
672 673
};

674
static const vshCmdOptDef opts_connect[] = {
675 676
    {"name",     VSH_OT_DATA, 0, N_("hypervisor connection URI")},
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
677
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
678 679 680
};

static int
681
cmdConnect(vshControl *ctl, const vshCmd *cmd)
682
{
K
Karel Zak 已提交
683
    int ro = vshCommandOptBool(cmd, "readonly");
684
    char *name;
685

K
Karel Zak 已提交
686
    if (ctl->conn) {
687 688 689
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
690 691 692 693
            return FALSE;
        }
        ctl->conn = NULL;
    }
694

695
    VIR_FREE(ctl->name);
696 697 698 699
    name = vshCommandOptString(cmd, "name", NULL);
    if (!name)
        return FALSE;
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
700

701 702 703 704 705
    if (!ro) {
        ctl->readonly = 0;
    } else {
        ctl->readonly = 1;
    }
K
Karel Zak 已提交
706

707 708 709
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

K
Karel Zak 已提交
713 714 715
    return ctl->conn ? TRUE : FALSE;
}

716 717
#ifndef WIN32

718
/*
719
 * "console" command
720
 */
721
static const vshCmdInfo info_console[] = {
722
    {"help", N_("connect to the guest console")},
723
    {"desc",
724
     N_("Connect the virtual serial console for the guest")},
725 726 727
    {NULL, NULL}
};

728
static const vshCmdOptDef opts_console[] = {
729
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
730
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
731 732 733 734
    {NULL, 0, 0, NULL}
};

static int
735
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
736 737
{
    int ret = FALSE;
738
    virDomainInfo dominfo;
739

740 741 742 743 744 745 746 747 748 749
    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;
    }

750 751
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
    vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
752
    if (vshRunConsole(dom, name) == 0)
753
        ret = TRUE;
754 755

 cleanup:
756

757 758 759
    return ret;
}

760 761 762 763 764
static int
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int ret;
765
    const char *name;
766

767
    if (!vshConnectionUsability(ctl, ctl->conn))
768 769 770 771 772
        return FALSE;

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

773
    name = vshCommandOptString(cmd, "devname", NULL);
774

775
    ret = cmdRunConsole(ctl, dom, name);
776 777 778 779 780

    virDomainFree(dom);
    return ret;
}

781 782 783
#endif /* WIN32 */


K
Karel Zak 已提交
784 785 786
/*
 * "list" command
 */
787
static const vshCmdInfo info_list[] = {
788 789
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
790
    {NULL, NULL}
K
Karel Zak 已提交
791 792
};

793
static const vshCmdOptDef opts_list[] = {
794 795
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
796 797 798
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
799 800

static int
801
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
802
{
803 804 805 806
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
807
    char **names = NULL;
808 809
    int maxname = 0;
    inactive |= all;
K
Karel Zak 已提交
810

811
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
812
        return FALSE;
813

814
    if (active) {
815 816
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
817
            vshError(ctl, "%s", _("Failed to list active domains"));
818 819 820 821 822 823
            return FALSE;
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
824
                vshError(ctl, "%s", _("Failed to list active domains"));
825
                VIR_FREE(ids);
826 827 828
                return FALSE;
            }

829
            qsort(&ids[0], maxid, sizeof(int), idsorter);
830
        }
831 832
    }
    if (inactive) {
833 834
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
835
            vshError(ctl, "%s", _("Failed to list inactive domains"));
836
            VIR_FREE(ids);
837
            return FALSE;
838
        }
839 840 841 842
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
843
                vshError(ctl, "%s", _("Failed to list inactive domains"));
844 845
                VIR_FREE(ids);
                VIR_FREE(names);
846 847
                return FALSE;
            }
848

849
            qsort(&names[0], maxname, sizeof(char*), namesorter);
850
        }
851
    }
852
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
853
    vshPrintExtra(ctl, "----------------------------------\n");
854 855

    for (i = 0; i < maxid; i++) {
K
Karel Zak 已提交
856 857
        virDomainInfo info;
        virDomainPtr dom = virDomainLookupByID(ctl->conn, ids[i]);
858
        const char *state;
859 860

        /* this kind of work with domains is not atomic operation */
K
Karel Zak 已提交
861 862
        if (!dom)
            continue;
863 864 865 866

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

K
Karel Zak 已提交
869
        vshPrint(ctl, "%3d %-20s %s\n",
870 871
                 virDomainGetID(dom),
                 virDomainGetName(dom),
872
                 state);
873
        virDomainFree(dom);
K
Karel Zak 已提交
874
    }
875 876 877
    for (i = 0; i < maxname; i++) {
        virDomainInfo info;
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);
878
        const char *state;
879 880

        /* this kind of work with domains is not atomic operation */
881
        if (!dom) {
882
            VIR_FREE(names[i]);
883
            continue;
884
        }
885 886 887 888

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

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

893
        virDomainFree(dom);
894
        VIR_FREE(names[i]);
895
    }
896 897
    VIR_FREE(ids);
    VIR_FREE(names);
K
Karel Zak 已提交
898 899 900 901
    return TRUE;
}

/*
K
Karel Zak 已提交
902
 * "domstate" command
K
Karel Zak 已提交
903
 */
904
static const vshCmdInfo info_domstate[] = {
905 906
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
907
    {NULL, NULL}
K
Karel Zak 已提交
908 909
};

910
static const vshCmdOptDef opts_domstate[] = {
911
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
912
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
913 914 915
};

static int
916
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
917
{
918
    virDomainInfo info;
K
Karel Zak 已提交
919
    virDomainPtr dom;
K
Karel Zak 已提交
920
    int ret = TRUE;
921

922
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
923
        return FALSE;
924

J
Jim Meyering 已提交
925
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
K
Karel Zak 已提交
926
        return FALSE;
927 928

    if (virDomainGetInfo(dom, &info) == 0)
K
Karel Zak 已提交
929
        vshPrint(ctl, "%s\n",
E
Eric Blake 已提交
930
                 _(vshDomainStateToString(info.state)));
K
Karel Zak 已提交
931 932
    else
        ret = FALSE;
933

934 935 936 937
    virDomainFree(dom);
    return ret;
}

938 939
/* "domblkstat" command
 */
940
static const vshCmdInfo info_domblkstat[] = {
941 942
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
943 944 945
    {NULL,NULL}
};

946
static const vshCmdOptDef opts_domblkstat[] = {
947 948
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
949 950 951 952
    {NULL, 0, 0, NULL}
};

static int
953
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
954 955 956 957 958
{
    virDomainPtr dom;
    char *name, *device;
    struct _virDomainBlockStats stats;

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

J
Jim Meyering 已提交
962
    if (!(dom = vshCommandOptDomain (ctl, cmd, &name)))
963 964
        return FALSE;

L
Laine Stump 已提交
965 966
    if (!(device = vshCommandOptString (cmd, "device", NULL))) {
        virDomainFree(dom);
967
        return FALSE;
L
Laine Stump 已提交
968
    }
969 970

    if (virDomainBlockStats (dom, device, &stats, sizeof stats) == -1) {
971
        vshError(ctl, _("Failed to get block stats %s %s"), name, device);
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
        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
 */
997
static const vshCmdInfo info_domifstat[] = {
998 999
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1000 1001 1002
    {NULL,NULL}
};

1003
static const vshCmdOptDef opts_domifstat[] = {
1004 1005
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1006 1007 1008 1009
    {NULL, 0, 0, NULL}
};

static int
1010
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1011 1012 1013 1014 1015
{
    virDomainPtr dom;
    char *name, *device;
    struct _virDomainInterfaceStats stats;

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

J
Jim Meyering 已提交
1019
    if (!(dom = vshCommandOptDomain (ctl, cmd, &name)))
1020 1021
        return FALSE;

L
Laine Stump 已提交
1022 1023
    if (!(device = vshCommandOptString (cmd, "interface", NULL))) {
        virDomainFree(dom);
1024
        return FALSE;
L
Laine Stump 已提交
1025
    }
1026 1027

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1028
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
        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;
}

1061 1062 1063
/*
 * "dommemstats" command
 */
1064
static const vshCmdInfo info_dommemstat[] = {
1065 1066
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1067 1068 1069
    {NULL,NULL}
};

1070
static const vshCmdOptDef opts_dommemstat[] = {
1071
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1072 1073 1074 1075
    {NULL, 0, 0, NULL}
};

static int
1076
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1077 1078 1079 1080 1081 1082
{
    virDomainPtr dom;
    char *name;
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1083
    if (!vshConnectionUsability(ctl, ctl->conn))
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
        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;
}

1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
/*
 * "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;

1138
    if (!vshConnectionUsability(ctl, ctl->conn))
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
        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;
}

1162 1163 1164
/*
 * "suspend" command
 */
1165
static const vshCmdInfo info_suspend[] = {
1166 1167
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1168
    {NULL, NULL}
1169 1170
};

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

static int
1177
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1178
{
1179
    virDomainPtr dom;
K
Karel Zak 已提交
1180 1181
    char *name;
    int ret = TRUE;
1182

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

J
Jim Meyering 已提交
1186
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1187
        return FALSE;
1188 1189

    if (virDomainSuspend(dom) == 0) {
1190
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1191
    } else {
1192
        vshError(ctl, _("Failed to suspend domain %s"), name);
1193 1194
        ret = FALSE;
    }
1195

1196 1197 1198 1199
    virDomainFree(dom);
    return ret;
}

1200 1201 1202
/*
 * "create" command
 */
1203
static const vshCmdInfo info_create[] = {
1204 1205
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1206 1207 1208
    {NULL, NULL}
};

1209
static const vshCmdOptDef opts_create[] = {
1210
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1211
#ifndef WIN32
1212
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1213
#endif
1214
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1215 1216 1217 1218
    {NULL, 0, 0, NULL}
};

static int
1219
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1220 1221 1222 1223 1224
{
    virDomainPtr dom;
    char *from;
    int found;
    int ret = TRUE;
1225
    char *buffer;
1226
#ifndef WIN32
1227
    int console = vshCommandOptBool(cmd, "console");
1228
#endif
1229
    unsigned int flags = VIR_DOMAIN_NONE;
1230

1231
    if (!vshConnectionUsability(ctl, ctl->conn))
1232 1233 1234 1235 1236 1237
        return FALSE;

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

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

1241 1242 1243 1244
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1245
    VIR_FREE(buffer);
1246

1247
    if (dom != NULL) {
1248
        vshPrint(ctl, _("Domain %s created from %s\n"),
1249
                 virDomainGetName(dom), from);
1250
#ifndef WIN32
1251
        if (console)
1252
            cmdRunConsole(ctl, dom, NULL);
1253
#endif
1254
        virDomainFree(dom);
1255
    } else {
1256
        vshError(ctl, _("Failed to create domain from %s"), from);
1257 1258 1259 1260 1261
        ret = FALSE;
    }
    return ret;
}

1262 1263 1264
/*
 * "define" command
 */
1265
static const vshCmdInfo info_define[] = {
1266 1267
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1268 1269 1270
    {NULL, NULL}
};

1271
static const vshCmdOptDef opts_define[] = {
1272
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1273 1274 1275 1276
    {NULL, 0, 0, NULL}
};

static int
1277
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1278 1279 1280 1281 1282
{
    virDomainPtr dom;
    char *from;
    int found;
    int ret = TRUE;
1283
    char *buffer;
1284

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

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

1292 1293
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
1294 1295

    dom = virDomainDefineXML(ctl->conn, buffer);
1296
    VIR_FREE(buffer);
1297

1298
    if (dom != NULL) {
1299
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1300
                 virDomainGetName(dom), from);
1301
        virDomainFree(dom);
1302
    } else {
1303
        vshError(ctl, _("Failed to define domain from %s"), from);
1304 1305 1306 1307 1308 1309 1310 1311
        ret = FALSE;
    }
    return ret;
}

/*
 * "undefine" command
 */
1312
static const vshCmdInfo info_undefine[] = {
1313 1314
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1315 1316 1317
    {NULL, NULL}
};

1318
static const vshCmdOptDef opts_undefine[] = {
1319
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1320 1321 1322 1323
    {NULL, 0, 0, NULL}
};

static int
1324
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1325 1326 1327 1328
{
    virDomainPtr dom;
    int ret = TRUE;
    char *name;
1329 1330
    int found;
    int id;
1331

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

1335 1336 1337 1338 1339 1340
    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))) {
1341 1342 1343 1344 1345
        vshError(ctl,
                 _("a running domain like %s cannot be undefined;\n"
                   "to undefine, first shutdown then undefine"
                   " using its name or UUID"),
                 name);
1346 1347 1348
        virDomainFree(dom);
        return FALSE;
    }
J
Jim Meyering 已提交
1349
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
1350
                                      VSH_BYNAME|VSH_BYUUID)))
1351 1352 1353
        return FALSE;

    if (virDomainUndefine(dom) == 0) {
1354
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1355
    } else {
1356
        vshError(ctl, _("Failed to undefine domain %s"), name);
1357 1358 1359
        ret = FALSE;
    }

1360
    virDomainFree(dom);
1361 1362 1363 1364 1365 1366 1367
    return ret;
}


/*
 * "start" command
 */
1368
static const vshCmdInfo info_start[] = {
1369
    {"help", N_("start a (previously defined) inactive domain")},
1370 1371 1372
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1373 1374 1375
    {NULL, NULL}
};

1376
static const vshCmdOptDef opts_start[] = {
1377
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1378
#ifndef WIN32
1379
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1380
#endif
E
Eric Blake 已提交
1381
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1382 1383 1384 1385
    {NULL, 0, 0, NULL}
};

static int
1386
cmdStart(vshControl *ctl, const vshCmd *cmd)
1387 1388 1389
{
    virDomainPtr dom;
    int ret = TRUE;
1390
#ifndef WIN32
1391
    int console = vshCommandOptBool(cmd, "console");
1392
#endif
E
Eric Blake 已提交
1393
    unsigned int flags = VIR_DOMAIN_NONE;
1394

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

J
Jim Meyering 已提交
1398
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL, VSH_BYNAME)))
1399 1400 1401
        return FALSE;

    if (virDomainGetID(dom) != (unsigned int)-1) {
1402
        vshError(ctl, "%s", _("Domain is already active"));
1403
        virDomainFree(dom);
1404 1405 1406
        return FALSE;
    }

E
Eric Blake 已提交
1407 1408 1409 1410 1411 1412
    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) {
1413
        vshPrint(ctl, _("Domain %s started\n"),
1414
                 virDomainGetName(dom));
1415
#ifndef WIN32
1416
        if (console)
1417
            cmdRunConsole(ctl, dom, NULL);
1418
#endif
1419
    } else {
1420
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
1421 1422
        ret = FALSE;
    }
1423
    virDomainFree(dom);
1424 1425 1426
    return ret;
}

1427 1428 1429
/*
 * "save" command
 */
1430
static const vshCmdInfo info_save[] = {
1431 1432
    {"help", N_("save a domain state to a file")},
    {"desc", N_("Save a running domain.")},
1433
    {NULL, NULL}
1434 1435
};

1436
static const vshCmdOptDef opts_save[] = {
1437 1438
    {"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")},
1439
    {NULL, 0, 0, NULL}
1440 1441 1442
};

static int
1443
cmdSave(vshControl *ctl, const vshCmd *cmd)
1444
{
1445 1446 1447 1448
    virDomainPtr dom;
    char *name;
    char *to;
    int ret = TRUE;
1449

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

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

J
Jim Meyering 已提交
1456
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1457
        return FALSE;
1458 1459

    if (virDomainSave(dom, to) == 0) {
1460
        vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
1461
    } else {
1462
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
1463 1464
        ret = FALSE;
    }
1465

1466 1467 1468 1469
    virDomainFree(dom);
    return ret;
}

1470 1471 1472 1473 1474
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1475 1476 1477 1478
    {"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.")},
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
    {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;

1494
    if (!vshConnectionUsability(ctl, ctl->conn))
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
        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;
}

1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532
/*
 * "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;

1533
    if (!vshConnectionUsability(ctl, ctl->conn))
1534 1535 1536 1537 1538 1539 1540
        return FALSE;

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

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1541
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
        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;
}

1565 1566 1567
/*
 * "schedinfo" command
 */
1568
static const vshCmdInfo info_schedinfo[] = {
1569 1570
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1571 1572 1573
    {NULL, NULL}
};

1574
static const vshCmdOptDef opts_schedinfo[] = {
1575 1576 1577 1578
    {"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")},
1579 1580 1581 1582
    {NULL, 0, 0, NULL}
};

static int
1583 1584
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
                   virSchedParameterPtr param)
1585
{
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595
    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) {
1596
            vshError(ctl, "%s", _("Invalid value of weight"));
1597
            return -1;
1598
        } else {
1599
            param->value.ui = val;
1600
        }
1601
        return 1;
1602 1603
    }

1604 1605 1606 1607 1608 1609 1610
    /* 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) {
1611
            vshError(ctl, "%s", _("Invalid value of cap"));
1612
            return -1;
1613
        } else {
1614
            param->value.ui = val;
1615
        }
1616
        return 1;
1617
    }
1618

1619 1620 1621 1622
    if ((data = vshCommandOptString(cmd, "set", NULL))) {
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
1623
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
1624
            return -1;
1625
        }
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636
        *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) {
1637
                vshError(ctl, "%s",
1638 1639 1640 1641 1642 1643
                         _("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) {
1644
                vshError(ctl, "%s",
1645 1646 1647 1648 1649 1650
                         _("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) {
1651
                vshError(ctl, "%s",
J
Jim Meyering 已提交
1652
                         _("Invalid value for parameter, expecting a long long"));
1653 1654 1655 1656 1657
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_ULLONG:
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
1658
                vshError(ctl, "%s",
1659 1660 1661 1662 1663 1664
                         _("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) {
1665
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
1666 1667 1668 1669 1670
                return -1;
            }
            break;
        case VIR_DOMAIN_SCHED_FIELD_BOOLEAN:
            param->value.b = STREQ(val, "0") ? 0 : 1;
1671
        }
1672
        return 1;
1673
    }
1674

1675 1676
    return 0;
}
1677

1678

1679 1680 1681 1682 1683 1684 1685 1686 1687 1688
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;
1689

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

1693 1694
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;
1695 1696 1697 1698

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
    if (schedulertype!= NULL){
1699
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
1700
             schedulertype);
1701
        VIR_FREE(schedulertype);
1702
    } else {
1703
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
1704
        goto cleanup;
1705 1706
    }

1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733
    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;
1734 1735 1736 1737 1738 1739 1740 1741 1742 1743
        } 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;
            }
1744 1745 1746
        }

        ret_val = TRUE;
1747 1748 1749
        for (i = 0; i < nparams; i++){
            switch (params[i].type) {
            case VIR_DOMAIN_SCHED_FIELD_INT:
1750
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1751 1752
                 break;
            case VIR_DOMAIN_SCHED_FIELD_UINT:
1753
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1754 1755
                 break;
            case VIR_DOMAIN_SCHED_FIELD_LLONG:
1756
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1757 1758
                 break;
            case VIR_DOMAIN_SCHED_FIELD_ULLONG:
1759
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1760 1761
                 break;
            case VIR_DOMAIN_SCHED_FIELD_DOUBLE:
1762
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1763 1764
                 break;
            case VIR_DOMAIN_SCHED_FIELD_BOOLEAN:
1765
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
1766 1767
                 break;
            default:
1768
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
1769 1770 1771
            }
        }
    }
1772

1773
 cleanup:
1774
    VIR_FREE(params);
1775
    virDomainFree(dom);
1776
    return ret_val;
1777 1778
}

1779 1780 1781
/*
 * "restore" command
 */
1782
static const vshCmdInfo info_restore[] = {
1783 1784
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
1785
    {NULL, NULL}
1786 1787
};

1788
static const vshCmdOptDef opts_restore[] = {
1789
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
1790
    {NULL, 0, 0, NULL}
1791 1792 1793
};

static int
1794
cmdRestore(vshControl *ctl, const vshCmd *cmd)
1795
{
1796 1797 1798
    char *from;
    int found;
    int ret = TRUE;
1799

1800
    if (!vshConnectionUsability(ctl, ctl->conn))
1801 1802 1803 1804 1805
        return FALSE;

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

    if (virDomainRestore(ctl->conn, from) == 0) {
1808
        vshPrint(ctl, _("Domain restored from %s\n"), from);
1809
    } else {
1810
        vshError(ctl, _("Failed to restore domain from %s"), from);
1811 1812 1813 1814 1815
        ret = FALSE;
    }
    return ret;
}

D
Daniel Veillard 已提交
1816 1817 1818
/*
 * "dump" command
 */
1819
static const vshCmdInfo info_dump[] = {
1820 1821
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
1822 1823 1824
    {NULL, NULL}
};

1825
static const vshCmdOptDef opts_dump[] = {
1826 1827 1828 1829
    {"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 已提交
1830 1831 1832 1833
    {NULL, 0, 0, NULL}
};

static int
1834
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
1835 1836 1837 1838 1839
{
    virDomainPtr dom;
    char *name;
    char *to;
    int ret = TRUE;
1840
    int flags = 0;
D
Daniel Veillard 已提交
1841

1842
    if (!vshConnectionUsability(ctl, ctl->conn))
D
Daniel Veillard 已提交
1843 1844 1845 1846 1847
        return FALSE;

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

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

P
Paolo Bonzini 已提交
1851 1852
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
1853 1854 1855 1856
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;

    if (virDomainCoreDump(dom, to, flags) == 0) {
1857
        vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
D
Daniel Veillard 已提交
1858
    } else {
1859
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
D
Daniel Veillard 已提交
1860 1861 1862 1863 1864 1865 1866
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

1867 1868 1869
/*
 * "resume" command
 */
1870
static const vshCmdInfo info_resume[] = {
1871 1872
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
1873
    {NULL, NULL}
1874 1875
};

1876
static const vshCmdOptDef opts_resume[] = {
1877
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1878
    {NULL, 0, 0, NULL}
1879 1880 1881
};

static int
1882
cmdResume(vshControl *ctl, const vshCmd *cmd)
1883
{
1884
    virDomainPtr dom;
K
Karel Zak 已提交
1885 1886
    int ret = TRUE;
    char *name;
1887

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

J
Jim Meyering 已提交
1891
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1892
        return FALSE;
1893 1894

    if (virDomainResume(dom) == 0) {
1895
        vshPrint(ctl, _("Domain %s resumed\n"), name);
1896
    } else {
1897
        vshError(ctl, _("Failed to resume domain %s"), name);
1898 1899
        ret = FALSE;
    }
1900

1901 1902 1903 1904
    virDomainFree(dom);
    return ret;
}

1905 1906 1907
/*
 * "shutdown" command
 */
1908
static const vshCmdInfo info_shutdown[] = {
1909 1910
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
1911
    {NULL, NULL}
1912 1913
};

1914
static const vshCmdOptDef opts_shutdown[] = {
1915
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1916
    {NULL, 0, 0, NULL}
1917 1918 1919
};

static int
1920
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
1921
{
1922 1923 1924
    virDomainPtr dom;
    int ret = TRUE;
    char *name;
1925

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

J
Jim Meyering 已提交
1929
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1930
        return FALSE;
1931 1932

    if (virDomainShutdown(dom) == 0) {
1933
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
1934
    } else {
1935
        vshError(ctl, _("Failed to shutdown domain %s"), name);
1936 1937
        ret = FALSE;
    }
1938

1939 1940 1941 1942
    virDomainFree(dom);
    return ret;
}

1943 1944 1945
/*
 * "reboot" command
 */
1946
static const vshCmdInfo info_reboot[] = {
1947 1948
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
1949 1950 1951
    {NULL, NULL}
};

1952
static const vshCmdOptDef opts_reboot[] = {
1953
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1954 1955 1956 1957
    {NULL, 0, 0, NULL}
};

static int
1958
cmdReboot(vshControl *ctl, const vshCmd *cmd)
1959 1960 1961 1962 1963
{
    virDomainPtr dom;
    int ret = TRUE;
    char *name;

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

J
Jim Meyering 已提交
1967
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1968 1969 1970
        return FALSE;

    if (virDomainReboot(dom, 0) == 0) {
1971
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
1972
    } else {
1973
        vshError(ctl, _("Failed to reboot domain %s"), name);
1974 1975 1976 1977 1978 1979 1980
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

1981 1982 1983
/*
 * "destroy" command
 */
1984
static const vshCmdInfo info_destroy[] = {
1985 1986
    {"help", N_("destroy a domain")},
    {"desc", N_("Destroy a given domain.")},
1987
    {NULL, NULL}
1988 1989
};

1990
static const vshCmdOptDef opts_destroy[] = {
1991
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1992
    {NULL, 0, 0, NULL}
1993 1994 1995
};

static int
1996
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
1997
{
1998
    virDomainPtr dom;
K
Karel Zak 已提交
1999 2000
    int ret = TRUE;
    char *name;
2001

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

J
Jim Meyering 已提交
2005
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
2006
        return FALSE;
2007 2008

    if (virDomainDestroy(dom) == 0) {
2009
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2010
    } else {
2011
        vshError(ctl, _("Failed to destroy domain %s"), name);
2012 2013
        ret = FALSE;
    }
2014

2015
    virDomainFree(dom);
K
Karel Zak 已提交
2016 2017 2018 2019
    return ret;
}

/*
2020
 * "dominfo" command
K
Karel Zak 已提交
2021
 */
2022
static const vshCmdInfo info_dominfo[] = {
2023 2024
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2025
    {NULL, NULL}
K
Karel Zak 已提交
2026 2027
};

2028
static const vshCmdOptDef opts_dominfo[] = {
2029
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2030
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2031 2032 2033
};

static int
2034
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2035
{
K
Karel Zak 已提交
2036 2037
    virDomainInfo info;
    virDomainPtr dom;
2038 2039
    virSecurityModel secmodel;
    virSecurityLabel seclabel;
2040
    int persistent = 0;
2041
    int ret = TRUE, autostart;
2042
    unsigned int id;
2043
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2044

2045
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
2046 2047
        return FALSE;

J
Jim Meyering 已提交
2048
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
K
Karel Zak 已提交
2049
        return FALSE;
2050

2051 2052
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2053
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2054
    else
2055
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2056 2057
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2058
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2059
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2060 2061

    if ((str = virDomainGetOSType(dom))) {
2062
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2063
        VIR_FREE(str);
2064 2065 2066
    }

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

2070
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2071 2072

        if (info.cpuTime != 0) {
2073
            double cpuUsed = info.cpuTime;
2074

2075
            cpuUsed /= 1000000000.0;
2076

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

2080 2081
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2082
                 info.maxMem);
2083
        else
2084
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2085 2086
                 _("no limit"));

2087
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2088 2089
                 info.memory);

K
Karel Zak 已提交
2090 2091 2092
    } else {
        ret = FALSE;
    }
2093

2094 2095 2096 2097 2098 2099 2100 2101 2102
    /* 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 */
2103
    if (!virDomainGetAutostart(dom, &autostart)) {
2104
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2105 2106 2107
                 autostart ? _("enable") : _("disable") );
    }

2108 2109 2110
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2111 2112 2113 2114
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
            return FALSE;
        }
2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132
    } 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");
            }
        }
    }
2133
    virDomainFree(dom);
K
Karel Zak 已提交
2134 2135 2136
    return ret;
}

2137 2138 2139 2140
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2141 2142
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2143 2144 2145 2146
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2147
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2148 2149 2150 2151 2152 2153 2154 2155 2156
    {NULL, 0, 0, NULL}
};


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

2159
    if (!vshConnectionUsability(ctl, ctl->conn))
2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189
        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 已提交
2190
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2191
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2192
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2193
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2194
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2195 2196 2197
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2198
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2199
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2200
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2201
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2202
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2203 2204 2205
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2206
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2207
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2208
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2209
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2210
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2211 2212 2213 2214 2215 2216 2217 2218 2219
        }
    } else {
        ret = FALSE;
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2220 2221 2222 2223
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2224 2225
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2226 2227 2228 2229
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2230
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2231 2232 2233 2234 2235 2236 2237 2238 2239
    {NULL, 0, 0, NULL}
};

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

2240
    if (!vshConnectionUsability(ctl, ctl->conn))
2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252
        return FALSE;

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

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

    virDomainFree(dom);
    return ret;
}

2253 2254 2255
/*
 * "freecell" command
 */
2256
static const vshCmdInfo info_freecell[] = {
2257 2258
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2259 2260 2261
    {NULL, NULL}
};

2262
static const vshCmdOptDef opts_freecell[] = {
2263
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2264 2265 2266 2267
    {NULL, 0, 0, NULL}
};

static int
2268
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2269 2270 2271 2272 2273
{
    int ret;
    int cell, cell_given;
    unsigned long long memory;

2274
    if (!vshConnectionUsability(ctl, ctl->conn))
2275 2276 2277 2278
        return FALSE;

    cell = vshCommandOptInt(cmd, "cellno", &cell_given);
    if (!cell_given) {
2279
        memory = virNodeGetFreeMemory(ctl->conn);
D
Daniel P. Berrange 已提交
2280 2281
        if (memory == 0)
            return FALSE;
2282
    } else {
2283 2284 2285
        ret = virNodeGetCellsFreeMemory(ctl->conn, &memory, cell, 1);
        if (ret != 1)
            return FALSE;
2286 2287 2288
    }

    if (cell == -1)
D
Daniel P. Berrange 已提交
2289
        vshPrint(ctl, "%s: %llu kB\n", _("Total"), (memory/1024));
2290
    else
D
Daniel P. Berrange 已提交
2291
        vshPrint(ctl, "%d: %llu kB\n", cell, (memory/1024));
2292 2293 2294 2295

    return TRUE;
}

E
Eric Blake 已提交
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 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501
/*
 * "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;
}

2502 2503 2504
/*
 * "vcpuinfo" command
 */
2505
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
2506
    {"help", N_("detailed domain vcpu information")},
2507
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
2508 2509 2510
    {NULL, NULL}
};

2511
static const vshCmdOptDef opts_vcpuinfo[] = {
2512
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2513 2514 2515 2516
    {NULL, 0, 0, NULL}
};

static int
2517
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
2518 2519 2520 2521 2522 2523 2524 2525 2526 2527
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
    unsigned char *cpumap;
    int ncpus;
    size_t cpumaplen;
    int ret = TRUE;

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

J
Jim Meyering 已提交
2531
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2532 2533 2534 2535
        return FALSE;

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
2536
        return FALSE;
2537 2538 2539 2540 2541 2542 2543
    }

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

2544
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
2545
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2546
    cpumap = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
2547

2548 2549 2550
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
                                   cpumap, cpumaplen)) >= 0) {
2551
        int n;
2552 2553 2554 2555 2556
        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 已提交
2557
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573
            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");
            }
        }
2574
    } else {
2575
        if (info.state == VIR_DOMAIN_SHUTOFF) {
2576 2577
            vshError(ctl, "%s",
                     _("Domain shut off, virtual CPUs not present."));
2578
        }
2579 2580 2581
        ret = FALSE;
    }

2582 2583
    VIR_FREE(cpumap);
    VIR_FREE(cpuinfo);
2584 2585 2586 2587 2588 2589 2590
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
2591
static const vshCmdInfo info_vcpupin[] = {
2592 2593
    {"help", N_("control domain vcpu affinity")},
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
2594 2595 2596
    {NULL, NULL}
};

2597
static const vshCmdOptDef opts_vcpupin[] = {
2598
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2599
    {"vcpu", VSH_OT_INT, VSH_OFLAG_REQ, N_("vcpu number")},
2600
    {"cpulist", VSH_OT_DATA, VSH_OFLAG_REQ, N_("host cpu number(s) (comma separated)")},
2601 2602 2603 2604
    {NULL, 0, 0, NULL}
};

static int
2605
cmdVcpupin(vshControl *ctl, const vshCmd *cmd)
2606 2607 2608 2609 2610 2611 2612 2613 2614 2615
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    int vcpu;
    char *cpulist;
    int ret = TRUE;
    int vcpufound = 0;
    unsigned char *cpumap;
    int cpumaplen;
2616 2617
    int i;
    enum { expect_num, expect_num_or_comma } state;
2618

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

J
Jim Meyering 已提交
2622
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2623 2624 2625 2626
        return FALSE;

    vcpu = vshCommandOptInt(cmd, "vcpu", &vcpufound);
    if (!vcpufound) {
2627
        vshError(ctl, "%s", _("vcpupin: Invalid or missing vCPU number."));
2628 2629 2630 2631 2632 2633 2634 2635
        virDomainFree(dom);
        return FALSE;
    }

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

2637 2638 2639 2640 2641 2642
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
        return FALSE;
    }

    if (virDomainGetInfo(dom, &info) != 0) {
2643
        vshError(ctl, "%s", _("vcpupin: failed to get domain informations."));
2644 2645 2646 2647 2648
        virDomainFree(dom);
        return FALSE;
    }

    if (vcpu >= info.nrVirtCpu) {
2649
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
2650 2651 2652 2653
        virDomainFree(dom);
        return FALSE;
    }

2654 2655 2656 2657
    /* Check that the cpulist parameter is a comma-separated list of
     * numbers and give an intelligent error message if not.
     */
    if (cpulist[0] == '\0') {
2658
        vshError(ctl, "%s", _("cpulist: Invalid format. Empty string."));
2659 2660 2661 2662 2663 2664 2665 2666
        virDomainFree (dom);
        return FALSE;
    }

    state = expect_num;
    for (i = 0; cpulist[i]; i++) {
        switch (state) {
        case expect_num:
2667
          if (!c_isdigit (cpulist[i])) {
2668 2669 2670
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2671 2672 2673 2674 2675 2676 2677 2678
                virDomainFree (dom);
                return FALSE;
            }
            state = expect_num_or_comma;
            break;
        case expect_num_or_comma:
            if (cpulist[i] == ',')
                state = expect_num;
2679
            else if (!c_isdigit (cpulist[i])) {
2680 2681 2682
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit or comma at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2683 2684 2685 2686 2687 2688
                virDomainFree (dom);
                return FALSE;
            }
        }
    }
    if (state == expect_num) {
2689 2690 2691
        vshError(ctl, _("cpulist: %s: Invalid format. Trailing comma "
                        "at position %d."),
                 cpulist, i);
2692 2693 2694 2695
        virDomainFree (dom);
        return FALSE;
    }

2696
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2697
    cpumap = vshCalloc(ctl, 1, cpumaplen);
2698 2699 2700 2701 2702 2703

    do {
        unsigned int cpu = atoi(cpulist);

        if (cpu < VIR_NODEINFO_MAXCPUS(nodeinfo)) {
            VIR_USE_CPU(cpumap, cpu);
2704
        } else {
2705
            vshError(ctl, _("Physical CPU %d doesn't exist."), cpu);
2706
            VIR_FREE(cpumap);
2707 2708
            virDomainFree(dom);
            return FALSE;
2709
        }
2710
        cpulist = strchr(cpulist, ',');
2711 2712 2713 2714 2715 2716 2717 2718
        if (cpulist)
            cpulist++;
    } while (cpulist);

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

2719
    VIR_FREE(cpumap);
2720 2721 2722 2723
    virDomainFree(dom);
    return ret;
}

2724 2725 2726
/*
 * "setvcpus" command
 */
2727
static const vshCmdInfo info_setvcpus[] = {
2728 2729
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
2730 2731 2732
    {NULL, NULL}
};

2733
static const vshCmdOptDef opts_setvcpus[] = {
2734
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2735
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
2736 2737 2738
    {"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")},
2739 2740 2741 2742
    {NULL, 0, 0, NULL}
};

static int
2743
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
2744 2745 2746 2747
{
    virDomainPtr dom;
    int count;
    int ret = TRUE;
E
Eric Blake 已提交
2748 2749 2750 2751 2752 2753
    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));
2754

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

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

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

E
Eric Blake 已提交
2763 2764 2765 2766 2767 2768 2769 2770
    if (!flags) {
        if (virDomainSetVcpus(dom, count) != 0) {
            ret = FALSE;
        }
    } else {
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
            ret = FALSE;
        }
2771 2772 2773 2774 2775 2776 2777 2778 2779
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmemory" command
 */
2780
static const vshCmdInfo info_setmem[] = {
2781 2782
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
2783 2784 2785
    {NULL, NULL}
};

2786
static const vshCmdOptDef opts_setmem[] = {
2787
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2788
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
2789 2790 2791 2792
    {NULL, 0, 0, NULL}
};

static int
2793
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
2794 2795
{
    virDomainPtr dom;
2796
    virDomainInfo info;
2797
    unsigned long kilobytes;
2798 2799
    int ret = TRUE;

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

J
Jim Meyering 已提交
2803
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2804 2805
        return FALSE;

2806
    kilobytes = vshCommandOptUL(cmd, "kilobytes", NULL);
2807
    if (kilobytes <= 0) {
2808
        virDomainFree(dom);
2809
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
2810 2811 2812
        return FALSE;
    }

2813 2814
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
2815
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
2816 2817 2818 2819 2820
        return FALSE;
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
2821
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
2822
                 kilobytes, info.maxMem);
2823 2824 2825
        return FALSE;
    }

2826
    if (virDomainSetMemory(dom, kilobytes) != 0) {
2827 2828 2829 2830 2831 2832 2833 2834 2835 2836
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
2837
static const vshCmdInfo info_setmaxmem[] = {
2838 2839
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
2840 2841 2842
    {NULL, NULL}
};

2843
static const vshCmdOptDef opts_setmaxmem[] = {
2844
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2845
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
2846 2847 2848 2849
    {NULL, 0, 0, NULL}
};

static int
2850
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
2851 2852
{
    virDomainPtr dom;
2853
    virDomainInfo info;
2854
    int kilobytes;
2855 2856
    int ret = TRUE;

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

J
Jim Meyering 已提交
2860
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2861 2862
        return FALSE;

2863 2864
    kilobytes = vshCommandOptInt(cmd, "kilobytes", &kilobytes);
    if (kilobytes <= 0) {
2865
        virDomainFree(dom);
2866
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
2867 2868 2869
        return FALSE;
    }

2870 2871
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
2872
        vshError(ctl, "%s", _("Unable to verify current MemorySize"));
2873 2874 2875
        return FALSE;
    }

2876 2877 2878 2879 2880 2881
    if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
        vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
        virDomainFree(dom);
        return FALSE;
    }

2882 2883
    if (kilobytes < info.memory) {
        if (virDomainSetMemory(dom, kilobytes) != 0) {
2884
            vshError(ctl, "%s", _("Unable to shrink current MemorySize"));
2885
            ret = FALSE;
2886 2887 2888
        }
    }

2889 2890 2891 2892
    virDomainFree(dom);
    return ret;
}

2893 2894 2895 2896
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
2897 2898 2899
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
2900 2901 2902 2903 2904 2905 2906
                "    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")},
2907
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
2908
     N_("Max memory in kilobytes")},
2909
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
2910
     N_("Memory during contention in kilobytes")},
2911
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
2912
     N_("Max swap in kilobytes")},
2913
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
2914
     N_("Min guaranteed memory in kilobytes")},
2915 2916 2917 2918 2919 2920 2921
    {NULL, 0, 0, NULL}
};

static int
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2922
    long long hard_limit, soft_limit, swap_hard_limit, min_guarantee;
2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934
    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 =
2935
        vshCommandOptLongLong(cmd, "hard-limit", NULL);
2936 2937 2938 2939
    if (hard_limit)
        nparams++;

    soft_limit =
2940
        vshCommandOptLongLong(cmd, "soft-limit", NULL);
2941 2942 2943 2944
    if (soft_limit)
        nparams++;

    swap_hard_limit =
2945
        vshCommandOptLongLong(cmd, "swap-hard-limit", NULL);
2946 2947 2948
    if (swap_hard_limit)
        nparams++;

2949
    min_guarantee =
2950
        vshCommandOptLongLong(cmd, "min-guarantee", NULL);
2951 2952 2953
    if (min_guarantee)
        nparams++;

2954 2955
    if (nparams == 0) {
        /* get the number of memory parameters */
2956
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, 0) != 0) {
2957 2958 2959 2960 2961
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

2962 2963 2964 2965 2966 2967
        if (nparams == 0) {
            /* nothing to output */
            ret = TRUE;
            goto cleanup;
        }

2968
        /* now go get all the memory parameters */
E
Eric Blake 已提交
2969
        params = vshCalloc(ctl, nparams, sizeof(*params));
2970
        if (virDomainGetMemoryParameters(dom, params, &nparams, 0) != 0) {
2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001
            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:
3002
                    vshPrint(ctl, "unimplemented memory parameter type\n");
3003 3004 3005 3006 3007 3008
            }
        }

        ret = TRUE;
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
3009
        params = vshCalloc(ctl, nparams, sizeof(*params));
3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032

        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;
3033
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
3034 3035
                        sizeof(temp->field));
                swap_hard_limit = 0;
3036 3037 3038 3039 3040
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
3041 3042 3043
            }
        }
        if (virDomainSetMemoryParameters(dom, params, nparams, 0) != 0)
3044
            vshError(ctl, "%s", _("Unable to change memory parameters"));
3045 3046 3047 3048 3049
        else
            ret = TRUE;
    }

  cleanup:
E
Eric Blake 已提交
3050
    VIR_FREE(params);
3051 3052 3053 3054
    virDomainFree(dom);
    return ret;
}

3055 3056 3057
/*
 * "nodeinfo" command
 */
3058
static const vshCmdInfo info_nodeinfo[] = {
3059 3060
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
3061 3062 3063 3064
    {NULL, NULL}
};

static int
3065
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3066 3067
{
    virNodeInfo info;
3068

3069
    if (!vshConnectionUsability(ctl, ctl->conn))
3070 3071 3072
        return FALSE;

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
3073
        vshError(ctl, "%s", _("failed to get node information"));
3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084
        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);

3085 3086 3087
    return TRUE;
}

3088 3089 3090
/*
 * "capabilities" command
 */
3091
static const vshCmdInfo info_capabilities[] = {
3092 3093
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
3094 3095 3096 3097
    {NULL, NULL}
};

static int
3098
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3099 3100 3101
{
    char *caps;

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

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
3106
        vshError(ctl, "%s", _("failed to get capabilities"));
3107 3108 3109
        return FALSE;
    }
    vshPrint (ctl, "%s\n", caps);
3110
    VIR_FREE(caps);
3111 3112 3113 3114

    return TRUE;
}

3115 3116 3117
/*
 * "dumpxml" command
 */
3118
static const vshCmdInfo info_dumpxml[] = {
3119 3120
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
3121
    {NULL, NULL}
3122 3123
};

3124
static const vshCmdOptDef opts_dumpxml[] = {
3125 3126 3127
    {"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")},
3128
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
3129
    {NULL, 0, 0, NULL}
3130 3131 3132
};

static int
3133
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
3134
{
3135
    virDomainPtr dom;
K
Karel Zak 已提交
3136
    int ret = TRUE;
3137
    char *dump;
3138 3139 3140
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
3141
    int update = vshCommandOptBool(cmd, "update-cpu");
3142 3143 3144 3145 3146

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
3147 3148
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
3149

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

J
Jim Meyering 已提交
3153
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
3154
        return FALSE;
3155

3156
    dump = virDomainGetXMLDesc(dom, flags);
3157
    if (dump != NULL) {
3158
        vshPrint(ctl, "%s", dump);
3159
        VIR_FREE(dump);
3160 3161 3162
    } else {
        ret = FALSE;
    }
3163

3164 3165 3166 3167
    virDomainFree(dom);
    return ret;
}

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

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

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

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

3199
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
3200 3201 3202 3203
        return FALSE;

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
3204
        vshPrint(ctl, "%s", xmlData);
3205
        VIR_FREE(xmlData);
3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216
    } else {
        ret = FALSE;
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
3217 3218
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
3219 3220 3221 3222
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
3223 3224
    {"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")},
3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237
    {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;

3238
    if (!vshConnectionUsability(ctl, ctl->conn))
3239 3240 3241 3242 3243
        return FALSE;

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

3244
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
3245 3246 3247 3248
        return FALSE;

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
3249
        vshPrint(ctl, "%s", configData);
3250
        VIR_FREE(configData);
3251 3252 3253 3254 3255 3256 3257
    } else {
        ret = FALSE;
    }

    return ret;
}

K
Karel Zak 已提交
3258
/*
K
Karel Zak 已提交
3259
 * "domname" command
K
Karel Zak 已提交
3260
 */
3261
static const vshCmdInfo info_domname[] = {
3262
    {"help", N_("convert a domain id or UUID to domain name")},
3263
    {"desc", ""},
3264
    {NULL, NULL}
K
Karel Zak 已提交
3265 3266
};

3267
static const vshCmdOptDef opts_domname[] = {
3268
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
3269
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3270 3271 3272
};

static int
3273
cmdDomname(vshControl *ctl, const vshCmd *cmd)
3274
{
K
Karel Zak 已提交
3275 3276
    virDomainPtr dom;

3277
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3278
        return FALSE;
J
Jim Meyering 已提交
3279
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3280
                                      VSH_BYID|VSH_BYUUID)))
K
Karel Zak 已提交
3281
        return FALSE;
3282

K
Karel Zak 已提交
3283 3284
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
K
Karel Zak 已提交
3285 3286 3287 3288
    return TRUE;
}

/*
K
Karel Zak 已提交
3289
 * "domid" command
K
Karel Zak 已提交
3290
 */
3291
static const vshCmdInfo info_domid[] = {
3292
    {"help", N_("convert a domain name or UUID to domain id")},
3293
    {"desc", ""},
3294
    {NULL, NULL}
K
Karel Zak 已提交
3295 3296
};

3297
static const vshCmdOptDef opts_domid[] = {
3298
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
3299
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3300 3301 3302
};

static int
3303
cmdDomid(vshControl *ctl, const vshCmd *cmd)
3304
{
3305
    virDomainPtr dom;
3306
    unsigned int id;
K
Karel Zak 已提交
3307

3308
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3309
        return FALSE;
J
Jim Meyering 已提交
3310
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3311
                                      VSH_BYNAME|VSH_BYUUID)))
K
Karel Zak 已提交
3312
        return FALSE;
3313

3314 3315
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3316
        vshPrint(ctl, "%s\n", "-");
3317
    else
3318
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
3319 3320 3321
    virDomainFree(dom);
    return TRUE;
}
3322

K
Karel Zak 已提交
3323 3324 3325
/*
 * "domuuid" command
 */
3326
static const vshCmdInfo info_domuuid[] = {
3327
    {"help", N_("convert a domain name or id to domain UUID")},
3328
    {"desc", ""},
K
Karel Zak 已提交
3329 3330 3331
    {NULL, NULL}
};

3332
static const vshCmdOptDef opts_domuuid[] = {
3333
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
3334 3335 3336 3337
    {NULL, 0, 0, NULL}
};

static int
3338
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
3339 3340
{
    virDomainPtr dom;
3341
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
3342

3343
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3344
        return FALSE;
J
Jim Meyering 已提交
3345
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3346
                                      VSH_BYNAME|VSH_BYID)))
K
Karel Zak 已提交
3347
        return FALSE;
3348

K
Karel Zak 已提交
3349 3350 3351
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
3352
        vshError(ctl, "%s", _("failed to get domain UUID"));
3353

3354
    virDomainFree(dom);
K
Karel Zak 已提交
3355 3356 3357
    return TRUE;
}

3358 3359 3360
/*
 * "migrate" command
 */
3361
static const vshCmdInfo info_migrate[] = {
3362 3363
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
3364 3365 3366
    {NULL, NULL}
};

3367
static const vshCmdOptDef opts_migrate[] = {
3368 3369 3370 3371 3372 3373 3374
    {"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")},
3375 3376
    {"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)")},
3377
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3378
    {"desturi", VSH_OT_DATA, VSH_OFLAG_REQ, N_("connection URI of the destination host as seen from the client(normal migration) or source(p2p migration)")},
3379 3380
    {"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)")},
3381 3382 3383 3384
    {NULL, 0, 0, NULL}
};

static int
3385
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
3386 3387 3388 3389
{
    virDomainPtr dom = NULL;
    const char *desturi;
    const char *migrateuri;
D
Daniel Veillard 已提交
3390
    const char *dname;
3391 3392
    int flags = 0, found, ret = FALSE;

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

J
Jim Meyering 已提交
3396
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
3397 3398 3399
        return FALSE;

    desturi = vshCommandOptString (cmd, "desturi", &found);
3400
    if (!found)
3401 3402
        goto done;

3403
    migrateuri = vshCommandOptString (cmd, "migrateuri", NULL);
3404

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

3407 3408
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
3409 3410
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
3411 3412 3413
    if (vshCommandOptBool (cmd, "tunnelled"))
        flags |= VIR_MIGRATE_TUNNELLED;

C
Chris Lalancette 已提交
3414 3415 3416 3417 3418
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

3419 3420 3421
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

3422 3423 3424 3425 3426 3427
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

3428 3429 3430 3431
    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. */
3432

3433
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
3434
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
3435 3436
            goto done;
        }
3437

3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454
        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);
    }
3455 3456 3457 3458 3459 3460

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

3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471
/*
 * "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")},
3472
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483
    {NULL, 0, 0, NULL}
};

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

3484
    if (!vshConnectionUsability(ctl, ctl->conn))
3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505
        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;
}

3506 3507 3508
/*
 * "net-autostart" command
 */
3509
static const vshCmdInfo info_network_autostart[] = {
3510
    {"help", N_("autostart a network")},
3511
    {"desc",
3512
     N_("Configure a network to be automatically started at boot.")},
3513 3514 3515
    {NULL, NULL}
};

3516
static const vshCmdOptDef opts_network_autostart[] = {
3517 3518
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
3519 3520 3521 3522
    {NULL, 0, 0, NULL}
};

static int
3523
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
3524 3525 3526 3527 3528
{
    virNetworkPtr network;
    char *name;
    int autostart;

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

J
Jim Meyering 已提交
3532
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
3533 3534 3535 3536 3537
        return FALSE;

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
3538
        if (autostart)
3539
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
3540
        else
3541
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
3542 3543 3544 3545
        virNetworkFree(network);
        return FALSE;
    }

3546
    if (autostart)
3547
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
3548
    else
3549
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
3550

L
Laine Stump 已提交
3551
    virNetworkFree(network);
3552 3553
    return TRUE;
}
K
Karel Zak 已提交
3554

3555 3556 3557
/*
 * "net-create" command
 */
3558
static const vshCmdInfo info_network_create[] = {
3559 3560
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
3561 3562 3563
    {NULL, NULL}
};

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

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

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

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

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

    network = virNetworkCreateXML(ctl->conn, buffer);
3589
    VIR_FREE(buffer);
3590

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


/*
 * "net-define" command
 */
3606
static const vshCmdInfo info_network_define[] = {
3607 3608
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
3609 3610 3611
    {NULL, NULL}
};

3612
static const vshCmdOptDef opts_network_define[] = {
3613
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
3614 3615 3616 3617
    {NULL, 0, 0, NULL}
};

static int
3618
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
3619 3620 3621 3622 3623
{
    virNetworkPtr network;
    char *from;
    int found;
    int ret = TRUE;
3624
    char *buffer;
3625

3626
    if (!vshConnectionUsability(ctl, ctl->conn))
3627 3628 3629 3630 3631 3632
        return FALSE;

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

3633 3634
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
3635 3636

    network = virNetworkDefineXML(ctl->conn, buffer);
3637
    VIR_FREE(buffer);
3638

3639 3640 3641
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
3642
        virNetworkFree(network);
3643
    } else {
3644
        vshError(ctl, _("Failed to define network from %s"), from);
3645 3646 3647 3648 3649 3650 3651 3652 3653
        ret = FALSE;
    }
    return ret;
}


/*
 * "net-destroy" command
 */
3654
static const vshCmdInfo info_network_destroy[] = {
3655 3656
    {"help", N_("destroy a network")},
    {"desc", N_("Destroy a given network.")},
3657 3658 3659
    {NULL, NULL}
};

3660
static const vshCmdOptDef opts_network_destroy[] = {
3661
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
3662 3663 3664 3665
    {NULL, 0, 0, NULL}
};

static int
3666
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
3667 3668 3669 3670 3671
{
    virNetworkPtr network;
    int ret = TRUE;
    char *name;

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

J
Jim Meyering 已提交
3675
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
3676 3677 3678 3679 3680
        return FALSE;

    if (virNetworkDestroy(network) == 0) {
        vshPrint(ctl, _("Network %s destroyed\n"), name);
    } else {
3681
        vshError(ctl, _("Failed to destroy network %s"), name);
3682 3683 3684
        ret = FALSE;
    }

3685
    virNetworkFree(network);
3686 3687 3688 3689 3690 3691 3692
    return ret;
}


/*
 * "net-dumpxml" command
 */
3693
static const vshCmdInfo info_network_dumpxml[] = {
3694 3695
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
3696 3697 3698
    {NULL, NULL}
};

3699
static const vshCmdOptDef opts_network_dumpxml[] = {
3700
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
3701 3702 3703 3704
    {NULL, 0, 0, NULL}
};

static int
3705
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
3706 3707 3708 3709 3710
{
    virNetworkPtr network;
    int ret = TRUE;
    char *dump;

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

J
Jim Meyering 已提交
3714
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
3715 3716 3717 3718
        return FALSE;

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
3719
        vshPrint(ctl, "%s", dump);
3720
        VIR_FREE(dump);
3721 3722 3723 3724 3725 3726 3727 3728
    } else {
        ret = FALSE;
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786
/*
 * "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;
}
3787

3788 3789 3790 3791
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
3792 3793
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
3794 3795 3796 3797
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
3798
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810
    {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;
3811
    int flags = VIR_INTERFACE_XML_INACTIVE;
3812

3813
    if (!vshConnectionUsability(ctl, ctl->conn))
3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852
        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)) {
3853 3854
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872
        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);

3873 3874 3875
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
3876 3877 3878

    if (tmp) {
        unlink (tmp);
3879
        VIR_FREE(tmp);
3880 3881 3882 3883 3884
    }

    return ret;
}

3885 3886 3887
/*
 * "net-list" command
 */
3888
static const vshCmdInfo info_network_list[] = {
3889 3890
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
3891 3892 3893
    {NULL, NULL}
};

3894
static const vshCmdOptDef opts_network_list[] = {
3895 3896
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
3897 3898 3899 3900
    {NULL, 0, 0, NULL}
};

static int
3901
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3902 3903 3904 3905 3906
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
3907
    char **activeNames = NULL, **inactiveNames = NULL;
3908 3909
    inactive |= all;

3910
    if (!vshConnectionUsability(ctl, ctl->conn))
3911 3912 3913
        return FALSE;

    if (active) {
3914 3915
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
3916
            vshError(ctl, "%s", _("Failed to list active networks"));
3917
            return FALSE;
3918
        }
3919
        if (maxactive) {
3920
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
3921

3922
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
3923
                                                    maxactive)) < 0) {
3924
                vshError(ctl, "%s", _("Failed to list active networks"));
3925
                VIR_FREE(activeNames);
3926 3927
                return FALSE;
            }
3928

3929
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
3930
        }
3931 3932
    }
    if (inactive) {
3933 3934
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
3935
            vshError(ctl, "%s", _("Failed to list inactive networks"));
3936
            VIR_FREE(activeNames);
3937
            return FALSE;
3938
        }
3939 3940 3941
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

3942 3943 3944
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
3945
                vshError(ctl, "%s", _("Failed to list inactive networks"));
3946 3947
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
3948 3949
                return FALSE;
            }
3950

3951 3952
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
3953
    }
3954 3955
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
3956
    vshPrintExtra(ctl, "-----------------------------------------\n");
3957 3958

    for (i = 0; i < maxactive; i++) {
3959 3960
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
3961 3962
        const char *autostartStr;
        int autostart = 0;
3963 3964 3965

        /* this kind of work with networks is not atomic operation */
        if (!network) {
3966
            VIR_FREE(activeNames[i]);
3967
            continue;
3968
        }
3969

3970 3971 3972
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
3973
            autostartStr = autostart ? _("yes") : _("no");
3974 3975 3976 3977 3978

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
3979
        virNetworkFree(network);
3980
        VIR_FREE(activeNames[i]);
3981 3982 3983
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
3984 3985
        const char *autostartStr;
        int autostart = 0;
3986 3987 3988

        /* this kind of work with networks is not atomic operation */
        if (!network) {
3989
            VIR_FREE(inactiveNames[i]);
3990
            continue;
3991
        }
3992

3993 3994 3995
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
3996
            autostartStr = autostart ? _("yes") : _("no");
3997

3998
        vshPrint(ctl, "%-20s %-10s %-10s\n",
3999 4000 4001
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
4002 4003

        virNetworkFree(network);
4004
        VIR_FREE(inactiveNames[i]);
4005
    }
4006 4007
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
4008 4009 4010 4011 4012 4013 4014
    return TRUE;
}


/*
 * "net-name" command
 */
4015
static const vshCmdInfo info_network_name[] = {
4016
    {"help", N_("convert a network UUID to network name")},
4017
    {"desc", ""},
4018 4019 4020
    {NULL, NULL}
};

4021
static const vshCmdOptDef opts_network_name[] = {
4022
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
4023 4024 4025 4026
    {NULL, 0, 0, NULL}
};

static int
4027
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
4028 4029 4030
{
    virNetworkPtr network;

4031
    if (!vshConnectionUsability(ctl, ctl->conn))
4032
        return FALSE;
J
Jim Meyering 已提交
4033
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4034
                                           VSH_BYUUID)))
4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045
        return FALSE;

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


/*
 * "net-start" command
 */
4046
static const vshCmdInfo info_network_start[] = {
4047 4048
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
4049 4050 4051
    {NULL, NULL}
};

4052
static const vshCmdOptDef opts_network_start[] = {
4053
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
4054 4055 4056 4057
    {NULL, 0, 0, NULL}
};

static int
4058
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
4059 4060 4061 4062
{
    virNetworkPtr network;
    int ret = TRUE;

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

J
Jim Meyering 已提交
4066
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
4067
         return FALSE;
4068 4069 4070

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
4071
                 virNetworkGetName(network));
4072
    } else {
4073
        vshError(ctl, _("Failed to start network %s"),
4074
                 virNetworkGetName(network));
4075 4076
        ret = FALSE;
    }
L
Laine Stump 已提交
4077
    virNetworkFree(network);
4078 4079 4080 4081 4082 4083 4084
    return ret;
}


/*
 * "net-undefine" command
 */
4085
static const vshCmdInfo info_network_undefine[] = {
4086 4087
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
4088 4089 4090
    {NULL, NULL}
};

4091
static const vshCmdOptDef opts_network_undefine[] = {
4092
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4093 4094 4095 4096
    {NULL, 0, 0, NULL}
};

static int
4097
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
4098 4099 4100 4101 4102
{
    virNetworkPtr network;
    int ret = TRUE;
    char *name;

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

J
Jim Meyering 已提交
4106
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
4107 4108 4109 4110 4111
        return FALSE;

    if (virNetworkUndefine(network) == 0) {
        vshPrint(ctl, _("Network %s has been undefined\n"), name);
    } else {
4112
        vshError(ctl, _("Failed to undefine network %s"), name);
4113 4114 4115
        ret = FALSE;
    }

L
Laine Stump 已提交
4116
    virNetworkFree(network);
4117 4118 4119 4120 4121 4122 4123
    return ret;
}


/*
 * "net-uuid" command
 */
4124
static const vshCmdInfo info_network_uuid[] = {
4125
    {"help", N_("convert a network name to network UUID")},
4126
    {"desc", ""},
4127 4128 4129
    {NULL, NULL}
};

4130
static const vshCmdOptDef opts_network_uuid[] = {
4131
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
4132 4133 4134 4135
    {NULL, 0, 0, NULL}
};

static int
4136
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
4137 4138 4139 4140
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

J
Jim Meyering 已提交
4144
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4145
                                           VSH_BYNAME)))
4146 4147 4148 4149 4150
        return FALSE;

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

L
Laine Stump 已提交
4153
    virNetworkFree(network);
4154 4155 4156 4157
    return TRUE;
}


4158 4159 4160 4161 4162
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
4163 4164
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
4165 4166 4167 4168
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
4169 4170
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182
    {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;

4183
    if (!vshConnectionUsability(ctl, ctl->conn))
4184 4185 4186 4187 4188
        return FALSE;

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
4189
            vshError(ctl, "%s", _("Failed to list active interfaces"));
4190 4191 4192 4193 4194 4195 4196
            return FALSE;
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
4197
                vshError(ctl, "%s", _("Failed to list active interfaces"));
4198
                VIR_FREE(activeNames);
4199 4200 4201 4202 4203 4204 4205 4206 4207
                return FALSE;
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
4208
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4209
            VIR_FREE(activeNames);
4210 4211 4212 4213 4214
            return FALSE;
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4215 4216 4217
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
4218
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4219 4220
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
4221 4222 4223 4224 4225 4226
                return FALSE;
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
4227 4228
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
4229 4230 4231
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
4232 4233
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
4234 4235 4236

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4237
            VIR_FREE(activeNames[i]);
4238 4239 4240 4241 4242 4243 4244 4245
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4246
        VIR_FREE(activeNames[i]);
4247 4248
    }
    for (i = 0; i < maxinactive; i++) {
4249 4250
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
4251 4252 4253

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4254
            VIR_FREE(inactiveNames[i]);
4255 4256 4257 4258 4259 4260 4261 4262
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4263
        VIR_FREE(inactiveNames[i]);
4264
    }
4265 4266
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
4267 4268 4269 4270 4271 4272 4273 4274
    return TRUE;

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
4275
    {"help", N_("convert an interface MAC address to interface name")},
4276 4277 4278 4279 4280
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
4281
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
4282 4283 4284 4285 4286 4287 4288 4289
    {NULL, 0, 0, NULL}
};

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

4290
    if (!vshConnectionUsability(ctl, ctl->conn))
4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304
        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[] = {
4305
    {"help", N_("convert an interface name to interface MAC address")},
4306 4307 4308 4309 4310
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
4311
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
4312 4313 4314 4315 4316 4317 4318 4319
    {NULL, 0, 0, NULL}
};

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

4320
    if (!vshConnectionUsability(ctl, ctl->conn))
4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334
        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[] = {
4335 4336
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
4337 4338 4339 4340
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
4341 4342
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
4343 4344 4345 4346 4347 4348 4349 4350 4351
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
    int ret = TRUE;
    char *dump;
4352 4353 4354 4355 4356
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
4357

4358
    if (!vshConnectionUsability(ctl, ctl->conn))
4359 4360 4361 4362 4363
        return FALSE;

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

4364
    dump = virInterfaceGetXMLDesc(iface, flags);
4365
    if (dump != NULL) {
4366
        vshPrint(ctl, "%s", dump);
4367
        VIR_FREE(dump);
4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379
    } else {
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
4380 4381
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
4382 4383 4384 4385
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
4386
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
4387 4388 4389 4390 4391 4392
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
4393
    virInterfacePtr iface;
4394 4395 4396 4397 4398
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;

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

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

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

4409
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
4410
    VIR_FREE(buffer);
4411

4412
    if (iface != NULL) {
4413
        vshPrint(ctl, _("Interface %s defined from %s\n"),
4414
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
4415
        virInterfaceFree (iface);
4416
    } else {
4417
        vshError(ctl, _("Failed to define interface from %s"), from);
4418 4419 4420 4421 4422 4423 4424 4425 4426
        ret = FALSE;
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
4427 4428
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
4429 4430 4431 4432
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
4433
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4434 4435 4436 4437 4438 4439 4440 4441 4442 4443
    {NULL, 0, 0, NULL}
};

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

4444
    if (!vshConnectionUsability(ctl, ctl->conn))
4445 4446 4447 4448 4449 4450 4451 4452
        return FALSE;

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

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
4453
        vshError(ctl, _("Failed to undefine interface %s"), name);
4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
4465 4466
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
4467 4468 4469 4470
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
4471
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4472 4473 4474 4475 4476 4477 4478 4479 4480 4481
    {NULL, 0, 0, NULL}
};

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

4482
    if (!vshConnectionUsability(ctl, ctl->conn))
4483 4484 4485 4486 4487 4488 4489 4490
        return FALSE;

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

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
4491
        vshError(ctl, _("Failed to start interface %s"), name);
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
4503 4504
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
    {"desc", N_("destroy a physical host interface.")},
4505 4506 4507 4508
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
4509
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4510 4511 4512 4513 4514 4515 4516 4517 4518 4519
    {NULL, 0, 0, NULL}
};

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

4520
    if (!vshConnectionUsability(ctl, ctl->conn))
4521 4522 4523 4524 4525 4526 4527 4528
        return FALSE;

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

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
4529
        vshError(ctl, _("Failed to destroy interface %s"), name);
4530 4531 4532 4533 4534 4535 4536
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560

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

4561
    if (!vshConnectionUsability(ctl, ctl->conn))
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 4599 4600 4601 4602 4603 4604 4605 4606
        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;

4607
    if (!vshConnectionUsability(ctl, ctl->conn))
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 4637 4638 4639 4640 4641 4642 4643 4644 4645
        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;

4646
    if (!vshConnectionUsability(ctl, ctl->conn))
4647 4648 4649 4650 4651 4652 4653
        return FALSE;

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

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
4654
        vshPrint(ctl, "%s", dump);
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
        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];

4684
    if (!vshConnectionUsability(ctl, ctl->conn))
4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 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
        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;

4755
    if (!vshConnectionUsability(ctl, ctl->conn))
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 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827
        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;
}


4828
/**************************************************************************/
4829
/*
4830
 * "pool-autostart" command
4831
 */
4832
static const vshCmdInfo info_pool_autostart[] = {
4833
    {"help", N_("autostart a pool")},
4834
    {"desc",
4835
     N_("Configure a pool to be automatically started at boot.")},
4836
    {NULL, NULL}
4837 4838
};

4839
static const vshCmdOptDef opts_pool_autostart[] = {
4840 4841
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4842 4843
    {NULL, 0, 0, NULL}
};
4844 4845

static int
4846
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
4847
{
4848 4849 4850
    virStoragePoolPtr pool;
    char *name;
    int autostart;
4851

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

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

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

4860 4861
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
4862
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
4863
        else
4864
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
4865
        virStoragePoolFree(pool);
4866 4867 4868
        return FALSE;
    }

4869
    if (autostart)
4870
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
4871
    else
4872
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
4873

L
Laine Stump 已提交
4874
    virStoragePoolFree(pool);
4875 4876 4877
    return TRUE;
}

4878
/*
4879
 * "pool-create" command
4880
 */
4881
static const vshCmdInfo info_pool_create[] = {
4882 4883
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
4884 4885 4886
    {NULL, NULL}
};

4887
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
4888
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
4889
     N_("file containing an XML pool description")},
4890 4891 4892
    {NULL, 0, 0, NULL}
};

4893
static int
4894
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
4895
{
4896 4897 4898 4899 4900
    virStoragePoolPtr pool;
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;
4901

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

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

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

4912
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
4913
    VIR_FREE(buffer);
4914 4915 4916 4917

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
4918
        virStoragePoolFree(pool);
4919
    } else {
4920
        vshError(ctl, _("Failed to create pool from %s"), from);
4921 4922 4923
        ret = FALSE;
    }
    return ret;
4924 4925
}

4926

4927 4928 4929 4930
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
4931
    {"help", N_("create a device defined "
4932
                          "by an XML file on the node")},
4933
    {"desc", N_("Create a device on the node.  Note that this "
4934 4935 4936 4937 4938 4939 4940
                          "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,
4941
     N_("file containing an XML description of the device")},
4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953
    {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;

4954
    if (!vshConnectionUsability(ctl, ctl->conn))
4955 4956 4957 4958 4959 4960 4961
        return FALSE;

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

4962
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
4963 4964 4965
        return FALSE;

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
4966
    VIR_FREE(buffer);
4967 4968 4969 4970

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
4971
        virNodeDeviceFree(dev);
4972
    } else {
4973
        vshError(ctl, _("Failed to create node device from %s"), from);
4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984
        ret = FALSE;
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
4985 4986
    {"help", N_("destroy a device on the node")},
    {"desc", N_("Destroy a device on the node.  Note that this "
4987 4988 4989 4990 4991 4992
                          "command destroys devices on the physical host ")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
4993
     N_("name of the device to be destroyed")},
4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004
    {NULL, 0, 0, NULL}
};

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

5005
    if (!vshConnectionUsability(ctl, ctl->conn)) {
5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018
        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 {
5019
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
5020 5021 5022 5023 5024 5025 5026 5027
        ret = FALSE;
    }

    virNodeDeviceFree(dev);
    return ret;
}


5028
/*
5029
 * XML Building helper for pool-define-as and pool-create-as
5030
 */
5031
static const vshCmdOptDef opts_pool_X_as[] = {
5032 5033 5034 5035 5036 5037 5038 5039
    {"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")},
5040
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
5041 5042 5043
    {NULL, 0, 0, NULL}
};

5044
static int buildPoolXML(const vshCmd *cmd, char **retname, char **xml) {
5045 5046

    int found;
5047
    char *name, *type, *srcHost, *srcPath, *srcDev, *srcName, *srcFormat, *target;
5048
    virBuffer buf = VIR_BUFFER_INITIALIZER;
5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059

    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);
5060
    srcName = vshCommandOptString(cmd, "source-name", &found);
5061
    srcFormat = vshCommandOptString(cmd, "source-format", &found);
5062 5063
    target = vshCommandOptString(cmd, "target", &found);

5064 5065
    virBufferVSprintf(&buf, "<pool type='%s'>\n", type);
    virBufferVSprintf(&buf, "  <name>%s</name>\n", name);
5066
    if (srcHost || srcPath || srcDev) {
5067
        virBufferAddLit(&buf, "  <source>\n");
5068

5069 5070
        if (srcHost)
            virBufferVSprintf(&buf, "    <host name='%s'/>\n", srcHost);
5071 5072 5073 5074
        if (srcPath)
            virBufferVSprintf(&buf, "    <dir path='%s'/>\n", srcPath);
        if (srcDev)
            virBufferVSprintf(&buf, "    <device path='%s'/>\n", srcDev);
5075 5076
        if (srcFormat)
            virBufferVSprintf(&buf, "    <format type='%s'/>\n", srcFormat);
5077 5078
        if (srcName)
            virBufferVSprintf(&buf, "    <name>%s</name>\n", srcName);
5079 5080

        virBufferAddLit(&buf, "  </source>\n");
5081 5082
    }
    if (target) {
5083 5084 5085
        virBufferAddLit(&buf, "  <target>\n");
        virBufferVSprintf(&buf, "    <path>%s</path>\n", target);
        virBufferAddLit(&buf, "  </target>\n");
5086
    }
5087 5088 5089 5090 5091 5092
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
    }
5093 5094 5095 5096 5097 5098

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

cleanup:
5099
    virBufferFreeAndReset(&buf);
5100 5101 5102 5103 5104 5105 5106
    return FALSE;
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
5107 5108
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
5109 5110 5111 5112 5113 5114 5115 5116
    {NULL, NULL}
};

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

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

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

5125
    if (printXML) {
5126
        vshPrint(ctl, "%s", xml);
5127
        VIR_FREE(xml);
5128
    } else {
5129
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
5130
        VIR_FREE(xml);
5131

5132 5133 5134 5135
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
5136
            vshError(ctl, _("Failed to create pool %s"), name);
5137 5138 5139 5140
            return FALSE;
        }
    }
    return TRUE;
5141 5142
}

5143

5144
/*
5145
 * "pool-define" command
5146
 */
5147
static const vshCmdInfo info_pool_define[] = {
5148 5149
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
5150 5151 5152
    {NULL, NULL}
};

5153
static const vshCmdOptDef opts_pool_define[] = {
5154
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
5155 5156 5157
    {NULL, 0, 0, NULL}
};

5158
static int
5159
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
5160
{
5161 5162 5163 5164 5165
    virStoragePoolPtr pool;
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;
5166

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

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

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

5177
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
5178
    VIR_FREE(buffer);
5179 5180 5181 5182

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5183
        virStoragePoolFree(pool);
5184
    } else {
5185
        vshError(ctl, _("Failed to define pool from %s"), from);
5186 5187 5188
        ret = FALSE;
    }
    return ret;
5189 5190
}

5191

5192 5193 5194
/*
 * "pool-define-as" command
 */
5195
static const vshCmdInfo info_pool_define_as[] = {
5196 5197
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
5198 5199 5200 5201
    {NULL, NULL}
};

static int
5202
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
5203 5204
{
    virStoragePoolPtr pool;
5205
    char *xml, *name;
5206
    int printXML = vshCommandOptBool(cmd, "print-xml");
5207

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

5211
    if (!buildPoolXML(cmd, &name, &xml))
5212 5213
        return FALSE;

5214
    if (printXML) {
5215
        vshPrint(ctl, "%s", xml);
5216
        VIR_FREE(xml);
5217
    } else {
5218
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
5219
        VIR_FREE(xml);
5220

5221 5222 5223 5224
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
5225
            vshError(ctl, _("Failed to define pool %s"), name);
5226 5227 5228 5229
            return FALSE;
        }
    }
    return TRUE;
5230 5231 5232
}


5233
/*
5234
 * "pool-build" command
5235
 */
5236
static const vshCmdInfo info_pool_build[] = {
5237 5238
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
5239 5240 5241
    {NULL, NULL}
};

5242
static const vshCmdOptDef opts_pool_build[] = {
5243
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5244 5245 5246 5247
    {NULL, 0, 0, NULL}
};

static int
5248
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
5249
{
5250 5251 5252
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;
5253

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

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

5260
    if (virStoragePoolBuild(pool, 0) == 0) {
5261
        vshPrint(ctl, _("Pool %s built\n"), name);
5262
    } else {
5263
        vshError(ctl, _("Failed to build pool %s"), name);
5264
        ret = FALSE;
5265 5266
    }

5267 5268
    virStoragePoolFree(pool);

5269 5270 5271
    return ret;
}

5272

5273
/*
5274
 * "pool-destroy" command
5275
 */
5276
static const vshCmdInfo info_pool_destroy[] = {
5277 5278
    {"help", N_("destroy a pool")},
    {"desc", N_("Destroy a given pool.")},
5279 5280 5281
    {NULL, NULL}
};

5282
static const vshCmdOptDef opts_pool_destroy[] = {
5283
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5284 5285 5286 5287
    {NULL, 0, 0, NULL}
};

static int
5288
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
5289
{
5290 5291 5292
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;
5293

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

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

5300 5301 5302
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
5303
        vshError(ctl, _("Failed to destroy pool %s"), name);
5304
        ret = FALSE;
5305 5306
    }

5307
    virStoragePoolFree(pool);
5308 5309 5310
    return ret;
}

5311

5312
/*
5313 5314
 * "pool-delete" command
 */
5315
static const vshCmdInfo info_pool_delete[] = {
5316 5317
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
5318 5319 5320
    {NULL, NULL}
};

5321
static const vshCmdOptDef opts_pool_delete[] = {
5322
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5323 5324 5325 5326
    {NULL, 0, 0, NULL}
};

static int
5327
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
5328 5329 5330 5331 5332
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;

5333
    if (!vshConnectionUsability(ctl, ctl->conn))
5334 5335 5336 5337 5338 5339
        return FALSE;

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

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
5340
        vshPrint(ctl, _("Pool %s deleted\n"), name);
5341
    } else {
5342
        vshError(ctl, _("Failed to delete pool %s"), name);
5343 5344 5345
        ret = FALSE;
    }

L
Laine Stump 已提交
5346
    virStoragePoolFree(pool);
5347 5348 5349 5350 5351 5352 5353
    return ret;
}


/*
 * "pool-refresh" command
 */
5354
static const vshCmdInfo info_pool_refresh[] = {
5355 5356
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
5357 5358 5359
    {NULL, NULL}
};

5360
static const vshCmdOptDef opts_pool_refresh[] = {
5361
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5362 5363 5364 5365
    {NULL, 0, 0, NULL}
};

static int
5366
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
5367 5368 5369 5370 5371
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;

5372
    if (!vshConnectionUsability(ctl, ctl->conn))
5373 5374 5375 5376 5377 5378 5379 5380
        return FALSE;

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

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
5381
        vshError(ctl, _("Failed to refresh pool %s"), name);
5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392
        ret = FALSE;
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
5393
static const vshCmdInfo info_pool_dumpxml[] = {
5394 5395
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
5396 5397 5398
    {NULL, NULL}
};

5399
static const vshCmdOptDef opts_pool_dumpxml[] = {
5400
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5401 5402 5403 5404
    {NULL, 0, 0, NULL}
};

static int
5405
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
5406 5407 5408 5409 5410
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *dump;

5411
    if (!vshConnectionUsability(ctl, ctl->conn))
5412 5413 5414 5415 5416 5417 5418
        return FALSE;

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

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
5419
        vshPrint(ctl, "%s", dump);
5420
        VIR_FREE(dump);
5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432
    } else {
        ret = FALSE;
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
5433
static const vshCmdInfo info_pool_list[] = {
5434 5435
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
5436 5437 5438
    {NULL, NULL}
};

5439
static const vshCmdOptDef opts_pool_list[] = {
5440 5441
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
5442
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
5443 5444 5445 5446
    {NULL, 0, 0, NULL}
};

static int
5447
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5448
{
5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467
    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 */
5468
    int all = vshCommandOptBool(cmd, "all");
5469 5470
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
5471 5472 5473
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

5474
    /* Check the connection to libvirtd daemon is still working */
5475
    if (!vshConnectionUsability(ctl, ctl->conn))
5476 5477
        return FALSE;

5478
    /* Retrieve the number of active storage pools */
5479
    if (active) {
5480 5481
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
5482
            vshError(ctl, "%s", _("Failed to list active pools"));
5483 5484 5485
            return FALSE;
        }
    }
5486 5487

    /* Retrieve the number of inactive storage pools */
5488
    if (inactive) {
5489 5490
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
5491
            vshError(ctl, "%s", _("Failed to list inactive pools"));
5492 5493
            return FALSE;
        }
5494
    }
5495

5496 5497
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
5498

5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511
    /* 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;
5512 5513 5514
        }
    }

5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525
    /* 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;
        }
    }
5526

5527 5528 5529 5530 5531 5532 5533 5534 5535 5536
    /* 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]);
5537
        if (!pool) {
5538
            VIR_FREE(poolNames[i]);
5539 5540 5541
            continue;
        }

5542
        /* Retrieve the autostart status of the pool */
5543
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
5544
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
5545
        else
5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563
            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;
        }
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 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676
        /* 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 */
5677 5678 5679
        virStoragePoolFree(pool);
    }

5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697
    /* 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);
5698 5699
        }

5700 5701 5702 5703
        /* Cleanup and return */
        functionReturn = TRUE;
        goto cleanup;
    }
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 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814
    /* 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;
5815

5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827
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]);
5828
    }
5829 5830 5831 5832 5833 5834 5835

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

    /* Return the desired value */
    return functionReturn;
5836 5837
}

5838 5839 5840 5841
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
5842 5843
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
5844 5845 5846 5847 5848
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
5849 5850 5851
     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")},
5852
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
5853 5854 5855 5856 5857 5858 5859 5860 5861
    {NULL, 0, 0, NULL}
};

static int
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
    char *type, *host;
    char *srcSpec = NULL;
    char *srcList;
5862
    char *initiator;
5863 5864 5865 5866 5867 5868 5869 5870
    int found;

    type = vshCommandOptString(cmd, "type", &found);
    if (!found)
        return FALSE;
    host = vshCommandOptString(cmd, "host", &found);
    if (!found)
        host = NULL;
5871 5872 5873
    initiator = vshCommandOptString(cmd, "initiator", &found);
    if (!found)
        initiator = NULL;
5874

5875
    if (!vshConnectionUsability(ctl, ctl->conn))
5876 5877 5878 5879
        return FALSE;

    if (host) {
        char *port = vshCommandOptString(cmd, "port", &found);
5880 5881
        if (!found)
            port = NULL;
5882 5883
        virBuffer buf = VIR_BUFFER_INITIALIZER;
        virBufferAddLit(&buf, "<source>\n");
5884
        virBufferVSprintf(&buf, "  <host name='%s'", host);
5885 5886 5887
        if (port)
            virBufferVSprintf(&buf, " port='%s'", port);
        virBufferAddLit(&buf, "/>\n");
5888 5889 5890 5891 5892
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
            virBufferVSprintf(&buf, "    <iqn name='%s'/>\n", initiator);
            virBufferAddLit(&buf, "  </initiator>\n");
        }
5893 5894 5895
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
5896 5897
            return FALSE;
        }
5898
        srcSpec = virBufferContentAndReset(&buf);
5899 5900 5901
    }

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

    return TRUE;
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
5918 5919
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
5920 5921 5922 5923 5924
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
5925
     N_("type of storage pool sources to discover")},
5926
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
5927
     N_("optional file of source xml to query for pools")},
5928 5929 5930 5931 5932 5933
    {NULL, 0, 0, NULL}
};

static int
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
5934 5935
    char *type, *srcSpecFile, *srcList;
    char *srcSpec = NULL;
5936 5937 5938 5939 5940 5941
    int found;

    type = vshCommandOptString(cmd, "type", &found);
    if (!found)
        return FALSE;
    srcSpecFile = vshCommandOptString(cmd, "srcSpec", &found);
5942
    if (!found)
5943 5944
        srcSpecFile = NULL;

5945
    if (!vshConnectionUsability(ctl, ctl->conn))
5946 5947 5948 5949 5950 5951
        return FALSE;

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

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
5952
    VIR_FREE(srcSpec);
5953
    if (srcList == NULL) {
5954
        vshError(ctl, _("Failed to find any %s pool sources"), type);
5955 5956 5957
        return FALSE;
    }
    vshPrint(ctl, "%s", srcList);
5958
    VIR_FREE(srcList);
5959 5960 5961 5962 5963

    return TRUE;
}


5964 5965 5966
/*
 * "pool-info" command
 */
5967
static const vshCmdInfo info_pool_info[] = {
5968 5969
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
5970 5971 5972
    {NULL, NULL}
};

5973
static const vshCmdOptDef opts_pool_info[] = {
5974
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5975 5976 5977 5978
    {NULL, 0, 0, NULL}
};

static int
5979
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
5980 5981 5982
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
5983 5984
    int autostart = 0;
    int persistent = 0;
5985 5986 5987
    int ret = TRUE;
    char uuid[VIR_UUID_STRING_BUFLEN];

5988
    if (!vshConnectionUsability(ctl, ctl->conn))
5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018
        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;
6019 6020 6021 6022
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
6023 6024
        }

6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040
        /* 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"));

6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063
        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
 */
6064
static const vshCmdInfo info_pool_name[] = {
6065
    {"help", N_("convert a pool UUID to pool name")},
6066
    {"desc", ""},
6067 6068 6069
    {NULL, NULL}
};

6070
static const vshCmdOptDef opts_pool_name[] = {
6071
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
6072 6073 6074 6075
    {NULL, 0, 0, NULL}
};

static int
6076
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
6077 6078 6079
{
    virStoragePoolPtr pool;

6080
    if (!vshConnectionUsability(ctl, ctl->conn))
6081 6082
        return FALSE;
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6083
                                           VSH_BYUUID)))
6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094
        return FALSE;

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


/*
 * "pool-start" command
 */
6095
static const vshCmdInfo info_pool_start[] = {
6096 6097
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
6098 6099 6100
    {NULL, NULL}
};

6101
static const vshCmdOptDef opts_pool_start[] = {
6102
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
6103 6104 6105 6106
    {NULL, 0, 0, NULL}
};

static int
6107
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
6108 6109 6110 6111
{
    virStoragePoolPtr pool;
    int ret = TRUE;

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

6115
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
6116 6117 6118 6119 6120 6121
         return FALSE;

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
6122
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
6123 6124
        ret = FALSE;
    }
L
Laine Stump 已提交
6125 6126

    virStoragePoolFree(pool);
6127 6128 6129 6130
    return ret;
}


6131 6132 6133
/*
 * "vol-create-as" command
 */
6134
static const vshCmdInfo info_vol_create_as[] = {
6135 6136
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
6137 6138 6139
    {NULL, NULL}
};

6140
static const vshCmdOptDef opts_vol_create_as[] = {
6141 6142 6143 6144 6145
    {"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")},
6146 6147
    {"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")},
6148 6149 6150 6151 6152 6153 6154 6155 6156 6157
    {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 已提交
6158
        /* Deliberate fallthrough cases here :-) */
6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179
        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
6180
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
6181 6182 6183 6184
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
    int found;
6185
    char *xml;
6186
    char *name, *capacityStr, *allocationStr, *format;
6187
    char *snapshotStrVol, *snapshotStrFormat;
6188
    unsigned long long capacity, allocation = 0;
6189
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6190

6191
    if (!vshConnectionUsability(ctl, ctl->conn))
6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205
        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)
6206
        vshError(ctl, _("Malformed size %s"), capacityStr);
6207 6208 6209 6210

    allocationStr = vshCommandOptString(cmd, "allocation", &found);
    if (allocationStr &&
        cmdVolSize(allocationStr, &allocation) < 0)
6211
        vshError(ctl, _("Malformed size %s"), allocationStr);
6212 6213

    format = vshCommandOptString(cmd, "format", &found);
6214 6215
    snapshotStrVol = vshCommandOptString(cmd, "backing-vol", &found);
    snapshotStrFormat = vshCommandOptString(cmd, "backing-vol-format", &found);
6216

6217 6218 6219 6220 6221
    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);
6222 6223

    if (format) {
6224
        virBufferAddLit(&buf, "  <target>\n");
6225
        virBufferVSprintf(&buf, "    <format type='%s'/>\n",format);
6226
        virBufferAddLit(&buf, "  </target>\n");
6227
    }
6228

6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283
    /* 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");
6284

6285 6286 6287 6288 6289 6290
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
6291
    VIR_FREE(xml);
6292 6293 6294 6295 6296 6297 6298
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
        return TRUE;
    } else {
6299
        vshError(ctl, _("Failed to create vol %s"), name);
6300 6301 6302 6303
        return FALSE;
    }

 cleanup:
6304
    virBufferFreeAndReset(&buf);
6305 6306 6307 6308 6309
    virStoragePoolFree(pool);
    return FALSE;
}


6310 6311 6312
/*
 * "pool-undefine" command
 */
6313
static const vshCmdInfo info_pool_undefine[] = {
6314 6315
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
6316 6317 6318
    {NULL, NULL}
};

6319
static const vshCmdOptDef opts_pool_undefine[] = {
6320
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6321 6322 6323 6324
    {NULL, 0, 0, NULL}
};

static int
6325
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
6326 6327 6328 6329 6330
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;

6331
    if (!vshConnectionUsability(ctl, ctl->conn))
6332 6333 6334 6335 6336 6337 6338 6339
        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 {
6340
        vshError(ctl, _("Failed to undefine pool %s"), name);
6341 6342 6343
        ret = FALSE;
    }

L
Laine Stump 已提交
6344
    virStoragePoolFree(pool);
6345 6346 6347 6348 6349 6350 6351
    return ret;
}


/*
 * "pool-uuid" command
 */
6352
static const vshCmdInfo info_pool_uuid[] = {
6353
    {"help", N_("convert a pool name to pool UUID")},
6354
    {"desc", ""},
6355 6356 6357
    {NULL, NULL}
};

6358
static const vshCmdOptDef opts_pool_uuid[] = {
6359
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
6360 6361 6362 6363
    {NULL, 0, 0, NULL}
};

static int
6364
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
6365 6366 6367 6368
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

6369
    if (!vshConnectionUsability(ctl, ctl->conn))
6370 6371 6372
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6373
                                           VSH_BYNAME)))
6374 6375 6376 6377 6378
        return FALSE;

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

L
Laine Stump 已提交
6381
    virStoragePoolFree(pool);
6382 6383 6384 6385 6386 6387 6388
    return TRUE;
}


/*
 * "vol-create" command
 */
6389
static const vshCmdInfo info_vol_create[] = {
6390 6391
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
6392 6393 6394
    {NULL, NULL}
};

6395
static const vshCmdOptDef opts_vol_create[] = {
6396 6397
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
6398 6399 6400 6401
    {NULL, 0, 0, NULL}
};

static int
6402
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
6403 6404 6405 6406 6407 6408 6409 6410
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;

6411
    if (!vshConnectionUsability(ctl, ctl->conn))
6412 6413 6414
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6415
                                           VSH_BYNAME)))
6416 6417 6418 6419 6420 6421 6422 6423 6424
        return FALSE;

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
6425
        virshReportError(ctl);
6426 6427 6428 6429 6430
        virStoragePoolFree(pool);
        return FALSE;
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
6431
    VIR_FREE(buffer);
6432 6433 6434 6435 6436 6437 6438
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
6439
        vshError(ctl, _("Failed to create vol from %s"), from);
6440 6441 6442 6443 6444
        ret = FALSE;
    }
    return ret;
}

6445 6446 6447 6448
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
6449 6450
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
6451 6452 6453 6454
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
6455 6456 6457 6458
    {"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")},
6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471
    {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;

6472
    if (!vshConnectionUsability(ctl, ctl->conn))
6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486
        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) {
6487
        virshReportError(ctl);
6488 6489 6490 6491 6492 6493 6494 6495 6496
        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 {
6497
        vshError(ctl, _("Failed to create vol from %s"), from);
6498 6499 6500 6501 6502
        goto cleanup;
    }

    ret = TRUE;
cleanup:
6503
    VIR_FREE(buffer);
6504 6505 6506 6507
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
6508 6509
    if (newvol)
        virStorageVolFree(newvol);
6510 6511 6512 6513 6514 6515
    return ret;
}

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

6516 6517 6518
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548
    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[] = {
6549 6550
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
6551 6552 6553 6554
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
6555 6556 6557
    {"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")},
6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570
    {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;

6571
    if (!vshConnectionUsability(ctl, ctl->conn))
6572 6573 6574 6575 6576 6577 6578
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
6579
        vshError(ctl, "%s", _("failed to get parent pool"));
6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602
        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 {
6603
        vshError(ctl, _("Failed to clone vol from %s"),
6604 6605 6606 6607 6608 6609 6610
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

    ret = TRUE;

cleanup:
6611
    VIR_FREE(origxml);
6612 6613 6614
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
6615 6616
    if (newvol)
        virStorageVolFree(newvol);
6617 6618 6619 6620 6621
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

6622 6623 6624
/*
 * "vol-delete" command
 */
6625
static const vshCmdInfo info_vol_delete[] = {
6626 6627
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
6628 6629 6630
    {NULL, NULL}
};

6631
static const vshCmdOptDef opts_vol_delete[] = {
6632 6633
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
6634 6635 6636 6637
    {NULL, 0, 0, NULL}
};

static int
6638
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
6639 6640 6641 6642 6643
{
    virStorageVolPtr vol;
    int ret = TRUE;
    char *name;

6644
    if (!vshConnectionUsability(ctl, ctl->conn))
6645 6646 6647 6648 6649 6650 6651
        return FALSE;

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

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
6652
        vshPrint(ctl, _("Vol %s deleted\n"), name);
6653
    } else {
6654
        vshError(ctl, _("Failed to delete vol %s"), name);
6655 6656 6657
        ret = FALSE;
    }

L
Laine Stump 已提交
6658
    virStorageVolFree(vol);
6659 6660 6661 6662
    return ret;
}


D
David Allan 已提交
6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684
/*
 * "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;

6685
    if (!vshConnectionUsability(ctl, ctl->conn))
D
David Allan 已提交
6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703
        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;
}


6704 6705 6706
/*
 * "vol-info" command
 */
6707
static const vshCmdInfo info_vol_info[] = {
6708 6709
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
6710 6711 6712
    {NULL, NULL}
};

6713
static const vshCmdOptDef opts_vol_info[] = {
6714 6715
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
6716 6717 6718 6719
    {NULL, 0, 0, NULL}
};

static int
6720
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
6721 6722 6723 6724 6725
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
    int ret = TRUE;

6726
    if (!vshConnectionUsability(ctl, ctl->conn))
6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757
        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
 */
6758
static const vshCmdInfo info_vol_dumpxml[] = {
6759 6760
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
6761 6762 6763
    {NULL, NULL}
};

6764
static const vshCmdOptDef opts_vol_dumpxml[] = {
6765 6766
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
6767 6768 6769 6770
    {NULL, 0, 0, NULL}
};

static int
6771
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
6772 6773 6774 6775 6776
{
    virStorageVolPtr vol;
    int ret = TRUE;
    char *dump;

6777
    if (!vshConnectionUsability(ctl, ctl->conn))
6778 6779 6780 6781 6782 6783 6784
        return FALSE;

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

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
6785
        vshPrint(ctl, "%s", dump);
6786
        VIR_FREE(dump);
6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798
    } else {
        ret = FALSE;
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
6799
static const vshCmdInfo info_vol_list[] = {
6800 6801
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
6802 6803 6804
    {NULL, NULL}
};

6805
static const vshCmdOptDef opts_vol_list[] = {
6806
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6807
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
6808 6809 6810 6811
    {NULL, 0, 0, NULL}
};

static int
6812
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6813
{
6814
    virStorageVolInfo volumeInfo;
6815 6816
    virStoragePoolPtr pool;
    char **activeNames = NULL;
6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833
    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;
6834

6835
    /* Check the connection to libvirtd daemon is still working */
6836
    if (!vshConnectionUsability(ctl, ctl->conn))
6837 6838
        return FALSE;

6839
    /* Look up the pool information given to us by the user */
6840 6841 6842
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
        return FALSE;

6843 6844
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
6845

6846 6847 6848 6849 6850 6851
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
        return FALSE;
    }

6852 6853 6854 6855 6856
    /* 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) {
6857
            vshError(ctl, "%s", _("Failed to list active vols"));
6858
            VIR_FREE(activeNames);
6859 6860 6861 6862
            virStoragePoolFree(pool);
            return FALSE;
        }

6863 6864 6865 6866 6867
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

6870 6871 6872 6873 6874
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
6875

6876 6877 6878 6879
        /* 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"));
6880 6881
        }

6882 6883 6884 6885 6886 6887 6888 6889 6890
        /* 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 */
6891

6892 6893 6894 6895 6896 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
                /* 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;
        }
6947

6948
        /* Cleanup memory allocation */
6949
        virStorageVolFree(vol);
6950 6951 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
    }

    /* 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 已提交
7000 7001 7002 7003 7004
    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);
7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064

    /* 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);
7065
        VIR_FREE(activeNames[i]);
7066
    }
7067 7068 7069 7070

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
7071
    VIR_FREE(activeNames);
7072
    virStoragePoolFree(pool);
7073 7074 7075

    /* Return the desired value */
    return functionReturn;
7076 7077 7078 7079 7080 7081
}


/*
 * "vol-name" command
 */
7082
static const vshCmdInfo info_vol_name[] = {
7083
    {"help", N_("returns the volume name for a given volume key or path")},
7084
    {"desc", ""},
7085 7086 7087
    {NULL, NULL}
};

7088
static const vshCmdOptDef opts_vol_name[] = {
7089
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
7090 7091 7092 7093
    {NULL, 0, 0, NULL}
};

static int
7094
cmdVolName(vshControl *ctl, const vshCmd *cmd)
7095 7096 7097
{
    virStorageVolPtr vol;

7098
    if (!vshConnectionUsability(ctl, ctl->conn))
7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110
        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 已提交
7111 7112 7113 7114 7115 7116 7117 7118 7119 7120
/*
 * "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[] = {
7121
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
7122 7123 7124 7125 7126 7127 7128 7129 7130
    {"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;
7131
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
7132 7133

    /* Check the connection to libvirtd daemon is still working */
7134
    if (!vshConnectionUsability(ctl, ctl->conn))
J
Justin Clift 已提交
7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150
        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;
    }

7151 7152 7153 7154 7155 7156 7157 7158 7159
    /* 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 已提交
7160 7161 7162 7163 7164 7165 7166

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

7167 7168 7169 7170

/*
 * "vol-key" command
 */
7171
static const vshCmdInfo info_vol_key[] = {
7172
    {"help", N_("returns the volume key for a given volume name or path")},
7173
    {"desc", ""},
7174 7175 7176
    {NULL, NULL}
};

7177
static const vshCmdOptDef opts_vol_key[] = {
7178
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7179
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
7180 7181 7182 7183
    {NULL, 0, 0, NULL}
};

static int
7184
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
7185 7186 7187
{
    virStorageVolPtr vol;

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

7191
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203
        return FALSE;

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
    return TRUE;
}



/*
 * "vol-path" command
 */
7204
static const vshCmdInfo info_vol_path[] = {
7205
    {"help", N_("returns the volume path for a given volume name or key")},
7206
    {"desc", ""},
7207 7208 7209
    {NULL, NULL}
};

7210
static const vshCmdOptDef opts_vol_path[] = {
7211
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7212
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
7213 7214 7215 7216
    {NULL, 0, 0, NULL}
};

static int
7217
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
7218 7219
{
    virStorageVolPtr vol;
7220
    char *name = NULL;
7221

7222
    if (!vshConnectionUsability(ctl, ctl->conn))
7223
        return FALSE;
7224 7225

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
7226
        return FALSE;
7227
    }
7228 7229 7230 7231 7232 7233 7234

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
    return TRUE;
}


7235 7236 7237 7238
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
7239 7240
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
7241 7242
    {NULL, NULL}
};
7243

7244
static const vshCmdOptDef opts_secret_define[] = {
7245
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
7246 7247
    {NULL, 0, 0, NULL}
};
7248

7249 7250 7251
static int
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
7252
    char *from, *buffer;
7253
    virSecretPtr res;
7254
    char uuid[VIR_UUID_STRING_BUFLEN];
7255

7256
    if (!vshConnectionUsability(ctl, ctl->conn))
7257 7258 7259 7260 7261 7262 7263 7264 7265 7266
        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);
7267
    VIR_FREE(buffer);
7268 7269

    if (res == NULL) {
7270
        vshError(ctl, _("Failed to set attributes from %s"), from);
7271 7272
        return FALSE;
    }
7273
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
7274
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286
        virSecretFree(res);
        return FALSE;
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
    return TRUE;
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
7287 7288
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
7289 7290 7291 7292
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
7293
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7294 7295 7296 7297 7298 7299 7300 7301 7302 7303
    {NULL, 0, 0, NULL}
};

static int
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    int ret = FALSE;
    char *xml;

7304
    if (!vshConnectionUsability(ctl, ctl->conn))
7305 7306 7307 7308 7309 7310 7311 7312 7313
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
        return FALSE;

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
7314
    vshPrint(ctl, "%s", xml);
7315
    VIR_FREE(xml);
7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
7327 7328
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
7329 7330 7331 7332
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
7333 7334
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345
    {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;

7346
    if (!vshConnectionUsability(ctl, ctl->conn))
7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357
        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 已提交
7358
        vshError(ctl, "%s", _("Invalid base64 data"));
7359 7360 7361
        goto cleanup;
    }
    if (value == NULL) {
7362
        vshError(ctl, "%s", _("Failed to allocate memory"));
7363 7364 7365 7366 7367
        return FALSE;
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
7368
    VIR_FREE(value);
7369 7370

    if (res != 0) {
7371
        vshError(ctl, "%s", _("Failed to set secret value"));
7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385
        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[] = {
7386 7387
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
7388 7389 7390 7391
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
7392
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404
    {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;

7405
    if (!vshConnectionUsability(ctl, ctl->conn))
7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417
        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);
7418
    VIR_FREE(value);
7419 7420

    if (base64 == NULL) {
7421
        vshError(ctl, "%s", _("Failed to allocate memory"));
7422 7423
        goto cleanup;
    }
7424
    vshPrint(ctl, "%s", base64);
7425
    memset(base64, 0, strlen(base64));
7426
    VIR_FREE(base64);
7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
7438 7439
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
7440 7441 7442 7443
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
7444
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7445 7446 7447 7448 7449 7450 7451 7452 7453 7454
    {NULL, 0, 0, NULL}
};

static int
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    int ret = FALSE;
    char *uuid;

7455
    if (!vshConnectionUsability(ctl, ctl->conn))
7456 7457 7458 7459 7460 7461 7462
        return FALSE;

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
        return FALSE;

    if (virSecretUndefine(secret) < 0) {
7463
        vshError(ctl, _("Failed to delete secret %s"), uuid);
7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477
        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[] = {
7478 7479
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
7480 7481 7482 7483 7484 7485 7486 7487 7488
    {NULL, NULL}
};

static int
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

7489
    if (!vshConnectionUsability(ctl, ctl->conn))
7490 7491 7492 7493
        return FALSE;

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
7494
        vshError(ctl, "%s", _("Failed to list secrets"));
7495 7496 7497 7498 7499 7500
        return FALSE;
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
7501
        vshError(ctl, "%s", _("Failed to list secrets"));
7502
        VIR_FREE(uuids);
7503 7504 7505 7506 7507
        return FALSE;
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

7508 7509
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
7510 7511

    for (i = 0; i < maxuuids; i++) {
7512 7513 7514 7515
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
7516
            VIR_FREE(uuids[i]);
7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534
            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);
7535
        VIR_FREE(uuids[i]);
7536
    }
7537
    VIR_FREE(uuids);
7538 7539
    return TRUE;
}
7540 7541 7542 7543 7544


/*
 * "version" command
 */
7545
static const vshCmdInfo info_version[] = {
7546 7547
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
7548 7549 7550 7551 7552
    {NULL, NULL}
};


static int
7553
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564
{
    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;

7565
    if (!vshConnectionUsability(ctl, ctl->conn))
7566 7567 7568 7569
        return FALSE;

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
7570
        vshError(ctl, "%s", _("failed to get hypervisor type"));
7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583
        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) {
7584
        vshError(ctl, "%s", _("failed to get the library version"));
7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602
        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) {
7603
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620
        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;
}

7621 7622 7623 7624
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
7625
    {"help", N_("enumerate devices on this host")},
7626
    {"desc", ""},
7627 7628 7629 7630
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
7631 7632
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
7633 7634 7635
    {NULL, 0, 0, NULL}
};

7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657
#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] = '-';
7658 7659
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
7660 7661 7662
    }

    /* Print this device */
7663
    vshPrint(ctl, "%s", indentBuf);
7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686
    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) {
7687
        vshPrint(ctl, "%s", indentBuf);
7688
        vshPrint(ctl, " |\n");
7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710
    }

    /* 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) {
7711
        vshPrint(ctl, "%s", indentBuf);
7712 7713 7714 7715
        vshPrint(ctl, "\n");
    }
}

7716 7717 7718 7719 7720 7721
static int
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cap;
    char **devices;
    int found, num_devices, i;
7722
    int tree = vshCommandOptBool(cmd, "tree");
7723

7724
    if (!vshConnectionUsability(ctl, ctl->conn))
7725 7726 7727 7728 7729 7730 7731 7732
        return FALSE;

    cap = vshCommandOptString(cmd, "cap", &found);
    if (!found)
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
7733
        vshError(ctl, "%s", _("Failed to count node devices"));
7734 7735 7736 7737 7738 7739 7740 7741 7742
        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) {
7743
        vshError(ctl, "%s", _("Failed to list node devices"));
7744
        VIR_FREE(devices);
7745 7746
        return FALSE;
    }
7747
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
7748 7749 7750 7751 7752 7753 7754
    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 已提交
7755
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774
            } 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++) {
7775 7776
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
7777
        }
7778
        VIR_FREE(parents);
7779 7780 7781
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
7782
            VIR_FREE(devices[i]);
7783
        }
7784
    }
7785
    VIR_FREE(devices);
7786 7787 7788 7789 7790 7791 7792
    return TRUE;
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
7793 7794
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
7795 7796 7797 7798 7799
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
7800
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7801 7802 7803 7804 7805 7806 7807 7808
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
L
Laine Stump 已提交
7809
    char *xml;
7810

7811
    if (!vshConnectionUsability(ctl, ctl->conn))
7812 7813 7814 7815
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7816
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7817 7818 7819
        return FALSE;
    }

L
Laine Stump 已提交
7820 7821 7822 7823 7824 7825 7826
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
        return FALSE;
    }

    vshPrint(ctl, "%s\n", xml);
7827
    VIR_FREE(xml);
7828 7829 7830 7831
    virNodeDeviceFree(device);
    return TRUE;
}

7832 7833 7834 7835
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
7836 7837
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
7838 7839 7840 7841 7842
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
7843
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7844 7845 7846 7847 7848 7849 7850 7851 7852 7853
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
    int ret = TRUE;

7854
    if (!vshConnectionUsability(ctl, ctl->conn))
7855 7856 7857 7858
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7859
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7860 7861 7862 7863 7864 7865
        return FALSE;
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
7866
        vshError(ctl, _("Failed to dettach device %s"), name);
7867 7868 7869 7870 7871 7872 7873 7874 7875 7876
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
7877 7878
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
7879 7880 7881 7882 7883
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
7884
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7885 7886 7887 7888 7889 7890 7891 7892 7893 7894
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
    int ret = TRUE;

7895
    if (!vshConnectionUsability(ctl, ctl->conn))
7896 7897 7898 7899
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7900
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7901 7902 7903 7904 7905 7906
        return FALSE;
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
7907
        vshError(ctl, _("Failed to re-attach device %s"), name);
7908 7909 7910 7911 7912 7913 7914 7915 7916 7917
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
7918 7919
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
7920 7921 7922 7923 7924
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
7925
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7926 7927 7928 7929 7930 7931 7932 7933 7934 7935
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
    int ret = TRUE;

7936
    if (!vshConnectionUsability(ctl, ctl->conn))
7937 7938 7939 7940
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7941
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7942 7943 7944 7945 7946 7947
        return FALSE;
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
7948
        vshError(ctl, _("Failed to reset device %s"), name);
7949 7950 7951 7952 7953 7954
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

7955 7956 7957
/*
 * "hostkey" command
 */
7958
static const vshCmdInfo info_hostname[] = {
7959
    {"help", N_("print the hypervisor hostname")},
7960
    {"desc", ""},
7961 7962 7963 7964
    {NULL, NULL}
};

static int
7965
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7966 7967 7968
{
    char *hostname;

7969
    if (!vshConnectionUsability(ctl, ctl->conn))
7970 7971 7972 7973
        return FALSE;

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
7974
        vshError(ctl, "%s", _("failed to get hostname"));
7975 7976 7977 7978
        return FALSE;
    }

    vshPrint (ctl, "%s\n", hostname);
7979
    VIR_FREE(hostname);
7980 7981 7982 7983 7984 7985 7986

    return TRUE;
}

/*
 * "uri" command
 */
7987
static const vshCmdInfo info_uri[] = {
7988
    {"help", N_("print the hypervisor canonical URI")},
7989
    {"desc", ""},
7990 7991 7992 7993
    {NULL, NULL}
};

static int
7994
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7995 7996 7997
{
    char *uri;

7998
    if (!vshConnectionUsability(ctl, ctl->conn))
7999 8000 8001 8002
        return FALSE;

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
8003
        vshError(ctl, "%s", _("failed to get URI"));
8004 8005 8006 8007
        return FALSE;
    }

    vshPrint (ctl, "%s\n", uri);
8008
    VIR_FREE(uri);
8009 8010 8011 8012 8013 8014 8015

    return TRUE;
}

/*
 * "vncdisplay" command
 */
8016
static const vshCmdInfo info_vncdisplay[] = {
8017 8018
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
8019 8020 8021
    {NULL, NULL}
};

8022
static const vshCmdOptDef opts_vncdisplay[] = {
8023
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8024 8025 8026 8027
    {NULL, 0, 0, NULL}
};

static int
8028
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
8029 8030 8031 8032 8033 8034 8035 8036 8037
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    int ret = FALSE;
    int port = 0;
    char *doc;

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

J
Jim Meyering 已提交
8041
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8042 8043 8044 8045 8046 8047 8048 8049 8050
        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);
8051
    VIR_FREE(doc);
8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069
    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) ||
8070
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090
        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
 */
8091
static const vshCmdInfo info_ttyconsole[] = {
8092 8093
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
8094 8095 8096
    {NULL, NULL}
};

8097
static const vshCmdOptDef opts_ttyconsole[] = {
8098
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8099 8100 8101 8102
    {NULL, 0, 0, NULL}
};

static int
8103
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
8104 8105 8106 8107 8108 8109 8110 8111
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    int ret = FALSE;
    char *doc;

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

J
Jim Meyering 已提交
8115
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8116 8117 8118 8119 8120 8121 8122 8123 8124
        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);
8125
    VIR_FREE(doc);
8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137
    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);
8138
    ret = TRUE;
8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150

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

/*
 * "attach-device" command
8151
 */
8152
static const vshCmdInfo info_attach_device[] = {
8153 8154
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
8155 8156 8157
    {NULL, NULL}
};

8158
static const vshCmdOptDef opts_attach_device[] = {
8159 8160 8161
    {"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")},
8162 8163 8164 8165
    {NULL, 0, 0, NULL}
};

static int
8166
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
8167 8168 8169 8170 8171 8172
{
    virDomainPtr dom;
    char *from;
    char *buffer;
    int ret = TRUE;
    int found;
J
Jim Fehlig 已提交
8173
    unsigned int flags;
8174

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

J
Jim Meyering 已提交
8178
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8179 8180 8181 8182 8183 8184 8185 8186
        return FALSE;

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

8187
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8188
        virshReportError(ctl);
8189
        virDomainFree(dom);
8190
        return FALSE;
8191
    }
8192

J
Jim Fehlig 已提交
8193 8194 8195 8196 8197 8198 8199 8200
    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);
    }
8201
    VIR_FREE(buffer);
8202 8203

    if (ret < 0) {
8204
        vshError(ctl, _("Failed to attach device from %s"), from);
8205 8206
        virDomainFree(dom);
        return FALSE;
8207
    } else {
J
Jim Meyering 已提交
8208
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
8209 8210 8211 8212 8213 8214 8215 8216 8217 8218
    }

    virDomainFree(dom);
    return TRUE;
}


/*
 * "detach-device" command
 */
8219
static const vshCmdInfo info_detach_device[] = {
8220 8221
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
8222 8223 8224
    {NULL, NULL}
};

8225
static const vshCmdOptDef opts_detach_device[] = {
8226 8227 8228
    {"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")},
8229 8230 8231 8232
    {NULL, 0, 0, NULL}
};

static int
8233
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
8234 8235 8236 8237 8238 8239
{
    virDomainPtr dom;
    char *from;
    char *buffer;
    int ret = TRUE;
    int found;
J
Jim Fehlig 已提交
8240
    unsigned int flags;
8241

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

J
Jim Meyering 已提交
8245
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8246 8247 8248 8249 8250 8251 8252 8253
        return FALSE;

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

8254
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8255
        virshReportError(ctl);
8256
        virDomainFree(dom);
8257
        return FALSE;
8258
    }
8259

J
Jim Fehlig 已提交
8260 8261 8262 8263 8264 8265 8266 8267
    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);
    }
8268
    VIR_FREE(buffer);
8269 8270

    if (ret < 0) {
8271
        vshError(ctl, _("Failed to detach device from %s"), from);
8272 8273
        virDomainFree(dom);
        return FALSE;
8274
    } else {
J
Jim Meyering 已提交
8275
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
8276 8277 8278 8279 8280 8281
    }

    virDomainFree(dom);
    return TRUE;
}

8282

8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295
/*
 * "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")},
8296
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309
    {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;

8310
    if (!vshConnectionUsability(ctl, ctl->conn))
8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322
        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) {
8323
        virshReportError(ctl);
8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334
        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;
    }
8335 8336 8337 8338

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354
    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;
}


8355 8356 8357
/*
 * "attach-interface" command
 */
8358
static const vshCmdInfo info_attach_interface[] = {
8359 8360
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
8361 8362 8363
    {NULL, NULL}
};

8364
static const vshCmdOptDef opts_attach_interface[] = {
8365 8366 8367 8368 8369 8370
    {"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")},
8371
    {"model", VSH_OT_DATA, 0, N_("model type")},
8372
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
8373 8374 8375 8376
    {NULL, 0, 0, NULL}
};

static int
8377
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
8378 8379
{
    virDomainPtr dom = NULL;
8380
    char *mac, *target, *script, *type, *source, *model;
8381
    int typ, ret = FALSE;
J
Jim Fehlig 已提交
8382
    unsigned int flags;
8383 8384
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
8385

8386
    if (!vshConnectionUsability(ctl, ctl->conn))
8387 8388
        goto cleanup;

J
Jim Meyering 已提交
8389
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8390 8391 8392 8393 8394 8395 8396 8397 8398
        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);
8399
    model = vshCommandOptString(cmd, "model", NULL);
8400 8401

    /* check interface type */
8402
    if (STREQ(type, "network")) {
8403
        typ = 1;
8404
    } else if (STREQ(type, "bridge")) {
8405 8406
        typ = 2;
    } else {
E
Eric Blake 已提交
8407 8408
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
8409 8410 8411 8412
        goto cleanup;
    }

    /* Make XML of interface */
8413
    virBufferVSprintf(&buf, "<interface type='%s'>\n", type);
8414

8415 8416 8417 8418
    if (typ == 1)
        virBufferVSprintf(&buf, "  <source network='%s'/>\n", source);
    else if (typ == 2)
        virBufferVSprintf(&buf, "  <source bridge='%s'/>\n", source);
8419

8420 8421 8422 8423 8424 8425
    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);
8426 8427
    if (model != NULL)
        virBufferVSprintf(&buf, "  <model type='%s'/>\n", model);
8428

8429
    virBufferAddLit(&buf, "</interface>\n");
8430

8431 8432 8433
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
8434 8435
    }

8436
    xml = virBufferContentAndReset(&buf);
8437

J
Jim Fehlig 已提交
8438 8439 8440 8441
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
8442
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
8443
    } else {
8444
        ret = virDomainAttachDevice(dom, xml);
8445
    }
8446

8447 8448
    VIR_FREE(xml);

J
Jim Fehlig 已提交
8449
    if (ret != 0) {
L
Laine Stump 已提交
8450
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
8451 8452 8453 8454 8455
        ret = FALSE;
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
        ret = TRUE;
    }
8456 8457 8458 8459

 cleanup:
    if (dom)
        virDomainFree(dom);
8460
    virBufferFreeAndReset(&buf);
8461 8462 8463 8464 8465 8466
    return ret;
}

/*
 * "detach-interface" command
 */
8467
static const vshCmdInfo info_detach_interface[] = {
8468 8469
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
8470 8471 8472
    {NULL, NULL}
};

8473
static const vshCmdOptDef opts_detach_interface[] = {
8474 8475 8476 8477
    {"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")},
8478 8479 8480 8481
    {NULL, 0, 0, NULL}
};

static int
8482
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
8483 8484 8485 8486 8487 8488 8489 8490 8491 8492
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    char *doc, *mac =NULL, *type;
    char buf[64];
    int i = 0, diff_mac, ret = FALSE;
J
Jim Fehlig 已提交
8493
    unsigned int flags;
8494

8495
    if (!vshConnectionUsability(ctl, ctl->conn))
8496 8497
        goto cleanup;

J
Jim Meyering 已提交
8498
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512
        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);
8513
    VIR_FREE(doc);
8514
    if (!xml) {
8515
        vshError(ctl, "%s", _("Failed to get interface information"));
8516 8517 8518 8519
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
8520
        vshError(ctl, "%s", _("Failed to get interface information"));
8521 8522 8523
        goto cleanup;
    }

E
Eric Blake 已提交
8524
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
8525 8526 8527
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
8528
        vshError(ctl, _("No found interface whose type is %s"), type);
8529 8530 8531 8532 8533 8534 8535 8536 8537 8538
        goto cleanup;
    }

    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
8539 8540 8541 8542 8543
            if (cur->type == XML_ELEMENT_NODE &&
                xmlStrEqual(cur->name, BAD_CAST "mac")) {
                char *tmp_mac = virXMLPropString(cur, "address");
                diff_mac = virMacAddrCompare (tmp_mac, mac);
                VIR_FREE(tmp_mac);
8544 8545 8546 8547 8548 8549 8550
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
8551
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
8552 8553 8554 8555 8556
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
8557
        vshError(ctl, "%s", _("Failed to allocate memory"));
8558 8559 8560 8561
        goto cleanup;
    }

    if(xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0){
8562
        vshError(ctl, "%s", _("Failed to create XML"));
8563 8564 8565
        goto cleanup;
    }

J
Jim Fehlig 已提交
8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577
    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 已提交
8578
        vshError(ctl, "%s", _("Failed to detach interface"));
8579
        ret = FALSE;
J
Jim Fehlig 已提交
8580
    } else {
J
Jim Meyering 已提交
8581
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
8582
        ret = TRUE;
8583
    }
8584 8585 8586 8587

 cleanup:
    if (dom)
        virDomainFree(dom);
8588
    xmlXPathFreeObject(obj);
8589
    xmlXPathFreeContext(ctxt);
8590 8591 8592 8593 8594 8595 8596 8597 8598 8599
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    return ret;
}

/*
 * "attach-disk" command
 */
8600
static const vshCmdInfo info_attach_disk[] = {
8601 8602
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
8603 8604 8605
    {NULL, NULL}
};

8606
static const vshCmdOptDef opts_attach_disk[] = {
8607 8608 8609 8610 8611 8612 8613 8614
    {"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")},
8615
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
8616 8617 8618 8619
    {NULL, 0, 0, NULL}
};

static int
8620
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
8621 8622 8623 8624
{
    virDomainPtr dom = NULL;
    char *source, *target, *driver, *subdriver, *type, *mode;
    int isFile = 0, ret = FALSE;
J
Jim Fehlig 已提交
8625
    unsigned int flags;
8626
    char *stype;
8627 8628
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
8629

8630
    if (!vshConnectionUsability(ctl, ctl->conn))
8631 8632
        goto cleanup;

J
Jim Meyering 已提交
8633
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645
        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);
8646
    stype = vshCommandOptString(cmd, "sourcetype", NULL);
8647

8648 8649
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
8650
            isFile = 1;
8651 8652 8653 8654 8655
    } else if (STREQ(stype, "file")) {
        isFile = 1;
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
8656 8657 8658
    }

    if (mode) {
8659
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
8660 8661
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
8662 8663 8664 8665 8666
            goto cleanup;
        }
    }

    /* Make XML of disk */
8667 8668 8669 8670 8671 8672
    virBufferVSprintf(&buf, "<disk type='%s'",
                      (isFile) ? "file" : "block");
    if (type)
        virBufferVSprintf(&buf, " device='%s'", type);
    virBufferAddLit(&buf, ">\n");

8673 8674 8675 8676 8677
    if (driver || subdriver)
        virBufferVSprintf(&buf, "  <driver");

    if (driver)
        virBufferVSprintf(&buf, " name='%s'", driver);
8678 8679
    if (subdriver)
        virBufferVSprintf(&buf, " type='%s'", subdriver);
8680 8681 8682

    if (driver || subdriver)
        virBufferAddLit(&buf, "/>\n");
8683 8684 8685 8686 8687 8688 8689 8690 8691

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

8693 8694 8695
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
8696 8697
    }

8698
    xml = virBufferContentAndReset(&buf);
8699

J
Jim Fehlig 已提交
8700 8701 8702 8703
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
8704
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
8705
    } else {
8706
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
8707
    }
8708

8709 8710
    VIR_FREE(xml);

J
Jim Fehlig 已提交
8711
    if (ret != 0) {
L
Laine Stump 已提交
8712
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
8713 8714 8715 8716 8717
        ret = FALSE;
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
        ret = TRUE;
    }
8718 8719 8720 8721

 cleanup:
    if (dom)
        virDomainFree(dom);
8722
    virBufferFreeAndReset(&buf);
8723 8724 8725 8726 8727 8728
    return ret;
}

/*
 * "detach-disk" command
 */
8729
static const vshCmdInfo info_detach_disk[] = {
8730 8731
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
8732 8733 8734
    {NULL, NULL}
};

8735
static const vshCmdOptDef opts_detach_disk[] = {
8736 8737 8738
    {"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")},
8739 8740 8741 8742
    {NULL, 0, 0, NULL}
};

static int
8743
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
8744 8745 8746 8747 8748 8749 8750 8751 8752
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
    char *doc, *target;
    int i = 0, diff_tgt, ret = FALSE;
J
Jim Fehlig 已提交
8753
    unsigned int flags;
8754

8755
    if (!vshConnectionUsability(ctl, ctl->conn))
8756 8757
        goto cleanup;

J
Jim Meyering 已提交
8758
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770
        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);
8771
    VIR_FREE(doc);
8772
    if (!xml) {
8773
        vshError(ctl, "%s", _("Failed to get disk information"));
8774 8775 8776 8777
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
8778
        vshError(ctl, "%s", _("Failed to get disk information"));
8779 8780 8781 8782 8783 8784
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
8785
        vshError(ctl, "%s", _("Failed to get disk information"));
8786 8787 8788 8789 8790 8791 8792
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
8793 8794 8795 8796 8797
            if (cur->type == XML_ELEMENT_NODE &&
                xmlStrEqual(cur->name, BAD_CAST "target")) {
                char *tmp_tgt = virXMLPropString(cur, "dev");
                diff_tgt = STREQ(tmp_tgt, target);
                VIR_FREE(tmp_tgt);
8798 8799 8800 8801 8802 8803 8804
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
8805
    vshError(ctl, _("No found disk whose target is %s"), target);
8806 8807 8808 8809 8810
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
8811
        vshError(ctl, "%s", _("Failed to allocate memory"));
8812 8813 8814 8815
        goto cleanup;
    }

    if(xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0){
8816
        vshError(ctl, "%s", _("Failed to create XML"));
8817 8818 8819
        goto cleanup;
    }

J
Jim Fehlig 已提交
8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831
    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 已提交
8832
        vshError(ctl, "%s", _("Failed to detach disk"));
8833
        ret = FALSE;
J
Jim Fehlig 已提交
8834
    } else {
J
Jim Meyering 已提交
8835
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
8836
        ret = TRUE;
8837
    }
8838 8839

 cleanup:
8840
    xmlXPathFreeObject(obj);
8841
    xmlXPathFreeContext(ctxt);
8842 8843 8844 8845 8846 8847 8848 8849 8850
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
    return ret;
}

8851 8852 8853 8854
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
8855 8856
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
8857 8858 8859 8860
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
8861
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873
    {NULL, 0, 0, NULL}
};

static int
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;
    int result;

8874
    if (!vshConnectionUsability(ctl, ctl->conn))
8875 8876 8877 8878 8879 8880 8881 8882 8883 8884
        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);
8885
    VIR_FREE(buffer);
8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914

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

8915 8916 8917 8918
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
8919 8920
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
8921 8922 8923 8924
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
8925
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939
    {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;
8940
    xmlNodePtr node_list;
8941 8942 8943 8944 8945 8946
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

8947
    if (!vshConnectionUsability(ctl, ctl->conn))
8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960
        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 已提交
8961 8962
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029
    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;
9030
    goto cleanup;
9031 9032
}

9033 9034 9035 9036 9037 9038 9039 9040
/* 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;

9041
    ret = vshMalloc(ctl, PATH_MAX);
9042 9043 9044

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
9045 9046
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
9047
    if (fd == -1) {
9048
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
9049
                 strerror(errno));
9050
        VIR_FREE(ret);
9051 9052 9053 9054
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
9055 9056
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
9057
        VIR_FORCE_CLOSE(fd);
9058
        unlink (ret);
9059
        VIR_FREE(ret);
9060 9061
        return NULL;
    }
S
Stefan Berger 已提交
9062
    if (VIR_CLOSE(fd) < 0) {
9063 9064
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
9065
        unlink (ret);
9066
        VIR_FREE(ret);
9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084
        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;

9085 9086
    editor = getenv ("VISUAL");
    if (!editor) editor = getenv ("EDITOR");
9087 9088
    if (!editor) editor = "vi"; /* could be cruel & default to ed(1) here */

9089 9090 9091 9092 9093 9094
    /* 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).
9095 9096
     */
    if (strspn (filename, ACCEPTED_CHARS) != strlen (filename)) {
9097 9098 9099
        vshError(ctl,
                 _("%s: temporary filename contains shell meta or other "
                   "unacceptable characters (is $TMPDIR wrong?)"),
9100 9101 9102 9103
                 filename);
        return -1;
    }

9104
    if (virAsprintf(&command, "%s %s", editor, filename) == -1) {
9105
        vshError(ctl,
9106
                 _("virAsprintf: could not create editing command: %s"),
9107
                 strerror(errno));
9108 9109 9110 9111 9112
        return -1;
    }

    command_ret = system (command);
    if (command_ret == -1) {
9113 9114
        vshError(ctl,
                 _("%s: edit command failed: %s"), command, strerror(errno));
9115
        VIR_FREE(command);
9116 9117
        return -1;
    }
9118
    if (WEXITSTATUS(command_ret) != 0) {
9119
        vshError(ctl,
9120
                 _("%s: command exited with non-zero status"), command);
9121
        VIR_FREE(command);
9122 9123
        return -1;
    }
9124
    VIR_FREE(command);
9125 9126 9127 9128 9129 9130 9131 9132 9133
    return 0;
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
9134
        vshError(ctl,
9135
                 _("%s: failed to read temporary file: %s"),
9136
                 filename, strerror(errno));
9137 9138 9139 9140 9141
        return NULL;
    }
    return ret;
}

9142 9143

#ifndef WIN32
P
Paolo Bonzini 已提交
9144 9145 9146 9147
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
9148 9149
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
9150 9151 9152 9153
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
9154
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
9155 9156 9157 9158 9159 9160 9161 9162 9163 9164
    {NULL, 0, 0, NULL}
};

static int
cmdCd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    const char *dir;
    int found;

    if (!ctl->imode) {
9165
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
C
Chris Lalancette 已提交
9166
        return FALSE;
P
Paolo Bonzini 已提交
9167 9168 9169 9170 9171
    }

    dir = vshCommandOptString(cmd, "dir", &found);
    if (!found) {
        uid_t uid = geteuid();
9172
        dir = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
9173 9174 9175 9176 9177
    }
    if (!dir)
        dir = "/";

    if (chdir (dir) == -1) {
9178
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
C
Chris Lalancette 已提交
9179
        return FALSE;
P
Paolo Bonzini 已提交
9180 9181
    }

C
Chris Lalancette 已提交
9182
    return TRUE;
P
Paolo Bonzini 已提交
9183 9184
}

9185 9186 9187
#endif

#ifndef WIN32
P
Paolo Bonzini 已提交
9188 9189 9190 9191
/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
9192 9193
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215
    {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)
9216 9217
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
P
Paolo Bonzini 已提交
9218 9219 9220
    else
        vshPrint (ctl, _("%s\n"), cwd);

9221
    VIR_FREE(cwd);
P
Paolo Bonzini 已提交
9222 9223
    return !err;
}
9224
#endif
P
Paolo Bonzini 已提交
9225

E
Eric Blake 已提交
9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 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
/*
 * "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;
}

9300 9301 9302 9303
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
9304 9305
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
9306 9307 9308 9309
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
9310
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325
    {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;
9326
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
9327

9328
    if (!vshConnectionUsability(ctl, ctl->conn))
9329 9330
        goto cleanup;

J
Jim Meyering 已提交
9331
    dom = vshCommandOptDomain (ctl, cmd, NULL);
9332 9333 9334 9335
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
9336
    doc = virDomainGetXMLDesc (dom, flags);
9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362
    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.
     */
9363
    doc_reread = virDomainGetXMLDesc (dom, flags);
9364 9365 9366 9367
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
9368 9369
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387
        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);

9388 9389 9390
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
9391 9392 9393

    if (tmp) {
        unlink (tmp);
9394
        VIR_FREE(tmp);
9395 9396 9397 9398 9399 9400 9401 9402 9403
    }

    return ret;
}

/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
9404 9405
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
9406 9407 9408 9409
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
9410
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
9411 9412 9413 9414 9415 9416 9417 9418 9419 9420
    {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[] = {
9421 9422
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
9423 9424 9425 9426
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
9427
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9428 9429 9430 9431 9432 9433
    {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 已提交
9434 9435 9436
/*
 * "quit" command
 */
9437
static const vshCmdInfo info_quit[] = {
9438
    {"help", N_("quit this interactive terminal")},
9439
    {"desc", ""},
9440
    {NULL, NULL}
K
Karel Zak 已提交
9441 9442 9443
};

static int
9444
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9445
{
K
Karel Zak 已提交
9446 9447 9448 9449
    ctl->imode = FALSE;
    return TRUE;
}

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

9478
    if (!vshConnectionUsability(ctl, ctl->conn))
9479 9480 9481 9482 9483 9484 9485 9486
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    from = vshCommandOptString(cmd, "xmlfile", NULL);
    if (from == NULL)
E
Eric Blake 已提交
9487
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 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 9564 9565 9566 9567 9568 9569 9570
    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;

9571
    if (!vshConnectionUsability(ctl, ctl->conn))
9572 9573 9574 9575 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
        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;
9627
    int actual = 0;
9628 9629 9630 9631 9632 9633 9634 9635 9636 9637
    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;

9638
    if (!vshConnectionUsability(ctl, ctl->conn))
9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 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 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696
        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);
9697
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713

            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);
9714 9715
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746
    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;

9747
    if (!vshConnectionUsability(ctl, ctl->conn))
9748 9749 9750 9751 9752 9753 9754
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    name = vshCommandOptString(cmd, "snapshotname", NULL);
9755
    if (name == NULL)
9756 9757 9758 9759 9760 9761 9762 9763 9764 9765
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

9766
    vshPrint(ctl, "%s", xml);
9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780

    ret = TRUE;

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
9781
 * "snapshot-revert" command
9782
 */
9783
static const vshCmdInfo info_snapshot_revert[] = {
9784 9785 9786 9787 9788
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

9789
static const vshCmdOptDef opts_snapshot_revert[] = {
9790 9791 9792 9793 9794 9795
    {"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
9796
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
9797 9798 9799 9800 9801 9802
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
    char *name;
    virDomainSnapshotPtr snapshot = NULL;

9803
    if (!vshConnectionUsability(ctl, ctl->conn))
9804 9805 9806 9807 9808 9809 9810
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    name = vshCommandOptString(cmd, "snapshotname", NULL);
9811
    if (name == NULL)
9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 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
        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;

9857
    if (!vshConnectionUsability(ctl, ctl->conn))
9858 9859 9860 9861 9862 9863 9864
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    name = vshCommandOptString(cmd, "snapshotname", NULL);
9865
    if (name == NULL)
9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888
        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;
}

9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939
/*
 * "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;
}

9940
static const vshCmdDef domManagementCmds[] = {
9941 9942 9943
    {"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},
9944
    {"autostart", cmdAutostart, opts_autostart, info_autostart},
9945
#ifndef WIN32
9946
    {"console", cmdConsole, opts_console, info_console},
9947
#endif
9948
    {"cpu-baseline", cmdCPUBaseline, opts_cpu_baseline, info_cpu_baseline},
9949
    {"cpu-compare", cmdCPUCompare, opts_cpu_compare, info_cpu_compare},
9950
    {"create", cmdCreate, opts_create, info_create},
9951
    {"define", cmdDefine, opts_define, info_define},
K
Karel Zak 已提交
9952
    {"destroy", cmdDestroy, opts_destroy, info_destroy},
9953 9954 9955
    {"detach-device", cmdDetachDevice, opts_detach_device, info_detach_device},
    {"detach-disk", cmdDetachDisk, opts_detach_disk, info_detach_disk},
    {"detach-interface", cmdDetachInterface, opts_detach_interface, info_detach_interface},
K
Karel Zak 已提交
9956
    {"domid", cmdDomid, opts_domid, info_domid},
9957
    {"domjobabort", cmdDomjobabort, opts_domjobabort, info_domjobabort},
9958
    {"domjobinfo", cmdDomjobinfo, opts_domjobinfo, info_domjobinfo},
K
Karel Zak 已提交
9959
    {"domname", cmdDomname, opts_domname, info_domname},
9960
    {"domuuid", cmdDomuuid, opts_domuuid, info_domuuid},
9961 9962
    {"domxml-from-native", cmdDomXMLFromNative, opts_domxmlfromnative, info_domxmlfromnative},
    {"domxml-to-native", cmdDomXMLToNative, opts_domxmltonative, info_domxmltonative},
9963
    {"dump", cmdDump, opts_dump, info_dump},
9964
    {"dumpxml", cmdDumpXML, opts_dumpxml, info_dumpxml},
9965
    {"edit", cmdEdit, opts_edit, info_edit},
9966 9967
    {"managedsave", cmdManagedSave, opts_managedsave, info_managedsave},
    {"managedsave-remove", cmdManagedSaveRemove, opts_managedsaveremove, info_managedsaveremove},
E
Eric Blake 已提交
9968
    {"maxvcpus", cmdMaxvcpus, opts_maxvcpus, info_maxvcpus},
9969
    {"memtune", cmdMemtune, opts_memtune, info_memtune},
9970
    {"migrate", cmdMigrate, opts_migrate, info_migrate},
9971
    {"migrate-setmaxdowntime", cmdMigrateSetMaxDowntime, opts_migrate_setmaxdowntime, info_migrate_setmaxdowntime},
9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005
    {"reboot", cmdReboot, opts_reboot, info_reboot},
    {"restore", cmdRestore, opts_restore, info_restore},
    {"resume", cmdResume, opts_resume, info_resume},
    {"save", cmdSave, opts_save, info_save},
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo},
    {"setmaxmem", cmdSetmaxmem, opts_setmaxmem, info_setmaxmem},
    {"setmem", cmdSetmem, opts_setmem, info_setmem},
    {"setvcpus", cmdSetvcpus, opts_setvcpus, info_setvcpus},
    {"shutdown", cmdShutdown, opts_shutdown, info_shutdown},
    {"start", cmdStart, opts_start, info_start},
    {"suspend", cmdSuspend, opts_suspend, info_suspend},
    {"ttyconsole", cmdTTYConsole, opts_ttyconsole, info_ttyconsole},
    {"undefine", cmdUndefine, opts_undefine, info_undefine},
    {"update-device", cmdUpdateDevice, opts_update_device, info_update_device},
    {"vcpucount", cmdVcpucount, opts_vcpucount, info_vcpucount},
    {"vcpuinfo", cmdVcpuinfo, opts_vcpuinfo, info_vcpuinfo},
    {"vcpupin", cmdVcpupin, opts_vcpupin, info_vcpupin},
    {"version", cmdVersion, NULL, info_version},
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay},
    {NULL, NULL, NULL, NULL}
};

static const vshCmdDef domMonitoringCmds[] = {
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat},
    {"domifstat", cmdDomIfstat, opts_domifstat, info_domifstat},
    {"dominfo", cmdDominfo, opts_dominfo, info_dominfo},
    {"dommemstat", cmdDomMemStat, opts_dommemstat, info_dommemstat},
    {"domstate", cmdDomstate, opts_domstate, info_domstate},
    {"list", cmdList, opts_list, info_list},
    {NULL, NULL, NULL, NULL}
};

static const vshCmdDef storagePoolCmds[] = {
10006 10007 10008 10009
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as},
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
     opts_find_storage_pool_sources, info_find_storage_pool_sources},
10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045
    {"pool-autostart", cmdPoolAutostart, opts_pool_autostart, info_pool_autostart},
    {"pool-build", cmdPoolBuild, opts_pool_build, info_pool_build},
    {"pool-create-as", cmdPoolCreateAs, opts_pool_X_as, info_pool_create_as},
    {"pool-create", cmdPoolCreate, opts_pool_create, info_pool_create},
    {"pool-define-as", cmdPoolDefineAs, opts_pool_X_as, info_pool_define_as},
    {"pool-define", cmdPoolDefine, opts_pool_define, info_pool_define},
    {"pool-delete", cmdPoolDelete, opts_pool_delete, info_pool_delete},
    {"pool-destroy", cmdPoolDestroy, opts_pool_destroy, info_pool_destroy},
    {"pool-dumpxml", cmdPoolDumpXML, opts_pool_dumpxml, info_pool_dumpxml},
    {"pool-edit", cmdPoolEdit, opts_pool_edit, info_pool_edit},
    {"pool-info", cmdPoolInfo, opts_pool_info, info_pool_info},
    {"pool-list", cmdPoolList, opts_pool_list, info_pool_list},
    {"pool-name", cmdPoolName, opts_pool_name, info_pool_name},
    {"pool-refresh", cmdPoolRefresh, opts_pool_refresh, info_pool_refresh},
    {"pool-start", cmdPoolStart, opts_pool_start, info_pool_start},
    {"pool-undefine", cmdPoolUndefine, opts_pool_undefine, info_pool_undefine},
    {"pool-uuid", cmdPoolUuid, opts_pool_uuid, info_pool_uuid},
    {NULL, NULL, NULL, NULL}
};

static const vshCmdDef storageVolCmds[] = {
    {"vol-clone", cmdVolClone, opts_vol_clone, info_vol_clone},
    {"vol-create-as", cmdVolCreateAs, opts_vol_create_as, info_vol_create_as},
    {"vol-create", cmdVolCreate, opts_vol_create, info_vol_create},
    {"vol-create-from", cmdVolCreateFrom, opts_vol_create_from, info_vol_create_from},
    {"vol-delete", cmdVolDelete, opts_vol_delete, info_vol_delete},
    {"vol-dumpxml", cmdVolDumpXML, opts_vol_dumpxml, info_vol_dumpxml},
    {"vol-info", cmdVolInfo, opts_vol_info, info_vol_info},
    {"vol-key", cmdVolKey, opts_vol_key, info_vol_key},
    {"vol-list", cmdVolList, opts_vol_list, info_vol_list},
    {"vol-name", cmdVolName, opts_vol_name, info_vol_name},
    {"vol-path", cmdVolPath, opts_vol_path, info_vol_path},
    {"vol-pool", cmdVolPool, opts_vol_pool, info_vol_pool},
    {"vol-wipe", cmdVolWipe, opts_vol_wipe, info_vol_wipe},
    {NULL, NULL, NULL, NULL}
};
10046

10047
static const vshCmdDef networkCmds[] = {
10048
    {"net-autostart", cmdNetworkAutostart, opts_network_autostart, info_network_autostart},
10049 10050 10051 10052
    {"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},
10053
    {"net-edit", cmdNetworkEdit, opts_network_edit, info_network_edit},
O
Osier Yang 已提交
10054
    {"net-info", cmdNetworkInfo, opts_network_info, info_network_info},
10055 10056 10057 10058 10059
    {"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},
10060 10061
    {NULL, NULL, NULL, NULL}
};
10062

10063 10064 10065
static const vshCmdDef nodedevCmds[] = {
    {"nodedev-create", cmdNodeDeviceCreate, opts_node_device_create, info_node_device_create},
    {"nodedev-destroy", cmdNodeDeviceDestroy, opts_node_device_destroy, info_node_device_destroy},
10066
    {"nodedev-dettach", cmdNodeDeviceDettach, opts_node_device_dettach, info_node_device_dettach},
10067 10068
    {"nodedev-dumpxml", cmdNodeDeviceDumpXML, opts_node_device_dumpxml, info_node_device_dumpxml},
    {"nodedev-list", cmdNodeListDevices, opts_node_list_devices, info_node_list_devices},
10069 10070
    {"nodedev-reattach", cmdNodeDeviceReAttach, opts_node_device_reattach, info_node_device_reattach},
    {"nodedev-reset", cmdNodeDeviceReset, opts_node_device_reset, info_node_device_reset},
10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085
    {NULL, NULL, NULL, NULL}
};

static const vshCmdDef ifaceCmds[] = {
    {"iface-define", cmdInterfaceDefine, opts_interface_define, info_interface_define},
    {"iface-destroy", cmdInterfaceDestroy, opts_interface_destroy, info_interface_destroy},
    {"iface-dumpxml", cmdInterfaceDumpXML, opts_interface_dumpxml, info_interface_dumpxml},
    {"iface-edit", cmdInterfaceEdit, opts_interface_edit, info_interface_edit},
    {"iface-list", cmdInterfaceList, opts_interface_list, info_interface_list},
    {"iface-mac", cmdInterfaceMAC, opts_interface_mac, info_interface_mac},
    {"iface-name", cmdInterfaceName, opts_interface_name, info_interface_name},
    {"iface-start", cmdInterfaceStart, opts_interface_start, info_interface_start},
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine, info_interface_undefine},
    {NULL, NULL, NULL, NULL}
};
10086

10087
static const vshCmdDef nwfilterCmds[] = {
10088 10089 10090
    {"nwfilter-define", cmdNWFilterDefine, opts_nwfilter_define, info_nwfilter_define},
    {"nwfilter-dumpxml", cmdNWFilterDumpXML, opts_nwfilter_dumpxml, info_nwfilter_dumpxml},
    {"nwfilter-edit", cmdNWFilterEdit, opts_nwfilter_edit, info_nwfilter_edit},
10091 10092 10093 10094
    {"nwfilter-list", cmdNWFilterList, opts_nwfilter_list, info_nwfilter_list},
    {"nwfilter-undefine", cmdNWFilterUndefine, opts_nwfilter_undefine, info_nwfilter_undefine},
    {NULL, NULL, NULL, NULL}
};
10095

10096
static const vshCmdDef secretCmds[] = {
10097 10098 10099 10100
    {"secret-define", cmdSecretDefine, opts_secret_define, info_secret_define},
    {"secret-dumpxml", cmdSecretDumpXML, opts_secret_dumpxml, info_secret_dumpxml},
    {"secret-get-value", cmdSecretGetValue, opts_secret_get_value, info_secret_get_value},
    {"secret-list", cmdSecretList, NULL, info_secret_list},
10101 10102 10103 10104
    {"secret-set-value", cmdSecretSetValue, opts_secret_set_value, info_secret_set_value},
    {"secret-undefine", cmdSecretUndefine, opts_secret_undefine, info_secret_undefine},
    {NULL, NULL, NULL, NULL}
};
10105

10106 10107 10108 10109 10110 10111 10112
static const vshCmdDef virshCmds[] = {
#ifndef WIN32
    {"cd", cmdCd, opts_cd, info_cd},
#endif
    {"echo", cmdEcho, opts_echo, info_echo},
    {"exit", cmdQuit, NULL, info_quit},
    {"help", cmdHelp, opts_help, info_help},
10113
#ifndef WIN32
P
Paolo Bonzini 已提交
10114
    {"pwd", cmdPwd, NULL, info_pwd},
10115
#endif
K
Karel Zak 已提交
10116
    {"quit", cmdQuit, NULL, info_quit},
10117 10118
    {NULL, NULL, NULL, NULL}
};
10119

10120
static const vshCmdDef snapshotCmds[] = {
10121 10122 10123 10124 10125
    {"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},
10126
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert, info_snapshot_revert},
10127 10128
    {NULL, NULL, NULL, NULL}
};
10129

10130 10131 10132 10133 10134
static const vshCmdDef hostAndHypervisorCmds[] = {
    {"capabilities", cmdCapabilities, NULL, info_capabilities},
    {"connect", cmdConnect, opts_connect, info_connect},
    {"freecell", cmdFreecell, opts_freecell, info_freecell},
    {"hostname", cmdHostname, NULL, info_hostname},
10135
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo},
10136
    {"qemu-monitor-command", cmdQemuMonitorCommand, opts_qemu_monitor_command, info_qemu_monitor_command},
10137
    {"uri", cmdURI, NULL, info_uri},
10138
    {NULL, NULL, NULL, NULL}
K
Karel Zak 已提交
10139 10140
};

10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157
static const vshCmdGrp cmdGroups[] = {
    {VSH_CMD_GRP_DOM_MANAGEMENT, "domain", domManagementCmds},
    {VSH_CMD_GRP_DOM_MONITORING, "monitor", domMonitoringCmds},
    {VSH_CMD_GRP_HOST_AND_HV, "host", hostAndHypervisorCmds},
    {VSH_CMD_GRP_IFACE, "interface", ifaceCmds},
    {VSH_CMD_GRP_NWFILTER, "filter", nwfilterCmds},
    {VSH_CMD_GRP_NETWORK, "network", networkCmds},
    {VSH_CMD_GRP_NODEDEV, "nodedev", nodedevCmds},
    {VSH_CMD_GRP_SECRET, "secret", secretCmds},
    {VSH_CMD_GRP_SNAPSHOT, "snapshot", snapshotCmds},
    {VSH_CMD_GRP_STORAGE_POOL, "pool", storagePoolCmds},
    {VSH_CMD_GRP_STORAGE_VOL, "volume", storageVolCmds},
    {VSH_CMD_GRP_VIRSH, "virsh", virshCmds},
    {NULL, NULL, NULL}
};


K
Karel Zak 已提交
10158 10159 10160 10161
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
10162
static const char *
10163
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
10164
{
10165
    const vshCmdInfo *info;
10166

K
Karel Zak 已提交
10167
    for (info = cmd->info; info && info->name; info++) {
10168
        if (STREQ(info->name, name))
K
Karel Zak 已提交
10169 10170 10171 10172 10173
            return info->data;
    }
    return NULL;
}

10174 10175
static const vshCmdOptDef *
vshCmddefGetOption(const vshCmdDef * cmd, const char *name)
10176
{
10177
    const vshCmdOptDef *opt;
10178

K
Karel Zak 已提交
10179
    for (opt = cmd->opts; opt && opt->name; opt++)
10180
        if (STREQ(opt->name, name))
K
Karel Zak 已提交
10181 10182 10183 10184
            return opt;
    return NULL;
}

10185 10186
static const vshCmdOptDef *
vshCmddefGetData(const vshCmdDef * cmd, int data_ct)
10187
{
10188
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
10189

10190
    for (opt = cmd->opts; opt && opt->name; opt++) {
10191 10192
        if (opt->type >= VSH_OT_DATA ||
            (opt->type == VSH_OT_INT && (opt->flag & VSH_OFLAG_REQ))) {
10193
            if (data_ct == 0 || opt->type == VSH_OT_ARGV)
10194 10195 10196 10197 10198
                return opt;
            else
                data_ct--;
        }
    }
K
Karel Zak 已提交
10199 10200 10201
    return NULL;
}

10202 10203 10204
/*
 * Checks for required options
 */
10205
static int
10206
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd)
10207
{
10208 10209
    const vshCmdDef *def = cmd->def;
    const vshCmdOptDef *d;
10210
    int err = 0;
10211 10212 10213 10214

    for (d = def->opts; d && d->name; d++) {
        if (d->flag & VSH_OFLAG_REQ) {
            vshCmdOpt *o = cmd->opts;
10215 10216 10217
            int ok = 0;

            while (o && ok == 0) {
10218
                if (o->def == d)
10219
                    ok = 1;
10220 10221 10222
                o = o->next;
            }
            if (!ok) {
10223
                vshError(ctl,
10224
                         d->type == VSH_OT_DATA ?
10225
                         _("command '%s' requires <%s> option") :
10226
                         _("command '%s' requires --%s option"),
10227
                         def->name, d->name);
10228 10229
                err = 1;
            }
10230

10231 10232 10233 10234 10235
        }
    }
    return !err;
}

10236
static const vshCmdDef *
10237 10238
vshCmddefSearch(const char *cmdname)
{
10239
    const vshCmdGrp *g;
10240
    const vshCmdDef *c;
10241

10242 10243 10244 10245 10246 10247 10248
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
            if(STREQ(c->name, cmdname))
                return c;
        }
    }

K
Karel Zak 已提交
10249 10250 10251
    return NULL;
}

10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
        if(STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
            return g;
    }

    return NULL;
}

static int
vshCmdGrpHelp(vshControl *ctl, const char *grpname)
{
    const vshCmdGrp *grp = vshCmdGrpSearch(grpname);
    const vshCmdDef *cmd = NULL;

    if (!grp) {
        vshError(ctl, _("command group '%s' doesn't exist"), grpname);
        return FALSE;
    } else {
        vshPrint(ctl, _(" %s (help keyword '%s'):\n"), grp->name,
                 grp->keyword);

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

    return TRUE;
}

K
Karel Zak 已提交
10287
static int
10288
vshCmddefHelp(vshControl *ctl, const char *cmdname)
10289
{
10290
    const vshCmdDef *def = vshCmddefSearch(cmdname);
10291

K
Karel Zak 已提交
10292
    if (!def) {
10293
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
10294 10295
        return FALSE;
    } else {
E
Eric Blake 已提交
10296 10297
        const char *desc = _(vshCmddefGetInfo(def, "desc"));
        const char *help = _(vshCmddefGetInfo(def, "help"));
10298
        char buf[256];
K
Karel Zak 已提交
10299

10300
        fputs(_("  NAME\n"), stdout);
10301 10302
        fprintf(stdout, "    %s - %s\n", def->name, help);

10303 10304 10305 10306 10307 10308
        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;
10309 10310
                switch (opt->type) {
                case VSH_OT_BOOL:
10311
                    fmt = "[--%s]";
10312 10313
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
10314
                    /* xgettext:c-format */
10315 10316
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
10317 10318
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
10319 10320
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
10321 10322
                    break;
                case VSH_OT_DATA:
10323
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
10324 10325 10326 10327 10328 10329
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
                    fmt = _("[<string>]...");
                    break;
                default:
10330
                    assert(0);
10331
                }
10332
                fputc(' ', stdout);
E
Eric Blake 已提交
10333
                fprintf(stdout, fmt, opt->name);
10334
            }
K
Karel Zak 已提交
10335
        }
10336 10337 10338
        fputc('\n', stdout);

        if (desc[0]) {
10339
            /* Print the description only if it's not empty.  */
10340
            fputs(_("\n  DESCRIPTION\n"), stdout);
K
Karel Zak 已提交
10341 10342
            fprintf(stdout, "    %s\n", desc);
        }
10343

K
Karel Zak 已提交
10344
        if (def->opts) {
10345
            const vshCmdOptDef *opt;
10346
            fputs(_("\n  OPTIONS\n"), stdout);
10347
            for (opt = def->opts; opt->name; opt++) {
10348 10349
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
10350
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
10351 10352
                    break;
                case VSH_OT_INT:
10353 10354 10355
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
10356 10357
                    break;
                case VSH_OT_STRING:
10358
                    /* OT_STRING should never be VSH_OFLAG_REQ */
10359
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
10360 10361
                    break;
                case VSH_OT_DATA:
10362 10363
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
10364 10365 10366 10367 10368 10369 10370
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
                    continue;
                default:
                    assert(0);
                }
10371

E
Eric Blake 已提交
10372
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
10373
            }
K
Karel Zak 已提交
10374 10375 10376 10377 10378 10379 10380 10381 10382 10383
        }
        fputc('\n', stdout);
    }
    return TRUE;
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
10384 10385 10386
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
10387 10388
    vshCmdOpt *a = arg;

10389
    while (a) {
K
Karel Zak 已提交
10390
        vshCmdOpt *tmp = a;
10391

K
Karel Zak 已提交
10392 10393
        a = a->next;

10394 10395
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
10396 10397 10398 10399
    }
}

static void
10400
vshCommandFree(vshCmd *cmd)
10401
{
K
Karel Zak 已提交
10402 10403
    vshCmd *c = cmd;

10404
    while (c) {
K
Karel Zak 已提交
10405
        vshCmd *tmp = c;
10406

K
Karel Zak 已提交
10407 10408 10409 10410
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
10411
        VIR_FREE(tmp);
K
Karel Zak 已提交
10412 10413 10414 10415 10416 10417 10418
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
10419
vshCommandOpt(const vshCmd *cmd, const char *name)
10420
{
K
Karel Zak 已提交
10421
    vshCmdOpt *opt = cmd->opts;
10422 10423

    while (opt) {
10424
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
10425 10426 10427 10428 10429 10430 10431 10432 10433 10434
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
 * Returns option as INT
 */
static int
10435
vshCommandOptInt(const vshCmd *cmd, const char *name, int *found)
10436
{
K
Karel Zak 已提交
10437
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
10438 10439
    int res = 0, num_found = FALSE;
    char *end_p = NULL;
10440

10441 10442
    if ((arg != NULL) && (arg->data != NULL)) {
        res = strtol(arg->data, &end_p, 10);
10443 10444 10445 10446
        if ((arg->data == end_p) || (*end_p!= 0))
            num_found = FALSE;
        else
            num_found = TRUE;
10447
    }
K
Karel Zak 已提交
10448
    if (found)
10449
        *found = num_found;
K
Karel Zak 已提交
10450 10451 10452
    return res;
}

10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472
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 已提交
10473 10474 10475 10476
/*
 * Returns option as STRING
 */
static char *
10477
vshCommandOptString(const vshCmd *cmd, const char *name, int *found)
10478
{
K
Karel Zak 已提交
10479
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
10480

K
Karel Zak 已提交
10481 10482
    if (found)
        *found = arg ? TRUE : FALSE;
10483

10484 10485 10486
    if (arg && arg->data && *arg->data)
        return arg->data;

10487
    if (arg && arg->def && ((arg->def->flag) & VSH_OFLAG_REQ))
10488 10489 10490
        vshError(NULL, _("Missing required option '%s'"), name);

    return NULL;
K
Karel Zak 已提交
10491 10492
}

10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510
/*
 * 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 已提交
10511 10512 10513 10514
/*
 * Returns TRUE/FALSE if the option exists
 */
static int
10515
vshCommandOptBool(const vshCmd *cmd, const char *name)
10516
{
K
Karel Zak 已提交
10517 10518 10519
    return vshCommandOpt(cmd, name) ? TRUE : FALSE;
}

10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540
/*
 * 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 已提交
10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558
/* 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)
10559
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
10560 10561 10562
                 cmd->def->name, optname);
    return found;
}
10563

K
Karel Zak 已提交
10564
static virDomainPtr
J
Jim Meyering 已提交
10565
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
10566
                      char **name, int flag)
10567
{
K
Karel Zak 已提交
10568
    virDomainPtr dom = NULL;
10569
    char *n;
K
Karel Zak 已提交
10570
    int id;
J
Jim Meyering 已提交
10571 10572 10573
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
10574

10575
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10576 10577
        return NULL;

K
Karel Zak 已提交
10578
    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
10579 10580
             cmd->def->name, optname, n);

K
Karel Zak 已提交
10581 10582
    if (name)
        *name = n;
10583

K
Karel Zak 已提交
10584
    /* try it by ID */
10585
    if (flag & VSH_BYID) {
10586
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
10587 10588 10589 10590
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
10591
    }
K
Karel Zak 已提交
10592
    /* try it by UUID */
10593
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
10594
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
10595
                 cmd->def->name, optname);
K
Karel Zak 已提交
10596
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
10597
    }
K
Karel Zak 已提交
10598
    /* try it by NAME */
10599
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
10600
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
10601
                 cmd->def->name, optname);
K
Karel Zak 已提交
10602
        dom = virDomainLookupByName(ctl->conn, n);
10603
    }
K
Karel Zak 已提交
10604

10605
    if (!dom)
10606
        vshError(ctl, _("failed to get domain '%s'"), n);
10607

K
Karel Zak 已提交
10608 10609 10610
    return dom;
}

10611
static virNetworkPtr
J
Jim Meyering 已提交
10612
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
10613
                       char **name, int flag)
10614 10615 10616
{
    virNetworkPtr network = NULL;
    char *n;
J
Jim Meyering 已提交
10617 10618 10619
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
10620

10621
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10622 10623 10624 10625 10626 10627 10628 10629 10630
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
10631
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
10632
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
10633
                 cmd->def->name, optname);
10634 10635 10636 10637
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
10638
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
10639 10640 10641 10642 10643
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
10644
        vshError(ctl, _("failed to get network '%s'"), n);
10645 10646 10647 10648

    return network;
}

10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659

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;

10660
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687
        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;
}

10688 10689 10690 10691 10692 10693 10694 10695 10696 10697
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;

10698
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10699 10700 10701 10702 10703 10704 10705 10706 10707
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
10708
    if ((flag & VSH_BYNAME)) {
10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720
        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)
10721
        vshError(ctl, _("failed to get interface '%s'"), n);
10722 10723 10724 10725

    return iface;
}

10726
static virStoragePoolPtr
10727
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
10728 10729 10730 10731 10732
                    char **name, int flag)
{
    virStoragePoolPtr pool = NULL;
    char *n;

10733
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10734 10735 10736 10737 10738 10739 10740 10741 10742
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
10743
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
10744
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
10745
                 cmd->def->name, optname);
10746 10747 10748
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
10749
    if (pool == NULL && (flag & VSH_BYNAME)) {
10750 10751 10752 10753 10754 10755
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
10756
        vshError(ctl, _("failed to get pool '%s'"), n);
10757 10758 10759 10760 10761

    return pool;
}

static virStorageVolPtr
10762
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
10763 10764 10765 10766 10767 10768 10769 10770 10771
                   const char *optname,
                   const char *pooloptname,
                   char **name, int flag)
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
    char *n, *p;
    int found;

10772
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10773 10774
        return NULL;

10775
    if (!(p = vshCommandOptString(cmd, pooloptname, &found)) && found)
10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786
        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;

10787
    /* try it by name */
10788
    if (pool && (flag & VSH_BYNAME)) {
10789
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
10790 10791 10792
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
10793
    /* try it by key */
10794 10795 10796 10797 10798
    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);
    }
10799
    /* try it by path */
10800 10801 10802 10803 10804 10805 10806
    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)
10807
        vshError(ctl, _("failed to get vol '%s'"), n);
10808 10809 10810 10811 10812 10813 10814

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825
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);
10826
    if (n == NULL)
10827 10828 10829 10830 10831 10832 10833 10834 10835 10836
        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)
10837
        vshError(ctl, _("failed to get secret '%s'"), n);
10838 10839 10840 10841

    return secret;
}

K
Karel Zak 已提交
10842 10843 10844 10845
/*
 * Executes command(s) and returns return code from last command
 */
static int
10846
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
10847
{
K
Karel Zak 已提交
10848
    int ret = TRUE;
10849 10850

    while (cmd) {
K
Karel Zak 已提交
10851
        struct timeval before, after;
10852
        bool enable_timing = ctl->timing;
10853

10854 10855 10856
        if ((ctl->conn == NULL) || (disconnected != 0))
            vshReconnect(ctl);

10857
        if (enable_timing)
K
Karel Zak 已提交
10858
            GETTIMEOFDAY(&before);
10859

K
Karel Zak 已提交
10860 10861
        ret = cmd->def->handler(ctl, cmd);

10862
        if (enable_timing)
K
Karel Zak 已提交
10863
            GETTIMEOFDAY(&after);
10864

J
John Levon 已提交
10865 10866 10867
        if (ret == FALSE)
            virshReportError(ctl);

10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878
        /* 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);

10879
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
10880 10881
            return ret;

10882
        if (enable_timing)
10883
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
10884 10885
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
10886
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
10887 10888 10889 10890 10891 10892
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
10893
 * Command parsing
K
Karel Zak 已提交
10894 10895 10896
 * ---------------
 */

10897 10898 10899 10900 10901 10902 10903 10904 10905 10906
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 已提交
10907
    /* vshCommandStringGetArg() */
10908
    char *pos;
L
Lai Jiangshan 已提交
10909 10910 10911
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
10912 10913
} vshCommandParser;

K
Karel Zak 已提交
10914
static int
10915
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
10916
{
K
Karel Zak 已提交
10917 10918 10919
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
10920

K
Karel Zak 已提交
10921 10922 10923 10924
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
10925

10926
    while (1) {
K
Karel Zak 已提交
10927
        vshCmdOpt *last = NULL;
10928
        const vshCmdDef *cmd = NULL;
10929
        vshCommandToken tk;
L
Lai Jiangshan 已提交
10930
        bool data_only = false;
10931
        int data_ct = 0;
10932

K
Karel Zak 已提交
10933
        first = NULL;
10934

10935
        while (1) {
10936
            const vshCmdOptDef *opt = NULL;
10937

K
Karel Zak 已提交
10938
            tkdata = NULL;
10939
            tk = parser->getNextArg(ctl, parser, &tkdata);
10940 10941

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
10942
                goto syntaxError;
H
Hu Tao 已提交
10943 10944
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
10945
                break;
H
Hu Tao 已提交
10946
            }
10947 10948

            if (cmd == NULL) {
K
Karel Zak 已提交
10949 10950
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
10951
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
10952
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
10953
                }
10954
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
10955 10956 10957 10958
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
10959 10960 10961 10962 10963 10964
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
                if (!(opt = vshCmddefGetOption(cmd, tkdata + 2))) {
10965
                    vshError(ctl,
10966
                             _("command '%s' doesn't support option --%s"),
10967 10968
                             cmd->name, tkdata + 2);
                    VIR_FREE(optstr);
K
Karel Zak 已提交
10969 10970
                    goto syntaxError;
                }
10971
                VIR_FREE(tkdata);
K
Karel Zak 已提交
10972 10973 10974

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
10975 10976 10977
                    if (optstr)
                        tkdata = optstr;
                    else
10978
                        tk = parser->getNextArg(ctl, parser, &tkdata);
10979
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
10980
                        goto syntaxError;
10981
                    if (tk != VSH_TK_ARG) {
10982
                        vshError(ctl,
10983
                                 _("expected syntax: --%s <%s>"),
10984 10985
                                 opt->name,
                                 opt->type ==
10986
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
10987 10988
                        goto syntaxError;
                    }
10989 10990 10991 10992 10993 10994 10995 10996
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
10997
                }
L
Lai Jiangshan 已提交
10998 10999 11000 11001
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
11002
            } else {
L
Lai Jiangshan 已提交
11003
get_data:
11004
                if (!(opt = vshCmddefGetData(cmd, data_ct++))) {
11005
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
11006 11007 11008 11009 11010
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
11011
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
11012

K
Karel Zak 已提交
11013 11014 11015 11016
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
11017

K
Karel Zak 已提交
11018 11019 11020 11021 11022
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
11023

K
Karel Zak 已提交
11024
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
11025 11026
                         cmd->name,
                         opt->name,
11027 11028
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
11029 11030
            }
        }
11031

D
Daniel Veillard 已提交
11032
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
11033
        if (cmd) {
11034
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
11035

K
Karel Zak 已提交
11036 11037 11038 11039
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

11040
            if (!vshCommandCheckOpts(ctl, c)) {
11041
                VIR_FREE(c);
11042
                goto syntaxError;
11043
            }
11044

K
Karel Zak 已提交
11045 11046 11047 11048 11049 11050
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
11051 11052 11053

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
11054
    }
11055

K
Karel Zak 已提交
11056 11057
    return TRUE;

11058
 syntaxError:
11059
    if (ctl->cmd) {
K
Karel Zak 已提交
11060
        vshCommandFree(ctl->cmd);
11061 11062
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
11063 11064
    if (first)
        vshCommandOptFree(first);
11065
    VIR_FREE(tkdata);
11066
    return FALSE;
K
Karel Zak 已提交
11067 11068
}

11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176
/* --------------------
 * 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 已提交
11177
/* ---------------
11178
 * Misc utils
K
Karel Zak 已提交
11179 11180
 * ---------------
 */
K
Karel Zak 已提交
11181
static const char *
11182 11183
vshDomainStateToString(int state)
{
K
Karel Zak 已提交
11184
    switch (state) {
11185
    case VIR_DOMAIN_RUNNING:
11186
        return N_("running");
11187
    case VIR_DOMAIN_BLOCKED:
11188
        return N_("idle");
11189
    case VIR_DOMAIN_PAUSED:
11190
        return N_("paused");
11191
    case VIR_DOMAIN_SHUTDOWN:
11192
        return N_("in shutdown");
11193
    case VIR_DOMAIN_SHUTOFF:
11194
        return N_("shut off");
11195
    case VIR_DOMAIN_CRASHED:
11196
        return N_("crashed");
11197
    default:
11198
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
11199
    }
11200
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
11201 11202
}

11203 11204 11205 11206
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
11207
    case VIR_VCPU_OFFLINE:
11208
        return N_("offline");
11209
    case VIR_VCPU_BLOCKED:
11210
        return N_("idle");
11211
    case VIR_VCPU_RUNNING:
11212
        return N_("running");
11213
    default:
11214
        ;/*FALLTHROUGH*/
11215
    }
11216
    return N_("no state");
11217 11218
}

K
Karel Zak 已提交
11219
static int
11220
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
11221
{
11222 11223
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
11224 11225
     */
    if (!conn) {
11226
        vshError(ctl, "%s", _("no valid connection"));
K
Karel Zak 已提交
11227 11228 11229 11230 11231
        return FALSE;
    }
    return TRUE;
}

K
Karel Zak 已提交
11232
static void
11233
vshDebug(vshControl *ctl, int level, const char *format, ...)
11234
{
K
Karel Zak 已提交
11235 11236
    va_list ap;

11237 11238 11239 11240
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
11241 11242 11243 11244 11245 11246
    if (level > ctl->debug)
        return;

    va_start(ap, format);
    vfprintf(stdout, format, ap);
    va_end(ap);
K
Karel Zak 已提交
11247 11248 11249
}

static void
11250
vshPrintExtra(vshControl *ctl, const char *format, ...)
11251
{
K
Karel Zak 已提交
11252
    va_list ap;
11253

K
Karel Zak 已提交
11254
    if (ctl->quiet == TRUE)
K
Karel Zak 已提交
11255
        return;
11256

K
Karel Zak 已提交
11257
    va_start(ap, format);
11258
    vfprintf(stdout, format, ap);
K
Karel Zak 已提交
11259 11260 11261
    va_end(ap);
}

K
Karel Zak 已提交
11262

K
Karel Zak 已提交
11263
static void
11264
vshError(vshControl *ctl, const char *format, ...)
11265
{
K
Karel Zak 已提交
11266
    va_list ap;
11267

11268 11269 11270 11271 11272
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
11273

11274
    fputs(_("error: "), stderr);
11275

K
Karel Zak 已提交
11276 11277 11278 11279 11280 11281 11282 11283
    va_start(ap, format);
    vfprintf(stderr, format, ap);
    va_end(ap);

    fputc('\n', stderr);
}

/*
11284
 * Initialize connection.
K
Karel Zak 已提交
11285 11286
 */
static int
11287
vshInit(vshControl *ctl)
11288
{
K
Karel Zak 已提交
11289 11290 11291
    if (ctl->conn)
        return FALSE;

11292 11293
    vshOpenLogFile(ctl);

11294 11295
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
11296

11297 11298 11299
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

11300 11301 11302 11303 11304 11305 11306 11307
    virEventRegisterImpl(virEventAddHandleImpl,
                         virEventUpdateHandleImpl,
                         virEventRemoveHandleImpl,
                         virEventAddTimeoutImpl,
                         virEventUpdateTimeoutImpl,
                         virEventRemoveTimeoutImpl);
    virEventInit();

11308 11309 11310 11311
    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

11312

11313 11314 11315 11316
    /* This is not necessarily fatal.  All the individual commands check
     * vshConnectionUsability, except ones which don't need a connection
     * such as "help".
     */
11317
    if (!ctl->conn) {
11318
        virshReportError(ctl);
11319
        vshError(ctl, "%s", _("failed to connect to the hypervisor"));
11320 11321
        return FALSE;
    }
K
Karel Zak 已提交
11322 11323 11324 11325

    return TRUE;
}

11326 11327
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346
/**
 * 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:
11347
                vshError(ctl, "%s",
J
Jim Meyering 已提交
11348
                         _("failed to get the log file information"));
11349
                exit(EXIT_FAILURE);
11350 11351 11352
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
11353 11354
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
11355 11356 11357 11358
        }
    }

    /* log file open */
11359
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
11360
        vshError(ctl, "%s",
J
Jim Meyering 已提交
11361
                 _("failed to open the log file. check the log file path"));
11362
        exit(EXIT_FAILURE);
11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427
    }
}

/**
 * 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 */
11428
    if (safewrite(ctl->log_fd, msg_buf, strlen(msg_buf)) < 0) {
11429
        vshCloseLogFile(ctl);
11430
        vshError(ctl, "%s", _("failed to write the log file"));
11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442
    }
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
11443 11444 11445
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
11446 11447 11448
    }

    if (ctl->logfile) {
11449
        VIR_FREE(ctl->logfile);
11450 11451 11452 11453
        ctl->logfile = NULL;
    }
}

11454
#ifdef USE_READLINE
11455

K
Karel Zak 已提交
11456 11457 11458 11459 11460
/* -----------------
 * Readline stuff
 * -----------------
 */

11461
/*
K
Karel Zak 已提交
11462 11463
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
11464
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
11465 11466
 */
static char *
11467 11468
vshReadlineCommandGenerator(const char *text, int state)
{
11469
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
11470
    const char *name;
11471 11472
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
11473 11474

    if (!state) {
11475 11476
        grp_list_index = 0;
        cmd_list_index = 0;
11477
        len = strlen(text);
K
Karel Zak 已提交
11478 11479
    }

11480 11481
    grp = cmdGroups;

K
Karel Zak 已提交
11482
    /* Return the next name which partially matches from the
11483
     * command list.
K
Karel Zak 已提交
11484
     */
11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498
    while (grp[grp_list_index].name) {
        cmds = grp[grp_list_index].commands;

        if (cmds[cmd_list_index].name) {
            while ((name = cmds[cmd_list_index].name)) {
                cmd_list_index++;

                if (STREQLEN(name, text, len))
                    return vshStrdup(NULL, name);
            }
        } else {
            cmd_list_index = 0;
            grp_list_index++;
        }
K
Karel Zak 已提交
11499 11500 11501 11502 11503 11504 11505
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
11506 11507
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
11508
    static int list_index, len;
11509
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
11510
    const char *name;
K
Karel Zak 已提交
11511 11512 11513 11514 11515 11516 11517 11518 11519

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

11520
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
11521
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
11522 11523 11524

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
11525
        len = strlen(text);
11526
        VIR_FREE(cmdname);
K
Karel Zak 已提交
11527 11528 11529 11530
    }

    if (!cmd)
        return NULL;
11531

11532 11533 11534
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
11535
    while ((name = cmd->opts[list_index].name)) {
11536
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
11537
        char *res;
11538

K
Karel Zak 已提交
11539
        list_index++;
11540

K
Karel Zak 已提交
11541
        if (opt->type == VSH_OT_DATA)
K
Karel Zak 已提交
11542 11543
            /* ignore non --option */
            continue;
11544

K
Karel Zak 已提交
11545
        if (len > 2) {
11546
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
11547 11548
                continue;
        }
11549
        res = vshMalloc(NULL, strlen(name) + 3);
11550
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
11551 11552 11553 11554 11555 11556 11557 11558
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
11559 11560 11561
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
11562 11563
    char **matches = (char **) NULL;

11564
    if (start == 0)
K
Karel Zak 已提交
11565
        /* command name generator */
11566
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
11567 11568
    else
        /* commands options */
11569
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
11570 11571 11572 11573
    return matches;
}


11574 11575
static int
vshReadlineInit(vshControl *ctl)
11576
{
11577 11578
    char *userdir = NULL;

K
Karel Zak 已提交
11579 11580 11581 11582 11583
    /* 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;
11584 11585 11586

    /* Limit the total size of the history buffer */
    stifle_history(500);
11587 11588

    /* Prepare to read/write history from/to the ~/.virsh/history file */
11589
    userdir = virGetUserDirectory(getuid());
11590 11591 11592 11593 11594 11595

    if (userdir == NULL)
        return -1;

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
11596
        VIR_FREE(userdir);
11597 11598 11599 11600 11601
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
11602
        VIR_FREE(userdir);
11603 11604 11605
        return -1;
    }

11606
    VIR_FREE(userdir);
11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624

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

11625 11626
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
11627 11628
}

11629 11630 11631 11632 11633 11634
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

11635
#else /* !USE_READLINE */
11636

11637 11638 11639 11640 11641 11642 11643
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

11644
static void
11645
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668
{
    /* 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);
}

11669
#endif /* !USE_READLINE */
11670

K
Karel Zak 已提交
11671
/*
J
Jim Meyering 已提交
11672
 * Deinitialize virsh
K
Karel Zak 已提交
11673 11674
 */
static int
11675
vshDeinit(vshControl *ctl)
11676
{
11677
    vshReadlineDeinit(ctl);
11678
    vshCloseLogFile(ctl);
11679
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
11680
    if (ctl->conn) {
11681 11682 11683
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
11684 11685
        }
    }
D
Daniel P. Berrange 已提交
11686 11687
    virResetLastError();

K
Karel Zak 已提交
11688 11689
    return TRUE;
}
11690

K
Karel Zak 已提交
11691 11692 11693 11694
/*
 * Print usage
 */
static void
11695
vshUsage(void)
11696
{
11697
    const vshCmdGrp *grp;
11698
    const vshCmdDef *cmd;
11699

L
Lai Jiangshan 已提交
11700 11701
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
11702 11703 11704 11705 11706 11707 11708 11709
                      "  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"
11710
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
11711
                      "    -V | --version=long     version and full options\n\n"
11712
                      "  commands (non interactive mode):\n\n"), progname, progname);
11713

11714 11715
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
11716

11717 11718 11719 11720 11721 11722 11723 11724 11725
        for (cmd = grp->commands; cmd->name; cmd++)
            fprintf(stdout,
                    "    %-30s %s\n", cmd->name, _(vshCmddefGetInfo(cmd, "help")));

        fprintf(stdout, "\n");
    }

    fprintf(stdout, "%s",
            _("\n  (specify help <group> for details about the commands in the group)\n"));
11726 11727 11728
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
11729 11730
}

11731 11732 11733 11734 11735 11736 11737 11738 11739 11740
/*
 * 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 已提交
11741 11742
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777
#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 已提交
11778
    vshPrint(ctl, "%s", _(" Networking:"));
11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804
#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 已提交
11805
    vshPrint(ctl, "%s", _(" Storage:"));
11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828
#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 已提交
11829
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853
#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 已提交
11854 11855 11856 11857 11858
/*
 * argv[]:  virsh [options] [command]
 *
 */
static int
11859
vshParseArgv(vshControl *ctl, int argc, char **argv)
11860
{
11861 11862
    bool help = false;
    int arg;
K
Karel Zak 已提交
11863
    struct option opt[] = {
E
Eric Blake 已提交
11864 11865 11866 11867 11868 11869 11870 11871 11872
        {"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}
11873 11874
    };

11875 11876 11877
    /* 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. */
11878
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
11879
        switch (arg) {
11880
        case 'd':
D
Daniel Veillard 已提交
11881
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
11882
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
11883 11884
                exit(EXIT_FAILURE);
            }
11885 11886
            break;
        case 'h':
11887
            help = true;
11888 11889 11890 11891 11892 11893 11894 11895 11896 11897
            break;
        case 'q':
            ctl->quiet = TRUE;
            break;
        case 't':
            ctl->timing = TRUE;
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
11898 11899 11900 11901 11902 11903
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
11904 11905 11906
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
11907 11908 11909
        case 'r':
            ctl->readonly = TRUE;
            break;
11910 11911 11912
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
11913
        default:
11914 11915
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
11916 11917 11918 11919
        }
    }

    if (help) {
11920 11921
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
11922 11923
            exit(EXIT_FAILURE);
        }
11924 11925 11926

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
11927
        exit(EXIT_SUCCESS);
11928 11929
    }

11930
    if (argc > optind) {
K
Karel Zak 已提交
11931 11932
        /* parse command */
        ctl->imode = FALSE;
11933 11934 11935
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
11936
        } else {
11937
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
11938 11939 11940 11941 11942
        }
    }
    return TRUE;
}

11943 11944 11945 11946
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
11947
    char *defaultConn;
K
Karel Zak 已提交
11948 11949
    int ret = TRUE;

11950 11951
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
11952
        /* failure to setup locale is not fatal */
11953
    }
11954
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
11955
        perror("bindtextdomain");
E
Eric Blake 已提交
11956
        return EXIT_FAILURE;
11957
    }
11958
    if (!textdomain(PACKAGE)) {
11959
        perror("textdomain");
E
Eric Blake 已提交
11960
        return EXIT_FAILURE;
11961 11962
    }

11963
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
11964 11965 11966
        progname = argv[0];
    else
        progname++;
11967

K
Karel Zak 已提交
11968
    memset(ctl, 0, sizeof(vshControl));
11969
    ctl->imode = TRUE;          /* default is interactive mode */
11970
    ctl->log_fd = -1;           /* Initialize log file descriptor */
K
Karel Zak 已提交
11971

11972
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
11973
        ctl->name = vshStrdup(ctl, defaultConn);
11974 11975
    }

D
Daniel P. Berrange 已提交
11976 11977
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
11978
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
11979
    }
11980

D
Daniel P. Berrange 已提交
11981 11982
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
11983
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
11984
    }
11985

K
Karel Zak 已提交
11986
    if (!ctl->imode) {
11987
        ret = vshCommandRun(ctl, ctl->cmd);
11988
    } else {
K
Karel Zak 已提交
11989 11990
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
11991
            vshPrint(ctl,
11992
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
11993
                     progname);
J
Jim Meyering 已提交
11994
            vshPrint(ctl, "%s",
11995
                     _("Type:  'help' for help with commands\n"
11996
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
11997
        }
11998 11999 12000 12001 12002 12003

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
12004
        do {
12005
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
12006
            ctl->cmdstr =
12007
                vshReadline(ctl, prompt);
12008 12009
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
12010
            if (*ctl->cmdstr) {
12011
#if USE_READLINE
K
Karel Zak 已提交
12012
                add_history(ctl->cmdstr);
12013
#endif
12014
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
12015 12016
                    vshCommandRun(ctl, ctl->cmd);
            }
12017
            VIR_FREE(ctl->cmdstr);
12018
        } while (ctl->imode);
K
Karel Zak 已提交
12019

12020 12021
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
12022
    }
12023

K
Karel Zak 已提交
12024 12025
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
12026
}