virsh.c 328.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"
K
Karel Zak 已提交
56 57 58 59

static char *progname;

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

64 65
#define VIRSH_MAX_XML_FILE 10*1024*1024

K
Karel Zak 已提交
66 67 68 69 70 71 72 73
#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)

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

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

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

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

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

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

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

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

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

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

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

209

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

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

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

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

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

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

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

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

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

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

258 259 260 261 262 263 264 265
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)

266 267 268 269 270 271 272 273
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)

274
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
275 276 277 278 279 280 281
                            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)

282
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
283 284 285 286 287 288 289 290 291
                                           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)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

476
#ifdef SIGPIPE
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
/*
 * 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 已提交
495
static void
496 497 498 499 500 501 502 503 504
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);
}
505 506 507 508
#else
static void
vshSetupSignals(void) {}
#endif
509 510 511 512

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

669 670
#ifndef WIN32

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

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

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

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

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

 cleanup:
709

710 711 712
    return ret;
}

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

734 735 736
#endif /* WIN32 */


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

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

K
Karel Zak 已提交
752 753

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1091
    if (!vshConnectionUsability(ctl, ctl->conn))
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, 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;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1288 1289 1290 1291 1292 1293
    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))) {
1294 1295 1296 1297 1298
        vshError(ctl,
                 _("a running domain like %s cannot be undefined;\n"
                   "to undefine, first shutdown then undefine"
                   " using its name or UUID"),
                 name);
1299 1300 1301
        virDomainFree(dom);
        return FALSE;
    }
J
Jim Meyering 已提交
1302
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
1303
                                      VSH_BYNAME|VSH_BYUUID)))
1304 1305 1306
        return FALSE;

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
/*
 * "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;

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

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

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

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

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

static int
1536 1537
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
                   virSchedParameterPtr param)
1538
{
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548
    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) {
1549
            vshError(ctl, "%s", _("Invalid value of weight"));
1550
            return -1;
1551
        } else {
1552
            param->value.ui = val;
1553
        }
1554
        return 1;
1555 1556
    }

1557 1558 1559 1560 1561 1562 1563
    /* 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) {
1564
            vshError(ctl, "%s", _("Invalid value of cap"));
1565
            return -1;
1566
        } else {
1567
            param->value.ui = val;
1568
        }
1569
        return 1;
1570
    }
1571

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

1628 1629
    return 0;
}
1630

1631

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

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

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

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

1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
    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;
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
        } 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;
            }
1697 1698 1699
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2028
            cpuUsed /= 1000000000.0;
2029

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

    return TRUE;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    do {
        unsigned int cpu = atoi(cpulist);

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

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

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

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

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

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

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

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

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

2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
    {"help", N_("Get/Set memory paramters")},
    {"desc", N_("Get/Set the current memory paramters for the guest domain.\n" \
                "    To get the memory parameters use following command: \n\n" \
                "    virsh # memtune <domain>")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_memtune[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2859
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
2860
     N_("Max memory in kilobytes")},
2861
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
2862
     N_("Memory during contention in kilobytes")},
2863
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
2864
     N_("Max swap in kilobytes")},
2865
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
2866
     N_("Min guaranteed memory in kilobytes")},
2867 2868 2869 2870 2871 2872 2873
    {NULL, 0, 0, NULL}
};

static int
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2874
    long long hard_limit, soft_limit, swap_hard_limit, min_guarantee;
2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886
    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 =
2887
        vshCommandOptLongLong(cmd, "hard-limit", NULL);
2888 2889 2890 2891
    if (hard_limit)
        nparams++;

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

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

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

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

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

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

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

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

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

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

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

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

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

3037 3038 3039
    return TRUE;
}

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

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

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

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

    return TRUE;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    return ret;
}

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

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

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

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

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

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

    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3319
static const vshCmdOptDef opts_migrate[] = {
3320 3321 3322 3323 3324 3325 3326
    {"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")},
3327 3328
    {"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)")},
3329 3330 3331 3332
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"desturi", VSH_OT_DATA, VSH_OFLAG_REQ, N_("connection URI of the destination host")},
    {"migrateuri", VSH_OT_DATA, 0, N_("migration URI, usually can be omitted")},
    {"dname", VSH_OT_DATA, 0, N_("rename to new name during migration (if supported)")},
3333 3334 3335 3336
    {NULL, 0, 0, NULL}
};

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

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

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

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

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

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

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

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

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

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

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

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

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

3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406
        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);
    }
3407 3408 3409 3410 3411 3412

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

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

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

3436
    if (!vshConnectionUsability(ctl, ctl->conn))
3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457
        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;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

3564
static const vshCmdOptDef opts_network_define[] = {
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
cmdNetworkDefine(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 = virNetworkDefineXML(ctl->conn, buffer);
3589
    VIR_FREE(buffer);
3590

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


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

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

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

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

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

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

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


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

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

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

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

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

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

    virNetworkFree(network);
    return ret;
}

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

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

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

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

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

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

    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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


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

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

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

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

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

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


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

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

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

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

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

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

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


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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

}

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

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

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

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

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

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

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

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

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

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
4309

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

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

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

    virInterfaceFree(iface);
    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    virInterfaceFree(iface);
    return ret;
}

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

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

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

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

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

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

    virInterfaceFree(iface);
    return ret;
}

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

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

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

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

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

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

    virInterfaceFree(iface);
    return ret;
}

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

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

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

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

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

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

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

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

4707
    if (!vshConnectionUsability(ctl, ctl->conn))
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 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779
        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;
}


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

4878

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

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

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

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

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

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

    return ret;
}


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

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

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

4957
    if (!vshConnectionUsability(ctl, ctl->conn)) {
4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970
        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 {
4971
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
4972 4973 4974 4975 4976 4977 4978 4979
        ret = FALSE;
    }

    virNodeDeviceFree(dev);
    return ret;
}


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

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

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

    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);
5012
    srcName = vshCommandOptString(cmd, "source-name", &found);
5013
    srcFormat = vshCommandOptString(cmd, "source-format", &found);
5014 5015
    target = vshCommandOptString(cmd, "target", &found);

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

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

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

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

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

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

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

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

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

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

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

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

5095

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

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

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

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

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

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

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

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

5143

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

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

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

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

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

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


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

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

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

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

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

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

5219 5220
    virStoragePoolFree(pool);

5221 5222 5223
    return ret;
}

5224

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

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

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

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

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

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

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

5263

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

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

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

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

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

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

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


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

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

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

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

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

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

    return ret;
}


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

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

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

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

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

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

    virStoragePoolFree(pool);
    return ret;
}


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
5801 5802 5803
     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")},
5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821
    {NULL, 0, 0, NULL}
};

static int
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
    char *type, *host;
    char *srcSpec = NULL;
    char *srcList;
    int found;

    type = vshCommandOptString(cmd, "type", &found);
    if (!found)
        return FALSE;
    host = vshCommandOptString(cmd, "host", &found);
    if (!found)
        host = NULL;

5822
    if (!vshConnectionUsability(ctl, ctl->conn))
5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838
        return FALSE;

    if (host) {
        size_t hostlen = strlen(host);
        char *port = vshCommandOptString(cmd, "port", &found);
        int ret;
        if (!found) {
            port = strrchr(host, ':');
            if (port) {
                if (*(++port))
                    hostlen = port - host - 1;
                else
                    port = NULL;
            }
        }
        ret = port ?
5839 5840 5841 5842 5843 5844
            virAsprintf(&srcSpec,
                        "<source><host name='%.*s' port='%s'/></source>",
                        (int)hostlen, host, port) :
            virAsprintf(&srcSpec,
                        "<source><host name='%.*s'/></source>",
                        (int)hostlen, host);
5845 5846 5847
        if (ret < 0) {
            switch (errno) {
            case ENOMEM:
5848
                vshError(ctl, "%s", _("Out of memory"));
5849 5850
                break;
            default:
5851
                vshError(ctl, _("virAsprintf failed (errno %d)"), errno);
5852 5853 5854 5855 5856 5857
            }
            return FALSE;
        }
    }

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

    return TRUE;
}


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

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

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

    type = vshCommandOptString(cmd, "type", &found);
    if (!found)
        return FALSE;
    srcSpecFile = vshCommandOptString(cmd, "srcSpec", &found);
5898
    if (!found)
5899 5900
        srcSpecFile = NULL;

5901
    if (!vshConnectionUsability(ctl, ctl->conn))
5902 5903 5904 5905 5906 5907
        return FALSE;

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

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

    return TRUE;
}


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

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

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

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

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

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

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

static int
6032
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
6033 6034 6035
{
    virStoragePoolPtr pool;

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

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


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

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

static int
6063
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
6064 6065 6066 6067
{
    virStoragePoolPtr pool;
    int ret = TRUE;

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

6071
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
6072 6073 6074 6075 6076 6077
         return FALSE;

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

    virStoragePoolFree(pool);
6083 6084 6085 6086
    return ret;
}


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

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

6147
    if (!vshConnectionUsability(ctl, ctl->conn))
6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161
        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)
6162
        vshError(ctl, _("Malformed size %s"), capacityStr);
6163 6164 6165 6166

    allocationStr = vshCommandOptString(cmd, "allocation", &found);
    if (allocationStr &&
        cmdVolSize(allocationStr, &allocation) < 0)
6167
        vshError(ctl, _("Malformed size %s"), allocationStr);
6168 6169

    format = vshCommandOptString(cmd, "format", &found);
6170 6171
    snapshotStrVol = vshCommandOptString(cmd, "backing-vol", &found);
    snapshotStrFormat = vshCommandOptString(cmd, "backing-vol-format", &found);
6172

6173 6174 6175 6176 6177
    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);
6178 6179

    if (format) {
6180
        virBufferAddLit(&buf, "  <target>\n");
6181
        virBufferVSprintf(&buf, "    <format type='%s'/>\n",format);
6182
        virBufferAddLit(&buf, "  </target>\n");
6183
    }
6184

6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239
    /* 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");
6240

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

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

 cleanup:
6260
    virBufferFreeAndReset(&buf);
6261 6262 6263 6264 6265
    virStoragePoolFree(pool);
    return FALSE;
}


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

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

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

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

L
Laine Stump 已提交
6300
    virStoragePoolFree(pool);
6301 6302 6303 6304 6305 6306 6307
    return ret;
}


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

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

static int
6320
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
6321 6322 6323 6324
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

6325
    if (!vshConnectionUsability(ctl, ctl->conn))
6326 6327 6328
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6329
                                           VSH_BYNAME)))
6330 6331 6332 6333 6334
        return FALSE;

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

L
Laine Stump 已提交
6337
    virStoragePoolFree(pool);
6338 6339 6340 6341 6342 6343 6344
    return TRUE;
}


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

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

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

6367
    if (!vshConnectionUsability(ctl, ctl->conn))
6368 6369 6370
        return FALSE;

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

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
6381
        virshReportError(ctl);
6382 6383 6384 6385 6386
        virStoragePoolFree(pool);
        return FALSE;
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
6387
    VIR_FREE(buffer);
6388 6389 6390 6391 6392 6393 6394
    virStoragePoolFree(pool);

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

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

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

6428
    if (!vshConnectionUsability(ctl, ctl->conn))
6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442
        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) {
6443
        virshReportError(ctl);
6444 6445 6446 6447 6448 6449 6450 6451 6452
        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 {
6453
        vshError(ctl, _("Failed to create vol from %s"), from);
6454 6455 6456 6457 6458
        goto cleanup;
    }

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

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

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

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

6527
    if (!vshConnectionUsability(ctl, ctl->conn))
6528 6529 6530 6531 6532 6533 6534
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
6535
        vshError(ctl, "%s", _("failed to get parent pool"));
6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558
        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 {
6559
        vshError(ctl, _("Failed to clone vol from %s"),
6560 6561 6562 6563 6564 6565 6566
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

    ret = TRUE;

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

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

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

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

6600
    if (!vshConnectionUsability(ctl, ctl->conn))
6601 6602 6603 6604 6605 6606 6607
        return FALSE;

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

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

L
Laine Stump 已提交
6614
    virStorageVolFree(vol);
6615 6616 6617 6618
    return ret;
}


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

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


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

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

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

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

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

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

6733
    if (!vshConnectionUsability(ctl, ctl->conn))
6734 6735 6736 6737 6738 6739 6740
        return FALSE;

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

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

    virStorageVolFree(vol);
    return ret;
}


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

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

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

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

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

6799 6800
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
6801

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

6813 6814 6815 6816 6817
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

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

6826 6827 6828 6829
        /* 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"));
6830 6831
        }

6832 6833 6834 6835 6836 6837 6838 6839 6840
        /* 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 */
6841

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

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

    /* 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 已提交
6950 6951 6952 6953 6954
    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);
6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014

    /* 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);
7015
        VIR_FREE(activeNames[i]);
7016
    }
7017 7018 7019 7020

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
7021
    VIR_FREE(activeNames);
7022
    virStoragePoolFree(pool);
7023 7024 7025

    /* Return the desired value */
    return functionReturn;
7026 7027 7028 7029 7030 7031
}


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

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

static int
7044
cmdVolName(vshControl *ctl, const vshCmd *cmd)
7045 7046 7047
{
    virStorageVolPtr vol;

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

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

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

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

7117 7118 7119 7120

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

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

static int
7134
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
7135 7136 7137
{
    virStorageVolPtr vol;

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

7141
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153
        return FALSE;

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



/*
 * "vol-path" command
 */
7154
static const vshCmdInfo info_vol_path[] = {
7155
    {"help", N_("returns the volume path for a given volume name or key")},
7156
    {"desc", ""},
7157 7158 7159
    {NULL, NULL}
};

7160
static const vshCmdOptDef opts_vol_path[] = {
7161
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7162
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
7163 7164 7165 7166
    {NULL, 0, 0, NULL}
};

static int
7167
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
7168 7169
{
    virStorageVolPtr vol;
7170
    char *name = NULL;
7171

7172
    if (!vshConnectionUsability(ctl, ctl->conn))
7173
        return FALSE;
7174 7175

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
7176
        return FALSE;
7177
    }
7178 7179 7180 7181 7182 7183 7184

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


7185 7186 7187 7188
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
7189 7190
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
7191 7192
    {NULL, NULL}
};
7193

7194
static const vshCmdOptDef opts_secret_define[] = {
7195
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
7196 7197
    {NULL, 0, 0, NULL}
};
7198

7199 7200 7201
static int
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
7202
    char *from, *buffer;
7203
    virSecretPtr res;
7204
    char uuid[VIR_UUID_STRING_BUFLEN];
7205

7206
    if (!vshConnectionUsability(ctl, ctl->conn))
7207 7208 7209 7210 7211 7212 7213 7214 7215 7216
        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);
7217
    VIR_FREE(buffer);
7218 7219

    if (res == NULL) {
7220
        vshError(ctl, _("Failed to set attributes from %s"), from);
7221 7222
        return FALSE;
    }
7223
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
7224
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236
        virSecretFree(res);
        return FALSE;
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
    return TRUE;
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
7237 7238
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
7239 7240 7241 7242
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
7243
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7244 7245 7246 7247 7248 7249 7250 7251 7252 7253
    {NULL, 0, 0, NULL}
};

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

7254
    if (!vshConnectionUsability(ctl, ctl->conn))
7255 7256 7257 7258 7259 7260 7261 7262 7263
        return FALSE;

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

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
7264
    vshPrint(ctl, "%s", xml);
7265
    VIR_FREE(xml);
7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
7277 7278
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
7279 7280 7281 7282
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
7283 7284
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295
    {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;

7296
    if (!vshConnectionUsability(ctl, ctl->conn))
7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307
        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 已提交
7308
        vshError(ctl, "%s", _("Invalid base64 data"));
7309 7310 7311
        goto cleanup;
    }
    if (value == NULL) {
7312
        vshError(ctl, "%s", _("Failed to allocate memory"));
7313 7314 7315 7316 7317
        return FALSE;
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
7318
    VIR_FREE(value);
7319 7320

    if (res != 0) {
7321
        vshError(ctl, "%s", _("Failed to set secret value"));
7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335
        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[] = {
7336 7337
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
7338 7339 7340 7341
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
7342
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354
    {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;

7355
    if (!vshConnectionUsability(ctl, ctl->conn))
7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367
        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);
7368
    VIR_FREE(value);
7369 7370

    if (base64 == NULL) {
7371
        vshError(ctl, "%s", _("Failed to allocate memory"));
7372 7373
        goto cleanup;
    }
7374
    vshPrint(ctl, "%s", base64);
7375
    memset(base64, 0, strlen(base64));
7376
    VIR_FREE(base64);
7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
7388 7389
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
7390 7391 7392 7393
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
7394
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7395 7396 7397 7398 7399 7400 7401 7402 7403 7404
    {NULL, 0, 0, NULL}
};

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

7405
    if (!vshConnectionUsability(ctl, ctl->conn))
7406 7407 7408 7409 7410 7411 7412
        return FALSE;

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

    if (virSecretUndefine(secret) < 0) {
7413
        vshError(ctl, _("Failed to delete secret %s"), uuid);
7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427
        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[] = {
7428 7429
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
7430 7431 7432 7433 7434 7435 7436 7437 7438
    {NULL, NULL}
};

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

7439
    if (!vshConnectionUsability(ctl, ctl->conn))
7440 7441 7442 7443
        return FALSE;

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
7444
        vshError(ctl, "%s", _("Failed to list secrets"));
7445 7446 7447 7448 7449 7450
        return FALSE;
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
7451
        vshError(ctl, "%s", _("Failed to list secrets"));
7452
        VIR_FREE(uuids);
7453 7454 7455 7456 7457
        return FALSE;
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

7458 7459
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
7460 7461

    for (i = 0; i < maxuuids; i++) {
7462 7463 7464 7465
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
7466
            VIR_FREE(uuids[i]);
7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484
            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);
7485
        VIR_FREE(uuids[i]);
7486
    }
7487
    VIR_FREE(uuids);
7488 7489
    return TRUE;
}
7490 7491 7492 7493 7494


/*
 * "version" command
 */
7495
static const vshCmdInfo info_version[] = {
7496 7497
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
7498 7499 7500 7501 7502
    {NULL, NULL}
};


static int
7503
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514
{
    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;

7515
    if (!vshConnectionUsability(ctl, ctl->conn))
7516 7517 7518 7519
        return FALSE;

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
7520
        vshError(ctl, "%s", _("failed to get hypervisor type"));
7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533
        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) {
7534
        vshError(ctl, "%s", _("failed to get the library version"));
7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552
        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) {
7553
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570
        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;
}

7571 7572 7573 7574
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
7575
    {"help", N_("enumerate devices on this host")},
7576
    {"desc", ""},
7577 7578 7579 7580
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
7581 7582
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
7583 7584 7585
    {NULL, 0, 0, NULL}
};

7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607
#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] = '-';
7608 7609
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
7610 7611 7612
    }

    /* Print this device */
7613
    vshPrint(ctl, "%s", indentBuf);
7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636
    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) {
7637
        vshPrint(ctl, "%s", indentBuf);
7638
        vshPrint(ctl, " |\n");
7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660
    }

    /* 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) {
7661
        vshPrint(ctl, "%s", indentBuf);
7662 7663 7664 7665
        vshPrint(ctl, "\n");
    }
}

7666 7667 7668 7669 7670 7671
static int
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cap;
    char **devices;
    int found, num_devices, i;
7672
    int tree = vshCommandOptBool(cmd, "tree");
7673

7674
    if (!vshConnectionUsability(ctl, ctl->conn))
7675 7676 7677 7678 7679 7680 7681 7682
        return FALSE;

    cap = vshCommandOptString(cmd, "cap", &found);
    if (!found)
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
7683
        vshError(ctl, "%s", _("Failed to count node devices"));
7684 7685 7686 7687 7688 7689 7690 7691 7692
        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) {
7693
        vshError(ctl, "%s", _("Failed to list node devices"));
7694
        VIR_FREE(devices);
7695 7696
        return FALSE;
    }
7697
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
7698 7699 7700 7701 7702 7703 7704
    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 已提交
7705
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724
            } 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++) {
7725 7726
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
7727
        }
7728
        VIR_FREE(parents);
7729 7730 7731
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
7732
            VIR_FREE(devices[i]);
7733
        }
7734
    }
7735
    VIR_FREE(devices);
7736 7737 7738 7739 7740 7741 7742
    return TRUE;
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
7743 7744
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
7745 7746 7747 7748 7749
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
7750
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7751 7752 7753 7754 7755 7756 7757 7758
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
L
Laine Stump 已提交
7759
    char *xml;
7760

7761
    if (!vshConnectionUsability(ctl, ctl->conn))
7762 7763 7764 7765
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7766
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7767 7768 7769
        return FALSE;
    }

L
Laine Stump 已提交
7770 7771 7772 7773 7774 7775 7776
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
        return FALSE;
    }

    vshPrint(ctl, "%s\n", xml);
7777
    VIR_FREE(xml);
7778 7779 7780 7781
    virNodeDeviceFree(device);
    return TRUE;
}

7782 7783 7784 7785
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
7786 7787
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
7788 7789 7790 7791 7792
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
7793
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7794 7795 7796 7797 7798 7799 7800 7801 7802 7803
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
    int ret = TRUE;

7804
    if (!vshConnectionUsability(ctl, ctl->conn))
7805 7806 7807 7808
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7809
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7810 7811 7812 7813 7814 7815
        return FALSE;
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
7816
        vshError(ctl, _("Failed to dettach device %s"), name);
7817 7818 7819 7820 7821 7822 7823 7824 7825 7826
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
7827 7828
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
7829 7830 7831 7832 7833
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
7834
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7835 7836 7837 7838 7839 7840 7841 7842 7843 7844
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
    int ret = TRUE;

7845
    if (!vshConnectionUsability(ctl, ctl->conn))
7846 7847 7848 7849
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7850
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7851 7852 7853 7854 7855 7856
        return FALSE;
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
7857
        vshError(ctl, _("Failed to re-attach device %s"), name);
7858 7859 7860 7861 7862 7863 7864 7865 7866 7867
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
7868 7869
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
7870 7871 7872 7873 7874
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
7875
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7876 7877 7878 7879 7880 7881 7882 7883 7884 7885
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
    int ret = TRUE;

7886
    if (!vshConnectionUsability(ctl, ctl->conn))
7887 7888 7889 7890
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7891
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7892 7893 7894 7895 7896 7897
        return FALSE;
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
7898
        vshError(ctl, _("Failed to reset device %s"), name);
7899 7900 7901 7902 7903 7904
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

7905 7906 7907
/*
 * "hostkey" command
 */
7908
static const vshCmdInfo info_hostname[] = {
7909
    {"help", N_("print the hypervisor hostname")},
7910
    {"desc", ""},
7911 7912 7913 7914
    {NULL, NULL}
};

static int
7915
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7916 7917 7918
{
    char *hostname;

7919
    if (!vshConnectionUsability(ctl, ctl->conn))
7920 7921 7922 7923
        return FALSE;

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
7924
        vshError(ctl, "%s", _("failed to get hostname"));
7925 7926 7927 7928
        return FALSE;
    }

    vshPrint (ctl, "%s\n", hostname);
7929
    VIR_FREE(hostname);
7930 7931 7932 7933 7934 7935 7936

    return TRUE;
}

/*
 * "uri" command
 */
7937
static const vshCmdInfo info_uri[] = {
7938
    {"help", N_("print the hypervisor canonical URI")},
7939
    {"desc", ""},
7940 7941 7942 7943
    {NULL, NULL}
};

static int
7944
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7945 7946 7947
{
    char *uri;

7948
    if (!vshConnectionUsability(ctl, ctl->conn))
7949 7950 7951 7952
        return FALSE;

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
7953
        vshError(ctl, "%s", _("failed to get URI"));
7954 7955 7956 7957
        return FALSE;
    }

    vshPrint (ctl, "%s\n", uri);
7958
    VIR_FREE(uri);
7959 7960 7961 7962 7963 7964 7965

    return TRUE;
}

/*
 * "vncdisplay" command
 */
7966
static const vshCmdInfo info_vncdisplay[] = {
7967 7968
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
7969 7970 7971
    {NULL, NULL}
};

7972
static const vshCmdOptDef opts_vncdisplay[] = {
7973
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
7974 7975 7976 7977
    {NULL, 0, 0, NULL}
};

static int
7978
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
7979 7980 7981 7982 7983 7984 7985 7986 7987
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    int ret = FALSE;
    int port = 0;
    char *doc;

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

J
Jim Meyering 已提交
7991
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
7992 7993 7994 7995 7996 7997 7998 7999 8000
        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);
8001
    VIR_FREE(doc);
8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019
    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) ||
8020
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040
        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
 */
8041
static const vshCmdInfo info_ttyconsole[] = {
8042 8043
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
8044 8045 8046
    {NULL, NULL}
};

8047
static const vshCmdOptDef opts_ttyconsole[] = {
8048
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8049 8050 8051 8052
    {NULL, 0, 0, NULL}
};

static int
8053
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
8054 8055 8056 8057 8058 8059 8060 8061
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    int ret = FALSE;
    char *doc;

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

J
Jim Meyering 已提交
8065
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8066 8067 8068 8069 8070 8071 8072 8073 8074
        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);
8075
    VIR_FREE(doc);
8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087
    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);
8088
    ret = TRUE;
8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
8101
 */
8102
static const vshCmdInfo info_attach_device[] = {
8103 8104
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
8105 8106 8107
    {NULL, NULL}
};

8108
static const vshCmdOptDef opts_attach_device[] = {
8109 8110 8111
    {"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")},
8112 8113 8114 8115
    {NULL, 0, 0, NULL}
};

static int
8116
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
8117 8118 8119 8120 8121 8122
{
    virDomainPtr dom;
    char *from;
    char *buffer;
    int ret = TRUE;
    int found;
J
Jim Fehlig 已提交
8123
    unsigned int flags;
8124

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

J
Jim Meyering 已提交
8128
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8129 8130 8131 8132 8133 8134 8135 8136
        return FALSE;

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

8137
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8138
        virshReportError(ctl);
8139
        virDomainFree(dom);
8140
        return FALSE;
8141
    }
8142

J
Jim Fehlig 已提交
8143 8144 8145 8146 8147 8148 8149 8150
    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);
    }
8151
    VIR_FREE(buffer);
8152 8153

    if (ret < 0) {
8154
        vshError(ctl, _("Failed to attach device from %s"), from);
8155 8156
        virDomainFree(dom);
        return FALSE;
8157
    } else {
J
Jim Meyering 已提交
8158
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
8159 8160 8161 8162 8163 8164 8165 8166 8167 8168
    }

    virDomainFree(dom);
    return TRUE;
}


/*
 * "detach-device" command
 */
8169
static const vshCmdInfo info_detach_device[] = {
8170 8171
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
8172 8173 8174
    {NULL, NULL}
};

8175
static const vshCmdOptDef opts_detach_device[] = {
8176 8177 8178
    {"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")},
8179 8180 8181 8182
    {NULL, 0, 0, NULL}
};

static int
8183
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
8184 8185 8186 8187 8188 8189
{
    virDomainPtr dom;
    char *from;
    char *buffer;
    int ret = TRUE;
    int found;
J
Jim Fehlig 已提交
8190
    unsigned int flags;
8191

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

J
Jim Meyering 已提交
8195
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8196 8197 8198 8199 8200 8201 8202 8203
        return FALSE;

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

8204
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8205
        virshReportError(ctl);
8206
        virDomainFree(dom);
8207
        return FALSE;
8208
    }
8209

J
Jim Fehlig 已提交
8210 8211 8212 8213 8214 8215 8216 8217
    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);
    }
8218
    VIR_FREE(buffer);
8219 8220

    if (ret < 0) {
8221
        vshError(ctl, _("Failed to detach device from %s"), from);
8222 8223
        virDomainFree(dom);
        return FALSE;
8224
    } else {
J
Jim Meyering 已提交
8225
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
8226 8227 8228 8229 8230 8231
    }

    virDomainFree(dom);
    return TRUE;
}

8232

8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258
/*
 * "update-device" command
 */
static const vshCmdInfo info_update_device[] = {
    {"help", N_("update device from an XML file")},
    {"desc", N_("Update device from an XML <file>.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_update_device[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"file",   VSH_OT_DATA, VSH_OFLAG_REQ, N_("XML file")},
    {"persistent", VSH_OT_BOOL, 0, N_("persist device update")},
    {NULL, 0, 0, NULL}
};

static int
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    char *from;
    char *buffer;
    int ret = TRUE;
    int found;
    unsigned int flags;

8259
    if (!vshConnectionUsability(ctl, ctl->conn))
8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271
        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) {
8272
        virshReportError(ctl);
8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299
        virDomainFree(dom);
        return FALSE;
    }

    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
           flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
    } else {
        flags = VIR_DOMAIN_DEVICE_MODIFY_LIVE;
    }
    ret = virDomainUpdateDeviceFlags(dom, buffer, flags);
    VIR_FREE(buffer);

    if (ret < 0) {
        vshError(ctl, _("Failed to update device from %s"), from);
        virDomainFree(dom);
        return FALSE;
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
    return TRUE;
}


8300 8301 8302
/*
 * "attach-interface" command
 */
8303
static const vshCmdInfo info_attach_interface[] = {
8304 8305
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
8306 8307 8308
    {NULL, NULL}
};

8309
static const vshCmdOptDef opts_attach_interface[] = {
8310 8311 8312 8313 8314 8315
    {"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")},
8316
    {"model", VSH_OT_DATA, 0, N_("model type")},
8317
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
8318 8319 8320 8321
    {NULL, 0, 0, NULL}
};

static int
8322
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
8323 8324
{
    virDomainPtr dom = NULL;
8325
    char *mac, *target, *script, *type, *source, *model;
8326
    int typ, ret = FALSE;
J
Jim Fehlig 已提交
8327
    unsigned int flags;
8328 8329
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
8330

8331
    if (!vshConnectionUsability(ctl, ctl->conn))
8332 8333
        goto cleanup;

J
Jim Meyering 已提交
8334
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8335 8336 8337 8338 8339 8340 8341 8342 8343
        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);
8344
    model = vshCommandOptString(cmd, "model", NULL);
8345 8346

    /* check interface type */
8347
    if (STREQ(type, "network")) {
8348
        typ = 1;
8349
    } else if (STREQ(type, "bridge")) {
8350 8351
        typ = 2;
    } else {
E
Eric Blake 已提交
8352 8353
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
8354 8355 8356 8357
        goto cleanup;
    }

    /* Make XML of interface */
8358
    virBufferVSprintf(&buf, "<interface type='%s'>\n", type);
8359

8360 8361 8362 8363
    if (typ == 1)
        virBufferVSprintf(&buf, "  <source network='%s'/>\n", source);
    else if (typ == 2)
        virBufferVSprintf(&buf, "  <source bridge='%s'/>\n", source);
8364

8365 8366 8367 8368 8369 8370
    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);
8371 8372
    if (model != NULL)
        virBufferVSprintf(&buf, "  <model type='%s'/>\n", model);
8373

8374
    virBufferAddLit(&buf, "</interface>\n");
8375

8376 8377 8378
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
8379 8380
    }

8381
    xml = virBufferContentAndReset(&buf);
8382

J
Jim Fehlig 已提交
8383 8384 8385 8386
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
8387
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
8388
    } else {
8389
        ret = virDomainAttachDevice(dom, xml);
8390
    }
8391

8392 8393
    VIR_FREE(xml);

J
Jim Fehlig 已提交
8394
    if (ret != 0) {
L
Laine Stump 已提交
8395
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
8396 8397 8398 8399 8400
        ret = FALSE;
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
        ret = TRUE;
    }
8401 8402 8403 8404

 cleanup:
    if (dom)
        virDomainFree(dom);
8405
    virBufferFreeAndReset(&buf);
8406 8407 8408 8409 8410 8411
    return ret;
}

/*
 * "detach-interface" command
 */
8412
static const vshCmdInfo info_detach_interface[] = {
8413 8414
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
8415 8416 8417
    {NULL, NULL}
};

8418
static const vshCmdOptDef opts_detach_interface[] = {
8419 8420 8421 8422
    {"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")},
8423 8424 8425 8426
    {NULL, 0, 0, NULL}
};

static int
8427
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlChar *tmp_mac = NULL;
    xmlBufferPtr xml_buf = NULL;
    char *doc, *mac =NULL, *type;
    char buf[64];
    int i = 0, diff_mac, ret = FALSE;
J
Jim Fehlig 已提交
8439
    unsigned int flags;
8440

8441
    if (!vshConnectionUsability(ctl, ctl->conn))
8442 8443
        goto cleanup;

J
Jim Meyering 已提交
8444
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458
        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);
8459
    VIR_FREE(doc);
8460
    if (!xml) {
8461
        vshError(ctl, "%s", _("Failed to get interface information"));
8462 8463 8464 8465
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
8466
        vshError(ctl, "%s", _("Failed to get interface information"));
8467 8468 8469 8470 8471 8472 8473
        goto cleanup;
    }

    sprintf(buf, "/domain/devices/interface[@type='%s']", type);
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
8474
        vshError(ctl, _("No found interface whose type is %s"), type);
8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486
        goto cleanup;
    }

    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
            if (cur->type == XML_ELEMENT_NODE && xmlStrEqual(cur->name, BAD_CAST "mac")) {
                tmp_mac = xmlGetProp(cur, BAD_CAST "address");
8487
                diff_mac = virMacAddrCompare ((char *) tmp_mac, mac);
8488 8489 8490 8491 8492 8493 8494 8495
                xmlFree(tmp_mac);
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
8496
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
8497 8498 8499 8500 8501
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
8502
        vshError(ctl, "%s", _("Failed to allocate memory"));
8503 8504 8505 8506
        goto cleanup;
    }

    if(xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0){
8507
        vshError(ctl, "%s", _("Failed to create XML"));
8508 8509 8510
        goto cleanup;
    }

J
Jim Fehlig 已提交
8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522
    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 已提交
8523
        vshError(ctl, "%s", _("Failed to detach interface"));
8524
        ret = FALSE;
J
Jim Fehlig 已提交
8525
    } else {
J
Jim Meyering 已提交
8526
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
8527
        ret = TRUE;
8528
    }
8529 8530 8531 8532

 cleanup:
    if (dom)
        virDomainFree(dom);
8533
    xmlXPathFreeObject(obj);
8534
    xmlXPathFreeContext(ctxt);
8535 8536 8537 8538 8539 8540 8541 8542 8543 8544
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    return ret;
}

/*
 * "attach-disk" command
 */
8545
static const vshCmdInfo info_attach_disk[] = {
8546 8547
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
8548 8549 8550
    {NULL, NULL}
};

8551
static const vshCmdOptDef opts_attach_disk[] = {
8552 8553 8554 8555 8556 8557 8558 8559
    {"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")},
8560
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
8561 8562 8563 8564
    {NULL, 0, 0, NULL}
};

static int
8565
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
8566 8567 8568 8569
{
    virDomainPtr dom = NULL;
    char *source, *target, *driver, *subdriver, *type, *mode;
    int isFile = 0, ret = FALSE;
J
Jim Fehlig 已提交
8570
    unsigned int flags;
8571
    char *stype;
8572 8573
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
8574

8575
    if (!vshConnectionUsability(ctl, ctl->conn))
8576 8577
        goto cleanup;

J
Jim Meyering 已提交
8578
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590
        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);
8591
    stype = vshCommandOptString(cmd, "sourcetype", NULL);
8592

8593 8594
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
8595
            isFile = 1;
8596 8597 8598 8599 8600
    } else if (STREQ(stype, "file")) {
        isFile = 1;
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
8601 8602 8603
    }

    if (mode) {
8604
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
8605 8606
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
8607 8608 8609 8610 8611
            goto cleanup;
        }
    }

    /* Make XML of disk */
8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631
    virBufferVSprintf(&buf, "<disk type='%s'",
                      (isFile) ? "file" : "block");
    if (type)
        virBufferVSprintf(&buf, " device='%s'", type);
    virBufferAddLit(&buf, ">\n");

    virBufferVSprintf(&buf, "  <driver name='%s'",
                      (driver) ? driver : "phy");
    if (subdriver)
        virBufferVSprintf(&buf, " type='%s'", subdriver);
    virBufferAddLit(&buf, "/>\n");

    virBufferVSprintf(&buf, "  <source %s='%s'/>\n",
                      (isFile) ? "file" : "dev",
                      source);
    virBufferVSprintf(&buf, "  <target dev='%s'/>\n", target);
    if (mode)
        virBufferVSprintf(&buf, "  <%s/>\n", mode);

    virBufferAddLit(&buf, "</disk>\n");
8632

8633 8634 8635
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
8636 8637
    }

8638
    xml = virBufferContentAndReset(&buf);
8639

J
Jim Fehlig 已提交
8640 8641 8642 8643
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
8644
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
8645
    } else {
8646
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
8647
    }
8648

8649 8650
    VIR_FREE(xml);

J
Jim Fehlig 已提交
8651
    if (ret != 0) {
L
Laine Stump 已提交
8652
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
8653 8654 8655 8656 8657
        ret = FALSE;
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
        ret = TRUE;
    }
8658 8659 8660 8661

 cleanup:
    if (dom)
        virDomainFree(dom);
8662
    virBufferFreeAndReset(&buf);
8663 8664 8665 8666 8667 8668
    return ret;
}

/*
 * "detach-disk" command
 */
8669
static const vshCmdInfo info_detach_disk[] = {
8670 8671
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
8672 8673 8674
    {NULL, NULL}
};

8675
static const vshCmdOptDef opts_detach_disk[] = {
8676 8677 8678
    {"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")},
8679 8680 8681 8682
    {NULL, 0, 0, NULL}
};

static int
8683
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
8684 8685 8686 8687 8688 8689 8690 8691 8692 8693
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlChar *tmp_tgt = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
    char *doc, *target;
    int i = 0, diff_tgt, ret = FALSE;
J
Jim Fehlig 已提交
8694
    unsigned int flags;
8695

8696
    if (!vshConnectionUsability(ctl, ctl->conn))
8697 8698
        goto cleanup;

J
Jim Meyering 已提交
8699
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711
        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);
8712
    VIR_FREE(doc);
8713
    if (!xml) {
8714
        vshError(ctl, "%s", _("Failed to get disk information"));
8715 8716 8717 8718
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
8719
        vshError(ctl, "%s", _("Failed to get disk information"));
8720 8721 8722 8723 8724 8725
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
8726
        vshError(ctl, "%s", _("Failed to get disk information"));
8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
            if (cur->type == XML_ELEMENT_NODE && xmlStrEqual(cur->name, BAD_CAST "target")) {
                tmp_tgt = xmlGetProp(cur, BAD_CAST "dev");
                diff_tgt = xmlStrEqual(tmp_tgt, BAD_CAST target);
                xmlFree(tmp_tgt);
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
8745
    vshError(ctl, _("No found disk whose target is %s"), target);
8746 8747 8748 8749 8750
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
8751
        vshError(ctl, "%s", _("Failed to allocate memory"));
8752 8753 8754 8755
        goto cleanup;
    }

    if(xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0){
8756
        vshError(ctl, "%s", _("Failed to create XML"));
8757 8758 8759
        goto cleanup;
    }

J
Jim Fehlig 已提交
8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771
    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 已提交
8772
        vshError(ctl, "%s", _("Failed to detach disk"));
8773
        ret = FALSE;
J
Jim Fehlig 已提交
8774
    } else {
J
Jim Meyering 已提交
8775
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
8776
        ret = TRUE;
8777
    }
8778 8779

 cleanup:
8780
    xmlXPathFreeObject(obj);
8781
    xmlXPathFreeContext(ctxt);
8782 8783 8784 8785 8786 8787 8788 8789 8790
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
    return ret;
}

8791 8792 8793 8794
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
8795 8796
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
8797 8798 8799 8800
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
8801
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813
    {NULL, 0, 0, NULL}
};

static int
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;
    int result;

8814
    if (!vshConnectionUsability(ctl, ctl->conn))
8815 8816 8817 8818 8819 8820 8821 8822 8823 8824
        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);
8825
    VIR_FREE(buffer);
8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854

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

8855 8856 8857 8858
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
8859 8860
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
8861 8862 8863 8864
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
8865
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879
    {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;
8880
    xmlNodePtr node_list;
8881 8882 8883 8884 8885 8886
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

8887
    if (!vshConnectionUsability(ctl, ctl->conn))
8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900
        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 已提交
8901 8902
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969
    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;
8970
    goto cleanup;
8971 8972
}

8973 8974 8975 8976 8977 8978 8979 8980
/* 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;

8981
    ret = vshMalloc(ctl, PATH_MAX);
8982 8983 8984

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
8985 8986
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
8987
    if (fd == -1) {
8988
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
8989
                 strerror(errno));
8990
        VIR_FREE(ret);
8991 8992 8993 8994
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
8995 8996
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
8997
        VIR_FORCE_CLOSE(fd);
8998
        unlink (ret);
8999
        VIR_FREE(ret);
9000 9001
        return NULL;
    }
S
Stefan Berger 已提交
9002
    if (VIR_CLOSE(fd) < 0) {
9003 9004
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
9005
        unlink (ret);
9006
        VIR_FREE(ret);
9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024
        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;

9025 9026
    editor = getenv ("VISUAL");
    if (!editor) editor = getenv ("EDITOR");
9027 9028
    if (!editor) editor = "vi"; /* could be cruel & default to ed(1) here */

9029 9030 9031 9032 9033 9034
    /* 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).
9035 9036
     */
    if (strspn (filename, ACCEPTED_CHARS) != strlen (filename)) {
9037 9038 9039
        vshError(ctl,
                 _("%s: temporary filename contains shell meta or other "
                   "unacceptable characters (is $TMPDIR wrong?)"),
9040 9041 9042 9043
                 filename);
        return -1;
    }

9044
    if (virAsprintf(&command, "%s %s", editor, filename) == -1) {
9045
        vshError(ctl,
9046
                 _("virAsprintf: could not create editing command: %s"),
9047
                 strerror(errno));
9048 9049 9050 9051 9052
        return -1;
    }

    command_ret = system (command);
    if (command_ret == -1) {
9053 9054
        vshError(ctl,
                 _("%s: edit command failed: %s"), command, strerror(errno));
9055
        VIR_FREE(command);
9056 9057
        return -1;
    }
9058
    if (WEXITSTATUS(command_ret) != 0) {
9059
        vshError(ctl,
9060
                 _("%s: command exited with non-zero status"), command);
9061
        VIR_FREE(command);
9062 9063
        return -1;
    }
9064
    VIR_FREE(command);
9065 9066 9067 9068 9069 9070 9071 9072 9073
    return 0;
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
9074
        vshError(ctl,
9075
                 _("%s: failed to read temporary file: %s"),
9076
                 filename, strerror(errno));
9077 9078 9079 9080 9081
        return NULL;
    }
    return ret;
}

9082 9083

#ifndef WIN32
P
Paolo Bonzini 已提交
9084 9085 9086 9087
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
9088 9089
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
9090 9091 9092 9093
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
9094
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
9095 9096 9097 9098 9099 9100 9101 9102 9103 9104
    {NULL, 0, 0, NULL}
};

static int
cmdCd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    const char *dir;
    int found;

    if (!ctl->imode) {
9105
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
C
Chris Lalancette 已提交
9106
        return FALSE;
P
Paolo Bonzini 已提交
9107 9108 9109 9110 9111
    }

    dir = vshCommandOptString(cmd, "dir", &found);
    if (!found) {
        uid_t uid = geteuid();
9112
        dir = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
9113 9114 9115 9116 9117
    }
    if (!dir)
        dir = "/";

    if (chdir (dir) == -1) {
9118
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
C
Chris Lalancette 已提交
9119
        return FALSE;
P
Paolo Bonzini 已提交
9120 9121
    }

C
Chris Lalancette 已提交
9122
    return TRUE;
P
Paolo Bonzini 已提交
9123 9124
}

9125 9126 9127
#endif

#ifndef WIN32
P
Paolo Bonzini 已提交
9128 9129 9130 9131
/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
9132 9133
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155
    {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)
9156 9157
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
P
Paolo Bonzini 已提交
9158 9159 9160
    else
        vshPrint (ctl, _("%s\n"), cwd);

9161
    VIR_FREE(cwd);
P
Paolo Bonzini 已提交
9162 9163
    return !err;
}
9164
#endif
P
Paolo Bonzini 已提交
9165

E
Eric Blake 已提交
9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239
/*
 * "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;
}

9240 9241 9242 9243
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
9244 9245
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
9246 9247 9248 9249
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
9250
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265
    {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;
9266
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
9267

9268
    if (!vshConnectionUsability(ctl, ctl->conn))
9269 9270
        goto cleanup;

J
Jim Meyering 已提交
9271
    dom = vshCommandOptDomain (ctl, cmd, NULL);
9272 9273 9274 9275
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
9276
    doc = virDomainGetXMLDesc (dom, flags);
9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302
    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.
     */
9303
    doc_reread = virDomainGetXMLDesc (dom, flags);
9304 9305 9306 9307
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
9308 9309
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327
        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);

9328 9329 9330
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
9331 9332 9333

    if (tmp) {
        unlink (tmp);
9334
        VIR_FREE(tmp);
9335 9336 9337 9338 9339 9340 9341 9342 9343
    }

    return ret;
}

/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
9344 9345
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
9346 9347 9348 9349
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
9350
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
9351 9352 9353 9354 9355 9356 9357 9358 9359 9360
    {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[] = {
9361 9362
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
9363 9364 9365 9366
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
9367
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9368 9369 9370 9371 9372 9373
    {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 已提交
9374 9375 9376
/*
 * "quit" command
 */
9377
static const vshCmdInfo info_quit[] = {
9378
    {"help", N_("quit this interactive terminal")},
9379
    {"desc", ""},
9380
    {NULL, NULL}
K
Karel Zak 已提交
9381 9382 9383
};

static int
9384
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9385
{
K
Karel Zak 已提交
9386 9387 9388 9389
    ctl->imode = FALSE;
    return TRUE;
}

9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417
/*
 * "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;

9418
    if (!vshConnectionUsability(ctl, ctl->conn))
9419 9420 9421 9422 9423 9424 9425 9426
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    from = vshCommandOptString(cmd, "xmlfile", NULL);
    if (from == NULL)
E
Eric Blake 已提交
9427
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510
    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;

9511
    if (!vshConnectionUsability(ctl, ctl->conn))
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
        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;
9567
    int actual = 0;
9568 9569 9570 9571 9572 9573 9574 9575 9576 9577
    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;

9578
    if (!vshConnectionUsability(ctl, ctl->conn))
9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636
        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);
9637
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653

            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);
9654 9655
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
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
    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;

9687
    if (!vshConnectionUsability(ctl, ctl->conn))
9688 9689 9690 9691 9692 9693 9694
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    name = vshCommandOptString(cmd, "snapshotname", NULL);
9695
    if (name == NULL)
9696 9697 9698 9699 9700 9701 9702 9703 9704 9705
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

9706
    vshPrint(ctl, "%s", xml);
9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720

    ret = TRUE;

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
9721
 * "snapshot-revert" command
9722
 */
9723
static const vshCmdInfo info_snapshot_revert[] = {
9724 9725 9726 9727 9728
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

9729
static const vshCmdOptDef opts_snapshot_revert[] = {
9730 9731 9732 9733 9734 9735
    {"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
9736
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
9737 9738 9739 9740 9741 9742
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
    char *name;
    virDomainSnapshotPtr snapshot = NULL;

9743
    if (!vshConnectionUsability(ctl, ctl->conn))
9744 9745 9746 9747 9748 9749 9750
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    name = vshCommandOptString(cmd, "snapshotname", NULL);
9751
    if (name == NULL)
9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796
        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;

9797
    if (!vshConnectionUsability(ctl, ctl->conn))
9798 9799 9800 9801 9802 9803 9804
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    name = vshCommandOptString(cmd, "snapshotname", NULL);
9805
    if (name == NULL)
9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828
        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;
}

9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
    {"help", N_("Qemu Monitor Command")},
    {"desc", N_("Qemu Monitor Command")},
    {NULL, NULL}
};

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

static int
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
    char *monitor_cmd;
    char *result = NULL;

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    monitor_cmd = vshCommandOptString(cmd, "cmd", NULL);
    if (monitor_cmd == NULL) {
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, 0) < 0)
        goto cleanup;

    printf("%s\n", result);

    ret = TRUE;

cleanup:
    VIR_FREE(result);
    if (dom)
        virDomainFree(dom);

    return ret;
}


K
Karel Zak 已提交
9881 9882 9883
/*
 * Commands
 */
9884
static const vshCmdDef commands[] = {
9885 9886 9887 9888
    {"help", cmdHelp, opts_help, info_help},
    {"attach-device", cmdAttachDevice, opts_attach_device, info_attach_device},
    {"attach-disk", cmdAttachDisk, opts_attach_disk, info_attach_disk},
    {"attach-interface", cmdAttachInterface, opts_attach_interface, info_attach_interface},
9889
    {"autostart", cmdAutostart, opts_autostart, info_autostart},
9890
    {"capabilities", cmdCapabilities, NULL, info_capabilities},
9891
#ifndef WIN32
P
Paolo Bonzini 已提交
9892
    {"cd", cmdCd, opts_cd, info_cd},
9893
#endif
9894
    {"connect", cmdConnect, opts_connect, info_connect},
9895
#ifndef WIN32
9896
    {"console", cmdConsole, opts_console, info_console},
9897
#endif
9898
    {"cpu-baseline", cmdCPUBaseline, opts_cpu_baseline, info_cpu_baseline},
9899
    {"cpu-compare", cmdCPUCompare, opts_cpu_compare, info_cpu_compare},
9900
    {"create", cmdCreate, opts_create, info_create},
9901
    {"start", cmdStart, opts_start, info_start},
K
Karel Zak 已提交
9902
    {"destroy", cmdDestroy, opts_destroy, info_destroy},
9903 9904 9905
    {"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},
9906
    {"define", cmdDefine, opts_define, info_define},
K
Karel Zak 已提交
9907
    {"domid", cmdDomid, opts_domid, info_domid},
K
Karel Zak 已提交
9908
    {"domuuid", cmdDomuuid, opts_domuuid, info_domuuid},
9909
    {"dominfo", cmdDominfo, opts_dominfo, info_dominfo},
9910
    {"domjobinfo", cmdDomjobinfo, opts_domjobinfo, info_domjobinfo},
9911
    {"domjobabort", cmdDomjobabort, opts_domjobabort, info_domjobabort},
K
Karel Zak 已提交
9912 9913
    {"domname", cmdDomname, opts_domname, info_domname},
    {"domstate", cmdDomstate, opts_domstate, info_domstate},
9914 9915
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat},
    {"domifstat", cmdDomIfstat, opts_domifstat, info_domifstat},
9916
    {"dommemstat", cmdDomMemStat, opts_dommemstat, info_dommemstat},
9917
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo},
9918 9919
    {"domxml-from-native", cmdDomXMLFromNative, opts_domxmlfromnative, info_domxmlfromnative},
    {"domxml-to-native", cmdDomXMLToNative, opts_domxmltonative, info_domxmltonative},
9920
    {"dumpxml", cmdDumpXML, opts_dumpxml, info_dumpxml},
E
Eric Blake 已提交
9921
    {"echo", cmdEcho, opts_echo, info_echo},
9922
    {"edit", cmdEdit, opts_edit, info_edit},
9923 9924 9925 9926
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
     opts_find_storage_pool_sources, info_find_storage_pool_sources},
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as},
9927
    {"freecell", cmdFreecell, opts_freecell, info_freecell},
9928
    {"hostname", cmdHostname, NULL, info_hostname},
9929
    {"list", cmdList, opts_list, info_list},
E
Eric Blake 已提交
9930
    {"maxvcpus", cmdMaxvcpus, opts_maxvcpus, info_maxvcpus},
9931
    {"migrate", cmdMigrate, opts_migrate, info_migrate},
9932
    {"migrate-setmaxdowntime", cmdMigrateSetMaxDowntime, opts_migrate_setmaxdowntime, info_migrate_setmaxdowntime},
9933

9934
    {"net-autostart", cmdNetworkAutostart, opts_network_autostart, info_network_autostart},
9935 9936 9937 9938
    {"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},
9939
    {"net-edit", cmdNetworkEdit, opts_network_edit, info_network_edit},
O
Osier Yang 已提交
9940
    {"net-info", cmdNetworkInfo, opts_network_info, info_network_info},
9941 9942 9943 9944 9945
    {"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},
9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956

    {"iface-list", cmdInterfaceList, opts_interface_list, info_interface_list},
    {"iface-name", cmdInterfaceName, opts_interface_name, info_interface_name},
    {"iface-mac", cmdInterfaceMAC, opts_interface_mac, info_interface_mac},
    {"iface-dumpxml", cmdInterfaceDumpXML, opts_interface_dumpxml, info_interface_dumpxml},
    {"iface-define", cmdInterfaceDefine, opts_interface_define, info_interface_define},
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine, info_interface_undefine},
    {"iface-edit", cmdInterfaceEdit, opts_interface_edit, info_interface_edit},
    {"iface-start", cmdInterfaceStart, opts_interface_start, info_interface_start},
    {"iface-destroy", cmdInterfaceDestroy, opts_interface_destroy, info_interface_destroy},

9957
    {"managedsave", cmdManagedSave, opts_managedsave, info_managedsave},
9958
    {"managedsave-remove", cmdManagedSaveRemove, opts_managedsaveremove, info_managedsaveremove},
9959

K
Karel Zak 已提交
9960
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo},
9961

9962 9963
    {"nodedev-list", cmdNodeListDevices, opts_node_list_devices, info_node_list_devices},
    {"nodedev-dumpxml", cmdNodeDeviceDumpXML, opts_node_device_dumpxml, info_node_device_dumpxml},
9964 9965 9966
    {"nodedev-dettach", cmdNodeDeviceDettach, opts_node_device_dettach, info_node_device_dettach},
    {"nodedev-reattach", cmdNodeDeviceReAttach, opts_node_device_reattach, info_node_device_reattach},
    {"nodedev-reset", cmdNodeDeviceReset, opts_node_device_reset, info_node_device_reset},
9967 9968
    {"nodedev-create", cmdNodeDeviceCreate, opts_node_device_create, info_node_device_create},
    {"nodedev-destroy", cmdNodeDeviceDestroy, opts_node_device_destroy, info_node_device_destroy},
9969

9970 9971 9972 9973 9974 9975
    {"nwfilter-define", cmdNWFilterDefine, opts_nwfilter_define, info_nwfilter_define},
    {"nwfilter-undefine", cmdNWFilterUndefine, opts_nwfilter_undefine, info_nwfilter_undefine},
    {"nwfilter-dumpxml", cmdNWFilterDumpXML, opts_nwfilter_dumpxml, info_nwfilter_dumpxml},
    {"nwfilter-list", cmdNWFilterList, opts_nwfilter_list, info_nwfilter_list},
    {"nwfilter-edit", cmdNWFilterEdit, opts_nwfilter_edit, info_nwfilter_edit},

9976 9977 9978
    {"pool-autostart", cmdPoolAutostart, opts_pool_autostart, info_pool_autostart},
    {"pool-build", cmdPoolBuild, opts_pool_build, info_pool_build},
    {"pool-create", cmdPoolCreate, opts_pool_create, info_pool_create},
9979
    {"pool-create-as", cmdPoolCreateAs, opts_pool_X_as, info_pool_create_as},
9980
    {"pool-define", cmdPoolDefine, opts_pool_define, info_pool_define},
9981
    {"pool-define-as", cmdPoolDefineAs, opts_pool_X_as, info_pool_define_as},
9982 9983 9984
    {"pool-destroy", cmdPoolDestroy, opts_pool_destroy, info_pool_destroy},
    {"pool-delete", cmdPoolDelete, opts_pool_delete, info_pool_delete},
    {"pool-dumpxml", cmdPoolDumpXML, opts_pool_dumpxml, info_pool_dumpxml},
9985
    {"pool-edit", cmdPoolEdit, opts_pool_edit, info_pool_edit},
9986 9987 9988 9989 9990 9991 9992 9993
    {"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},

9994 9995 9996 9997 9998 9999 10000 10001
    {"secret-define", cmdSecretDefine, opts_secret_define, info_secret_define},
    {"secret-dumpxml", cmdSecretDumpXML, opts_secret_dumpxml, info_secret_dumpxml},
    {"secret-set-value", cmdSecretSetValue, opts_secret_set_value, info_secret_set_value},
    {"secret-get-value", cmdSecretGetValue, opts_secret_get_value, info_secret_get_value},
    {"secret-undefine", cmdSecretUndefine, opts_secret_undefine, info_secret_undefine},
    {"secret-list", cmdSecretList, NULL, info_secret_list},


10002
#ifndef WIN32
P
Paolo Bonzini 已提交
10003
    {"pwd", cmdPwd, NULL, info_pwd},
10004
#endif
K
Karel Zak 已提交
10005
    {"quit", cmdQuit, NULL, info_quit},
10006
    {"exit", cmdQuit, NULL, info_quit},
K
Karel Zak 已提交
10007 10008
    {"reboot", cmdReboot, opts_reboot, info_reboot},
    {"restore", cmdRestore, opts_restore, info_restore},
10009 10010
    {"resume", cmdResume, opts_resume, info_resume},
    {"save", cmdSave, opts_save, info_save},
10011
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo},
D
Daniel Veillard 已提交
10012
    {"dump", cmdDump, opts_dump, info_dump},
10013
    {"shutdown", cmdShutdown, opts_shutdown, info_shutdown},
10014 10015
    {"setmem", cmdSetmem, opts_setmem, info_setmem},
    {"setmaxmem", cmdSetmaxmem, opts_setmaxmem, info_setmaxmem},
10016
    {"memtune", cmdMemtune, opts_memtune, info_memtune},
10017
    {"setvcpus", cmdSetvcpus, opts_setvcpus, info_setvcpus},
K
Karel Zak 已提交
10018
    {"suspend", cmdSuspend, opts_suspend, info_suspend},
10019
    {"ttyconsole", cmdTTYConsole, opts_ttyconsole, info_ttyconsole},
10020
    {"undefine", cmdUndefine, opts_undefine, info_undefine},
10021
    {"update-device", cmdUpdateDevice, opts_update_device, info_update_device},
10022
    {"uri", cmdURI, NULL, info_uri},
10023 10024

    {"vol-create", cmdVolCreate, opts_vol_create, info_vol_create},
10025
    {"vol-create-from", cmdVolCreateFrom, opts_vol_create_from, info_vol_create_from},
10026
    {"vol-create-as", cmdVolCreateAs, opts_vol_create_as, info_vol_create_as},
10027
    {"vol-clone", cmdVolClone, opts_vol_clone, info_vol_clone},
10028
    {"vol-delete", cmdVolDelete, opts_vol_delete, info_vol_delete},
D
David Allan 已提交
10029
    {"vol-wipe", cmdVolWipe, opts_vol_wipe, info_vol_wipe},
10030 10031 10032
    {"vol-dumpxml", cmdVolDumpXML, opts_vol_dumpxml, info_vol_dumpxml},
    {"vol-info", cmdVolInfo, opts_vol_info, info_vol_info},
    {"vol-list", cmdVolList, opts_vol_list, info_vol_list},
J
Justin Clift 已提交
10033
    {"vol-pool", cmdVolPool, opts_vol_pool, info_vol_pool},
10034 10035 10036 10037
    {"vol-path", cmdVolPath, opts_vol_path, info_vol_path},
    {"vol-name", cmdVolName, opts_vol_name, info_vol_name},
    {"vol-key", cmdVolKey, opts_vol_key, info_vol_key},

E
Eric Blake 已提交
10038
    {"vcpucount", cmdVcpucount, opts_vcpucount, info_vcpucount},
10039 10040
    {"vcpuinfo", cmdVcpuinfo, opts_vcpuinfo, info_vcpuinfo},
    {"vcpupin", cmdVcpupin, opts_vcpupin, info_vcpupin},
10041
    {"version", cmdVersion, NULL, info_version},
10042
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay},
10043 10044 10045 10046 10047 10048

    {"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},
10049
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert, info_snapshot_revert},
10050

10051 10052
    {"qemu-monitor-command", cmdQemuMonitorCommand, opts_qemu_monitor_command, info_qemu_monitor_command},

10053
    {NULL, NULL, NULL, NULL}
K
Karel Zak 已提交
10054 10055 10056 10057 10058 10059
};

/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
10060
static const char *
10061
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
10062
{
10063
    const vshCmdInfo *info;
10064

K
Karel Zak 已提交
10065
    for (info = cmd->info; info && info->name; info++) {
10066
        if (STREQ(info->name, name))
K
Karel Zak 已提交
10067 10068 10069 10070 10071
            return info->data;
    }
    return NULL;
}

10072 10073
static const vshCmdOptDef *
vshCmddefGetOption(const vshCmdDef * cmd, const char *name)
10074
{
10075
    const vshCmdOptDef *opt;
10076

K
Karel Zak 已提交
10077
    for (opt = cmd->opts; opt && opt->name; opt++)
10078
        if (STREQ(opt->name, name))
K
Karel Zak 已提交
10079 10080 10081 10082
            return opt;
    return NULL;
}

10083 10084
static const vshCmdOptDef *
vshCmddefGetData(const vshCmdDef * cmd, int data_ct)
10085
{
10086
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
10087

10088
    for (opt = cmd->opts; opt && opt->name; opt++) {
10089 10090
        if (opt->type >= VSH_OT_DATA ||
            (opt->type == VSH_OT_INT && (opt->flag & VSH_OFLAG_REQ))) {
10091
            if (data_ct == 0 || opt->type == VSH_OT_ARGV)
10092 10093 10094 10095 10096
                return opt;
            else
                data_ct--;
        }
    }
K
Karel Zak 已提交
10097 10098 10099
    return NULL;
}

10100 10101 10102
/*
 * Checks for required options
 */
10103
static int
10104
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd)
10105
{
10106 10107
    const vshCmdDef *def = cmd->def;
    const vshCmdOptDef *d;
10108
    int err = 0;
10109 10110 10111 10112

    for (d = def->opts; d && d->name; d++) {
        if (d->flag & VSH_OFLAG_REQ) {
            vshCmdOpt *o = cmd->opts;
10113 10114 10115
            int ok = 0;

            while (o && ok == 0) {
10116
                if (o->def == d)
10117
                    ok = 1;
10118 10119 10120
                o = o->next;
            }
            if (!ok) {
10121
                vshError(ctl,
10122
                         d->type == VSH_OT_DATA ?
10123
                         _("command '%s' requires <%s> option") :
10124
                         _("command '%s' requires --%s option"),
10125
                         def->name, d->name);
10126 10127
                err = 1;
            }
10128

10129 10130 10131 10132 10133
        }
    }
    return !err;
}

10134
static const vshCmdDef *
10135 10136
vshCmddefSearch(const char *cmdname)
{
10137
    const vshCmdDef *c;
10138

K
Karel Zak 已提交
10139
    for (c = commands; c->name; c++)
10140
        if (STREQ(c->name, cmdname))
K
Karel Zak 已提交
10141 10142 10143 10144 10145
            return c;
    return NULL;
}

static int
10146
vshCmddefHelp(vshControl *ctl, const char *cmdname)
10147
{
10148
    const vshCmdDef *def = vshCmddefSearch(cmdname);
10149

K
Karel Zak 已提交
10150
    if (!def) {
10151
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
10152 10153
        return FALSE;
    } else {
E
Eric Blake 已提交
10154 10155
        const char *desc = _(vshCmddefGetInfo(def, "desc"));
        const char *help = _(vshCmddefGetInfo(def, "help"));
10156
        char buf[256];
K
Karel Zak 已提交
10157

10158
        fputs(_("  NAME\n"), stdout);
10159 10160
        fprintf(stdout, "    %s - %s\n", def->name, help);

10161 10162 10163 10164 10165 10166
        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;
10167 10168
                switch (opt->type) {
                case VSH_OT_BOOL:
10169
                    fmt = "[--%s]";
10170 10171
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
10172
                    /* xgettext:c-format */
10173 10174
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
10175 10176
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
10177 10178
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
10179 10180
                    break;
                case VSH_OT_DATA:
10181
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
10182 10183 10184 10185 10186 10187
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
                    fmt = _("[<string>]...");
                    break;
                default:
10188
                    assert(0);
10189
                }
10190
                fputc(' ', stdout);
E
Eric Blake 已提交
10191
                fprintf(stdout, fmt, opt->name);
10192
            }
K
Karel Zak 已提交
10193
        }
10194 10195 10196
        fputc('\n', stdout);

        if (desc[0]) {
10197
            /* Print the description only if it's not empty.  */
10198
            fputs(_("\n  DESCRIPTION\n"), stdout);
K
Karel Zak 已提交
10199 10200
            fprintf(stdout, "    %s\n", desc);
        }
10201

K
Karel Zak 已提交
10202
        if (def->opts) {
10203
            const vshCmdOptDef *opt;
10204
            fputs(_("\n  OPTIONS\n"), stdout);
10205
            for (opt = def->opts; opt->name; opt++) {
10206 10207
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
10208
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
10209 10210
                    break;
                case VSH_OT_INT:
10211 10212 10213
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
10214 10215
                    break;
                case VSH_OT_STRING:
10216
                    /* OT_STRING should never be VSH_OFLAG_REQ */
10217
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
10218 10219
                    break;
                case VSH_OT_DATA:
10220 10221
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
10222 10223 10224 10225 10226 10227 10228
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
                    continue;
                default:
                    assert(0);
                }
10229

E
Eric Blake 已提交
10230
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
10231
            }
K
Karel Zak 已提交
10232 10233 10234 10235 10236 10237 10238 10239 10240 10241
        }
        fputc('\n', stdout);
    }
    return TRUE;
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
10242 10243 10244
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
10245 10246
    vshCmdOpt *a = arg;

10247
    while (a) {
K
Karel Zak 已提交
10248
        vshCmdOpt *tmp = a;
10249

K
Karel Zak 已提交
10250 10251
        a = a->next;

10252 10253
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
10254 10255 10256 10257
    }
}

static void
10258
vshCommandFree(vshCmd *cmd)
10259
{
K
Karel Zak 已提交
10260 10261
    vshCmd *c = cmd;

10262
    while (c) {
K
Karel Zak 已提交
10263
        vshCmd *tmp = c;
10264

K
Karel Zak 已提交
10265 10266 10267 10268
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
10269
        VIR_FREE(tmp);
K
Karel Zak 已提交
10270 10271 10272 10273 10274 10275 10276
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
10277
vshCommandOpt(const vshCmd *cmd, const char *name)
10278
{
K
Karel Zak 已提交
10279
    vshCmdOpt *opt = cmd->opts;
10280 10281

    while (opt) {
10282
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
10283 10284 10285 10286 10287 10288 10289 10290 10291 10292
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
 * Returns option as INT
 */
static int
10293
vshCommandOptInt(const vshCmd *cmd, const char *name, int *found)
10294
{
K
Karel Zak 已提交
10295
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
10296 10297
    int res = 0, num_found = FALSE;
    char *end_p = NULL;
10298

10299 10300
    if ((arg != NULL) && (arg->data != NULL)) {
        res = strtol(arg->data, &end_p, 10);
10301 10302 10303 10304
        if ((arg->data == end_p) || (*end_p!= 0))
            num_found = FALSE;
        else
            num_found = TRUE;
10305
    }
K
Karel Zak 已提交
10306
    if (found)
10307
        *found = num_found;
K
Karel Zak 已提交
10308 10309 10310
    return res;
}

10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330
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 已提交
10331 10332 10333 10334
/*
 * Returns option as STRING
 */
static char *
10335
vshCommandOptString(const vshCmd *cmd, const char *name, int *found)
10336
{
K
Karel Zak 已提交
10337
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
10338

K
Karel Zak 已提交
10339 10340
    if (found)
        *found = arg ? TRUE : FALSE;
10341

10342 10343 10344
    if (arg && arg->data && *arg->data)
        return arg->data;

10345
    if (arg && arg->def && ((arg->def->flag) & VSH_OFLAG_REQ))
10346 10347 10348
        vshError(NULL, _("Missing required option '%s'"), name);

    return NULL;
K
Karel Zak 已提交
10349 10350
}

10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368
/*
 * 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 已提交
10369 10370 10371 10372
/*
 * Returns TRUE/FALSE if the option exists
 */
static int
10373
vshCommandOptBool(const vshCmd *cmd, const char *name)
10374
{
K
Karel Zak 已提交
10375 10376 10377
    return vshCommandOpt(cmd, name) ? TRUE : FALSE;
}

10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398
/*
 * 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 已提交
10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416
/* 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)
10417
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
10418 10419 10420
                 cmd->def->name, optname);
    return found;
}
10421

K
Karel Zak 已提交
10422
static virDomainPtr
J
Jim Meyering 已提交
10423
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
10424
                      char **name, int flag)
10425
{
K
Karel Zak 已提交
10426
    virDomainPtr dom = NULL;
10427
    char *n;
K
Karel Zak 已提交
10428
    int id;
J
Jim Meyering 已提交
10429 10430 10431
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
10432

10433
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10434 10435
        return NULL;

K
Karel Zak 已提交
10436
    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
10437 10438
             cmd->def->name, optname, n);

K
Karel Zak 已提交
10439 10440
    if (name)
        *name = n;
10441

K
Karel Zak 已提交
10442
    /* try it by ID */
10443
    if (flag & VSH_BYID) {
10444
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
10445 10446 10447 10448
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
10449
    }
K
Karel Zak 已提交
10450
    /* try it by UUID */
10451
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
10452
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
10453
                 cmd->def->name, optname);
K
Karel Zak 已提交
10454
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
10455
    }
K
Karel Zak 已提交
10456
    /* try it by NAME */
10457
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
10458
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
10459
                 cmd->def->name, optname);
K
Karel Zak 已提交
10460
        dom = virDomainLookupByName(ctl->conn, n);
10461
    }
K
Karel Zak 已提交
10462

10463
    if (!dom)
10464
        vshError(ctl, _("failed to get domain '%s'"), n);
10465

K
Karel Zak 已提交
10466 10467 10468
    return dom;
}

10469
static virNetworkPtr
J
Jim Meyering 已提交
10470
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
10471
                       char **name, int flag)
10472 10473 10474
{
    virNetworkPtr network = NULL;
    char *n;
J
Jim Meyering 已提交
10475 10476 10477
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
10478

10479
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10480 10481 10482 10483 10484 10485 10486 10487 10488
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
10489
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
10490
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
10491
                 cmd->def->name, optname);
10492 10493 10494 10495
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
10496
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
10497 10498 10499 10500 10501
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
10502
        vshError(ctl, _("failed to get network '%s'"), n);
10503 10504 10505 10506

    return network;
}

10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517

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;

10518
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545
        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;
}

10546 10547 10548 10549 10550 10551 10552 10553 10554 10555
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;

10556
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10557 10558 10559 10560 10561 10562 10563 10564 10565
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
10566
    if ((flag & VSH_BYNAME)) {
10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578
        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)
10579
        vshError(ctl, _("failed to get interface '%s'"), n);
10580 10581 10582 10583

    return iface;
}

10584
static virStoragePoolPtr
10585
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
10586 10587 10588 10589 10590
                    char **name, int flag)
{
    virStoragePoolPtr pool = NULL;
    char *n;

10591
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10592 10593 10594 10595 10596 10597 10598 10599 10600
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
10601
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
10602
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
10603
                 cmd->def->name, optname);
10604 10605 10606
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
10607
    if (pool == NULL && (flag & VSH_BYNAME)) {
10608 10609 10610 10611 10612 10613
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
10614
        vshError(ctl, _("failed to get pool '%s'"), n);
10615 10616 10617 10618 10619

    return pool;
}

static virStorageVolPtr
10620
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
10621 10622 10623 10624 10625 10626 10627 10628 10629
                   const char *optname,
                   const char *pooloptname,
                   char **name, int flag)
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
    char *n, *p;
    int found;

10630
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10631 10632
        return NULL;

10633
    if (!(p = vshCommandOptString(cmd, pooloptname, &found)) && found)
10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644
        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;

10645
    /* try it by name */
10646
    if (pool && (flag & VSH_BYNAME)) {
10647
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
10648 10649 10650
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
10651
    /* try it by key */
10652 10653 10654 10655 10656
    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);
    }
10657
    /* try it by path */
10658 10659 10660 10661 10662 10663 10664
    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)
10665
        vshError(ctl, _("failed to get vol '%s'"), n);
10666 10667 10668 10669 10670 10671 10672

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683
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);
10684
    if (n == NULL)
10685 10686 10687 10688 10689 10690 10691 10692 10693 10694
        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)
10695
        vshError(ctl, _("failed to get secret '%s'"), n);
10696 10697 10698 10699

    return secret;
}

K
Karel Zak 已提交
10700 10701 10702 10703
/*
 * Executes command(s) and returns return code from last command
 */
static int
10704
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
10705
{
K
Karel Zak 已提交
10706
    int ret = TRUE;
10707 10708

    while (cmd) {
K
Karel Zak 已提交
10709
        struct timeval before, after;
10710
        bool enable_timing = ctl->timing;
10711

10712 10713 10714
        if ((ctl->conn == NULL) || (disconnected != 0))
            vshReconnect(ctl);

10715
        if (enable_timing)
K
Karel Zak 已提交
10716
            GETTIMEOFDAY(&before);
10717

K
Karel Zak 已提交
10718 10719
        ret = cmd->def->handler(ctl, cmd);

10720
        if (enable_timing)
K
Karel Zak 已提交
10721
            GETTIMEOFDAY(&after);
10722

J
John Levon 已提交
10723 10724 10725
        if (ret == FALSE)
            virshReportError(ctl);

10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736
        /* 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);

10737
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
10738 10739
            return ret;

10740
        if (enable_timing)
10741
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
10742 10743
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
10744
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
10745 10746 10747 10748 10749 10750
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
10751
 * Command parsing
K
Karel Zak 已提交
10752 10753 10754
 * ---------------
 */

10755 10756 10757 10758 10759 10760 10761 10762 10763 10764
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 已提交
10765
    /* vshCommandStringGetArg() */
10766
    char *pos;
L
Lai Jiangshan 已提交
10767 10768 10769
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
10770 10771
} vshCommandParser;

K
Karel Zak 已提交
10772
static int
10773
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
10774
{
K
Karel Zak 已提交
10775 10776 10777
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
10778

K
Karel Zak 已提交
10779 10780 10781 10782
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
10783

10784
    while (1) {
K
Karel Zak 已提交
10785
        vshCmdOpt *last = NULL;
10786
        const vshCmdDef *cmd = NULL;
10787
        vshCommandToken tk;
L
Lai Jiangshan 已提交
10788
        bool data_only = false;
10789
        int data_ct = 0;
10790

K
Karel Zak 已提交
10791
        first = NULL;
10792

10793
        while (1) {
10794
            const vshCmdOptDef *opt = NULL;
10795

K
Karel Zak 已提交
10796
            tkdata = NULL;
10797
            tk = parser->getNextArg(ctl, parser, &tkdata);
10798 10799

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
10800
                goto syntaxError;
10801 10802
            if (tk != VSH_TK_ARG)
                break;
10803 10804

            if (cmd == NULL) {
K
Karel Zak 已提交
10805 10806
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
10807
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
10808
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
10809
                }
10810
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
10811 10812 10813 10814
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
10815 10816 10817 10818 10819 10820
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
                if (!(opt = vshCmddefGetOption(cmd, tkdata + 2))) {
10821
                    vshError(ctl,
10822
                             _("command '%s' doesn't support option --%s"),
10823 10824
                             cmd->name, tkdata + 2);
                    VIR_FREE(optstr);
K
Karel Zak 已提交
10825 10826
                    goto syntaxError;
                }
10827
                VIR_FREE(tkdata);
K
Karel Zak 已提交
10828 10829 10830

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
10831 10832 10833
                    if (optstr)
                        tkdata = optstr;
                    else
10834
                        tk = parser->getNextArg(ctl, parser, &tkdata);
10835
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
10836
                        goto syntaxError;
10837
                    if (tk != VSH_TK_ARG) {
10838
                        vshError(ctl,
10839
                                 _("expected syntax: --%s <%s>"),
10840 10841
                                 opt->name,
                                 opt->type ==
10842
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
10843 10844
                        goto syntaxError;
                    }
10845 10846 10847 10848 10849 10850 10851 10852
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
10853
                }
L
Lai Jiangshan 已提交
10854 10855 10856 10857
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
10858
            } else {
L
Lai Jiangshan 已提交
10859
get_data:
10860
                if (!(opt = vshCmddefGetData(cmd, data_ct++))) {
10861
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
10862 10863 10864 10865 10866
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
10867
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
10868

K
Karel Zak 已提交
10869 10870 10871 10872
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
10873

K
Karel Zak 已提交
10874 10875 10876 10877 10878
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
10879

K
Karel Zak 已提交
10880
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
10881 10882
                         cmd->name,
                         opt->name,
10883 10884
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
10885 10886
            }
        }
10887

D
Daniel Veillard 已提交
10888
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
10889
        if (cmd) {
10890
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
10891

K
Karel Zak 已提交
10892 10893 10894 10895
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

10896
            if (!vshCommandCheckOpts(ctl, c)) {
10897
                VIR_FREE(c);
10898
                goto syntaxError;
10899
            }
10900

K
Karel Zak 已提交
10901 10902 10903 10904 10905 10906
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
10907 10908 10909

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
10910
    }
10911

K
Karel Zak 已提交
10912 10913
    return TRUE;

10914
 syntaxError:
10915
    if (ctl->cmd) {
K
Karel Zak 已提交
10916
        vshCommandFree(ctl->cmd);
10917 10918
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
10919 10920
    if (first)
        vshCommandOptFree(first);
10921
    VIR_FREE(tkdata);
10922
    return FALSE;
K
Karel Zak 已提交
10923 10924
}

10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032
/* --------------------
 * 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 已提交
11033
/* ---------------
11034
 * Misc utils
K
Karel Zak 已提交
11035 11036
 * ---------------
 */
K
Karel Zak 已提交
11037
static const char *
11038 11039
vshDomainStateToString(int state)
{
K
Karel Zak 已提交
11040
    switch (state) {
11041
    case VIR_DOMAIN_RUNNING:
11042
        return N_("running");
11043
    case VIR_DOMAIN_BLOCKED:
11044
        return N_("idle");
11045
    case VIR_DOMAIN_PAUSED:
11046
        return N_("paused");
11047
    case VIR_DOMAIN_SHUTDOWN:
11048
        return N_("in shutdown");
11049
    case VIR_DOMAIN_SHUTOFF:
11050
        return N_("shut off");
11051
    case VIR_DOMAIN_CRASHED:
11052
        return N_("crashed");
11053
    default:
11054
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
11055
    }
11056
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
11057 11058
}

11059 11060 11061 11062
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
11063
    case VIR_VCPU_OFFLINE:
11064
        return N_("offline");
11065
    case VIR_VCPU_BLOCKED:
11066
        return N_("idle");
11067
    case VIR_VCPU_RUNNING:
11068
        return N_("running");
11069
    default:
11070
        ;/*FALLTHROUGH*/
11071
    }
11072
    return N_("no state");
11073 11074
}

K
Karel Zak 已提交
11075
static int
11076
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
11077
{
11078 11079
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
11080 11081
     */
    if (!conn) {
11082
        vshError(ctl, "%s", _("no valid connection"));
K
Karel Zak 已提交
11083 11084 11085 11086 11087
        return FALSE;
    }
    return TRUE;
}

K
Karel Zak 已提交
11088
static void
11089
vshDebug(vshControl *ctl, int level, const char *format, ...)
11090
{
K
Karel Zak 已提交
11091 11092
    va_list ap;

11093 11094 11095 11096
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
11097 11098 11099 11100 11101 11102
    if (level > ctl->debug)
        return;

    va_start(ap, format);
    vfprintf(stdout, format, ap);
    va_end(ap);
K
Karel Zak 已提交
11103 11104 11105
}

static void
11106
vshPrintExtra(vshControl *ctl, const char *format, ...)
11107
{
K
Karel Zak 已提交
11108
    va_list ap;
11109

K
Karel Zak 已提交
11110
    if (ctl->quiet == TRUE)
K
Karel Zak 已提交
11111
        return;
11112

K
Karel Zak 已提交
11113
    va_start(ap, format);
11114
    vfprintf(stdout, format, ap);
K
Karel Zak 已提交
11115 11116 11117
    va_end(ap);
}

K
Karel Zak 已提交
11118

K
Karel Zak 已提交
11119
static void
11120
vshError(vshControl *ctl, const char *format, ...)
11121
{
K
Karel Zak 已提交
11122
    va_list ap;
11123

11124 11125 11126 11127 11128
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
11129

11130
    fputs(_("error: "), stderr);
11131

K
Karel Zak 已提交
11132 11133 11134 11135 11136 11137 11138 11139
    va_start(ap, format);
    vfprintf(stderr, format, ap);
    va_end(ap);

    fputc('\n', stderr);
}

/*
11140
 * Initialize connection.
K
Karel Zak 已提交
11141 11142
 */
static int
11143
vshInit(vshControl *ctl)
11144
{
K
Karel Zak 已提交
11145 11146 11147
    if (ctl->conn)
        return FALSE;

11148 11149
    vshOpenLogFile(ctl);

11150 11151
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
11152

11153 11154 11155
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

11156 11157 11158 11159 11160 11161 11162 11163
    virEventRegisterImpl(virEventAddHandleImpl,
                         virEventUpdateHandleImpl,
                         virEventRemoveHandleImpl,
                         virEventAddTimeoutImpl,
                         virEventUpdateTimeoutImpl,
                         virEventRemoveTimeoutImpl);
    virEventInit();

11164 11165 11166 11167
    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

11168

11169 11170 11171 11172
    /* This is not necessarily fatal.  All the individual commands check
     * vshConnectionUsability, except ones which don't need a connection
     * such as "help".
     */
11173
    if (!ctl->conn) {
11174
        virshReportError(ctl);
11175
        vshError(ctl, "%s", _("failed to connect to the hypervisor"));
11176 11177
        return FALSE;
    }
K
Karel Zak 已提交
11178 11179 11180 11181

    return TRUE;
}

11182 11183
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202
/**
 * 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:
11203
                vshError(ctl, "%s",
J
Jim Meyering 已提交
11204
                         _("failed to get the log file information"));
11205
                exit(EXIT_FAILURE);
11206 11207 11208
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
11209 11210
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
11211 11212 11213 11214
        }
    }

    /* log file open */
11215
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
11216
        vshError(ctl, "%s",
J
Jim Meyering 已提交
11217
                 _("failed to open the log file. check the log file path"));
11218
        exit(EXIT_FAILURE);
11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283
    }
}

/**
 * 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 */
11284
    if (safewrite(ctl->log_fd, msg_buf, strlen(msg_buf)) < 0) {
11285
        vshCloseLogFile(ctl);
11286
        vshError(ctl, "%s", _("failed to write the log file"));
11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298
    }
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
11299 11300 11301
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
11302 11303 11304
    }

    if (ctl->logfile) {
11305
        VIR_FREE(ctl->logfile);
11306 11307 11308 11309
        ctl->logfile = NULL;
    }
}

11310
#ifdef USE_READLINE
11311

K
Karel Zak 已提交
11312 11313 11314 11315 11316
/* -----------------
 * Readline stuff
 * -----------------
 */

11317
/*
K
Karel Zak 已提交
11318 11319
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
11320
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
11321 11322
 */
static char *
11323 11324
vshReadlineCommandGenerator(const char *text, int state)
{
K
Karel Zak 已提交
11325
    static int list_index, len;
K
Karel Zak 已提交
11326
    const char *name;
K
Karel Zak 已提交
11327 11328 11329

    /* If this is a new word to complete, initialize now.  This
     * includes saving the length of TEXT for efficiency, and
11330
     * initializing the index variable to 0.
K
Karel Zak 已提交
11331 11332 11333
     */
    if (!state) {
        list_index = 0;
11334
        len = strlen(text);
K
Karel Zak 已提交
11335 11336 11337
    }

    /* Return the next name which partially matches from the
11338
     * command list.
K
Karel Zak 已提交
11339
     */
K
Karel Zak 已提交
11340
    while ((name = commands[list_index].name)) {
K
Karel Zak 已提交
11341
        list_index++;
11342
        if (STREQLEN(name, text, len))
11343
            return vshStrdup(NULL, name);
K
Karel Zak 已提交
11344 11345 11346 11347 11348 11349 11350
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
11351 11352
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
11353
    static int list_index, len;
11354
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
11355
    const char *name;
K
Karel Zak 已提交
11356 11357 11358 11359 11360 11361 11362 11363 11364

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

11365
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
11366
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
11367 11368 11369

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
11370
        len = strlen(text);
11371
        VIR_FREE(cmdname);
K
Karel Zak 已提交
11372 11373 11374 11375
    }

    if (!cmd)
        return NULL;
11376

11377 11378 11379
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
11380
    while ((name = cmd->opts[list_index].name)) {
11381
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
11382
        char *res;
11383

K
Karel Zak 已提交
11384
        list_index++;
11385

K
Karel Zak 已提交
11386
        if (opt->type == VSH_OT_DATA)
K
Karel Zak 已提交
11387 11388
            /* ignore non --option */
            continue;
11389

K
Karel Zak 已提交
11390
        if (len > 2) {
11391
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
11392 11393
                continue;
        }
11394
        res = vshMalloc(NULL, strlen(name) + 3);
11395
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
11396 11397 11398 11399 11400 11401 11402 11403
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
11404 11405 11406
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
11407 11408
    char **matches = (char **) NULL;

11409
    if (start == 0)
K
Karel Zak 已提交
11410
        /* command name generator */
11411
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
11412 11413
    else
        /* commands options */
11414
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
11415 11416 11417 11418
    return matches;
}


11419 11420
static int
vshReadlineInit(vshControl *ctl)
11421
{
11422 11423
    char *userdir = NULL;

K
Karel Zak 已提交
11424 11425 11426 11427 11428
    /* 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;
11429 11430 11431

    /* Limit the total size of the history buffer */
    stifle_history(500);
11432 11433

    /* Prepare to read/write history from/to the ~/.virsh/history file */
11434
    userdir = virGetUserDirectory(getuid());
11435 11436 11437 11438 11439 11440

    if (userdir == NULL)
        return -1;

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
11441
        VIR_FREE(userdir);
11442 11443 11444 11445 11446
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
11447
        VIR_FREE(userdir);
11448 11449 11450
        return -1;
    }

11451
    VIR_FREE(userdir);
11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469

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

11470 11471
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
11472 11473
}

11474 11475 11476 11477 11478 11479
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

11480
#else /* !USE_READLINE */
11481

11482 11483 11484 11485 11486 11487 11488
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

11489
static void
11490
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513
{
    /* 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);
}

11514
#endif /* !USE_READLINE */
11515

K
Karel Zak 已提交
11516
/*
J
Jim Meyering 已提交
11517
 * Deinitialize virsh
K
Karel Zak 已提交
11518 11519
 */
static int
11520
vshDeinit(vshControl *ctl)
11521
{
11522
    vshReadlineDeinit(ctl);
11523
    vshCloseLogFile(ctl);
11524
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
11525
    if (ctl->conn) {
11526 11527 11528
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
11529 11530
        }
    }
D
Daniel P. Berrange 已提交
11531 11532
    virResetLastError();

K
Karel Zak 已提交
11533 11534
    return TRUE;
}
11535

K
Karel Zak 已提交
11536 11537 11538 11539
/*
 * Print usage
 */
static void
11540
vshUsage(void)
11541
{
11542
    const vshCmdDef *cmd;
L
Lai Jiangshan 已提交
11543 11544
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
11545 11546 11547 11548 11549 11550 11551 11552
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
                      "    -d | --debug <num>      debug level [0-5]\n"
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
E
Eric Blake 已提交
11553 11554
                      "    -v | --version[=short]  program version\n\n"
                      "    -V | --version=long     version and full options\n\n"
L
Lai Jiangshan 已提交
11555
                      "  commands (non interactive mode):\n"), progname, progname);
11556 11557 11558

    for (cmd = commands; cmd->name; cmd++)
        fprintf(stdout,
E
Eric Blake 已提交
11559
                "    %-15s %s\n", cmd->name, _(vshCmddefGetInfo(cmd, "help")));
11560 11561 11562 11563

    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
11564 11565
}

11566 11567 11568 11569 11570 11571 11572 11573 11574 11575
/*
 * 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 已提交
11576 11577
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612
#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 已提交
11613
    vshPrint(ctl, "%s", _(" Networking:"));
11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639
#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 已提交
11640
    vshPrint(ctl, "%s", _(" Storage:"));
11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663
#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 已提交
11664
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688
#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 已提交
11689 11690 11691 11692 11693
/*
 * argv[]:  virsh [options] [command]
 *
 */
static int
11694
vshParseArgv(vshControl *ctl, int argc, char **argv)
11695
{
11696 11697
    bool help = false;
    int arg;
K
Karel Zak 已提交
11698
    struct option opt[] = {
E
Eric Blake 已提交
11699 11700 11701 11702 11703 11704 11705 11706 11707
        {"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}
11708 11709
    };

11710 11711 11712
    /* 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. */
11713
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
11714
        switch (arg) {
11715
        case 'd':
D
Daniel Veillard 已提交
11716
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
11717
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
11718 11719
                exit(EXIT_FAILURE);
            }
11720 11721
            break;
        case 'h':
11722
            help = true;
11723 11724 11725 11726 11727 11728 11729 11730 11731 11732
            break;
        case 'q':
            ctl->quiet = TRUE;
            break;
        case 't':
            ctl->timing = TRUE;
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
11733 11734 11735 11736 11737 11738
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
11739 11740 11741
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
11742 11743 11744
        case 'r':
            ctl->readonly = TRUE;
            break;
11745 11746 11747
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
11748
        default:
11749 11750
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
11751 11752 11753 11754
        }
    }

    if (help) {
11755 11756
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
11757 11758
            exit(EXIT_FAILURE);
        }
11759 11760 11761

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
11762
        exit(EXIT_SUCCESS);
11763 11764
    }

11765
    if (argc > optind) {
K
Karel Zak 已提交
11766 11767
        /* parse command */
        ctl->imode = FALSE;
11768 11769 11770
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
11771
        } else {
11772
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
11773 11774 11775 11776 11777
        }
    }
    return TRUE;
}

11778 11779 11780 11781
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
11782
    char *defaultConn;
K
Karel Zak 已提交
11783 11784
    int ret = TRUE;

11785 11786
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
11787
        /* failure to setup locale is not fatal */
11788 11789 11790
    }
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR)) {
        perror("bindtextdomain");
11791
        return -1;
11792 11793 11794
    }
    if (!textdomain(GETTEXT_PACKAGE)) {
        perror("textdomain");
11795
        return -1;
11796 11797
    }

11798
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
11799 11800 11801
        progname = argv[0];
    else
        progname++;
11802

K
Karel Zak 已提交
11803
    memset(ctl, 0, sizeof(vshControl));
11804
    ctl->imode = TRUE;          /* default is interactive mode */
11805
    ctl->log_fd = -1;           /* Initialize log file descriptor */
K
Karel Zak 已提交
11806

11807
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
11808
        ctl->name = vshStrdup(ctl, defaultConn);
11809 11810
    }

D
Daniel P. Berrange 已提交
11811 11812
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
11813
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
11814
    }
11815

D
Daniel P. Berrange 已提交
11816 11817
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
11818
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
11819
    }
11820

K
Karel Zak 已提交
11821
    if (!ctl->imode) {
11822
        ret = vshCommandRun(ctl, ctl->cmd);
11823
    } else {
K
Karel Zak 已提交
11824 11825
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
11826
            vshPrint(ctl,
11827
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
11828
                     progname);
J
Jim Meyering 已提交
11829
            vshPrint(ctl, "%s",
11830
                     _("Type:  'help' for help with commands\n"
11831
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
11832
        }
11833 11834 11835 11836 11837 11838

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
11839
        do {
11840
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
11841
            ctl->cmdstr =
11842
                vshReadline(ctl, prompt);
11843 11844
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
11845
            if (*ctl->cmdstr) {
11846
#if USE_READLINE
K
Karel Zak 已提交
11847
                add_history(ctl->cmdstr);
11848
#endif
11849
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
11850 11851
                    vshCommandRun(ctl, ctl->cmd);
            }
11852
            VIR_FREE(ctl->cmdstr);
11853
        } while (ctl->imode);
K
Karel Zak 已提交
11854

11855 11856
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
11857
    }
11858

K
Karel Zak 已提交
11859 11860
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
11861
}