virsh.c 315.7 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"
K
Karel Zak 已提交
53 54 55 56

static char *progname;

#ifndef TRUE
57 58
# define TRUE 1
# define FALSE 0
K
Karel Zak 已提交
59 60
#endif

61 62
#define VIRSH_MAX_XML_FILE 10*1024*1024

K
Karel Zak 已提交
63 64 65 66 67 68 69 70
#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)

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

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

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

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

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

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

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

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

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

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

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

206

207
static const vshCmdDef commands[];
K
Karel Zak 已提交
208

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

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

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

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

235 236 237
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
238
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
239

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

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

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

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

255 256 257 258 259 260 261 262
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)

263 264 265 266 267 268 269 270
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)

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

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

289 290 291
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
                                        char **name);

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

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

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

304 305 306 307
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

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

317
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
318 319
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
320 321 322 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
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
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397

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

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

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

461
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
462 463 464 465 466 467

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

468 469 470 471 472
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

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

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

K
Karel Zak 已提交
528 529 530 531 532 533
/* ---------------
 * Commands
 * ---------------
 */

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

540
    {NULL, NULL}
K
Karel Zak 已提交
541 542
};

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

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

    if (!cmdname) {
554
        const vshCmdDef *def;
555

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

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

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

static int
582
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
583 584 585 586 587
{
    virDomainPtr dom;
    char *name;
    int autostart;

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

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

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

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

605
    if (autostart)
606
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
607
    else
608
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
609

610
    virDomainFree(dom);
611 612 613
    return TRUE;
}

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

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

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

K
Karel Zak 已提交
636
    if (ctl->conn) {
637
        if (virConnectClose(ctl->conn) != 0) {
638
            vshError(ctl, "%s", _("Failed to disconnect from the hypervisor"));
K
Karel Zak 已提交
639 640 641 642
            return FALSE;
        }
        ctl->conn = NULL;
    }
643

644
    VIR_FREE(ctl->name);
645 646 647 648
    name = vshCommandOptString(cmd, "name", NULL);
    if (!name)
        return FALSE;
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
649

650 651 652 653 654
    if (!ro) {
        ctl->readonly = 0;
    } else {
        ctl->readonly = 1;
    }
K
Karel Zak 已提交
655

656 657 658
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

K
Karel Zak 已提交
662 663 664
    return ctl->conn ? TRUE : FALSE;
}

665 666
#ifndef WIN32

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

677
static const vshCmdOptDef opts_console[] = {
678
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
679 680 681 682
    {NULL, 0, 0, NULL}
};

static int
683
cmdRunConsole(vshControl *ctl, virDomainPtr dom)
684 685 686 687 688 689
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    int ret = FALSE;
    char *doc;
690 691
    char *thatHost = NULL;
    char *thisHost = NULL;
692
    virDomainInfo dominfo;
693

694
    if (!(thisHost = virGetHostname(ctl->conn))) {
695
        vshError(ctl, "%s", _("Failed to get local hostname"));
696 697
        goto cleanup;
    }
698

699
    if (!(thatHost = virConnectGetHostname(ctl->conn))) {
700
        vshError(ctl, "%s", _("Failed to get connection hostname"));
701 702 703 704
        goto cleanup;
    }

    if (STRNEQ(thisHost, thatHost)) {
705
        vshError(ctl, "%s", _("Cannot connect to a remote console device"));
706 707
        goto cleanup;
    }
708

709 710 711 712 713 714 715 716 717 718
    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;
    }

719 720
    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
721
        goto cleanup;
722 723

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
724 725
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
726
    VIR_FREE(doc);
727 728 729 730 731 732 733 734
    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) &&
735
                          (obj->stringval != NULL) && (obj->stringval[0] != 0))) {
736 737
        vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
        vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
738
        if (vshRunConsole((const char *)obj->stringval) == 0)
739 740
            ret = TRUE;
    } else {
J
Jim Meyering 已提交
741
        vshPrintExtra(ctl, "%s", _("No console available for domain\n"));
742 743 744 745
    }
    xmlXPathFreeObject(obj);

 cleanup:
746
    xmlXPathFreeContext(ctxt);
747 748
    if (xml)
        xmlFreeDoc(xml);
749 750
    VIR_FREE(thisHost);
    VIR_FREE(thatHost);
751

752 753 754
    return ret;
}

755 756 757 758 759 760
static int
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int ret;

761
    if (!vshConnectionUsability(ctl, ctl->conn))
762 763 764 765 766 767 768 769 770 771 772
        return FALSE;

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

    ret = cmdRunConsole(ctl, dom);

    virDomainFree(dom);
    return ret;
}

773 774 775
#endif /* WIN32 */


K
Karel Zak 已提交
776 777 778
/*
 * "list" command
 */
779
static const vshCmdInfo info_list[] = {
780 781
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
782
    {NULL, NULL}
K
Karel Zak 已提交
783 784
};

785
static const vshCmdOptDef opts_list[] = {
786 787
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
788 789 790
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
791 792

static int
793
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
794
{
795 796 797 798
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
799
    char **names = NULL;
800 801
    int maxname = 0;
    inactive |= all;
K
Karel Zak 已提交
802

803
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
804
        return FALSE;
805

806
    if (active) {
807 808
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
809
            vshError(ctl, "%s", _("Failed to list active domains"));
810 811 812 813 814 815
            return FALSE;
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
816
                vshError(ctl, "%s", _("Failed to list active domains"));
817
                VIR_FREE(ids);
818 819 820
                return FALSE;
            }

821
            qsort(&ids[0], maxid, sizeof(int), idsorter);
822
        }
823 824
    }
    if (inactive) {
825 826
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
827
            vshError(ctl, "%s", _("Failed to list inactive domains"));
828
            VIR_FREE(ids);
829
            return FALSE;
830
        }
831 832 833 834
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
835
                vshError(ctl, "%s", _("Failed to list inactive domains"));
836 837
                VIR_FREE(ids);
                VIR_FREE(names);
838 839
                return FALSE;
            }
840

841
            qsort(&names[0], maxname, sizeof(char*), namesorter);
842
        }
843
    }
844
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
845
    vshPrintExtra(ctl, "----------------------------------\n");
846 847

    for (i = 0; i < maxid; i++) {
K
Karel Zak 已提交
848 849
        virDomainInfo info;
        virDomainPtr dom = virDomainLookupByID(ctl->conn, ids[i]);
850
        const char *state;
851 852

        /* this kind of work with domains is not atomic operation */
K
Karel Zak 已提交
853 854
        if (!dom)
            continue;
855 856 857 858

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

K
Karel Zak 已提交
861
        vshPrint(ctl, "%3d %-20s %s\n",
862 863
                 virDomainGetID(dom),
                 virDomainGetName(dom),
864
                 state);
865
        virDomainFree(dom);
K
Karel Zak 已提交
866
    }
867 868 869
    for (i = 0; i < maxname; i++) {
        virDomainInfo info;
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);
870
        const char *state;
871 872

        /* this kind of work with domains is not atomic operation */
873
        if (!dom) {
874
            VIR_FREE(names[i]);
875
            continue;
876
        }
877 878 879 880

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

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

885
        virDomainFree(dom);
886
        VIR_FREE(names[i]);
887
    }
888 889
    VIR_FREE(ids);
    VIR_FREE(names);
K
Karel Zak 已提交
890 891 892 893
    return TRUE;
}

/*
K
Karel Zak 已提交
894
 * "domstate" command
K
Karel Zak 已提交
895
 */
896
static const vshCmdInfo info_domstate[] = {
897 898
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
899
    {NULL, NULL}
K
Karel Zak 已提交
900 901
};

902
static const vshCmdOptDef opts_domstate[] = {
903
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
904
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
905 906 907
};

static int
908
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
909
{
910
    virDomainInfo info;
K
Karel Zak 已提交
911
    virDomainPtr dom;
K
Karel Zak 已提交
912
    int ret = TRUE;
913

914
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
915
        return FALSE;
916

J
Jim Meyering 已提交
917
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
K
Karel Zak 已提交
918
        return FALSE;
919 920

    if (virDomainGetInfo(dom, &info) == 0)
K
Karel Zak 已提交
921
        vshPrint(ctl, "%s\n",
E
Eric Blake 已提交
922
                 _(vshDomainStateToString(info.state)));
K
Karel Zak 已提交
923 924
    else
        ret = FALSE;
925

926 927 928 929
    virDomainFree(dom);
    return ret;
}

930 931
/* "domblkstat" command
 */
932
static const vshCmdInfo info_domblkstat[] = {
933 934
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
935 936 937
    {NULL,NULL}
};

938
static const vshCmdOptDef opts_domblkstat[] = {
939 940
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
941 942 943 944
    {NULL, 0, 0, NULL}
};

static int
945
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
946 947 948 949 950
{
    virDomainPtr dom;
    char *name, *device;
    struct _virDomainBlockStats stats;

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

J
Jim Meyering 已提交
954
    if (!(dom = vshCommandOptDomain (ctl, cmd, &name)))
955 956
        return FALSE;

L
Laine Stump 已提交
957 958
    if (!(device = vshCommandOptString (cmd, "device", NULL))) {
        virDomainFree(dom);
959
        return FALSE;
L
Laine Stump 已提交
960
    }
961 962

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

995
static const vshCmdOptDef opts_domifstat[] = {
996 997
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
998 999 1000 1001
    {NULL, 0, 0, NULL}
};

static int
1002
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1003 1004 1005 1006 1007
{
    virDomainPtr dom;
    char *name, *device;
    struct _virDomainInterfaceStats stats;

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

J
Jim Meyering 已提交
1011
    if (!(dom = vshCommandOptDomain (ctl, cmd, &name)))
1012 1013
        return FALSE;

L
Laine Stump 已提交
1014 1015
    if (!(device = vshCommandOptString (cmd, "interface", NULL))) {
        virDomainFree(dom);
1016
        return FALSE;
L
Laine Stump 已提交
1017
    }
1018 1019

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1020
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
        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;
}

1053 1054 1055
/*
 * "dommemstats" command
 */
1056
static const vshCmdInfo info_dommemstat[] = {
1057 1058
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1059 1060 1061
    {NULL,NULL}
};

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

static int
1068
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1069 1070 1071 1072 1073 1074
{
    virDomainPtr dom;
    char *name;
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1075
    if (!vshConnectionUsability(ctl, ctl->conn))
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
        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;
}

1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
/*
 * "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;

1130
    if (!vshConnectionUsability(ctl, ctl->conn))
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
        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;
}

1154 1155 1156
/*
 * "suspend" command
 */
1157
static const vshCmdInfo info_suspend[] = {
1158 1159
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1160
    {NULL, NULL}
1161 1162
};

1163
static const vshCmdOptDef opts_suspend[] = {
1164
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1165
    {NULL, 0, 0, NULL}
1166 1167 1168
};

static int
1169
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1170
{
1171
    virDomainPtr dom;
K
Karel Zak 已提交
1172 1173
    char *name;
    int ret = TRUE;
1174

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

J
Jim Meyering 已提交
1178
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1179
        return FALSE;
1180 1181

    if (virDomainSuspend(dom) == 0) {
1182
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1183
    } else {
1184
        vshError(ctl, _("Failed to suspend domain %s"), name);
1185 1186
        ret = FALSE;
    }
1187

1188 1189 1190 1191
    virDomainFree(dom);
    return ret;
}

1192 1193 1194
/*
 * "create" command
 */
1195
static const vshCmdInfo info_create[] = {
1196 1197
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1198 1199 1200
    {NULL, NULL}
};

1201
static const vshCmdOptDef opts_create[] = {
1202
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1203
#ifndef WIN32
1204
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1205
#endif
1206
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1207 1208 1209 1210
    {NULL, 0, 0, NULL}
};

static int
1211
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1212 1213 1214 1215 1216
{
    virDomainPtr dom;
    char *from;
    int found;
    int ret = TRUE;
1217
    char *buffer;
1218
#ifndef WIN32
1219
    int console = vshCommandOptBool(cmd, "console");
1220
#endif
1221
    unsigned int flags = VIR_DOMAIN_NONE;
1222

1223
    if (!vshConnectionUsability(ctl, ctl->conn))
1224 1225 1226 1227 1228 1229
        return FALSE;

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

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

1233 1234 1235 1236
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1237
    VIR_FREE(buffer);
1238

1239
    if (dom != NULL) {
1240
        vshPrint(ctl, _("Domain %s created from %s\n"),
1241
                 virDomainGetName(dom), from);
1242
#ifndef WIN32
1243 1244
        if (console)
            cmdRunConsole(ctl, dom);
1245
#endif
1246
        virDomainFree(dom);
1247
    } else {
1248
        vshError(ctl, _("Failed to create domain from %s"), from);
1249 1250 1251 1252 1253
        ret = FALSE;
    }
    return ret;
}

1254 1255 1256
/*
 * "define" command
 */
1257
static const vshCmdInfo info_define[] = {
1258 1259
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1260 1261 1262
    {NULL, NULL}
};

1263
static const vshCmdOptDef opts_define[] = {
1264
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1265 1266 1267 1268
    {NULL, 0, 0, NULL}
};

static int
1269
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1270 1271 1272 1273 1274
{
    virDomainPtr dom;
    char *from;
    int found;
    int ret = TRUE;
1275
    char *buffer;
1276

1277
    if (!vshConnectionUsability(ctl, ctl->conn))
1278 1279 1280 1281 1282 1283
        return FALSE;

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

1284 1285
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
1286 1287

    dom = virDomainDefineXML(ctl->conn, buffer);
1288
    VIR_FREE(buffer);
1289

1290
    if (dom != NULL) {
1291
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1292
                 virDomainGetName(dom), from);
1293
        virDomainFree(dom);
1294
    } else {
1295
        vshError(ctl, _("Failed to define domain from %s"), from);
1296 1297 1298 1299 1300 1301 1302 1303
        ret = FALSE;
    }
    return ret;
}

/*
 * "undefine" command
 */
1304
static const vshCmdInfo info_undefine[] = {
1305 1306
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1307 1308 1309
    {NULL, NULL}
};

1310
static const vshCmdOptDef opts_undefine[] = {
1311
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1312 1313 1314 1315
    {NULL, 0, 0, NULL}
};

static int
1316
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1317 1318 1319 1320
{
    virDomainPtr dom;
    int ret = TRUE;
    char *name;
1321 1322
    int found;
    int id;
1323

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

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

    if (virDomainUndefine(dom) == 0) {
1346
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1347
    } else {
1348
        vshError(ctl, _("Failed to undefine domain %s"), name);
1349 1350 1351
        ret = FALSE;
    }

1352
    virDomainFree(dom);
1353 1354 1355 1356 1357 1358 1359
    return ret;
}


/*
 * "start" command
 */
1360
static const vshCmdInfo info_start[] = {
1361 1362
    {"help", N_("start a (previously defined) inactive domain")},
    {"desc", N_("Start a domain.")},
1363 1364 1365
    {NULL, NULL}
};

1366
static const vshCmdOptDef opts_start[] = {
1367
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1368
#ifndef WIN32
1369
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1370
#endif
E
Eric Blake 已提交
1371
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1372 1373 1374 1375
    {NULL, 0, 0, NULL}
};

static int
1376
cmdStart(vshControl *ctl, const vshCmd *cmd)
1377 1378 1379
{
    virDomainPtr dom;
    int ret = TRUE;
1380
#ifndef WIN32
1381
    int console = vshCommandOptBool(cmd, "console");
1382
#endif
E
Eric Blake 已提交
1383
    unsigned int flags = VIR_DOMAIN_NONE;
1384

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

J
Jim Meyering 已提交
1388
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL, VSH_BYNAME)))
1389 1390 1391
        return FALSE;

    if (virDomainGetID(dom) != (unsigned int)-1) {
1392
        vshError(ctl, "%s", _("Domain is already active"));
1393
        virDomainFree(dom);
1394 1395 1396
        return FALSE;
    }

E
Eric Blake 已提交
1397 1398 1399 1400 1401 1402
    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) {
1403
        vshPrint(ctl, _("Domain %s started\n"),
1404
                 virDomainGetName(dom));
1405
#ifndef WIN32
1406 1407
        if (console)
            cmdRunConsole(ctl, dom);
1408
#endif
1409
    } else {
1410
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
1411 1412
        ret = FALSE;
    }
1413
    virDomainFree(dom);
1414 1415 1416
    return ret;
}

1417 1418 1419
/*
 * "save" command
 */
1420
static const vshCmdInfo info_save[] = {
1421 1422
    {"help", N_("save a domain state to a file")},
    {"desc", N_("Save a running domain.")},
1423
    {NULL, NULL}
1424 1425
};

1426
static const vshCmdOptDef opts_save[] = {
1427 1428
    {"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")},
1429
    {NULL, 0, 0, NULL}
1430 1431 1432
};

static int
1433
cmdSave(vshControl *ctl, const vshCmd *cmd)
1434
{
1435 1436 1437 1438
    virDomainPtr dom;
    char *name;
    char *to;
    int ret = TRUE;
1439

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

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

J
Jim Meyering 已提交
1446
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1447
        return FALSE;
1448 1449

    if (virDomainSave(dom, to) == 0) {
1450
        vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
1451
    } else {
1452
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
1453 1454
        ret = FALSE;
    }
1455

1456 1457 1458 1459
    virDomainFree(dom);
    return ret;
}

1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
    {"desc", N_("Save and stop a running domain, so libvirt can restart it from the same state")},
    {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;

1481
    if (!vshConnectionUsability(ctl, ctl->conn))
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
        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;
}

1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
/*
 * "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;

1520
    if (!vshConnectionUsability(ctl, ctl->conn))
1521 1522 1523 1524 1525 1526 1527
        return FALSE;

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

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1528
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551
        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;
}

1552 1553 1554
/*
 * "schedinfo" command
 */
1555
static const vshCmdInfo info_schedinfo[] = {
1556 1557
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1558 1559 1560
    {NULL, NULL}
};

1561
static const vshCmdOptDef opts_schedinfo[] = {
1562 1563 1564 1565
    {"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")},
1566 1567 1568 1569
    {NULL, 0, 0, NULL}
};

static int
1570 1571
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
                   virSchedParameterPtr param)
1572
{
1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
    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) {
1583
            vshError(ctl, "%s", _("Invalid value of weight"));
1584
            return -1;
1585
        } else {
1586
            param->value.ui = val;
1587
        }
1588
        return 1;
1589 1590
    }

1591 1592 1593 1594 1595 1596 1597
    /* 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) {
1598
            vshError(ctl, "%s", _("Invalid value of cap"));
1599
            return -1;
1600
        } else {
1601
            param->value.ui = val;
1602
        }
1603
        return 1;
1604
    }
1605

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

1662 1663
    return 0;
}
1664

1665

1666 1667 1668 1669 1670 1671 1672 1673 1674 1675
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;
1676

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

1680 1681
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return FALSE;
1682 1683 1684 1685

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
    if (schedulertype!= NULL){
1686
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
1687
             schedulertype);
1688
        VIR_FREE(schedulertype);
1689
    } else {
1690
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
1691
        goto cleanup;
1692 1693
    }

1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
    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;
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
        } 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;
            }
1731 1732 1733
        }

        ret_val = TRUE;
1734 1735 1736
        for (i = 0; i < nparams; i++){
            switch (params[i].type) {
            case VIR_DOMAIN_SCHED_FIELD_INT:
1737
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1738 1739
                 break;
            case VIR_DOMAIN_SCHED_FIELD_UINT:
1740
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1741 1742
                 break;
            case VIR_DOMAIN_SCHED_FIELD_LLONG:
1743
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1744 1745
                 break;
            case VIR_DOMAIN_SCHED_FIELD_ULLONG:
1746
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1747 1748
                 break;
            case VIR_DOMAIN_SCHED_FIELD_DOUBLE:
1749
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1750 1751
                 break;
            case VIR_DOMAIN_SCHED_FIELD_BOOLEAN:
1752
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
1753 1754
                 break;
            default:
1755
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
1756 1757 1758
            }
        }
    }
1759

1760
 cleanup:
1761
    VIR_FREE(params);
1762
    virDomainFree(dom);
1763
    return ret_val;
1764 1765
}

1766 1767 1768
/*
 * "restore" command
 */
1769
static const vshCmdInfo info_restore[] = {
1770 1771
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
1772
    {NULL, NULL}
1773 1774
};

1775
static const vshCmdOptDef opts_restore[] = {
1776
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
1777
    {NULL, 0, 0, NULL}
1778 1779 1780
};

static int
1781
cmdRestore(vshControl *ctl, const vshCmd *cmd)
1782
{
1783 1784 1785
    char *from;
    int found;
    int ret = TRUE;
1786

1787
    if (!vshConnectionUsability(ctl, ctl->conn))
1788 1789 1790 1791 1792
        return FALSE;

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

    if (virDomainRestore(ctl->conn, from) == 0) {
1795
        vshPrint(ctl, _("Domain restored from %s\n"), from);
1796
    } else {
1797
        vshError(ctl, _("Failed to restore domain from %s"), from);
1798 1799 1800 1801 1802
        ret = FALSE;
    }
    return ret;
}

D
Daniel Veillard 已提交
1803 1804 1805
/*
 * "dump" command
 */
1806
static const vshCmdInfo info_dump[] = {
1807 1808
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
1809 1810 1811
    {NULL, NULL}
};

1812
static const vshCmdOptDef opts_dump[] = {
1813 1814 1815 1816
    {"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 已提交
1817 1818 1819 1820
    {NULL, 0, 0, NULL}
};

static int
1821
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
1822 1823 1824 1825 1826
{
    virDomainPtr dom;
    char *name;
    char *to;
    int ret = TRUE;
1827
    int flags = 0;
D
Daniel Veillard 已提交
1828

1829
    if (!vshConnectionUsability(ctl, ctl->conn))
D
Daniel Veillard 已提交
1830 1831 1832 1833 1834
        return FALSE;

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

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

P
Paolo Bonzini 已提交
1838 1839
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
1840 1841 1842 1843
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;

    if (virDomainCoreDump(dom, to, flags) == 0) {
1844
        vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
D
Daniel Veillard 已提交
1845
    } else {
1846
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
D
Daniel Veillard 已提交
1847 1848 1849 1850 1851 1852 1853
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

1854 1855 1856
/*
 * "resume" command
 */
1857
static const vshCmdInfo info_resume[] = {
1858 1859
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
1860
    {NULL, NULL}
1861 1862
};

1863
static const vshCmdOptDef opts_resume[] = {
1864
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1865
    {NULL, 0, 0, NULL}
1866 1867 1868
};

static int
1869
cmdResume(vshControl *ctl, const vshCmd *cmd)
1870
{
1871
    virDomainPtr dom;
K
Karel Zak 已提交
1872 1873
    int ret = TRUE;
    char *name;
1874

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

J
Jim Meyering 已提交
1878
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1879
        return FALSE;
1880 1881

    if (virDomainResume(dom) == 0) {
1882
        vshPrint(ctl, _("Domain %s resumed\n"), name);
1883
    } else {
1884
        vshError(ctl, _("Failed to resume domain %s"), name);
1885 1886
        ret = FALSE;
    }
1887

1888 1889 1890 1891
    virDomainFree(dom);
    return ret;
}

1892 1893 1894
/*
 * "shutdown" command
 */
1895
static const vshCmdInfo info_shutdown[] = {
1896 1897
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
1898
    {NULL, NULL}
1899 1900
};

1901
static const vshCmdOptDef opts_shutdown[] = {
1902
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1903
    {NULL, 0, 0, NULL}
1904 1905 1906
};

static int
1907
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
1908
{
1909 1910 1911
    virDomainPtr dom;
    int ret = TRUE;
    char *name;
1912

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

J
Jim Meyering 已提交
1916
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1917
        return FALSE;
1918 1919

    if (virDomainShutdown(dom) == 0) {
1920
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
1921
    } else {
1922
        vshError(ctl, _("Failed to shutdown domain %s"), name);
1923 1924
        ret = FALSE;
    }
1925

1926 1927 1928 1929
    virDomainFree(dom);
    return ret;
}

1930 1931 1932
/*
 * "reboot" command
 */
1933
static const vshCmdInfo info_reboot[] = {
1934 1935
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
1936 1937 1938
    {NULL, NULL}
};

1939
static const vshCmdOptDef opts_reboot[] = {
1940
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1941 1942 1943 1944
    {NULL, 0, 0, NULL}
};

static int
1945
cmdReboot(vshControl *ctl, const vshCmd *cmd)
1946 1947 1948 1949 1950
{
    virDomainPtr dom;
    int ret = TRUE;
    char *name;

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

J
Jim Meyering 已提交
1954
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1955 1956 1957
        return FALSE;

    if (virDomainReboot(dom, 0) == 0) {
1958
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
1959
    } else {
1960
        vshError(ctl, _("Failed to reboot domain %s"), name);
1961 1962 1963 1964 1965 1966 1967
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

1968 1969 1970
/*
 * "destroy" command
 */
1971
static const vshCmdInfo info_destroy[] = {
1972 1973
    {"help", N_("destroy a domain")},
    {"desc", N_("Destroy a given domain.")},
1974
    {NULL, NULL}
1975 1976
};

1977
static const vshCmdOptDef opts_destroy[] = {
1978
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1979
    {NULL, 0, 0, NULL}
1980 1981 1982
};

static int
1983
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
1984
{
1985
    virDomainPtr dom;
K
Karel Zak 已提交
1986 1987
    int ret = TRUE;
    char *name;
1988

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

J
Jim Meyering 已提交
1992
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
1993
        return FALSE;
1994 1995

    if (virDomainDestroy(dom) == 0) {
1996
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
1997
    } else {
1998
        vshError(ctl, _("Failed to destroy domain %s"), name);
1999 2000
        ret = FALSE;
    }
2001

2002
    virDomainFree(dom);
K
Karel Zak 已提交
2003 2004 2005 2006
    return ret;
}

/*
2007
 * "dominfo" command
K
Karel Zak 已提交
2008
 */
2009
static const vshCmdInfo info_dominfo[] = {
2010 2011
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2012
    {NULL, NULL}
K
Karel Zak 已提交
2013 2014
};

2015
static const vshCmdOptDef opts_dominfo[] = {
2016
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2017
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2018 2019 2020
};

static int
2021
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2022
{
K
Karel Zak 已提交
2023 2024
    virDomainInfo info;
    virDomainPtr dom;
2025 2026
    virSecurityModel secmodel;
    virSecurityLabel seclabel;
2027
    int persistent = 0;
2028
    int ret = TRUE, autostart;
2029
    unsigned int id;
2030
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2031

2032
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
2033 2034
        return FALSE;

J
Jim Meyering 已提交
2035
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
K
Karel Zak 已提交
2036
        return FALSE;
2037

2038 2039
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2040
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2041
    else
2042
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2043 2044
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2045
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2046
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2047 2048

    if ((str = virDomainGetOSType(dom))) {
2049
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2050
        VIR_FREE(str);
2051 2052 2053
    }

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

2057
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2058 2059

        if (info.cpuTime != 0) {
2060
            double cpuUsed = info.cpuTime;
2061

2062
            cpuUsed /= 1000000000.0;
2063

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

2067 2068
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2069
                 info.maxMem);
2070
        else
2071
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2072 2073
                 _("no limit"));

2074
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2075 2076
                 info.memory);

K
Karel Zak 已提交
2077 2078 2079
    } else {
        ret = FALSE;
    }
2080

2081 2082 2083 2084 2085 2086 2087 2088 2089
    /* 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 */
2090
    if (!virDomainGetAutostart(dom, &autostart)) {
2091
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2092 2093 2094
                 autostart ? _("enable") : _("disable") );
    }

2095 2096 2097
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2098 2099 2100 2101
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
            return FALSE;
        }
2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119
    } 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");
            }
        }
    }
2120
    virDomainFree(dom);
K
Karel Zak 已提交
2121 2122 2123
    return ret;
}

2124 2125 2126 2127
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2128 2129
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2130 2131 2132 2133
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2134
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2135 2136 2137 2138 2139 2140 2141 2142 2143
    {NULL, 0, 0, NULL}
};


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

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

2207 2208 2209 2210
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2211 2212
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2213 2214 2215 2216
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2217
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2218 2219 2220 2221 2222 2223 2224 2225 2226
    {NULL, 0, 0, NULL}
};

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

2227
    if (!vshConnectionUsability(ctl, ctl->conn))
2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239
        return FALSE;

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

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

    virDomainFree(dom);
    return ret;
}

2240 2241 2242
/*
 * "freecell" command
 */
2243
static const vshCmdInfo info_freecell[] = {
2244 2245
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2246 2247 2248
    {NULL, NULL}
};

2249
static const vshCmdOptDef opts_freecell[] = {
2250
    {"cellno", VSH_OT_DATA, 0, N_("NUMA cell number")},
2251 2252 2253 2254
    {NULL, 0, 0, NULL}
};

static int
2255
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2256 2257 2258 2259 2260
{
    int ret;
    int cell, cell_given;
    unsigned long long memory;

2261
    if (!vshConnectionUsability(ctl, ctl->conn))
2262 2263 2264 2265
        return FALSE;

    cell = vshCommandOptInt(cmd, "cellno", &cell_given);
    if (!cell_given) {
2266
        memory = virNodeGetFreeMemory(ctl->conn);
D
Daniel P. Berrange 已提交
2267 2268
        if (memory == 0)
            return FALSE;
2269
    } else {
2270 2271 2272
        ret = virNodeGetCellsFreeMemory(ctl->conn, &memory, cell, 1);
        if (ret != 1)
            return FALSE;
2273 2274 2275
    }

    if (cell == -1)
D
Daniel P. Berrange 已提交
2276
        vshPrint(ctl, "%s: %llu kB\n", _("Total"), (memory/1024));
2277
    else
D
Daniel P. Berrange 已提交
2278
        vshPrint(ctl, "%d: %llu kB\n", cell, (memory/1024));
2279 2280 2281 2282

    return TRUE;
}

2283 2284 2285
/*
 * "vcpuinfo" command
 */
2286
static const vshCmdInfo info_vcpuinfo[] = {
2287 2288
    {"help", N_("domain vcpu information")},
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
2289 2290 2291
    {NULL, NULL}
};

2292
static const vshCmdOptDef opts_vcpuinfo[] = {
2293
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2294 2295 2296 2297
    {NULL, 0, 0, NULL}
};

static int
2298
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
2299 2300 2301 2302 2303 2304 2305 2306 2307 2308
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
    unsigned char *cpumap;
    int ncpus;
    size_t cpumaplen;
    int ret = TRUE;

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

J
Jim Meyering 已提交
2312
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2313 2314 2315 2316
        return FALSE;

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
2317
        return FALSE;
2318 2319 2320 2321 2322 2323 2324
    }

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

2325
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
2326
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2327
    cpumap = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
2328

2329 2330 2331
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
                                   cpumap, cpumaplen)) >= 0) {
2332
        int n;
2333 2334 2335 2336 2337
        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 已提交
2338
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354
            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");
            }
        }
2355
    } else {
2356
        if (info.state == VIR_DOMAIN_SHUTOFF) {
2357 2358
            vshError(ctl, "%s",
                     _("Domain shut off, virtual CPUs not present."));
2359
        }
2360 2361 2362
        ret = FALSE;
    }

2363 2364
    VIR_FREE(cpumap);
    VIR_FREE(cpuinfo);
2365 2366 2367 2368 2369 2370 2371
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
2372
static const vshCmdInfo info_vcpupin[] = {
2373 2374
    {"help", N_("control domain vcpu affinity")},
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
2375 2376 2377
    {NULL, NULL}
};

2378
static const vshCmdOptDef opts_vcpupin[] = {
2379 2380 2381
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"vcpu", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vcpu number")},
    {"cpulist", VSH_OT_DATA, VSH_OFLAG_REQ, N_("host cpu number(s) (comma separated)")},
2382 2383 2384 2385
    {NULL, 0, 0, NULL}
};

static int
2386
cmdVcpupin(vshControl *ctl, const vshCmd *cmd)
2387 2388 2389 2390 2391 2392 2393 2394 2395 2396
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    int vcpu;
    char *cpulist;
    int ret = TRUE;
    int vcpufound = 0;
    unsigned char *cpumap;
    int cpumaplen;
2397 2398
    int i;
    enum { expect_num, expect_num_or_comma } state;
2399

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

J
Jim Meyering 已提交
2403
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2404 2405 2406 2407
        return FALSE;

    vcpu = vshCommandOptInt(cmd, "vcpu", &vcpufound);
    if (!vcpufound) {
2408
        vshError(ctl, "%s", _("vcpupin: Invalid or missing vCPU number."));
2409 2410 2411 2412 2413 2414 2415 2416
        virDomainFree(dom);
        return FALSE;
    }

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

2418 2419 2420 2421 2422 2423
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
        return FALSE;
    }

    if (virDomainGetInfo(dom, &info) != 0) {
2424
        vshError(ctl, "%s", _("vcpupin: failed to get domain informations."));
2425 2426 2427 2428 2429
        virDomainFree(dom);
        return FALSE;
    }

    if (vcpu >= info.nrVirtCpu) {
2430
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
2431 2432 2433 2434
        virDomainFree(dom);
        return FALSE;
    }

2435 2436 2437 2438
    /* Check that the cpulist parameter is a comma-separated list of
     * numbers and give an intelligent error message if not.
     */
    if (cpulist[0] == '\0') {
2439
        vshError(ctl, "%s", _("cpulist: Invalid format. Empty string."));
2440 2441 2442 2443 2444 2445 2446 2447
        virDomainFree (dom);
        return FALSE;
    }

    state = expect_num;
    for (i = 0; cpulist[i]; i++) {
        switch (state) {
        case expect_num:
2448
          if (!c_isdigit (cpulist[i])) {
2449 2450 2451
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2452 2453 2454 2455 2456 2457 2458 2459
                virDomainFree (dom);
                return FALSE;
            }
            state = expect_num_or_comma;
            break;
        case expect_num_or_comma:
            if (cpulist[i] == ',')
                state = expect_num;
2460
            else if (!c_isdigit (cpulist[i])) {
2461 2462 2463
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit or comma at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2464 2465 2466 2467 2468 2469
                virDomainFree (dom);
                return FALSE;
            }
        }
    }
    if (state == expect_num) {
2470 2471 2472
        vshError(ctl, _("cpulist: %s: Invalid format. Trailing comma "
                        "at position %d."),
                 cpulist, i);
2473 2474 2475 2476
        virDomainFree (dom);
        return FALSE;
    }

2477
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2478
    cpumap = vshCalloc(ctl, 1, cpumaplen);
2479 2480 2481 2482 2483 2484

    do {
        unsigned int cpu = atoi(cpulist);

        if (cpu < VIR_NODEINFO_MAXCPUS(nodeinfo)) {
            VIR_USE_CPU(cpumap, cpu);
2485
        } else {
2486
            vshError(ctl, _("Physical CPU %d doesn't exist."), cpu);
2487
            VIR_FREE(cpumap);
2488 2489
            virDomainFree(dom);
            return FALSE;
2490
        }
2491
        cpulist = strchr(cpulist, ',');
2492 2493 2494 2495 2496 2497 2498 2499
        if (cpulist)
            cpulist++;
    } while (cpulist);

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

2500
    VIR_FREE(cpumap);
2501 2502 2503 2504
    virDomainFree(dom);
    return ret;
}

2505 2506 2507
/*
 * "setvcpus" command
 */
2508
static const vshCmdInfo info_setvcpus[] = {
2509 2510
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
2511 2512 2513
    {NULL, NULL}
};

2514
static const vshCmdOptDef opts_setvcpus[] = {
2515 2516
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"count", VSH_OT_DATA, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
2517 2518 2519 2520
    {NULL, 0, 0, NULL}
};

static int
2521
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
2522 2523 2524
{
    virDomainPtr dom;
    int count;
2525
    int maxcpu;
2526 2527
    int ret = TRUE;

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

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

    count = vshCommandOptInt(cmd, "count", &count);
2535
    if (count <= 0) {
2536
        vshError(ctl, "%s", _("Invalid number of virtual CPUs."));
2537 2538 2539 2540
        virDomainFree(dom);
        return FALSE;
    }

2541
    maxcpu = virDomainGetMaxVcpus(dom);
2542
    if (maxcpu <= 0) {
2543 2544 2545 2546 2547
        virDomainFree(dom);
        return FALSE;
    }

    if (count > maxcpu) {
2548
        vshError(ctl, "%s", _("Too many virtual CPUs."));
2549 2550 2551 2552
        virDomainFree(dom);
        return FALSE;
    }

2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563
    if (virDomainSetVcpus(dom, count) != 0) {
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmemory" command
 */
2564
static const vshCmdInfo info_setmem[] = {
2565 2566
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
2567 2568 2569
    {NULL, NULL}
};

2570
static const vshCmdOptDef opts_setmem[] = {
2571 2572
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"kilobytes", VSH_OT_DATA, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
2573 2574 2575 2576
    {NULL, 0, 0, NULL}
};

static int
2577
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
2578 2579
{
    virDomainPtr dom;
2580
    virDomainInfo info;
2581
    unsigned long kilobytes;
2582 2583
    int ret = TRUE;

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

J
Jim Meyering 已提交
2587
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2588 2589
        return FALSE;

2590
    kilobytes = vshCommandOptUL(cmd, "kilobytes", NULL);
2591
    if (kilobytes <= 0) {
2592
        virDomainFree(dom);
2593
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
2594 2595 2596
        return FALSE;
    }

2597 2598
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
2599
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
2600 2601 2602 2603 2604
        return FALSE;
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
2605
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
2606
                 kilobytes, info.maxMem);
2607 2608 2609
        return FALSE;
    }

2610
    if (virDomainSetMemory(dom, kilobytes) != 0) {
2611 2612 2613 2614 2615 2616 2617 2618 2619 2620
        ret = FALSE;
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
2621
static const vshCmdInfo info_setmaxmem[] = {
2622 2623
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
2624 2625 2626
    {NULL, NULL}
};

2627
static const vshCmdOptDef opts_setmaxmem[] = {
2628 2629
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"kilobytes", VSH_OT_DATA, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
2630 2631 2632 2633
    {NULL, 0, 0, NULL}
};

static int
2634
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
2635 2636
{
    virDomainPtr dom;
2637
    virDomainInfo info;
2638
    int kilobytes;
2639 2640
    int ret = TRUE;

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

J
Jim Meyering 已提交
2644
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2645 2646
        return FALSE;

2647 2648
    kilobytes = vshCommandOptInt(cmd, "kilobytes", &kilobytes);
    if (kilobytes <= 0) {
2649
        virDomainFree(dom);
2650
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
2651 2652 2653
        return FALSE;
    }

2654 2655
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
2656
        vshError(ctl, "%s", _("Unable to verify current MemorySize"));
2657 2658 2659
        return FALSE;
    }

2660 2661 2662 2663 2664 2665
    if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
        vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
        virDomainFree(dom);
        return FALSE;
    }

2666 2667
    if (kilobytes < info.memory) {
        if (virDomainSetMemory(dom, kilobytes) != 0) {
2668
            vshError(ctl, "%s", _("Unable to shrink current MemorySize"));
2669
            ret = FALSE;
2670 2671 2672
        }
    }

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

2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822
/*
 * "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")},
    {VIR_DOMAIN_MEMORY_HARD_LIMIT, VSH_OT_STRING, VSH_OFLAG_NONE,
     N_("Max memory in kilobytes")},
    {VIR_DOMAIN_MEMORY_SOFT_LIMIT, VSH_OT_STRING, VSH_OFLAG_NONE,
     N_("Memory during contention in kilobytes")},
    {VIR_DOMAIN_SWAP_HARD_LIMIT, VSH_OT_STRING, VSH_OFLAG_NONE,
     N_("Max swap in kilobytes")},
    {NULL, 0, 0, NULL}
};

static int
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int hard_limit, soft_limit, swap_hard_limit;
    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 =
        vshCommandOptInt(cmd, VIR_DOMAIN_MEMORY_HARD_LIMIT, &hard_limit);
    if (hard_limit)
        nparams++;

    soft_limit =
        vshCommandOptInt(cmd, VIR_DOMAIN_MEMORY_SOFT_LIMIT, &soft_limit);
    if (soft_limit)
        nparams++;

    swap_hard_limit =
        vshCommandOptInt(cmd, VIR_DOMAIN_SWAP_HARD_LIMIT,
                         &swap_hard_limit);
    if (swap_hard_limit)
        nparams++;

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

        /* now go get all the memory parameters */
        params = vshMalloc(ctl, sizeof(virMemoryParameter) * nparams);
        memset(params, 0, sizeof(virMemoryParameter) * nparams);
        if (virDomainGetMemoryParameters(dom, params, &nparams, 0)) {
            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:
                    vshPrint(ctl, "unimplemented scheduler parameter type\n");
            }
        }

        ret = TRUE;
    } else {
        /* set the memory parameters */
        params = vshMalloc(ctl, sizeof(virMemoryParameter) * nparams);

        memset(params, 0, sizeof(virMemoryParameter) * nparams);
        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;
                strncpy(temp->field, VIR_DOMAIN_SWAP_HARD_LIMIT,
                        sizeof(temp->field));
                swap_hard_limit = 0;
            }
        }
        if (virDomainSetMemoryParameters(dom, params, nparams, 0) != 0)
            vshError(ctl, "%s", _("Unable to change Memory Parameters"));
        else
            ret = TRUE;
    }

  cleanup:
    virDomainFree(dom);
    return ret;
}

2823 2824 2825
/*
 * "nodeinfo" command
 */
2826
static const vshCmdInfo info_nodeinfo[] = {
2827 2828
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
2829 2830 2831 2832
    {NULL, NULL}
};

static int
2833
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
2834 2835
{
    virNodeInfo info;
2836

2837
    if (!vshConnectionUsability(ctl, ctl->conn))
2838 2839 2840
        return FALSE;

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
2841
        vshError(ctl, "%s", _("failed to get node information"));
2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852
        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);

2853 2854 2855
    return TRUE;
}

2856 2857 2858
/*
 * "capabilities" command
 */
2859
static const vshCmdInfo info_capabilities[] = {
2860 2861
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
2862 2863 2864 2865
    {NULL, NULL}
};

static int
2866
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
2867 2868 2869
{
    char *caps;

2870
    if (!vshConnectionUsability(ctl, ctl->conn))
2871 2872 2873
        return FALSE;

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
2874
        vshError(ctl, "%s", _("failed to get capabilities"));
2875 2876 2877
        return FALSE;
    }
    vshPrint (ctl, "%s\n", caps);
2878
    VIR_FREE(caps);
2879 2880 2881 2882

    return TRUE;
}

2883 2884 2885
/*
 * "dumpxml" command
 */
2886
static const vshCmdInfo info_dumpxml[] = {
2887 2888
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
2889
    {NULL, NULL}
2890 2891
};

2892
static const vshCmdOptDef opts_dumpxml[] = {
2893 2894 2895
    {"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")},
2896
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
2897
    {NULL, 0, 0, NULL}
2898 2899 2900
};

static int
2901
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
2902
{
2903
    virDomainPtr dom;
K
Karel Zak 已提交
2904
    int ret = TRUE;
2905
    char *dump;
2906 2907 2908
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
2909
    int update = vshCommandOptBool(cmd, "update-cpu");
2910 2911 2912 2913 2914

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
2915 2916
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
2917

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

J
Jim Meyering 已提交
2921
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
2922
        return FALSE;
2923

2924
    dump = virDomainGetXMLDesc(dom, flags);
2925
    if (dump != NULL) {
2926
        vshPrint(ctl, "%s", dump);
2927
        VIR_FREE(dump);
2928 2929 2930
    } else {
        ret = FALSE;
    }
2931

2932 2933 2934 2935
    virDomainFree(dom);
    return ret;
}

2936 2937 2938 2939
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
2940 2941
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
2942 2943 2944 2945
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
2946 2947
    {"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")},
2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960
    {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;

2961
    if (!vshConnectionUsability(ctl, ctl->conn))
2962 2963 2964 2965 2966
        return FALSE;

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

2967
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
2968 2969 2970 2971
        return FALSE;

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
2972
        vshPrint(ctl, "%s", xmlData);
2973
        VIR_FREE(xmlData);
2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984
    } else {
        ret = FALSE;
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
2985 2986
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
2987 2988 2989 2990
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
2991 2992
    {"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")},
2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005
    {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;

3006
    if (!vshConnectionUsability(ctl, ctl->conn))
3007 3008 3009 3010 3011
        return FALSE;

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

3012
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
3013 3014 3015 3016
        return FALSE;

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
3017
        vshPrint(ctl, "%s", configData);
3018
        VIR_FREE(configData);
3019 3020 3021 3022 3023 3024 3025
    } else {
        ret = FALSE;
    }

    return ret;
}

K
Karel Zak 已提交
3026
/*
K
Karel Zak 已提交
3027
 * "domname" command
K
Karel Zak 已提交
3028
 */
3029
static const vshCmdInfo info_domname[] = {
3030
    {"help", N_("convert a domain id or UUID to domain name")},
3031
    {"desc", ""},
3032
    {NULL, NULL}
K
Karel Zak 已提交
3033 3034
};

3035
static const vshCmdOptDef opts_domname[] = {
3036
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
3037
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3038 3039 3040
};

static int
3041
cmdDomname(vshControl *ctl, const vshCmd *cmd)
3042
{
K
Karel Zak 已提交
3043 3044
    virDomainPtr dom;

3045
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3046
        return FALSE;
J
Jim Meyering 已提交
3047
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3048
                                      VSH_BYID|VSH_BYUUID)))
K
Karel Zak 已提交
3049
        return FALSE;
3050

K
Karel Zak 已提交
3051 3052
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
K
Karel Zak 已提交
3053 3054 3055 3056
    return TRUE;
}

/*
K
Karel Zak 已提交
3057
 * "domid" command
K
Karel Zak 已提交
3058
 */
3059
static const vshCmdInfo info_domid[] = {
3060
    {"help", N_("convert a domain name or UUID to domain id")},
3061
    {"desc", ""},
3062
    {NULL, NULL}
K
Karel Zak 已提交
3063 3064
};

3065
static const vshCmdOptDef opts_domid[] = {
3066
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
3067
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3068 3069 3070
};

static int
3071
cmdDomid(vshControl *ctl, const vshCmd *cmd)
3072
{
3073
    virDomainPtr dom;
3074
    unsigned int id;
K
Karel Zak 已提交
3075

3076
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3077
        return FALSE;
J
Jim Meyering 已提交
3078
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3079
                                      VSH_BYNAME|VSH_BYUUID)))
K
Karel Zak 已提交
3080
        return FALSE;
3081

3082 3083
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3084
        vshPrint(ctl, "%s\n", "-");
3085
    else
3086
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
3087 3088 3089
    virDomainFree(dom);
    return TRUE;
}
3090

K
Karel Zak 已提交
3091 3092 3093
/*
 * "domuuid" command
 */
3094
static const vshCmdInfo info_domuuid[] = {
3095
    {"help", N_("convert a domain name or id to domain UUID")},
3096
    {"desc", ""},
K
Karel Zak 已提交
3097 3098 3099
    {NULL, NULL}
};

3100
static const vshCmdOptDef opts_domuuid[] = {
3101
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
3102 3103 3104 3105
    {NULL, 0, 0, NULL}
};

static int
3106
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
3107 3108
{
    virDomainPtr dom;
3109
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
3110

3111
    if (!vshConnectionUsability(ctl, ctl->conn))
K
Karel Zak 已提交
3112
        return FALSE;
J
Jim Meyering 已提交
3113
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3114
                                      VSH_BYNAME|VSH_BYID)))
K
Karel Zak 已提交
3115
        return FALSE;
3116

K
Karel Zak 已提交
3117 3118 3119
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
3120
        vshError(ctl, "%s", _("failed to get domain UUID"));
3121

3122
    virDomainFree(dom);
K
Karel Zak 已提交
3123 3124 3125
    return TRUE;
}

3126 3127 3128
/*
 * "migrate" command
 */
3129
static const vshCmdInfo info_migrate[] = {
3130 3131
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
3132 3133 3134
    {NULL, NULL}
};

3135
static const vshCmdOptDef opts_migrate[] = {
3136 3137 3138 3139 3140 3141 3142
    {"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")},
3143 3144
    {"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)")},
3145 3146 3147 3148
    {"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)")},
3149 3150 3151 3152
    {NULL, 0, 0, NULL}
};

static int
3153
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
3154 3155 3156 3157
{
    virDomainPtr dom = NULL;
    const char *desturi;
    const char *migrateuri;
D
Daniel Veillard 已提交
3158
    const char *dname;
3159 3160
    int flags = 0, found, ret = FALSE;

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

J
Jim Meyering 已提交
3164
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
3165 3166 3167
        return FALSE;

    desturi = vshCommandOptString (cmd, "desturi", &found);
3168
    if (!found)
3169 3170
        goto done;

3171
    migrateuri = vshCommandOptString (cmd, "migrateuri", NULL);
3172

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

3175 3176
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
3177 3178
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
3179 3180 3181
    if (vshCommandOptBool (cmd, "tunnelled"))
        flags |= VIR_MIGRATE_TUNNELLED;

C
Chris Lalancette 已提交
3182 3183 3184 3185 3186
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

3187 3188 3189
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

3190 3191 3192 3193 3194 3195
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

3196 3197 3198 3199
    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. */
3200

3201
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
3202
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
3203 3204
            goto done;
        }
3205

3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222
        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);
    }
3223 3224 3225 3226 3227 3228

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

3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251
/*
 * "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")},
    {"downtime", VSH_OT_DATA, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
    {NULL, 0, 0, NULL}
};

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

3252
    if (!vshConnectionUsability(ctl, ctl->conn))
3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273
        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;
}

3274 3275 3276
/*
 * "net-autostart" command
 */
3277
static const vshCmdInfo info_network_autostart[] = {
3278
    {"help", N_("autostart a network")},
3279
    {"desc",
3280
     N_("Configure a network to be automatically started at boot.")},
3281 3282 3283
    {NULL, NULL}
};

3284
static const vshCmdOptDef opts_network_autostart[] = {
3285 3286
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
3287 3288 3289 3290
    {NULL, 0, 0, NULL}
};

static int
3291
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
3292 3293 3294 3295 3296
{
    virNetworkPtr network;
    char *name;
    int autostart;

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

J
Jim Meyering 已提交
3300
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
3301 3302 3303 3304 3305
        return FALSE;

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
3306
        if (autostart)
3307
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
3308
        else
3309
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
3310 3311 3312 3313
        virNetworkFree(network);
        return FALSE;
    }

3314
    if (autostart)
3315
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
3316
    else
3317
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
3318

L
Laine Stump 已提交
3319
    virNetworkFree(network);
3320 3321
    return TRUE;
}
K
Karel Zak 已提交
3322

3323 3324 3325
/*
 * "net-create" command
 */
3326
static const vshCmdInfo info_network_create[] = {
3327 3328
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
3329 3330 3331
    {NULL, NULL}
};

3332
static const vshCmdOptDef opts_network_create[] = {
3333
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
3334 3335 3336 3337
    {NULL, 0, 0, NULL}
};

static int
3338
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
3339 3340 3341 3342 3343
{
    virNetworkPtr network;
    char *from;
    int found;
    int ret = TRUE;
3344
    char *buffer;
3345

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

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

3353 3354
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
3355 3356

    network = virNetworkCreateXML(ctl->conn, buffer);
3357
    VIR_FREE(buffer);
3358

3359 3360 3361
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
3362
        virNetworkFree(network);
3363
    } else {
3364
        vshError(ctl, _("Failed to create network from %s"), from);
3365 3366 3367 3368 3369 3370 3371 3372 3373
        ret = FALSE;
    }
    return ret;
}


/*
 * "net-define" command
 */
3374
static const vshCmdInfo info_network_define[] = {
3375 3376
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
3377 3378 3379
    {NULL, NULL}
};

3380
static const vshCmdOptDef opts_network_define[] = {
3381
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
3382 3383 3384 3385
    {NULL, 0, 0, NULL}
};

static int
3386
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
3387 3388 3389 3390 3391
{
    virNetworkPtr network;
    char *from;
    int found;
    int ret = TRUE;
3392
    char *buffer;
3393

3394
    if (!vshConnectionUsability(ctl, ctl->conn))
3395 3396 3397 3398 3399 3400
        return FALSE;

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

3401 3402
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
        return FALSE;
3403 3404

    network = virNetworkDefineXML(ctl->conn, buffer);
3405
    VIR_FREE(buffer);
3406

3407 3408 3409
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
3410
        virNetworkFree(network);
3411
    } else {
3412
        vshError(ctl, _("Failed to define network from %s"), from);
3413 3414 3415 3416 3417 3418 3419 3420 3421
        ret = FALSE;
    }
    return ret;
}


/*
 * "net-destroy" command
 */
3422
static const vshCmdInfo info_network_destroy[] = {
3423 3424
    {"help", N_("destroy a network")},
    {"desc", N_("Destroy a given network.")},
3425 3426 3427
    {NULL, NULL}
};

3428
static const vshCmdOptDef opts_network_destroy[] = {
3429
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name, id or uuid")},
3430 3431 3432 3433
    {NULL, 0, 0, NULL}
};

static int
3434
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
3435 3436 3437 3438 3439
{
    virNetworkPtr network;
    int ret = TRUE;
    char *name;

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

J
Jim Meyering 已提交
3443
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
3444 3445 3446 3447 3448
        return FALSE;

    if (virNetworkDestroy(network) == 0) {
        vshPrint(ctl, _("Network %s destroyed\n"), name);
    } else {
3449
        vshError(ctl, _("Failed to destroy network %s"), name);
3450 3451 3452
        ret = FALSE;
    }

3453
    virNetworkFree(network);
3454 3455 3456 3457 3458 3459 3460
    return ret;
}


/*
 * "net-dumpxml" command
 */
3461
static const vshCmdInfo info_network_dumpxml[] = {
3462 3463
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
3464 3465 3466
    {NULL, NULL}
};

3467
static const vshCmdOptDef opts_network_dumpxml[] = {
3468
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name, id or uuid")},
3469 3470 3471 3472
    {NULL, 0, 0, NULL}
};

static int
3473
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
3474 3475 3476 3477 3478
{
    virNetworkPtr network;
    int ret = TRUE;
    char *dump;

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

J
Jim Meyering 已提交
3482
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
3483 3484 3485 3486
        return FALSE;

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
3487
        vshPrint(ctl, "%s", dump);
3488
        VIR_FREE(dump);
3489 3490 3491 3492 3493 3494 3495 3496 3497
    } else {
        ret = FALSE;
    }

    virNetworkFree(network);
    return ret;
}


3498 3499 3500 3501
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
3502 3503
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
3504 3505 3506 3507
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
3508
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520
    {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;
3521
    int flags = VIR_INTERFACE_XML_INACTIVE;
3522

3523
    if (!vshConnectionUsability(ctl, ctl->conn))
3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562
        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)) {
3563 3564
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582
        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);

3583 3584 3585
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
3586 3587 3588

    if (tmp) {
        unlink (tmp);
3589
        VIR_FREE(tmp);
3590 3591 3592 3593 3594
    }

    return ret;
}

3595 3596 3597
/*
 * "net-list" command
 */
3598
static const vshCmdInfo info_network_list[] = {
3599 3600
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
3601 3602 3603
    {NULL, NULL}
};

3604
static const vshCmdOptDef opts_network_list[] = {
3605 3606
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
3607 3608 3609 3610
    {NULL, 0, 0, NULL}
};

static int
3611
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3612 3613 3614 3615 3616
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
3617
    char **activeNames = NULL, **inactiveNames = NULL;
3618 3619
    inactive |= all;

3620
    if (!vshConnectionUsability(ctl, ctl->conn))
3621 3622 3623
        return FALSE;

    if (active) {
3624 3625
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
3626
            vshError(ctl, "%s", _("Failed to list active networks"));
3627
            return FALSE;
3628
        }
3629
        if (maxactive) {
3630
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
3631

3632
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
3633
                                                    maxactive)) < 0) {
3634
                vshError(ctl, "%s", _("Failed to list active networks"));
3635
                VIR_FREE(activeNames);
3636 3637
                return FALSE;
            }
3638

3639
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
3640
        }
3641 3642
    }
    if (inactive) {
3643 3644
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
3645
            vshError(ctl, "%s", _("Failed to list inactive networks"));
3646
            VIR_FREE(activeNames);
3647
            return FALSE;
3648
        }
3649 3650 3651
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

3652 3653 3654
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
3655
                vshError(ctl, "%s", _("Failed to list inactive networks"));
3656 3657
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
3658 3659
                return FALSE;
            }
3660

3661 3662
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
3663
    }
3664 3665
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
3666
    vshPrintExtra(ctl, "-----------------------------------------\n");
3667 3668

    for (i = 0; i < maxactive; i++) {
3669 3670
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
3671 3672
        const char *autostartStr;
        int autostart = 0;
3673 3674 3675

        /* this kind of work with networks is not atomic operation */
        if (!network) {
3676
            VIR_FREE(activeNames[i]);
3677
            continue;
3678
        }
3679

3680 3681 3682
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
3683
            autostartStr = autostart ? _("yes") : _("no");
3684 3685 3686 3687 3688

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
3689
        virNetworkFree(network);
3690
        VIR_FREE(activeNames[i]);
3691 3692 3693
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
3694 3695
        const char *autostartStr;
        int autostart = 0;
3696 3697 3698

        /* this kind of work with networks is not atomic operation */
        if (!network) {
3699
            VIR_FREE(inactiveNames[i]);
3700
            continue;
3701
        }
3702

3703 3704 3705
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
3706
            autostartStr = autostart ? _("yes") : _("no");
3707

3708
        vshPrint(ctl, "%-20s %-10s %-10s\n",
3709 3710 3711
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
3712 3713

        virNetworkFree(network);
3714
        VIR_FREE(inactiveNames[i]);
3715
    }
3716 3717
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
3718 3719 3720 3721 3722 3723 3724
    return TRUE;
}


/*
 * "net-name" command
 */
3725
static const vshCmdInfo info_network_name[] = {
3726
    {"help", N_("convert a network UUID to network name")},
3727
    {"desc", ""},
3728 3729 3730
    {NULL, NULL}
};

3731
static const vshCmdOptDef opts_network_name[] = {
3732
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
3733 3734 3735 3736
    {NULL, 0, 0, NULL}
};

static int
3737
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
3738 3739 3740
{
    virNetworkPtr network;

3741
    if (!vshConnectionUsability(ctl, ctl->conn))
3742
        return FALSE;
J
Jim Meyering 已提交
3743
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
3744
                                           VSH_BYUUID)))
3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755
        return FALSE;

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


/*
 * "net-start" command
 */
3756
static const vshCmdInfo info_network_start[] = {
3757 3758
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
3759 3760 3761
    {NULL, NULL}
};

3762
static const vshCmdOptDef opts_network_start[] = {
3763
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
3764 3765 3766 3767
    {NULL, 0, 0, NULL}
};

static int
3768
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
3769 3770 3771 3772
{
    virNetworkPtr network;
    int ret = TRUE;

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

J
Jim Meyering 已提交
3776
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
3777
         return FALSE;
3778 3779 3780

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
3781
                 virNetworkGetName(network));
3782
    } else {
3783
        vshError(ctl, _("Failed to start network %s"),
3784
                 virNetworkGetName(network));
3785 3786
        ret = FALSE;
    }
L
Laine Stump 已提交
3787
    virNetworkFree(network);
3788 3789 3790 3791 3792 3793 3794
    return ret;
}


/*
 * "net-undefine" command
 */
3795
static const vshCmdInfo info_network_undefine[] = {
3796 3797
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
3798 3799 3800
    {NULL, NULL}
};

3801
static const vshCmdOptDef opts_network_undefine[] = {
3802
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
3803 3804 3805 3806
    {NULL, 0, 0, NULL}
};

static int
3807
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
3808 3809 3810 3811 3812
{
    virNetworkPtr network;
    int ret = TRUE;
    char *name;

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

J
Jim Meyering 已提交
3816
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
3817 3818 3819 3820 3821
        return FALSE;

    if (virNetworkUndefine(network) == 0) {
        vshPrint(ctl, _("Network %s has been undefined\n"), name);
    } else {
3822
        vshError(ctl, _("Failed to undefine network %s"), name);
3823 3824 3825
        ret = FALSE;
    }

L
Laine Stump 已提交
3826
    virNetworkFree(network);
3827 3828 3829 3830 3831 3832 3833
    return ret;
}


/*
 * "net-uuid" command
 */
3834
static const vshCmdInfo info_network_uuid[] = {
3835
    {"help", N_("convert a network name to network UUID")},
3836
    {"desc", ""},
3837 3838 3839
    {NULL, NULL}
};

3840
static const vshCmdOptDef opts_network_uuid[] = {
3841
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
3842 3843 3844 3845
    {NULL, 0, 0, NULL}
};

static int
3846
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
3847 3848 3849 3850
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

J
Jim Meyering 已提交
3854
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
3855
                                           VSH_BYNAME)))
3856 3857 3858 3859 3860
        return FALSE;

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

L
Laine Stump 已提交
3863
    virNetworkFree(network);
3864 3865 3866 3867
    return TRUE;
}


3868 3869 3870 3871 3872
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
3873 3874
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
3875 3876 3877 3878
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
3879 3880
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892
    {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;

3893
    if (!vshConnectionUsability(ctl, ctl->conn))
3894 3895 3896 3897 3898
        return FALSE;

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
3899
            vshError(ctl, "%s", _("Failed to list active interfaces"));
3900 3901 3902 3903 3904 3905 3906
            return FALSE;
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
3907
                vshError(ctl, "%s", _("Failed to list active interfaces"));
3908
                VIR_FREE(activeNames);
3909 3910 3911 3912 3913 3914 3915 3916 3917
                return FALSE;
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
3918
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
3919
            VIR_FREE(activeNames);
3920 3921 3922 3923 3924
            return FALSE;
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

3925 3926 3927
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
3928
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
3929 3930
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
3931 3932 3933 3934 3935 3936
                return FALSE;
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
3937 3938
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
3939 3940 3941
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
3942 3943
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
3944 3945 3946

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
3947
            VIR_FREE(activeNames[i]);
3948 3949 3950 3951 3952 3953 3954 3955
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
3956
        VIR_FREE(activeNames[i]);
3957 3958
    }
    for (i = 0; i < maxinactive; i++) {
3959 3960
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
3961 3962 3963

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
3964
            VIR_FREE(inactiveNames[i]);
3965 3966 3967 3968 3969 3970 3971 3972
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
3973
        VIR_FREE(inactiveNames[i]);
3974
    }
3975 3976
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
3977 3978 3979 3980 3981 3982 3983 3984
    return TRUE;

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
3985
    {"help", N_("convert an interface MAC address to interface name")},
3986 3987 3988 3989 3990
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
3991
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
3992 3993 3994 3995 3996 3997 3998 3999
    {NULL, 0, 0, NULL}
};

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

4000
    if (!vshConnectionUsability(ctl, ctl->conn))
4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014
        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[] = {
4015
    {"help", N_("convert an interface name to interface MAC address")},
4016 4017 4018 4019 4020
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
4021
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
4022 4023 4024 4025 4026 4027 4028 4029
    {NULL, 0, 0, NULL}
};

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

4030
    if (!vshConnectionUsability(ctl, ctl->conn))
4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044
        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[] = {
4045 4046
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
4047 4048 4049 4050
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
4051 4052
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
4053 4054 4055 4056 4057 4058 4059 4060 4061
    {NULL, 0, 0, NULL}
};

static int
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
    int ret = TRUE;
    char *dump;
4062 4063 4064 4065 4066
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
4067

4068
    if (!vshConnectionUsability(ctl, ctl->conn))
4069 4070 4071 4072 4073
        return FALSE;

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

4074
    dump = virInterfaceGetXMLDesc(iface, flags);
4075
    if (dump != NULL) {
4076
        vshPrint(ctl, "%s", dump);
4077
        VIR_FREE(dump);
4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089
    } else {
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
4090 4091
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
4092 4093 4094 4095
    {NULL, NULL}
};

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

static int
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
4103
    virInterfacePtr iface;
4104 4105 4106 4107 4108
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;

4109
    if (!vshConnectionUsability(ctl, ctl->conn))
4110 4111 4112 4113 4114 4115 4116 4117 4118
        return FALSE;

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

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

4119
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
4120
    VIR_FREE(buffer);
4121

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

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
4137 4138
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
4139 4140 4141 4142
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
4143
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4144 4145 4146 4147 4148 4149 4150 4151 4152 4153
    {NULL, 0, 0, NULL}
};

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

4154
    if (!vshConnectionUsability(ctl, ctl->conn))
4155 4156 4157 4158 4159 4160 4161 4162
        return FALSE;

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

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
4163
        vshError(ctl, _("Failed to undefine interface %s"), name);
4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
4175 4176
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
4177 4178 4179 4180
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
4181
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4182 4183 4184 4185 4186 4187 4188 4189 4190 4191
    {NULL, 0, 0, NULL}
};

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

4192
    if (!vshConnectionUsability(ctl, ctl->conn))
4193 4194 4195 4196 4197 4198 4199 4200
        return FALSE;

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

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
4201
        vshError(ctl, _("Failed to start interface %s"), name);
4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
4213 4214
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
    {"desc", N_("destroy a physical host interface.")},
4215 4216 4217 4218
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
4219
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4220 4221 4222 4223 4224 4225 4226 4227 4228 4229
    {NULL, 0, 0, NULL}
};

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

4230
    if (!vshConnectionUsability(ctl, ctl->conn))
4231 4232 4233 4234 4235 4236 4237 4238
        return FALSE;

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

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
4239
        vshError(ctl, _("Failed to destroy interface %s"), name);
4240 4241 4242 4243 4244 4245 4246
        ret = FALSE;
    }

    virInterfaceFree(iface);
    return ret;
}

4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270

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

4271
    if (!vshConnectionUsability(ctl, ctl->conn))
4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316
        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;

4317
    if (!vshConnectionUsability(ctl, ctl->conn))
4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355
        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;

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

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

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
4364
        vshPrint(ctl, "%s", dump);
4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393
        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];

4394
    if (!vshConnectionUsability(ctl, ctl->conn))
4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464
        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;

4465
    if (!vshConnectionUsability(ctl, ctl->conn))
4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537
        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;
}


4538
/**************************************************************************/
4539
/*
4540
 * "pool-autostart" command
4541
 */
4542
static const vshCmdInfo info_pool_autostart[] = {
4543
    {"help", N_("autostart a pool")},
4544
    {"desc",
4545
     N_("Configure a pool to be automatically started at boot.")},
4546
    {NULL, NULL}
4547 4548
};

4549
static const vshCmdOptDef opts_pool_autostart[] = {
4550 4551
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4552 4553
    {NULL, 0, 0, NULL}
};
4554 4555

static int
4556
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
4557
{
4558 4559 4560
    virStoragePoolPtr pool;
    char *name;
    int autostart;
4561

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

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

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

4570 4571
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
4572
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
4573
        else
4574
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
4575
        virStoragePoolFree(pool);
4576 4577 4578
        return FALSE;
    }

4579
    if (autostart)
4580
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
4581
    else
4582
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
4583

L
Laine Stump 已提交
4584
    virStoragePoolFree(pool);
4585 4586 4587
    return TRUE;
}

4588
/*
4589
 * "pool-create" command
4590
 */
4591
static const vshCmdInfo info_pool_create[] = {
4592 4593
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
4594 4595 4596
    {NULL, NULL}
};

4597
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
4598
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
4599
     N_("file containing an XML pool description")},
4600 4601 4602
    {NULL, 0, 0, NULL}
};

4603
static int
4604
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
4605
{
4606 4607 4608 4609 4610
    virStoragePoolPtr pool;
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;
4611

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

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

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

4622
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
4623
    VIR_FREE(buffer);
4624 4625 4626 4627

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
4628
        virStoragePoolFree(pool);
4629
    } else {
4630
        vshError(ctl, _("Failed to create pool from %s"), from);
4631 4632 4633
        ret = FALSE;
    }
    return ret;
4634 4635
}

4636

4637 4638 4639 4640
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
4641
    {"help", N_("create a device defined "
4642
                          "by an XML file on the node")},
4643
    {"desc", N_("Create a device on the node.  Note that this "
4644 4645 4646 4647 4648 4649 4650
                          "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,
4651
     N_("file containing an XML description of the device")},
4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663
    {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;

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

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

4672
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
4673 4674 4675
        return FALSE;

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
4676
    VIR_FREE(buffer);
4677 4678 4679 4680

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
4681
        virNodeDeviceFree(dev);
4682
    } else {
4683
        vshError(ctl, _("Failed to create node device from %s"), from);
4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694
        ret = FALSE;
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
4695 4696
    {"help", N_("destroy a device on the node")},
    {"desc", N_("Destroy a device on the node.  Note that this "
4697 4698 4699 4700 4701 4702
                          "command destroys devices on the physical host ")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
4703
     N_("name of the device to be destroyed")},
4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714
    {NULL, 0, 0, NULL}
};

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

4715
    if (!vshConnectionUsability(ctl, ctl->conn)) {
4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728
        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 {
4729
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
4730 4731 4732 4733 4734 4735 4736 4737
        ret = FALSE;
    }

    virNodeDeviceFree(dev);
    return ret;
}


4738
/*
4739
 * XML Building helper for pool-define-as and pool-create-as
4740
 */
4741
static const vshCmdOptDef opts_pool_X_as[] = {
4742 4743 4744 4745 4746 4747 4748 4749
    {"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")},
4750
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
4751 4752 4753
    {NULL, 0, 0, NULL}
};

4754
static int buildPoolXML(const vshCmd *cmd, char **retname, char **xml) {
4755 4756

    int found;
4757
    char *name, *type, *srcHost, *srcPath, *srcDev, *srcName, *srcFormat, *target;
4758
    virBuffer buf = VIR_BUFFER_INITIALIZER;
4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769

    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);
4770
    srcName = vshCommandOptString(cmd, "source-name", &found);
4771
    srcFormat = vshCommandOptString(cmd, "source-format", &found);
4772 4773
    target = vshCommandOptString(cmd, "target", &found);

4774 4775
    virBufferVSprintf(&buf, "<pool type='%s'>\n", type);
    virBufferVSprintf(&buf, "  <name>%s</name>\n", name);
4776
    if (srcHost || srcPath || srcDev) {
4777
        virBufferAddLit(&buf, "  <source>\n");
4778

4779 4780
        if (srcHost)
            virBufferVSprintf(&buf, "    <host name='%s'/>\n", srcHost);
4781 4782 4783 4784
        if (srcPath)
            virBufferVSprintf(&buf, "    <dir path='%s'/>\n", srcPath);
        if (srcDev)
            virBufferVSprintf(&buf, "    <device path='%s'/>\n", srcDev);
4785 4786
        if (srcFormat)
            virBufferVSprintf(&buf, "    <format type='%s'/>\n", srcFormat);
4787 4788
        if (srcName)
            virBufferVSprintf(&buf, "    <name>%s</name>\n", srcName);
4789 4790

        virBufferAddLit(&buf, "  </source>\n");
4791 4792
    }
    if (target) {
4793 4794 4795
        virBufferAddLit(&buf, "  <target>\n");
        virBufferVSprintf(&buf, "    <path>%s</path>\n", target);
        virBufferAddLit(&buf, "  </target>\n");
4796
    }
4797 4798 4799 4800 4801 4802
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
    }
4803 4804 4805 4806 4807 4808

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

cleanup:
4809
    virBufferFreeAndReset(&buf);
4810 4811 4812 4813 4814 4815 4816
    return FALSE;
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
4817 4818
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
4819 4820 4821 4822 4823 4824 4825 4826
    {NULL, NULL}
};

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

4829
    if (!vshConnectionUsability(ctl, ctl->conn))
4830 4831 4832 4833
        return FALSE;

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

4835
    if (printXML) {
4836
        vshPrint(ctl, "%s", xml);
4837
        VIR_FREE(xml);
4838
    } else {
4839
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
4840
        VIR_FREE(xml);
4841

4842 4843 4844 4845
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
4846
            vshError(ctl, _("Failed to create pool %s"), name);
4847 4848 4849 4850
            return FALSE;
        }
    }
    return TRUE;
4851 4852
}

4853

4854
/*
4855
 * "pool-define" command
4856
 */
4857
static const vshCmdInfo info_pool_define[] = {
4858 4859
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
4860 4861 4862
    {NULL, NULL}
};

4863
static const vshCmdOptDef opts_pool_define[] = {
4864
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
4865 4866 4867
    {NULL, 0, 0, NULL}
};

4868
static int
4869
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
4870
{
4871 4872 4873 4874 4875
    virStoragePoolPtr pool;
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;
4876

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

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

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

4887
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
4888
    VIR_FREE(buffer);
4889 4890 4891 4892

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
4893
        virStoragePoolFree(pool);
4894
    } else {
4895
        vshError(ctl, _("Failed to define pool from %s"), from);
4896 4897 4898
        ret = FALSE;
    }
    return ret;
4899 4900
}

4901

4902 4903 4904
/*
 * "pool-define-as" command
 */
4905
static const vshCmdInfo info_pool_define_as[] = {
4906 4907
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
4908 4909 4910 4911
    {NULL, NULL}
};

static int
4912
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
4913 4914
{
    virStoragePoolPtr pool;
4915
    char *xml, *name;
4916
    int printXML = vshCommandOptBool(cmd, "print-xml");
4917

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

4921
    if (!buildPoolXML(cmd, &name, &xml))
4922 4923
        return FALSE;

4924
    if (printXML) {
4925
        vshPrint(ctl, "%s", xml);
4926
        VIR_FREE(xml);
4927
    } else {
4928
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
4929
        VIR_FREE(xml);
4930

4931 4932 4933 4934
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
4935
            vshError(ctl, _("Failed to define pool %s"), name);
4936 4937 4938 4939
            return FALSE;
        }
    }
    return TRUE;
4940 4941 4942
}


4943
/*
4944
 * "pool-build" command
4945
 */
4946
static const vshCmdInfo info_pool_build[] = {
4947 4948
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
4949 4950 4951
    {NULL, NULL}
};

4952
static const vshCmdOptDef opts_pool_build[] = {
4953
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
4954 4955 4956 4957
    {NULL, 0, 0, NULL}
};

static int
4958
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
4959
{
4960 4961 4962
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;
4963

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

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

4970
    if (virStoragePoolBuild(pool, 0) == 0) {
4971
        vshPrint(ctl, _("Pool %s built\n"), name);
4972
    } else {
4973
        vshError(ctl, _("Failed to build pool %s"), name);
4974
        ret = FALSE;
4975 4976
    }

4977 4978
    virStoragePoolFree(pool);

4979 4980 4981
    return ret;
}

4982

4983
/*
4984
 * "pool-destroy" command
4985
 */
4986
static const vshCmdInfo info_pool_destroy[] = {
4987 4988
    {"help", N_("destroy a pool")},
    {"desc", N_("Destroy a given pool.")},
4989 4990 4991
    {NULL, NULL}
};

4992
static const vshCmdOptDef opts_pool_destroy[] = {
4993
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
4994 4995 4996 4997
    {NULL, 0, 0, NULL}
};

static int
4998
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
4999
{
5000 5001 5002
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;
5003

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

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

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

5017
    virStoragePoolFree(pool);
5018 5019 5020
    return ret;
}

5021

5022
/*
5023 5024
 * "pool-delete" command
 */
5025
static const vshCmdInfo info_pool_delete[] = {
5026 5027
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
5028 5029 5030
    {NULL, NULL}
};

5031
static const vshCmdOptDef opts_pool_delete[] = {
5032
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5033 5034 5035 5036
    {NULL, 0, 0, NULL}
};

static int
5037
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
5038 5039 5040 5041 5042
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;

5043
    if (!vshConnectionUsability(ctl, ctl->conn))
5044 5045 5046 5047 5048 5049
        return FALSE;

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

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
5050
        vshPrint(ctl, _("Pool %s deleted\n"), name);
5051
    } else {
5052
        vshError(ctl, _("Failed to delete pool %s"), name);
5053 5054 5055
        ret = FALSE;
    }

L
Laine Stump 已提交
5056
    virStoragePoolFree(pool);
5057 5058 5059 5060 5061 5062 5063
    return ret;
}


/*
 * "pool-refresh" command
 */
5064
static const vshCmdInfo info_pool_refresh[] = {
5065 5066
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
5067 5068 5069
    {NULL, NULL}
};

5070
static const vshCmdOptDef opts_pool_refresh[] = {
5071
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5072 5073 5074 5075
    {NULL, 0, 0, NULL}
};

static int
5076
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
5077 5078 5079 5080 5081
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;

5082
    if (!vshConnectionUsability(ctl, ctl->conn))
5083 5084 5085 5086 5087 5088 5089 5090
        return FALSE;

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

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
5091
        vshError(ctl, _("Failed to refresh pool %s"), name);
5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102
        ret = FALSE;
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
5103
static const vshCmdInfo info_pool_dumpxml[] = {
5104 5105
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
5106 5107 5108
    {NULL, NULL}
};

5109
static const vshCmdOptDef opts_pool_dumpxml[] = {
5110
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5111 5112 5113 5114
    {NULL, 0, 0, NULL}
};

static int
5115
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
5116 5117 5118 5119 5120
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *dump;

5121
    if (!vshConnectionUsability(ctl, ctl->conn))
5122 5123 5124 5125 5126 5127 5128
        return FALSE;

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

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
5129
        vshPrint(ctl, "%s", dump);
5130
        VIR_FREE(dump);
5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142
    } else {
        ret = FALSE;
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
5143
static const vshCmdInfo info_pool_list[] = {
5144 5145
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
5146 5147 5148
    {NULL, NULL}
};

5149
static const vshCmdOptDef opts_pool_list[] = {
5150 5151
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
5152
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
5153 5154 5155 5156
    {NULL, 0, 0, NULL}
};

static int
5157
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5158
{
5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177
    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 */
5178
    int all = vshCommandOptBool(cmd, "all");
5179 5180
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
5181 5182 5183
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

5184
    /* Check the connection to libvirtd daemon is still working */
5185
    if (!vshConnectionUsability(ctl, ctl->conn))
5186 5187
        return FALSE;

5188
    /* Retrieve the number of active storage pools */
5189
    if (active) {
5190 5191
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
5192
            vshError(ctl, "%s", _("Failed to list active pools"));
5193 5194 5195
            return FALSE;
        }
    }
5196 5197

    /* Retrieve the number of inactive storage pools */
5198
    if (inactive) {
5199 5200
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
5201
            vshError(ctl, "%s", _("Failed to list inactive pools"));
5202 5203
            return FALSE;
        }
5204
    }
5205

5206 5207
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
5208

5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221
    /* 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;
5222 5223 5224
        }
    }

5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235
    /* 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;
        }
    }
5236

5237 5238 5239 5240 5241 5242 5243 5244 5245 5246
    /* 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]);
5247
        if (!pool) {
5248
            VIR_FREE(poolNames[i]);
5249 5250 5251
            continue;
        }

5252
        /* Retrieve the autostart status of the pool */
5253
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
5254
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
5255
        else
5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273
            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;
        }
5274

5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386
        /* 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 */
5387 5388 5389
        virStoragePoolFree(pool);
    }

5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407
    /* 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);
5408 5409
        }

5410 5411 5412 5413
        /* Cleanup and return */
        functionReturn = TRUE;
        goto cleanup;
    }
5414

5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524
    /* 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;
5525

5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537
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]);
5538
    }
5539 5540 5541 5542 5543 5544 5545

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

    /* Return the desired value */
    return functionReturn;
5546 5547
}

5548 5549 5550 5551
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
5552 5553
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
5554 5555 5556 5557 5558
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
5559 5560 5561
     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")},
5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579
    {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;

5580
    if (!vshConnectionUsability(ctl, ctl->conn))
5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596
        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 ?
5597 5598 5599 5600 5601 5602
            virAsprintf(&srcSpec,
                        "<source><host name='%.*s' port='%s'/></source>",
                        (int)hostlen, host, port) :
            virAsprintf(&srcSpec,
                        "<source><host name='%.*s'/></source>",
                        (int)hostlen, host);
5603 5604 5605
        if (ret < 0) {
            switch (errno) {
            case ENOMEM:
5606
                vshError(ctl, "%s", _("Out of memory"));
5607 5608
                break;
            default:
5609
                vshError(ctl, _("virAsprintf failed (errno %d)"), errno);
5610 5611 5612 5613 5614 5615
            }
            return FALSE;
        }
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
5616
    VIR_FREE(srcSpec);
5617
    if (srcList == NULL) {
5618
        vshError(ctl, _("Failed to find any %s pool sources"), type);
5619 5620 5621
        return FALSE;
    }
    vshPrint(ctl, "%s", srcList);
5622
    VIR_FREE(srcList);
5623 5624 5625 5626 5627 5628 5629 5630 5631

    return TRUE;
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
5632 5633
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
5634 5635 5636 5637 5638
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
5639
     N_("type of storage pool sources to discover")},
5640
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
5641
     N_("optional file of source xml to query for pools")},
5642 5643 5644 5645 5646 5647
    {NULL, 0, 0, NULL}
};

static int
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
5648 5649
    char *type, *srcSpecFile, *srcList;
    char *srcSpec = NULL;
5650 5651 5652 5653 5654 5655
    int found;

    type = vshCommandOptString(cmd, "type", &found);
    if (!found)
        return FALSE;
    srcSpecFile = vshCommandOptString(cmd, "srcSpec", &found);
5656
    if (!found)
5657 5658
        srcSpecFile = NULL;

5659
    if (!vshConnectionUsability(ctl, ctl->conn))
5660 5661 5662 5663 5664 5665
        return FALSE;

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

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
5666
    VIR_FREE(srcSpec);
5667
    if (srcList == NULL) {
5668
        vshError(ctl, _("Failed to find any %s pool sources"), type);
5669 5670 5671
        return FALSE;
    }
    vshPrint(ctl, "%s", srcList);
5672
    VIR_FREE(srcList);
5673 5674 5675 5676 5677

    return TRUE;
}


5678 5679 5680
/*
 * "pool-info" command
 */
5681
static const vshCmdInfo info_pool_info[] = {
5682 5683
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
5684 5685 5686
    {NULL, NULL}
};

5687
static const vshCmdOptDef opts_pool_info[] = {
5688
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5689 5690 5691 5692
    {NULL, 0, 0, NULL}
};

static int
5693
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
5694 5695 5696
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
5697 5698
    int autostart = 0;
    int persistent = 0;
5699 5700 5701
    int ret = TRUE;
    char uuid[VIR_UUID_STRING_BUFLEN];

5702
    if (!vshConnectionUsability(ctl, ctl->conn))
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
        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;
5733 5734 5735 5736
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
5737 5738
        }

5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754
        /* 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"));

5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777
        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
 */
5778
static const vshCmdInfo info_pool_name[] = {
5779
    {"help", N_("convert a pool UUID to pool name")},
5780
    {"desc", ""},
5781 5782 5783
    {NULL, NULL}
};

5784
static const vshCmdOptDef opts_pool_name[] = {
5785
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
5786 5787 5788 5789
    {NULL, 0, 0, NULL}
};

static int
5790
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
5791 5792 5793
{
    virStoragePoolPtr pool;

5794
    if (!vshConnectionUsability(ctl, ctl->conn))
5795 5796
        return FALSE;
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
5797
                                           VSH_BYUUID)))
5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808
        return FALSE;

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


/*
 * "pool-start" command
 */
5809
static const vshCmdInfo info_pool_start[] = {
5810 5811
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
5812 5813 5814
    {NULL, NULL}
};

5815
static const vshCmdOptDef opts_pool_start[] = {
5816
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
5817 5818 5819 5820
    {NULL, 0, 0, NULL}
};

static int
5821
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
5822 5823 5824 5825
{
    virStoragePoolPtr pool;
    int ret = TRUE;

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

5829
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
5830 5831 5832 5833 5834 5835
         return FALSE;

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
5836
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
5837 5838
        ret = FALSE;
    }
L
Laine Stump 已提交
5839 5840

    virStoragePoolFree(pool);
5841 5842 5843 5844
    return ret;
}


5845 5846 5847
/*
 * "vol-create-as" command
 */
5848
static const vshCmdInfo info_vol_create_as[] = {
5849 5850
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
5851 5852 5853
    {NULL, NULL}
};

5854
static const vshCmdOptDef opts_vol_create_as[] = {
5855 5856 5857 5858 5859
    {"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")},
5860 5861
    {"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")},
5862 5863 5864 5865 5866 5867 5868 5869 5870 5871
    {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 已提交
5872
        /* Deliberate fallthrough cases here :-) */
5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893
        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
5894
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
5895 5896 5897 5898
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
    int found;
5899
    char *xml;
5900
    char *name, *capacityStr, *allocationStr, *format;
5901
    char *snapshotStrVol, *snapshotStrFormat;
5902
    unsigned long long capacity, allocation = 0;
5903
    virBuffer buf = VIR_BUFFER_INITIALIZER;
5904

5905
    if (!vshConnectionUsability(ctl, ctl->conn))
5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919
        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)
5920
        vshError(ctl, _("Malformed size %s"), capacityStr);
5921 5922 5923 5924

    allocationStr = vshCommandOptString(cmd, "allocation", &found);
    if (allocationStr &&
        cmdVolSize(allocationStr, &allocation) < 0)
5925
        vshError(ctl, _("Malformed size %s"), allocationStr);
5926 5927

    format = vshCommandOptString(cmd, "format", &found);
5928 5929
    snapshotStrVol = vshCommandOptString(cmd, "backing-vol", &found);
    snapshotStrFormat = vshCommandOptString(cmd, "backing-vol-format", &found);
5930

5931 5932 5933 5934 5935
    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);
5936 5937

    if (format) {
5938
        virBufferAddLit(&buf, "  <target>\n");
5939
        virBufferVSprintf(&buf, "    <format type='%s'/>\n",format);
5940
        virBufferAddLit(&buf, "  </target>\n");
5941
    }
5942

5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997
    /* 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");
5998

5999 6000 6001 6002 6003 6004
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
6005
    VIR_FREE(xml);
6006 6007 6008 6009 6010 6011 6012
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
        return TRUE;
    } else {
6013
        vshError(ctl, _("Failed to create vol %s"), name);
6014 6015 6016 6017
        return FALSE;
    }

 cleanup:
6018
    virBufferFreeAndReset(&buf);
6019 6020 6021 6022 6023
    virStoragePoolFree(pool);
    return FALSE;
}


6024 6025 6026
/*
 * "pool-undefine" command
 */
6027
static const vshCmdInfo info_pool_undefine[] = {
6028 6029
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
6030 6031 6032
    {NULL, NULL}
};

6033
static const vshCmdOptDef opts_pool_undefine[] = {
6034
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6035 6036 6037 6038
    {NULL, 0, 0, NULL}
};

static int
6039
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
6040 6041 6042 6043 6044
{
    virStoragePoolPtr pool;
    int ret = TRUE;
    char *name;

6045
    if (!vshConnectionUsability(ctl, ctl->conn))
6046 6047 6048 6049 6050 6051 6052 6053
        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 {
6054
        vshError(ctl, _("Failed to undefine pool %s"), name);
6055 6056 6057
        ret = FALSE;
    }

L
Laine Stump 已提交
6058
    virStoragePoolFree(pool);
6059 6060 6061 6062 6063 6064 6065
    return ret;
}


/*
 * "pool-uuid" command
 */
6066
static const vshCmdInfo info_pool_uuid[] = {
6067
    {"help", N_("convert a pool name to pool UUID")},
6068
    {"desc", ""},
6069 6070 6071
    {NULL, NULL}
};

6072
static const vshCmdOptDef opts_pool_uuid[] = {
6073
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
6074 6075 6076 6077
    {NULL, 0, 0, NULL}
};

static int
6078
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
6079 6080 6081 6082
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

6083
    if (!vshConnectionUsability(ctl, ctl->conn))
6084 6085 6086
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6087
                                           VSH_BYNAME)))
6088 6089 6090 6091 6092
        return FALSE;

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

L
Laine Stump 已提交
6095
    virStoragePoolFree(pool);
6096 6097 6098 6099 6100 6101 6102
    return TRUE;
}


/*
 * "vol-create" command
 */
6103
static const vshCmdInfo info_vol_create[] = {
6104 6105
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
6106 6107 6108
    {NULL, NULL}
};

6109
static const vshCmdOptDef opts_vol_create[] = {
6110 6111
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
6112 6113 6114 6115
    {NULL, 0, 0, NULL}
};

static int
6116
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
6117 6118 6119 6120 6121 6122 6123 6124
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;

6125
    if (!vshConnectionUsability(ctl, ctl->conn))
6126 6127 6128
        return FALSE;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6129
                                           VSH_BYNAME)))
6130 6131 6132 6133 6134 6135 6136 6137 6138
        return FALSE;

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
6139
        virshReportError(ctl);
6140 6141 6142 6143 6144
        virStoragePoolFree(pool);
        return FALSE;
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
6145
    VIR_FREE(buffer);
6146 6147 6148 6149 6150 6151 6152
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
6153
        vshError(ctl, _("Failed to create vol from %s"), from);
6154 6155 6156 6157 6158
        ret = FALSE;
    }
    return ret;
}

6159 6160 6161 6162
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
6163 6164
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
6165 6166 6167 6168
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
6169 6170 6171 6172
    {"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")},
6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185
    {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;

6186
    if (!vshConnectionUsability(ctl, ctl->conn))
6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200
        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) {
6201
        virshReportError(ctl);
6202 6203 6204 6205 6206 6207 6208 6209 6210
        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 {
6211
        vshError(ctl, _("Failed to create vol from %s"), from);
6212 6213 6214 6215 6216
        goto cleanup;
    }

    ret = TRUE;
cleanup:
6217
    VIR_FREE(buffer);
6218 6219 6220 6221
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
6222 6223
    if (newvol)
        virStorageVolFree(newvol);
6224 6225 6226 6227 6228 6229
    return ret;
}

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

6230 6231 6232
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262
    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[] = {
6263 6264
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
6265 6266 6267 6268
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
6269 6270 6271
    {"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")},
6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284
    {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;

6285
    if (!vshConnectionUsability(ctl, ctl->conn))
6286 6287 6288 6289 6290 6291 6292
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
6293
        vshError(ctl, "%s", _("failed to get parent pool"));
6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316
        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 {
6317
        vshError(ctl, _("Failed to clone vol from %s"),
6318 6319 6320 6321 6322 6323 6324
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

    ret = TRUE;

cleanup:
6325
    VIR_FREE(origxml);
6326 6327 6328
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
6329 6330
    if (newvol)
        virStorageVolFree(newvol);
6331 6332 6333 6334 6335
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

6336 6337 6338
/*
 * "vol-delete" command
 */
6339
static const vshCmdInfo info_vol_delete[] = {
6340 6341
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
6342 6343 6344
    {NULL, NULL}
};

6345
static const vshCmdOptDef opts_vol_delete[] = {
6346 6347
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
6348 6349 6350 6351
    {NULL, 0, 0, NULL}
};

static int
6352
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
6353 6354 6355 6356 6357
{
    virStorageVolPtr vol;
    int ret = TRUE;
    char *name;

6358
    if (!vshConnectionUsability(ctl, ctl->conn))
6359 6360 6361 6362 6363 6364 6365
        return FALSE;

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

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
6366
        vshPrint(ctl, _("Vol %s deleted\n"), name);
6367
    } else {
6368
        vshError(ctl, _("Failed to delete vol %s"), name);
6369 6370 6371
        ret = FALSE;
    }

L
Laine Stump 已提交
6372
    virStorageVolFree(vol);
6373 6374 6375 6376
    return ret;
}


D
David Allan 已提交
6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398
/*
 * "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;

6399
    if (!vshConnectionUsability(ctl, ctl->conn))
D
David Allan 已提交
6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417
        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;
}


6418 6419 6420
/*
 * "vol-info" command
 */
6421
static const vshCmdInfo info_vol_info[] = {
6422 6423
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
6424 6425 6426
    {NULL, NULL}
};

6427
static const vshCmdOptDef opts_vol_info[] = {
6428 6429
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
6430 6431 6432 6433
    {NULL, 0, 0, NULL}
};

static int
6434
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
6435 6436 6437 6438 6439
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
    int ret = TRUE;

6440
    if (!vshConnectionUsability(ctl, ctl->conn))
6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471
        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
 */
6472
static const vshCmdInfo info_vol_dumpxml[] = {
6473 6474
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
6475 6476 6477
    {NULL, NULL}
};

6478
static const vshCmdOptDef opts_vol_dumpxml[] = {
6479 6480
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
6481 6482 6483 6484
    {NULL, 0, 0, NULL}
};

static int
6485
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
6486 6487 6488 6489 6490
{
    virStorageVolPtr vol;
    int ret = TRUE;
    char *dump;

6491
    if (!vshConnectionUsability(ctl, ctl->conn))
6492 6493 6494 6495 6496 6497 6498
        return FALSE;

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

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
6499
        vshPrint(ctl, "%s", dump);
6500
        VIR_FREE(dump);
6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512
    } else {
        ret = FALSE;
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
6513
static const vshCmdInfo info_vol_list[] = {
6514 6515
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
6516 6517 6518
    {NULL, NULL}
};

6519
static const vshCmdOptDef opts_vol_list[] = {
6520
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6521
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
6522 6523 6524 6525
    {NULL, 0, 0, NULL}
};

static int
6526
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6527
{
6528
    virStorageVolInfo volumeInfo;
6529 6530
    virStoragePoolPtr pool;
    char **activeNames = NULL;
6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547
    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;
6548

6549
    /* Check the connection to libvirtd daemon is still working */
6550
    if (!vshConnectionUsability(ctl, ctl->conn))
6551 6552
        return FALSE;

6553
    /* Look up the pool information given to us by the user */
6554 6555 6556
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
        return FALSE;

6557 6558
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
6559

6560 6561 6562 6563 6564
    /* 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) {
6565
            vshError(ctl, "%s", _("Failed to list active vols"));
6566
            VIR_FREE(activeNames);
6567 6568 6569 6570
            virStoragePoolFree(pool);
            return FALSE;
        }

6571 6572 6573 6574 6575
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

6578 6579 6580 6581 6582
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
6583

6584 6585 6586 6587
        /* 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"));
6588 6589
        }

6590 6591 6592 6593 6594 6595 6596 6597 6598
        /* 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 */
6599

6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654
                /* 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;
        }
6655

6656
        /* Cleanup memory allocation */
6657
        virStorageVolFree(vol);
6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707
    }

    /* 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 已提交
6708 6709 6710 6711 6712
    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);
6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772

    /* 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);
6773
        VIR_FREE(activeNames[i]);
6774
    }
6775 6776 6777 6778

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
6779
    VIR_FREE(activeNames);
6780
    virStoragePoolFree(pool);
6781 6782 6783

    /* Return the desired value */
    return functionReturn;
6784 6785 6786 6787 6788 6789
}


/*
 * "vol-name" command
 */
6790
static const vshCmdInfo info_vol_name[] = {
6791
    {"help", N_("returns the volume name for a given volume key or path")},
6792
    {"desc", ""},
6793 6794 6795
    {NULL, NULL}
};

6796
static const vshCmdOptDef opts_vol_name[] = {
6797
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
6798 6799 6800 6801
    {NULL, 0, 0, NULL}
};

static int
6802
cmdVolName(vshControl *ctl, const vshCmd *cmd)
6803 6804 6805
{
    virStorageVolPtr vol;

6806
    if (!vshConnectionUsability(ctl, ctl->conn))
6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818
        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 已提交
6819 6820 6821 6822 6823 6824 6825 6826 6827 6828
/*
 * "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[] = {
6829
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
6830 6831 6832 6833 6834 6835 6836 6837 6838
    {"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;
6839
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
6840 6841

    /* Check the connection to libvirtd daemon is still working */
6842
    if (!vshConnectionUsability(ctl, ctl->conn))
J
Justin Clift 已提交
6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858
        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;
    }

6859 6860 6861 6862 6863 6864 6865 6866 6867
    /* 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 已提交
6868 6869 6870 6871 6872 6873 6874

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

6875 6876 6877 6878

/*
 * "vol-key" command
 */
6879
static const vshCmdInfo info_vol_key[] = {
6880
    {"help", N_("returns the volume key for a given volume name or path")},
6881
    {"desc", ""},
6882 6883 6884
    {NULL, NULL}
};

6885
static const vshCmdOptDef opts_vol_key[] = {
6886
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
6887
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
6888 6889 6890 6891
    {NULL, 0, 0, NULL}
};

static int
6892
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
6893 6894 6895
{
    virStorageVolPtr vol;

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

6899
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911
        return FALSE;

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



/*
 * "vol-path" command
 */
6912
static const vshCmdInfo info_vol_path[] = {
6913
    {"help", N_("returns the volume path for a given volume name or key")},
6914
    {"desc", ""},
6915 6916 6917
    {NULL, NULL}
};

6918
static const vshCmdOptDef opts_vol_path[] = {
6919
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
6920
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
6921 6922 6923 6924
    {NULL, 0, 0, NULL}
};

static int
6925
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
6926 6927
{
    virStorageVolPtr vol;
6928
    char *name = NULL;
6929

6930
    if (!vshConnectionUsability(ctl, ctl->conn))
6931
        return FALSE;
6932 6933

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
6934
        return FALSE;
6935
    }
6936 6937 6938 6939 6940 6941 6942

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


6943 6944 6945 6946
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
6947 6948
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
6949 6950
    {NULL, NULL}
};
6951

6952
static const vshCmdOptDef opts_secret_define[] = {
6953
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
6954 6955
    {NULL, 0, 0, NULL}
};
6956

6957 6958 6959
static int
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
6960
    char *from, *buffer;
6961
    virSecretPtr res;
6962
    char uuid[VIR_UUID_STRING_BUFLEN];
6963

6964
    if (!vshConnectionUsability(ctl, ctl->conn))
6965 6966 6967 6968 6969 6970 6971 6972 6973 6974
        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);
6975
    VIR_FREE(buffer);
6976 6977

    if (res == NULL) {
6978
        vshError(ctl, _("Failed to set attributes from %s"), from);
6979 6980
        return FALSE;
    }
6981
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
6982
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994
        virSecretFree(res);
        return FALSE;
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
    return TRUE;
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
6995 6996
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
6997 6998 6999 7000
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
7001
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7002 7003 7004 7005 7006 7007 7008 7009 7010 7011
    {NULL, 0, 0, NULL}
};

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

7012
    if (!vshConnectionUsability(ctl, ctl->conn))
7013 7014 7015 7016 7017 7018 7019 7020 7021
        return FALSE;

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

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
7022
    vshPrint(ctl, "%s", xml);
7023
    VIR_FREE(xml);
7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
7035 7036
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
7037 7038 7039 7040
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
7041 7042
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053
    {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;

7054
    if (!vshConnectionUsability(ctl, ctl->conn))
7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065
        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 已提交
7066
        vshError(ctl, "%s", _("Invalid base64 data"));
7067 7068 7069
        goto cleanup;
    }
    if (value == NULL) {
7070
        vshError(ctl, "%s", _("Failed to allocate memory"));
7071 7072 7073 7074 7075
        return FALSE;
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
7076
    VIR_FREE(value);
7077 7078

    if (res != 0) {
7079
        vshError(ctl, "%s", _("Failed to set secret value"));
7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093
        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[] = {
7094 7095
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
7096 7097 7098 7099
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
7100
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112
    {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;

7113
    if (!vshConnectionUsability(ctl, ctl->conn))
7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125
        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);
7126
    VIR_FREE(value);
7127 7128

    if (base64 == NULL) {
7129
        vshError(ctl, "%s", _("Failed to allocate memory"));
7130 7131
        goto cleanup;
    }
7132
    vshPrint(ctl, "%s", base64);
7133
    memset(base64, 0, strlen(base64));
7134
    VIR_FREE(base64);
7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145
    ret = TRUE;

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
7146 7147
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
7148 7149 7150 7151
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
7152
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
7153 7154 7155 7156 7157 7158 7159 7160 7161 7162
    {NULL, 0, 0, NULL}
};

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

7163
    if (!vshConnectionUsability(ctl, ctl->conn))
7164 7165 7166 7167 7168 7169 7170
        return FALSE;

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

    if (virSecretUndefine(secret) < 0) {
7171
        vshError(ctl, _("Failed to delete secret %s"), uuid);
7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185
        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[] = {
7186 7187
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
7188 7189 7190 7191 7192 7193 7194 7195 7196
    {NULL, NULL}
};

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

7197
    if (!vshConnectionUsability(ctl, ctl->conn))
7198 7199 7200 7201
        return FALSE;

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
7202
        vshError(ctl, "%s", _("Failed to list secrets"));
7203 7204 7205 7206 7207 7208
        return FALSE;
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
7209
        vshError(ctl, "%s", _("Failed to list secrets"));
7210
        VIR_FREE(uuids);
7211 7212 7213 7214 7215
        return FALSE;
    }

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

7216 7217
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
7218 7219

    for (i = 0; i < maxuuids; i++) {
7220 7221 7222 7223
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
7224
            VIR_FREE(uuids[i]);
7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242
            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);
7243
        VIR_FREE(uuids[i]);
7244
    }
7245
    VIR_FREE(uuids);
7246 7247
    return TRUE;
}
7248 7249 7250 7251 7252


/*
 * "version" command
 */
7253
static const vshCmdInfo info_version[] = {
7254 7255
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
7256 7257 7258 7259 7260
    {NULL, NULL}
};


static int
7261
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272
{
    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;

7273
    if (!vshConnectionUsability(ctl, ctl->conn))
7274 7275 7276 7277
        return FALSE;

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
7278
        vshError(ctl, "%s", _("failed to get hypervisor type"));
7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291
        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) {
7292
        vshError(ctl, "%s", _("failed to get the library version"));
7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310
        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) {
7311
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328
        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;
}

7329 7330 7331 7332
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
7333
    {"help", N_("enumerate devices on this host")},
7334
    {"desc", ""},
7335 7336 7337 7338
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
7339 7340
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
7341 7342 7343
    {NULL, 0, 0, NULL}
};

7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365
#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] = '-';
7366 7367
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
7368 7369 7370
    }

    /* Print this device */
7371
    vshPrint(ctl, "%s", indentBuf);
7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394
    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) {
7395
        vshPrint(ctl, "%s", indentBuf);
7396
        vshPrint(ctl, " |\n");
7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418
    }

    /* 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) {
7419
        vshPrint(ctl, "%s", indentBuf);
7420 7421 7422 7423
        vshPrint(ctl, "\n");
    }
}

7424 7425 7426 7427 7428 7429
static int
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cap;
    char **devices;
    int found, num_devices, i;
7430
    int tree = vshCommandOptBool(cmd, "tree");
7431

7432
    if (!vshConnectionUsability(ctl, ctl->conn))
7433 7434 7435 7436 7437 7438 7439 7440
        return FALSE;

    cap = vshCommandOptString(cmd, "cap", &found);
    if (!found)
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
7441
        vshError(ctl, "%s", _("Failed to count node devices"));
7442 7443 7444 7445 7446 7447 7448 7449 7450
        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) {
7451
        vshError(ctl, "%s", _("Failed to list node devices"));
7452
        VIR_FREE(devices);
7453 7454
        return FALSE;
    }
7455
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
7456 7457 7458 7459 7460 7461 7462
    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 已提交
7463
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482
            } 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++) {
7483 7484
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
7485
        }
7486
        VIR_FREE(parents);
7487 7488 7489
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
7490
            VIR_FREE(devices[i]);
7491
        }
7492
    }
7493
    VIR_FREE(devices);
7494 7495 7496 7497 7498 7499 7500
    return TRUE;
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
7501 7502
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
7503 7504 7505 7506 7507
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
7508
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7509 7510 7511 7512 7513 7514 7515 7516
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
L
Laine Stump 已提交
7517
    char *xml;
7518

7519
    if (!vshConnectionUsability(ctl, ctl->conn))
7520 7521 7522 7523
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7524
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7525 7526 7527
        return FALSE;
    }

L
Laine Stump 已提交
7528 7529 7530 7531 7532 7533 7534
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
        return FALSE;
    }

    vshPrint(ctl, "%s\n", xml);
7535
    VIR_FREE(xml);
7536 7537 7538 7539
    virNodeDeviceFree(device);
    return TRUE;
}

7540 7541 7542 7543
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
7544 7545
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
7546 7547 7548 7549 7550
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
7551
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7552 7553 7554 7555 7556 7557 7558 7559 7560 7561
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
    int ret = TRUE;

7562
    if (!vshConnectionUsability(ctl, ctl->conn))
7563 7564 7565 7566
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7567
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7568 7569 7570 7571 7572 7573
        return FALSE;
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
7574
        vshError(ctl, _("Failed to dettach device %s"), name);
7575 7576 7577 7578 7579 7580 7581 7582 7583 7584
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
7585 7586
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
7587 7588 7589 7590 7591
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
7592
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7593 7594 7595 7596 7597 7598 7599 7600 7601 7602
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
    int ret = TRUE;

7603
    if (!vshConnectionUsability(ctl, ctl->conn))
7604 7605 7606 7607
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7608
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7609 7610 7611 7612 7613 7614
        return FALSE;
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
7615
        vshError(ctl, _("Failed to re-attach device %s"), name);
7616 7617 7618 7619 7620 7621 7622 7623 7624 7625
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
7626 7627
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
7628 7629 7630 7631 7632
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
7633
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
7634 7635 7636 7637 7638 7639 7640 7641 7642 7643
    {NULL, 0, 0, NULL}
};

static int
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
    const char *name;
    virNodeDevicePtr device;
    int ret = TRUE;

7644
    if (!vshConnectionUsability(ctl, ctl->conn))
7645 7646 7647 7648
        return FALSE;
    if (!(name = vshCommandOptString(cmd, "device", NULL)))
        return FALSE;
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
7649
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
7650 7651 7652 7653 7654 7655
        return FALSE;
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
7656
        vshError(ctl, _("Failed to reset device %s"), name);
7657 7658 7659 7660 7661 7662
        ret = FALSE;
    }
    virNodeDeviceFree(device);
    return ret;
}

7663 7664 7665
/*
 * "hostkey" command
 */
7666
static const vshCmdInfo info_hostname[] = {
7667
    {"help", N_("print the hypervisor hostname")},
7668
    {"desc", ""},
7669 7670 7671 7672
    {NULL, NULL}
};

static int
7673
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7674 7675 7676
{
    char *hostname;

7677
    if (!vshConnectionUsability(ctl, ctl->conn))
7678 7679 7680 7681
        return FALSE;

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
7682
        vshError(ctl, "%s", _("failed to get hostname"));
7683 7684 7685 7686
        return FALSE;
    }

    vshPrint (ctl, "%s\n", hostname);
7687
    VIR_FREE(hostname);
7688 7689 7690 7691 7692 7693 7694

    return TRUE;
}

/*
 * "uri" command
 */
7695
static const vshCmdInfo info_uri[] = {
7696
    {"help", N_("print the hypervisor canonical URI")},
7697
    {"desc", ""},
7698 7699 7700 7701
    {NULL, NULL}
};

static int
7702
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7703 7704 7705
{
    char *uri;

7706
    if (!vshConnectionUsability(ctl, ctl->conn))
7707 7708 7709 7710
        return FALSE;

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
7711
        vshError(ctl, "%s", _("failed to get URI"));
7712 7713 7714 7715
        return FALSE;
    }

    vshPrint (ctl, "%s\n", uri);
7716
    VIR_FREE(uri);
7717 7718 7719 7720 7721 7722 7723

    return TRUE;
}

/*
 * "vncdisplay" command
 */
7724
static const vshCmdInfo info_vncdisplay[] = {
7725 7726
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
7727 7728 7729
    {NULL, NULL}
};

7730
static const vshCmdOptDef opts_vncdisplay[] = {
7731
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
7732 7733 7734 7735
    {NULL, 0, 0, NULL}
};

static int
7736
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
7737 7738 7739 7740 7741 7742 7743 7744 7745
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    int ret = FALSE;
    int port = 0;
    char *doc;

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

J
Jim Meyering 已提交
7749
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
7750 7751 7752 7753 7754 7755 7756 7757 7758
        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);
7759
    VIR_FREE(doc);
7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777
    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) ||
7778
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798
        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
 */
7799
static const vshCmdInfo info_ttyconsole[] = {
7800 7801
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
7802 7803 7804
    {NULL, NULL}
};

7805
static const vshCmdOptDef opts_ttyconsole[] = {
7806
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
7807 7808 7809 7810
    {NULL, 0, 0, NULL}
};

static int
7811
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
7812 7813 7814 7815 7816 7817 7818 7819
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    int ret = FALSE;
    char *doc;

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

J
Jim Meyering 已提交
7823
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
7824 7825 7826 7827 7828 7829 7830 7831 7832
        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);
7833
    VIR_FREE(doc);
7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845
    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);
7846
    ret = TRUE;
7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
7859
 */
7860
static const vshCmdInfo info_attach_device[] = {
7861 7862
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
7863 7864 7865
    {NULL, NULL}
};

7866
static const vshCmdOptDef opts_attach_device[] = {
7867 7868 7869
    {"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")},
7870 7871 7872 7873
    {NULL, 0, 0, NULL}
};

static int
7874
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
7875 7876 7877 7878 7879 7880
{
    virDomainPtr dom;
    char *from;
    char *buffer;
    int ret = TRUE;
    int found;
J
Jim Fehlig 已提交
7881
    unsigned int flags;
7882

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

J
Jim Meyering 已提交
7886
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
7887 7888 7889 7890 7891 7892 7893 7894
        return FALSE;

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

7895
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7896
        virshReportError(ctl);
7897
        virDomainFree(dom);
7898
        return FALSE;
7899
    }
7900

J
Jim Fehlig 已提交
7901 7902 7903 7904 7905 7906 7907 7908
    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);
    }
7909
    VIR_FREE(buffer);
7910 7911

    if (ret < 0) {
7912
        vshError(ctl, _("Failed to attach device from %s"), from);
7913 7914
        virDomainFree(dom);
        return FALSE;
7915
    } else {
J
Jim Meyering 已提交
7916
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
7917 7918 7919 7920 7921 7922 7923 7924 7925 7926
    }

    virDomainFree(dom);
    return TRUE;
}


/*
 * "detach-device" command
 */
7927
static const vshCmdInfo info_detach_device[] = {
7928 7929
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
7930 7931 7932
    {NULL, NULL}
};

7933
static const vshCmdOptDef opts_detach_device[] = {
7934 7935 7936
    {"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")},
7937 7938 7939 7940
    {NULL, 0, 0, NULL}
};

static int
7941
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
7942 7943 7944 7945 7946 7947
{
    virDomainPtr dom;
    char *from;
    char *buffer;
    int ret = TRUE;
    int found;
J
Jim Fehlig 已提交
7948
    unsigned int flags;
7949

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

J
Jim Meyering 已提交
7953
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
7954 7955 7956 7957 7958 7959 7960 7961
        return FALSE;

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

7962
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7963
        virshReportError(ctl);
7964
        virDomainFree(dom);
7965
        return FALSE;
7966
    }
7967

J
Jim Fehlig 已提交
7968 7969 7970 7971 7972 7973 7974 7975
    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);
    }
7976
    VIR_FREE(buffer);
7977 7978

    if (ret < 0) {
7979
        vshError(ctl, _("Failed to detach device from %s"), from);
7980 7981
        virDomainFree(dom);
        return FALSE;
7982
    } else {
J
Jim Meyering 已提交
7983
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
7984 7985 7986 7987 7988 7989
    }

    virDomainFree(dom);
    return TRUE;
}

7990

7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016
/*
 * "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;

8017
    if (!vshConnectionUsability(ctl, ctl->conn))
8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029
        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) {
8030
        virshReportError(ctl);
8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057
        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;
}


8058 8059 8060
/*
 * "attach-interface" command
 */
8061
static const vshCmdInfo info_attach_interface[] = {
8062 8063
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
8064 8065 8066
    {NULL, NULL}
};

8067
static const vshCmdOptDef opts_attach_interface[] = {
8068 8069 8070 8071 8072 8073 8074
    {"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")},
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
8075 8076 8077 8078
    {NULL, 0, 0, NULL}
};

static int
8079
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
8080 8081 8082 8083
{
    virDomainPtr dom = NULL;
    char *mac, *target, *script, *type, *source;
    int typ, ret = FALSE;
J
Jim Fehlig 已提交
8084
    unsigned int flags;
8085 8086
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
8087

8088
    if (!vshConnectionUsability(ctl, ctl->conn))
8089 8090
        goto cleanup;

J
Jim Meyering 已提交
8091
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102
        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);

    /* check interface type */
8103
    if (STREQ(type, "network")) {
8104
        typ = 1;
8105
    } else if (STREQ(type, "bridge")) {
8106 8107
        typ = 2;
    } else {
E
Eric Blake 已提交
8108 8109
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
8110 8111 8112 8113
        goto cleanup;
    }

    /* Make XML of interface */
8114
    virBufferVSprintf(&buf, "<interface type='%s'>\n", type);
8115

8116 8117 8118 8119
    if (typ == 1)
        virBufferVSprintf(&buf, "  <source network='%s'/>\n", source);
    else if (typ == 2)
        virBufferVSprintf(&buf, "  <source bridge='%s'/>\n", source);
8120

8121 8122 8123 8124 8125 8126
    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);
8127

8128
    virBufferAddLit(&buf, "</interface>\n");
8129

8130 8131 8132
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
8133 8134
    }

8135
    xml = virBufferContentAndReset(&buf);
8136

J
Jim Fehlig 已提交
8137 8138 8139 8140
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
8141
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
8142
    } else {
8143
        ret = virDomainAttachDevice(dom, xml);
8144
    }
8145

8146 8147
    VIR_FREE(xml);

J
Jim Fehlig 已提交
8148
    if (ret != 0) {
L
Laine Stump 已提交
8149
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
8150 8151 8152 8153 8154
        ret = FALSE;
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
        ret = TRUE;
    }
8155 8156 8157 8158

 cleanup:
    if (dom)
        virDomainFree(dom);
8159
    virBufferFreeAndReset(&buf);
8160 8161 8162 8163 8164 8165
    return ret;
}

/*
 * "detach-interface" command
 */
8166
static const vshCmdInfo info_detach_interface[] = {
8167 8168
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
8169 8170 8171
    {NULL, NULL}
};

8172
static const vshCmdOptDef opts_detach_interface[] = {
8173 8174 8175 8176
    {"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")},
8177 8178 8179 8180
    {NULL, 0, 0, NULL}
};

static int
8181
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192
{
    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 已提交
8193
    unsigned int flags;
8194

8195
    if (!vshConnectionUsability(ctl, ctl->conn))
8196 8197
        goto cleanup;

J
Jim Meyering 已提交
8198
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212
        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);
8213
    VIR_FREE(doc);
8214
    if (!xml) {
8215
        vshError(ctl, "%s", _("Failed to get interface information"));
8216 8217 8218 8219
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
8220
        vshError(ctl, "%s", _("Failed to get interface information"));
8221 8222 8223 8224 8225 8226 8227
        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)) {
8228
        vshError(ctl, _("No found interface whose type is %s"), type);
8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240
        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");
8241
                diff_mac = virMacAddrCompare ((char *) tmp_mac, mac);
8242 8243 8244 8245 8246 8247 8248 8249
                xmlFree(tmp_mac);
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
8250
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
8251 8252 8253 8254 8255
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
8256
        vshError(ctl, "%s", _("Failed to allocate memory"));
8257 8258 8259 8260
        goto cleanup;
    }

    if(xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0){
8261
        vshError(ctl, "%s", _("Failed to create XML"));
8262 8263 8264
        goto cleanup;
    }

J
Jim Fehlig 已提交
8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276
    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 已提交
8277
        vshError(ctl, "%s", _("Failed to detach interface"));
8278
        ret = FALSE;
J
Jim Fehlig 已提交
8279
    } else {
J
Jim Meyering 已提交
8280
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
8281
        ret = TRUE;
8282
    }
8283 8284 8285 8286

 cleanup:
    if (dom)
        virDomainFree(dom);
8287
    xmlXPathFreeObject(obj);
8288
    xmlXPathFreeContext(ctxt);
8289 8290 8291 8292 8293 8294 8295 8296 8297 8298
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    return ret;
}

/*
 * "attach-disk" command
 */
8299
static const vshCmdInfo info_attach_disk[] = {
8300 8301
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
8302 8303 8304
    {NULL, NULL}
};

8305
static const vshCmdOptDef opts_attach_disk[] = {
8306 8307 8308 8309 8310 8311 8312 8313
    {"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")},
8314
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
8315 8316 8317 8318
    {NULL, 0, 0, NULL}
};

static int
8319
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
8320 8321 8322 8323
{
    virDomainPtr dom = NULL;
    char *source, *target, *driver, *subdriver, *type, *mode;
    int isFile = 0, ret = FALSE;
J
Jim Fehlig 已提交
8324
    unsigned int flags;
8325
    char *stype;
8326 8327
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
8328

8329
    if (!vshConnectionUsability(ctl, ctl->conn))
8330 8331
        goto cleanup;

J
Jim Meyering 已提交
8332
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344
        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);
8345
    stype = vshCommandOptString(cmd, "sourcetype", NULL);
8346

8347 8348
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
8349
            isFile = 1;
8350 8351 8352 8353 8354
    } else if (STREQ(stype, "file")) {
        isFile = 1;
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
8355 8356 8357
    }

    if (mode) {
8358
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
8359 8360
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
8361 8362 8363 8364 8365
            goto cleanup;
        }
    }

    /* Make XML of disk */
8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385
    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");
8386

8387 8388 8389
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        return FALSE;
8390 8391
    }

8392
    xml = virBufferContentAndReset(&buf);
8393

J
Jim Fehlig 已提交
8394 8395 8396 8397
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
8398
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
8399
    } else {
8400
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
8401
    }
8402

8403 8404
    VIR_FREE(xml);

J
Jim Fehlig 已提交
8405
    if (ret != 0) {
L
Laine Stump 已提交
8406
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
8407 8408 8409 8410 8411
        ret = FALSE;
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
        ret = TRUE;
    }
8412 8413 8414 8415

 cleanup:
    if (dom)
        virDomainFree(dom);
8416
    virBufferFreeAndReset(&buf);
8417 8418 8419 8420 8421 8422
    return ret;
}

/*
 * "detach-disk" command
 */
8423
static const vshCmdInfo info_detach_disk[] = {
8424 8425
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
8426 8427 8428
    {NULL, NULL}
};

8429
static const vshCmdOptDef opts_detach_disk[] = {
8430 8431 8432
    {"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")},
8433 8434 8435 8436
    {NULL, 0, 0, NULL}
};

static int
8437
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
8438 8439 8440 8441 8442 8443 8444 8445 8446 8447
{
    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 已提交
8448
    unsigned int flags;
8449

8450
    if (!vshConnectionUsability(ctl, ctl->conn))
8451 8452
        goto cleanup;

J
Jim Meyering 已提交
8453
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465
        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);
8466
    VIR_FREE(doc);
8467
    if (!xml) {
8468
        vshError(ctl, "%s", _("Failed to get disk information"));
8469 8470 8471 8472
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
8473
        vshError(ctl, "%s", _("Failed to get disk information"));
8474 8475 8476 8477 8478 8479
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
8480
        vshError(ctl, "%s", _("Failed to get disk information"));
8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498
        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;
        }
    }
8499
    vshError(ctl, _("No found disk whose target is %s"), target);
8500 8501 8502 8503 8504
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
8505
        vshError(ctl, "%s", _("Failed to allocate memory"));
8506 8507 8508 8509
        goto cleanup;
    }

    if(xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0){
8510
        vshError(ctl, "%s", _("Failed to create XML"));
8511 8512 8513
        goto cleanup;
    }

J
Jim Fehlig 已提交
8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525
    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 已提交
8526
        vshError(ctl, "%s", _("Failed to detach disk"));
8527
        ret = FALSE;
J
Jim Fehlig 已提交
8528
    } else {
J
Jim Meyering 已提交
8529
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
8530
        ret = TRUE;
8531
    }
8532 8533

 cleanup:
8534
    xmlXPathFreeObject(obj);
8535
    xmlXPathFreeContext(ctxt);
8536 8537 8538 8539 8540 8541 8542 8543 8544
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
    return ret;
}

8545 8546 8547 8548
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
8549 8550
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
8551 8552 8553 8554
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
8555
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567
    {NULL, 0, 0, NULL}
};

static int
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
    char *from;
    int found;
    int ret = TRUE;
    char *buffer;
    int result;

8568
    if (!vshConnectionUsability(ctl, ctl->conn))
8569 8570 8571 8572 8573 8574 8575 8576 8577 8578
        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);
8579
    VIR_FREE(buffer);
8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608

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

8609 8610 8611 8612
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
8613 8614
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
8615 8616 8617 8618
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
8619
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633
    {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;
8634
    xmlNodePtr node_list;
8635 8636 8637 8638 8639 8640
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

8641
    if (!vshConnectionUsability(ctl, ctl->conn))
8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654
        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 已提交
8655 8656
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723
    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;
8724
    goto cleanup;
8725 8726
}

8727 8728 8729 8730 8731 8732 8733 8734
/* 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;

8735
    ret = vshMalloc(ctl, PATH_MAX);
8736 8737 8738 8739 8740 8741

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX", tmpdir);
    fd = mkstemp (ret);
    if (fd == -1) {
8742 8743
        vshError(ctl, _("mkstemp: failed to create temporary file: %s"),
                 strerror(errno));
8744
        VIR_FREE(ret);
8745 8746 8747 8748
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
8749 8750
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
8751 8752
        close (fd);
        unlink (ret);
8753
        VIR_FREE(ret);
8754 8755 8756
        return NULL;
    }
    if (close (fd) == -1) {
8757 8758
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
8759
        unlink (ret);
8760
        VIR_FREE(ret);
8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778
        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;

8779 8780
    editor = getenv ("VISUAL");
    if (!editor) editor = getenv ("EDITOR");
8781 8782
    if (!editor) editor = "vi"; /* could be cruel & default to ed(1) here */

8783 8784 8785 8786 8787 8788
    /* 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).
8789 8790
     */
    if (strspn (filename, ACCEPTED_CHARS) != strlen (filename)) {
8791 8792 8793
        vshError(ctl,
                 _("%s: temporary filename contains shell meta or other "
                   "unacceptable characters (is $TMPDIR wrong?)"),
8794 8795 8796 8797
                 filename);
        return -1;
    }

8798
    if (virAsprintf(&command, "%s %s", editor, filename) == -1) {
8799
        vshError(ctl,
8800
                 _("virAsprintf: could not create editing command: %s"),
8801
                 strerror(errno));
8802 8803 8804 8805 8806
        return -1;
    }

    command_ret = system (command);
    if (command_ret == -1) {
8807 8808
        vshError(ctl,
                 _("%s: edit command failed: %s"), command, strerror(errno));
8809
        VIR_FREE(command);
8810 8811
        return -1;
    }
8812
    if (WEXITSTATUS(command_ret) != 0) {
8813
        vshError(ctl,
8814
                 _("%s: command exited with non-zero status"), command);
8815
        VIR_FREE(command);
8816 8817
        return -1;
    }
8818
    VIR_FREE(command);
8819 8820 8821 8822 8823 8824 8825 8826 8827
    return 0;
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
8828
        vshError(ctl,
8829
                 _("%s: failed to read temporary file: %s"),
8830
                 filename, strerror(errno));
8831 8832 8833 8834 8835
        return NULL;
    }
    return ret;
}

8836 8837

#ifndef WIN32
P
Paolo Bonzini 已提交
8838 8839 8840 8841
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
8842 8843
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
8844 8845 8846 8847
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
8848
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
8849 8850 8851 8852 8853 8854 8855 8856 8857 8858
    {NULL, 0, 0, NULL}
};

static int
cmdCd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    const char *dir;
    int found;

    if (!ctl->imode) {
8859
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
C
Chris Lalancette 已提交
8860
        return FALSE;
P
Paolo Bonzini 已提交
8861 8862 8863 8864 8865
    }

    dir = vshCommandOptString(cmd, "dir", &found);
    if (!found) {
        uid_t uid = geteuid();
8866
        dir = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
8867 8868 8869 8870 8871
    }
    if (!dir)
        dir = "/";

    if (chdir (dir) == -1) {
8872
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
C
Chris Lalancette 已提交
8873
        return FALSE;
P
Paolo Bonzini 已提交
8874 8875
    }

C
Chris Lalancette 已提交
8876
    return TRUE;
P
Paolo Bonzini 已提交
8877 8878
}

8879 8880 8881
#endif

#ifndef WIN32
P
Paolo Bonzini 已提交
8882 8883 8884 8885
/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
8886 8887
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909
    {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)
8910 8911
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
P
Paolo Bonzini 已提交
8912 8913 8914
    else
        vshPrint (ctl, _("%s\n"), cwd);

8915
    VIR_FREE(cwd);
P
Paolo Bonzini 已提交
8916 8917
    return !err;
}
8918
#endif
P
Paolo Bonzini 已提交
8919

E
Eric Blake 已提交
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 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993
/*
 * "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;
}

8994 8995 8996 8997
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
8998 8999
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
9000 9001 9002 9003
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
9004
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019
    {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;
9020
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
9021

9022
    if (!vshConnectionUsability(ctl, ctl->conn))
9023 9024
        goto cleanup;

J
Jim Meyering 已提交
9025
    dom = vshCommandOptDomain (ctl, cmd, NULL);
9026 9027 9028 9029
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
9030
    doc = virDomainGetXMLDesc (dom, flags);
9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056
    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.
     */
9057
    doc_reread = virDomainGetXMLDesc (dom, flags);
9058 9059 9060 9061
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
9062 9063
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081
        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);

9082 9083 9084
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
9085 9086 9087

    if (tmp) {
        unlink (tmp);
9088
        VIR_FREE(tmp);
9089 9090 9091 9092 9093 9094 9095 9096 9097
    }

    return ret;
}

/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
9098 9099
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
9100 9101 9102 9103
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
9104
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name, id or uuid")},
9105 9106 9107 9108 9109 9110 9111 9112 9113 9114
    {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[] = {
9115 9116
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
9117 9118 9119 9120
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
9121
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9122 9123 9124 9125 9126 9127
    {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 已提交
9128 9129 9130
/*
 * "quit" command
 */
9131
static const vshCmdInfo info_quit[] = {
9132
    {"help", N_("quit this interactive terminal")},
9133
    {"desc", ""},
9134
    {NULL, NULL}
K
Karel Zak 已提交
9135 9136 9137
};

static int
9138
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9139
{
K
Karel Zak 已提交
9140 9141 9142 9143
    ctl->imode = FALSE;
    return TRUE;
}

9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171
/*
 * "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;

9172
    if (!vshConnectionUsability(ctl, ctl->conn))
9173 9174 9175 9176 9177 9178 9179 9180
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    from = vshCommandOptString(cmd, "xmlfile", NULL);
    if (from == NULL)
E
Eric Blake 已提交
9181
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
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 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264
    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;

9265
    if (!vshConnectionUsability(ctl, ctl->conn))
9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320
        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;
9321
    int actual = 0;
9322 9323 9324 9325 9326 9327 9328 9329 9330 9331
    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;

9332
    if (!vshConnectionUsability(ctl, ctl->conn))
9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390
        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);
9391
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407

            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);
9408 9409
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440
    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;

9441
    if (!vshConnectionUsability(ctl, ctl->conn))
9442 9443 9444 9445 9446 9447 9448
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    name = vshCommandOptString(cmd, "snapshotname", NULL);
9449
    if (name == NULL)
9450 9451 9452 9453 9454 9455 9456 9457 9458 9459
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

9460
    vshPrint(ctl, "%s", xml);
9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474

    ret = TRUE;

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
9475
 * "snapshot-revert" command
9476
 */
9477
static const vshCmdInfo info_snapshot_revert[] = {
9478 9479 9480 9481 9482
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

9483
static const vshCmdOptDef opts_snapshot_revert[] = {
9484 9485 9486 9487 9488 9489
    {"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
9490
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
9491 9492 9493 9494 9495 9496
{
    virDomainPtr dom = NULL;
    int ret = FALSE;
    char *name;
    virDomainSnapshotPtr snapshot = NULL;

9497
    if (!vshConnectionUsability(ctl, ctl->conn))
9498 9499 9500 9501 9502 9503 9504
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    name = vshCommandOptString(cmd, "snapshotname", NULL);
9505
    if (name == NULL)
9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550
        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;

9551
    if (!vshConnectionUsability(ctl, ctl->conn))
9552 9553 9554 9555 9556 9557 9558
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    name = vshCommandOptString(cmd, "snapshotname", NULL);
9559
    if (name == NULL)
9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582
        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;
}

K
Karel Zak 已提交
9583 9584 9585
/*
 * Commands
 */
9586
static const vshCmdDef commands[] = {
9587 9588 9589 9590
    {"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},
9591
    {"autostart", cmdAutostart, opts_autostart, info_autostart},
9592
    {"capabilities", cmdCapabilities, NULL, info_capabilities},
9593
#ifndef WIN32
P
Paolo Bonzini 已提交
9594
    {"cd", cmdCd, opts_cd, info_cd},
9595
#endif
9596
    {"connect", cmdConnect, opts_connect, info_connect},
9597
#ifndef WIN32
9598
    {"console", cmdConsole, opts_console, info_console},
9599
#endif
9600
    {"cpu-baseline", cmdCPUBaseline, opts_cpu_baseline, info_cpu_baseline},
9601
    {"cpu-compare", cmdCPUCompare, opts_cpu_compare, info_cpu_compare},
9602
    {"create", cmdCreate, opts_create, info_create},
9603
    {"start", cmdStart, opts_start, info_start},
K
Karel Zak 已提交
9604
    {"destroy", cmdDestroy, opts_destroy, info_destroy},
9605 9606 9607
    {"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},
9608
    {"define", cmdDefine, opts_define, info_define},
K
Karel Zak 已提交
9609
    {"domid", cmdDomid, opts_domid, info_domid},
K
Karel Zak 已提交
9610
    {"domuuid", cmdDomuuid, opts_domuuid, info_domuuid},
9611
    {"dominfo", cmdDominfo, opts_dominfo, info_dominfo},
9612
    {"domjobinfo", cmdDomjobinfo, opts_domjobinfo, info_domjobinfo},
9613
    {"domjobabort", cmdDomjobabort, opts_domjobabort, info_domjobabort},
K
Karel Zak 已提交
9614 9615
    {"domname", cmdDomname, opts_domname, info_domname},
    {"domstate", cmdDomstate, opts_domstate, info_domstate},
9616 9617
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat},
    {"domifstat", cmdDomIfstat, opts_domifstat, info_domifstat},
9618
    {"dommemstat", cmdDomMemStat, opts_dommemstat, info_dommemstat},
9619
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo},
9620 9621
    {"domxml-from-native", cmdDomXMLFromNative, opts_domxmlfromnative, info_domxmlfromnative},
    {"domxml-to-native", cmdDomXMLToNative, opts_domxmltonative, info_domxmltonative},
9622
    {"dumpxml", cmdDumpXML, opts_dumpxml, info_dumpxml},
E
Eric Blake 已提交
9623
    {"echo", cmdEcho, opts_echo, info_echo},
9624
    {"edit", cmdEdit, opts_edit, info_edit},
9625 9626 9627 9628
    {"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},
9629
    {"freecell", cmdFreecell, opts_freecell, info_freecell},
9630
    {"hostname", cmdHostname, NULL, info_hostname},
9631
    {"list", cmdList, opts_list, info_list},
9632
    {"migrate", cmdMigrate, opts_migrate, info_migrate},
9633
    {"migrate-setmaxdowntime", cmdMigrateSetMaxDowntime, opts_migrate_setmaxdowntime, info_migrate_setmaxdowntime},
9634

9635
    {"net-autostart", cmdNetworkAutostart, opts_network_autostart, info_network_autostart},
9636 9637 9638 9639
    {"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},
9640
    {"net-edit", cmdNetworkEdit, opts_network_edit, info_network_edit},
9641 9642 9643 9644 9645
    {"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},
9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656

    {"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},

9657
    {"managedsave", cmdManagedSave, opts_managedsave, info_managedsave},
9658
    {"managedsave-remove", cmdManagedSaveRemove, opts_managedsaveremove, info_managedsaveremove},
9659

K
Karel Zak 已提交
9660
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo},
9661

9662 9663
    {"nodedev-list", cmdNodeListDevices, opts_node_list_devices, info_node_list_devices},
    {"nodedev-dumpxml", cmdNodeDeviceDumpXML, opts_node_device_dumpxml, info_node_device_dumpxml},
9664 9665 9666
    {"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},
9667 9668
    {"nodedev-create", cmdNodeDeviceCreate, opts_node_device_create, info_node_device_create},
    {"nodedev-destroy", cmdNodeDeviceDestroy, opts_node_device_destroy, info_node_device_destroy},
9669

9670 9671 9672 9673 9674 9675
    {"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},

9676 9677 9678
    {"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},
9679
    {"pool-create-as", cmdPoolCreateAs, opts_pool_X_as, info_pool_create_as},
9680
    {"pool-define", cmdPoolDefine, opts_pool_define, info_pool_define},
9681
    {"pool-define-as", cmdPoolDefineAs, opts_pool_X_as, info_pool_define_as},
9682 9683 9684
    {"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},
9685
    {"pool-edit", cmdPoolEdit, opts_pool_edit, info_pool_edit},
9686 9687 9688 9689 9690 9691 9692 9693
    {"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},

9694 9695 9696 9697 9698 9699 9700 9701
    {"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},


9702
#ifndef WIN32
P
Paolo Bonzini 已提交
9703
    {"pwd", cmdPwd, NULL, info_pwd},
9704
#endif
K
Karel Zak 已提交
9705
    {"quit", cmdQuit, NULL, info_quit},
9706
    {"exit", cmdQuit, NULL, info_quit},
K
Karel Zak 已提交
9707 9708
    {"reboot", cmdReboot, opts_reboot, info_reboot},
    {"restore", cmdRestore, opts_restore, info_restore},
9709 9710
    {"resume", cmdResume, opts_resume, info_resume},
    {"save", cmdSave, opts_save, info_save},
9711
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo},
D
Daniel Veillard 已提交
9712
    {"dump", cmdDump, opts_dump, info_dump},
9713
    {"shutdown", cmdShutdown, opts_shutdown, info_shutdown},
9714 9715
    {"setmem", cmdSetmem, opts_setmem, info_setmem},
    {"setmaxmem", cmdSetmaxmem, opts_setmaxmem, info_setmaxmem},
9716
    {"memtune", cmdMemtune, opts_memtune, info_memtune},
9717
    {"setvcpus", cmdSetvcpus, opts_setvcpus, info_setvcpus},
K
Karel Zak 已提交
9718
    {"suspend", cmdSuspend, opts_suspend, info_suspend},
9719
    {"ttyconsole", cmdTTYConsole, opts_ttyconsole, info_ttyconsole},
9720
    {"undefine", cmdUndefine, opts_undefine, info_undefine},
9721
    {"update-device", cmdUpdateDevice, opts_update_device, info_update_device},
9722
    {"uri", cmdURI, NULL, info_uri},
9723 9724

    {"vol-create", cmdVolCreate, opts_vol_create, info_vol_create},
9725
    {"vol-create-from", cmdVolCreateFrom, opts_vol_create_from, info_vol_create_from},
9726
    {"vol-create-as", cmdVolCreateAs, opts_vol_create_as, info_vol_create_as},
9727
    {"vol-clone", cmdVolClone, opts_vol_clone, info_vol_clone},
9728
    {"vol-delete", cmdVolDelete, opts_vol_delete, info_vol_delete},
D
David Allan 已提交
9729
    {"vol-wipe", cmdVolWipe, opts_vol_wipe, info_vol_wipe},
9730 9731 9732
    {"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 已提交
9733
    {"vol-pool", cmdVolPool, opts_vol_pool, info_vol_pool},
9734 9735 9736 9737
    {"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},

9738 9739
    {"vcpuinfo", cmdVcpuinfo, opts_vcpuinfo, info_vcpuinfo},
    {"vcpupin", cmdVcpupin, opts_vcpupin, info_vcpupin},
9740
    {"version", cmdVersion, NULL, info_version},
9741
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay},
9742 9743 9744 9745 9746 9747

    {"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},
9748
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert, info_snapshot_revert},
9749

9750
    {NULL, NULL, NULL, NULL}
K
Karel Zak 已提交
9751 9752 9753 9754 9755 9756
};

/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
9757
static const char *
9758
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
9759
{
9760
    const vshCmdInfo *info;
9761

K
Karel Zak 已提交
9762
    for (info = cmd->info; info && info->name; info++) {
9763
        if (STREQ(info->name, name))
K
Karel Zak 已提交
9764 9765 9766 9767 9768
            return info->data;
    }
    return NULL;
}

9769 9770
static const vshCmdOptDef *
vshCmddefGetOption(const vshCmdDef * cmd, const char *name)
9771
{
9772
    const vshCmdOptDef *opt;
9773

K
Karel Zak 已提交
9774
    for (opt = cmd->opts; opt && opt->name; opt++)
9775
        if (STREQ(opt->name, name))
K
Karel Zak 已提交
9776 9777 9778 9779
            return opt;
    return NULL;
}

9780 9781
static const vshCmdOptDef *
vshCmddefGetData(const vshCmdDef * cmd, int data_ct)
9782
{
9783
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
9784

9785
    for (opt = cmd->opts; opt && opt->name; opt++) {
9786 9787
        if (opt->type >= VSH_OT_DATA) {
            if (data_ct == 0 || opt->type == VSH_OT_ARGV)
9788 9789 9790 9791 9792
                return opt;
            else
                data_ct--;
        }
    }
K
Karel Zak 已提交
9793 9794 9795
    return NULL;
}

9796 9797 9798
/*
 * Checks for required options
 */
9799
static int
9800
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd)
9801
{
9802 9803
    const vshCmdDef *def = cmd->def;
    const vshCmdOptDef *d;
9804
    int err = 0;
9805 9806 9807 9808

    for (d = def->opts; d && d->name; d++) {
        if (d->flag & VSH_OFLAG_REQ) {
            vshCmdOpt *o = cmd->opts;
9809 9810 9811
            int ok = 0;

            while (o && ok == 0) {
9812
                if (o->def == d)
9813
                    ok = 1;
9814 9815 9816
                o = o->next;
            }
            if (!ok) {
9817
                vshError(ctl,
9818
                         d->type == VSH_OT_DATA ?
9819
                         _("command '%s' requires <%s> option") :
9820
                         _("command '%s' requires --%s option"),
9821
                         def->name, d->name);
9822 9823
                err = 1;
            }
9824

9825 9826 9827 9828 9829
        }
    }
    return !err;
}

9830
static const vshCmdDef *
9831 9832
vshCmddefSearch(const char *cmdname)
{
9833
    const vshCmdDef *c;
9834

K
Karel Zak 已提交
9835
    for (c = commands; c->name; c++)
9836
        if (STREQ(c->name, cmdname))
K
Karel Zak 已提交
9837 9838 9839 9840 9841
            return c;
    return NULL;
}

static int
9842
vshCmddefHelp(vshControl *ctl, const char *cmdname)
9843
{
9844
    const vshCmdDef *def = vshCmddefSearch(cmdname);
9845

K
Karel Zak 已提交
9846
    if (!def) {
9847
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
9848 9849
        return FALSE;
    } else {
E
Eric Blake 已提交
9850 9851
        const char *desc = _(vshCmddefGetInfo(def, "desc"));
        const char *help = _(vshCmddefGetInfo(def, "help"));
9852
        char buf[256];
K
Karel Zak 已提交
9853

9854
        fputs(_("  NAME\n"), stdout);
9855 9856
        fprintf(stdout, "    %s - %s\n", def->name, help);

9857 9858 9859 9860 9861 9862
        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;
9863 9864
                switch (opt->type) {
                case VSH_OT_BOOL:
9865
                    fmt = "[--%s]";
9866 9867
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
9868 9869
                    /* xgettext:c-format */
                    fmt = _("[--%s <number>]");
9870 9871
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
9872 9873
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
9874 9875
                    break;
                case VSH_OT_DATA:
9876
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
9877 9878 9879 9880 9881 9882
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
                    fmt = _("[<string>]...");
                    break;
                default:
9883
                    assert(0);
9884
                }
9885
                fputc(' ', stdout);
E
Eric Blake 已提交
9886
                fprintf(stdout, fmt, opt->name);
9887
            }
K
Karel Zak 已提交
9888
        }
9889 9890 9891
        fputc('\n', stdout);

        if (desc[0]) {
9892
            /* Print the description only if it's not empty.  */
9893
            fputs(_("\n  DESCRIPTION\n"), stdout);
K
Karel Zak 已提交
9894 9895
            fprintf(stdout, "    %s\n", desc);
        }
9896

K
Karel Zak 已提交
9897
        if (def->opts) {
9898
            const vshCmdOptDef *opt;
9899
            fputs(_("\n  OPTIONS\n"), stdout);
9900
            for (opt = def->opts; opt->name; opt++) {
9901 9902
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
9903
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
9904 9905
                    break;
                case VSH_OT_INT:
9906
                    snprintf(buf, sizeof(buf), _("--%s <number>"), opt->name);
9907 9908
                    break;
                case VSH_OT_STRING:
9909
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
9910 9911
                    break;
                case VSH_OT_DATA:
9912 9913
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
9914 9915 9916 9917 9918 9919 9920
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
                    continue;
                default:
                    assert(0);
                }
9921

E
Eric Blake 已提交
9922
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
9923
            }
K
Karel Zak 已提交
9924 9925 9926 9927 9928 9929 9930 9931 9932 9933
        }
        fputc('\n', stdout);
    }
    return TRUE;
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
9934 9935 9936
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
9937 9938
    vshCmdOpt *a = arg;

9939
    while (a) {
K
Karel Zak 已提交
9940
        vshCmdOpt *tmp = a;
9941

K
Karel Zak 已提交
9942 9943
        a = a->next;

9944 9945
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
9946 9947 9948 9949
    }
}

static void
9950
vshCommandFree(vshCmd *cmd)
9951
{
K
Karel Zak 已提交
9952 9953
    vshCmd *c = cmd;

9954
    while (c) {
K
Karel Zak 已提交
9955
        vshCmd *tmp = c;
9956

K
Karel Zak 已提交
9957 9958 9959 9960
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
9961
        VIR_FREE(tmp);
K
Karel Zak 已提交
9962 9963 9964 9965 9966 9967 9968
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
9969
vshCommandOpt(const vshCmd *cmd, const char *name)
9970
{
K
Karel Zak 已提交
9971
    vshCmdOpt *opt = cmd->opts;
9972 9973

    while (opt) {
9974
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
9975 9976 9977 9978 9979 9980 9981 9982 9983 9984
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
 * Returns option as INT
 */
static int
9985
vshCommandOptInt(const vshCmd *cmd, const char *name, int *found)
9986
{
K
Karel Zak 已提交
9987
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
9988 9989
    int res = 0, num_found = FALSE;
    char *end_p = NULL;
9990

9991 9992
    if ((arg != NULL) && (arg->data != NULL)) {
        res = strtol(arg->data, &end_p, 10);
9993 9994 9995 9996
        if ((arg->data == end_p) || (*end_p!= 0))
            num_found = FALSE;
        else
            num_found = TRUE;
9997
    }
K
Karel Zak 已提交
9998
    if (found)
9999
        *found = num_found;
K
Karel Zak 已提交
10000 10001 10002
    return res;
}

10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022
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 已提交
10023 10024 10025 10026
/*
 * Returns option as STRING
 */
static char *
10027
vshCommandOptString(const vshCmd *cmd, const char *name, int *found)
10028
{
K
Karel Zak 已提交
10029
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
10030

K
Karel Zak 已提交
10031 10032
    if (found)
        *found = arg ? TRUE : FALSE;
10033

10034 10035 10036
    if (arg && arg->data && *arg->data)
        return arg->data;

10037
    if (arg && arg->def && ((arg->def->flag) & VSH_OFLAG_REQ))
10038 10039 10040
        vshError(NULL, _("Missing required option '%s'"), name);

    return NULL;
K
Karel Zak 已提交
10041 10042
}

10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060
/*
 * 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 已提交
10061 10062 10063 10064
/*
 * Returns TRUE/FALSE if the option exists
 */
static int
10065
vshCommandOptBool(const vshCmd *cmd, const char *name)
10066
{
K
Karel Zak 已提交
10067 10068 10069
    return vshCommandOpt(cmd, name) ? TRUE : FALSE;
}

10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090
/*
 * 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 已提交
10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108
/* 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)
10109
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
10110 10111 10112
                 cmd->def->name, optname);
    return found;
}
10113

K
Karel Zak 已提交
10114
static virDomainPtr
J
Jim Meyering 已提交
10115
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
10116
                      char **name, int flag)
10117
{
K
Karel Zak 已提交
10118
    virDomainPtr dom = NULL;
10119
    char *n;
K
Karel Zak 已提交
10120
    int id;
J
Jim Meyering 已提交
10121 10122 10123
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
10124

10125
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10126 10127
        return NULL;

K
Karel Zak 已提交
10128
    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
10129 10130
             cmd->def->name, optname, n);

K
Karel Zak 已提交
10131 10132
    if (name)
        *name = n;
10133

K
Karel Zak 已提交
10134
    /* try it by ID */
10135
    if (flag & VSH_BYID) {
10136
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
10137 10138 10139 10140
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
10141
    }
K
Karel Zak 已提交
10142
    /* try it by UUID */
10143
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
10144
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
10145
                 cmd->def->name, optname);
K
Karel Zak 已提交
10146
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
10147
    }
K
Karel Zak 已提交
10148
    /* try it by NAME */
10149
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
10150
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
10151
                 cmd->def->name, optname);
K
Karel Zak 已提交
10152
        dom = virDomainLookupByName(ctl->conn, n);
10153
    }
K
Karel Zak 已提交
10154

10155
    if (!dom)
10156
        vshError(ctl, _("failed to get domain '%s'"), n);
10157

K
Karel Zak 已提交
10158 10159 10160
    return dom;
}

10161
static virNetworkPtr
J
Jim Meyering 已提交
10162
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
10163
                       char **name, int flag)
10164 10165 10166
{
    virNetworkPtr network = NULL;
    char *n;
J
Jim Meyering 已提交
10167 10168 10169
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
10170

10171
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10172 10173 10174 10175 10176 10177 10178 10179 10180
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
10181
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
10182
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
10183
                 cmd->def->name, optname);
10184 10185 10186 10187
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
10188
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
10189 10190 10191 10192 10193
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
10194
        vshError(ctl, _("failed to get network '%s'"), n);
10195 10196 10197 10198

    return network;
}

10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209

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;

10210
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237
        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;
}

10238 10239 10240 10241 10242 10243 10244 10245 10246 10247
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;

10248
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10249 10250 10251 10252 10253 10254 10255 10256 10257
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
10258
    if ((flag & VSH_BYNAME)) {
10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270
        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)
10271
        vshError(ctl, _("failed to get interface '%s'"), n);
10272 10273 10274 10275

    return iface;
}

10276
static virStoragePoolPtr
10277
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
10278 10279 10280 10281 10282
                    char **name, int flag)
{
    virStoragePoolPtr pool = NULL;
    char *n;

10283
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10284 10285 10286 10287 10288 10289 10290 10291 10292
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
10293
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
10294
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
10295
                 cmd->def->name, optname);
10296 10297 10298
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
10299
    if (pool == NULL && (flag & VSH_BYNAME)) {
10300 10301 10302 10303 10304 10305
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
10306
        vshError(ctl, _("failed to get pool '%s'"), n);
10307 10308 10309 10310 10311

    return pool;
}

static virStorageVolPtr
10312
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
10313 10314 10315 10316 10317 10318 10319 10320 10321
                   const char *optname,
                   const char *pooloptname,
                   char **name, int flag)
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
    char *n, *p;
    int found;

10322
    if (!(n = vshCommandOptString(cmd, optname, NULL)))
10323 10324
        return NULL;

10325
    if (!(p = vshCommandOptString(cmd, pooloptname, &found)) && found)
10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336
        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;

10337
    /* try it by name */
10338
    if (pool && (flag & VSH_BYNAME)) {
10339
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
10340 10341 10342
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
10343
    /* try it by key */
10344 10345 10346 10347 10348
    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);
    }
10349
    /* try it by path */
10350 10351 10352 10353 10354 10355 10356
    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)
10357
        vshError(ctl, _("failed to get vol '%s'"), n);
10358 10359 10360 10361 10362 10363 10364

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375
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);
10376
    if (n == NULL)
10377 10378 10379 10380 10381 10382 10383 10384 10385 10386
        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)
10387
        vshError(ctl, _("failed to get secret '%s'"), n);
10388 10389 10390 10391

    return secret;
}

K
Karel Zak 已提交
10392 10393 10394 10395
/*
 * Executes command(s) and returns return code from last command
 */
static int
10396
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
10397
{
K
Karel Zak 已提交
10398
    int ret = TRUE;
10399 10400

    while (cmd) {
K
Karel Zak 已提交
10401
        struct timeval before, after;
10402
        bool enable_timing = ctl->timing;
10403

10404 10405 10406
        if ((ctl->conn == NULL) || (disconnected != 0))
            vshReconnect(ctl);

10407
        if (enable_timing)
K
Karel Zak 已提交
10408
            GETTIMEOFDAY(&before);
10409

K
Karel Zak 已提交
10410 10411
        ret = cmd->def->handler(ctl, cmd);

10412
        if (enable_timing)
K
Karel Zak 已提交
10413
            GETTIMEOFDAY(&after);
10414

J
John Levon 已提交
10415 10416 10417
        if (ret == FALSE)
            virshReportError(ctl);

10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428
        /* 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);

10429
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
10430 10431
            return ret;

10432
        if (enable_timing)
10433
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
10434 10435
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
10436
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
10437 10438 10439 10440 10441 10442
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
10443
 * Command parsing
K
Karel Zak 已提交
10444 10445 10446
 * ---------------
 */

10447 10448 10449 10450 10451 10452 10453 10454 10455 10456
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 已提交
10457
    /* vshCommandStringGetArg() */
10458
    char *pos;
L
Lai Jiangshan 已提交
10459 10460 10461
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
10462 10463
} vshCommandParser;

K
Karel Zak 已提交
10464
static int
10465
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
10466
{
K
Karel Zak 已提交
10467 10468 10469
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
10470

K
Karel Zak 已提交
10471 10472 10473 10474
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
10475

10476
    while (1) {
K
Karel Zak 已提交
10477
        vshCmdOpt *last = NULL;
10478
        const vshCmdDef *cmd = NULL;
10479
        vshCommandToken tk;
L
Lai Jiangshan 已提交
10480
        bool data_only = false;
10481
        int data_ct = 0;
10482

K
Karel Zak 已提交
10483
        first = NULL;
10484

10485
        while (1) {
10486
            const vshCmdOptDef *opt = NULL;
10487

K
Karel Zak 已提交
10488
            tkdata = NULL;
10489
            tk = parser->getNextArg(ctl, parser, &tkdata);
10490 10491

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
10492
                goto syntaxError;
10493 10494
            if (tk != VSH_TK_ARG)
                break;
10495 10496

            if (cmd == NULL) {
K
Karel Zak 已提交
10497 10498
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
10499
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
10500
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
10501
                }
10502
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
10503 10504 10505 10506
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
10507 10508 10509 10510 10511 10512
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
                if (!(opt = vshCmddefGetOption(cmd, tkdata + 2))) {
10513
                    vshError(ctl,
10514
                             _("command '%s' doesn't support option --%s"),
10515 10516
                             cmd->name, tkdata + 2);
                    VIR_FREE(optstr);
K
Karel Zak 已提交
10517 10518
                    goto syntaxError;
                }
10519
                VIR_FREE(tkdata);
K
Karel Zak 已提交
10520 10521 10522

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
10523 10524 10525
                    if (optstr)
                        tkdata = optstr;
                    else
10526
                        tk = parser->getNextArg(ctl, parser, &tkdata);
10527
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
10528
                        goto syntaxError;
10529
                    if (tk != VSH_TK_ARG) {
10530
                        vshError(ctl,
10531
                                 _("expected syntax: --%s <%s>"),
10532 10533
                                 opt->name,
                                 opt->type ==
10534
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
10535 10536
                        goto syntaxError;
                    }
10537 10538 10539 10540 10541 10542 10543 10544
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
10545
                }
L
Lai Jiangshan 已提交
10546 10547 10548 10549
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
10550
            } else {
L
Lai Jiangshan 已提交
10551
get_data:
10552
                if (!(opt = vshCmddefGetData(cmd, data_ct++))) {
10553
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
10554 10555 10556 10557 10558
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
10559
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
10560

K
Karel Zak 已提交
10561 10562 10563 10564
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
10565

K
Karel Zak 已提交
10566 10567 10568 10569 10570
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
10571

K
Karel Zak 已提交
10572
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
10573 10574
                         cmd->name,
                         opt->name,
10575 10576
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
10577 10578
            }
        }
10579

D
Daniel Veillard 已提交
10580
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
10581
        if (cmd) {
10582
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
10583

K
Karel Zak 已提交
10584 10585 10586 10587
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

10588
            if (!vshCommandCheckOpts(ctl, c)) {
10589
                VIR_FREE(c);
10590
                goto syntaxError;
10591
            }
10592

K
Karel Zak 已提交
10593 10594 10595 10596 10597 10598
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
10599 10600 10601

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
10602
    }
10603

K
Karel Zak 已提交
10604 10605
    return TRUE;

10606
 syntaxError:
10607
    if (ctl->cmd) {
K
Karel Zak 已提交
10608
        vshCommandFree(ctl->cmd);
10609 10610
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
10611 10612
    if (first)
        vshCommandOptFree(first);
10613
    VIR_FREE(tkdata);
10614
    return FALSE;
K
Karel Zak 已提交
10615 10616
}

10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724
/* --------------------
 * 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 已提交
10725
/* ---------------
10726
 * Misc utils
K
Karel Zak 已提交
10727 10728
 * ---------------
 */
K
Karel Zak 已提交
10729
static const char *
10730 10731
vshDomainStateToString(int state)
{
K
Karel Zak 已提交
10732
    switch (state) {
10733
    case VIR_DOMAIN_RUNNING:
10734
        return N_("running");
10735
    case VIR_DOMAIN_BLOCKED:
10736
        return N_("idle");
10737
    case VIR_DOMAIN_PAUSED:
10738
        return N_("paused");
10739
    case VIR_DOMAIN_SHUTDOWN:
10740
        return N_("in shutdown");
10741
    case VIR_DOMAIN_SHUTOFF:
10742
        return N_("shut off");
10743
    case VIR_DOMAIN_CRASHED:
10744
        return N_("crashed");
10745
    default:
10746
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
10747
    }
10748
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
10749 10750
}

10751 10752 10753 10754
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
10755
    case VIR_VCPU_OFFLINE:
10756
        return N_("offline");
10757
    case VIR_VCPU_BLOCKED:
10758
        return N_("idle");
10759
    case VIR_VCPU_RUNNING:
10760
        return N_("running");
10761
    default:
10762
        ;/*FALLTHROUGH*/
10763
    }
10764
    return N_("no state");
10765 10766
}

K
Karel Zak 已提交
10767
static int
10768
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
10769
{
10770 10771
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
10772 10773
     */
    if (!conn) {
10774
        vshError(ctl, "%s", _("no valid connection"));
K
Karel Zak 已提交
10775 10776 10777 10778 10779
        return FALSE;
    }
    return TRUE;
}

K
Karel Zak 已提交
10780
static void
10781
vshDebug(vshControl *ctl, int level, const char *format, ...)
10782
{
K
Karel Zak 已提交
10783 10784
    va_list ap;

10785 10786 10787 10788
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
10789 10790 10791 10792 10793 10794
    if (level > ctl->debug)
        return;

    va_start(ap, format);
    vfprintf(stdout, format, ap);
    va_end(ap);
K
Karel Zak 已提交
10795 10796 10797
}

static void
10798
vshPrintExtra(vshControl *ctl, const char *format, ...)
10799
{
K
Karel Zak 已提交
10800
    va_list ap;
10801

K
Karel Zak 已提交
10802
    if (ctl->quiet == TRUE)
K
Karel Zak 已提交
10803
        return;
10804

K
Karel Zak 已提交
10805
    va_start(ap, format);
10806
    vfprintf(stdout, format, ap);
K
Karel Zak 已提交
10807 10808 10809
    va_end(ap);
}

K
Karel Zak 已提交
10810

K
Karel Zak 已提交
10811
static void
10812
vshError(vshControl *ctl, const char *format, ...)
10813
{
K
Karel Zak 已提交
10814
    va_list ap;
10815

10816 10817 10818 10819 10820
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
10821

10822
    fputs(_("error: "), stderr);
10823

K
Karel Zak 已提交
10824 10825 10826 10827 10828 10829 10830 10831
    va_start(ap, format);
    vfprintf(stderr, format, ap);
    va_end(ap);

    fputc('\n', stderr);
}

/*
10832
 * Initialize connection.
K
Karel Zak 已提交
10833 10834
 */
static int
10835
vshInit(vshControl *ctl)
10836
{
K
Karel Zak 已提交
10837 10838 10839
    if (ctl->conn)
        return FALSE;

10840 10841
    vshOpenLogFile(ctl);

10842 10843
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
10844

10845 10846 10847
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

10848 10849 10850 10851
    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

10852

10853 10854 10855 10856
    /* This is not necessarily fatal.  All the individual commands check
     * vshConnectionUsability, except ones which don't need a connection
     * such as "help".
     */
10857
    if (!ctl->conn) {
10858
        virshReportError(ctl);
10859
        vshError(ctl, "%s", _("failed to connect to the hypervisor"));
10860 10861
        return FALSE;
    }
K
Karel Zak 已提交
10862 10863 10864 10865

    return TRUE;
}

10866 10867
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886
/**
 * 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:
10887
                vshError(ctl, "%s",
J
Jim Meyering 已提交
10888
                         _("failed to get the log file information"));
10889
                exit(EXIT_FAILURE);
10890 10891 10892
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
10893 10894
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
10895 10896 10897 10898
        }
    }

    /* log file open */
10899
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
10900
        vshError(ctl, "%s",
J
Jim Meyering 已提交
10901
                 _("failed to open the log file. check the log file path"));
10902
        exit(EXIT_FAILURE);
10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967
    }
}

/**
 * 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 */
10968
    if (safewrite(ctl->log_fd, msg_buf, strlen(msg_buf)) < 0) {
10969
        vshCloseLogFile(ctl);
10970
        vshError(ctl, "%s", _("failed to write the log file"));
10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983
    }
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
    if (ctl->log_fd >= 0) {
10984
        if (close(ctl->log_fd) < 0)
10985
            vshError(ctl, _("%s: failed to write log file: %s"),
10986
                     ctl->logfile ? ctl->logfile : "?", strerror (errno));
10987 10988 10989 10990
        ctl->log_fd = -1;
    }

    if (ctl->logfile) {
10991
        VIR_FREE(ctl->logfile);
10992 10993 10994 10995
        ctl->logfile = NULL;
    }
}

10996
#ifdef USE_READLINE
10997

K
Karel Zak 已提交
10998 10999 11000 11001 11002
/* -----------------
 * Readline stuff
 * -----------------
 */

11003
/*
K
Karel Zak 已提交
11004 11005
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
11006
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
11007 11008
 */
static char *
11009 11010
vshReadlineCommandGenerator(const char *text, int state)
{
K
Karel Zak 已提交
11011
    static int list_index, len;
K
Karel Zak 已提交
11012
    const char *name;
K
Karel Zak 已提交
11013 11014 11015

    /* If this is a new word to complete, initialize now.  This
     * includes saving the length of TEXT for efficiency, and
11016
     * initializing the index variable to 0.
K
Karel Zak 已提交
11017 11018 11019
     */
    if (!state) {
        list_index = 0;
11020
        len = strlen(text);
K
Karel Zak 已提交
11021 11022 11023
    }

    /* Return the next name which partially matches from the
11024
     * command list.
K
Karel Zak 已提交
11025
     */
K
Karel Zak 已提交
11026
    while ((name = commands[list_index].name)) {
K
Karel Zak 已提交
11027
        list_index++;
11028
        if (STREQLEN(name, text, len))
11029
            return vshStrdup(NULL, name);
K
Karel Zak 已提交
11030 11031 11032 11033 11034 11035 11036
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
11037 11038
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
11039
    static int list_index, len;
11040
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
11041
    const char *name;
K
Karel Zak 已提交
11042 11043 11044 11045 11046 11047 11048 11049 11050

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

11051
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
11052
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
11053 11054 11055

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
11056
        len = strlen(text);
11057
        VIR_FREE(cmdname);
K
Karel Zak 已提交
11058 11059 11060 11061
    }

    if (!cmd)
        return NULL;
11062

11063 11064 11065
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
11066
    while ((name = cmd->opts[list_index].name)) {
11067
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
11068
        char *res;
11069

K
Karel Zak 已提交
11070
        list_index++;
11071

K
Karel Zak 已提交
11072
        if (opt->type == VSH_OT_DATA)
K
Karel Zak 已提交
11073 11074
            /* ignore non --option */
            continue;
11075

K
Karel Zak 已提交
11076
        if (len > 2) {
11077
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
11078 11079
                continue;
        }
11080
        res = vshMalloc(NULL, strlen(name) + 3);
11081
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
11082 11083 11084 11085 11086 11087 11088 11089
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
11090 11091 11092
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
11093 11094
    char **matches = (char **) NULL;

11095
    if (start == 0)
K
Karel Zak 已提交
11096
        /* command name generator */
11097
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
11098 11099
    else
        /* commands options */
11100
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
11101 11102 11103 11104
    return matches;
}


11105 11106
static int
vshReadlineInit(vshControl *ctl)
11107
{
11108 11109
    char *userdir = NULL;

K
Karel Zak 已提交
11110 11111 11112 11113 11114
    /* 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;
11115 11116 11117

    /* Limit the total size of the history buffer */
    stifle_history(500);
11118 11119

    /* Prepare to read/write history from/to the ~/.virsh/history file */
11120
    userdir = virGetUserDirectory(getuid());
11121 11122 11123 11124 11125 11126

    if (userdir == NULL)
        return -1;

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
11127
        VIR_FREE(userdir);
11128 11129 11130 11131 11132
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
11133
        VIR_FREE(userdir);
11134 11135 11136
        return -1;
    }

11137
    VIR_FREE(userdir);
11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155

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

11156 11157
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
11158 11159
}

11160 11161 11162 11163 11164 11165
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

11166
#else /* !USE_READLINE */
11167

11168 11169 11170 11171 11172 11173 11174
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

11175
static void
11176
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199
{
    /* 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);
}

11200
#endif /* !USE_READLINE */
11201

K
Karel Zak 已提交
11202
/*
J
Jim Meyering 已提交
11203
 * Deinitialize virsh
K
Karel Zak 已提交
11204 11205
 */
static int
11206
vshDeinit(vshControl *ctl)
11207
{
11208
    vshReadlineDeinit(ctl);
11209
    vshCloseLogFile(ctl);
11210
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
11211
    if (ctl->conn) {
11212
        if (virConnectClose(ctl->conn) != 0) {
11213
            vshError(ctl, "%s", _("failed to disconnect from the hypervisor"));
K
Karel Zak 已提交
11214 11215
        }
    }
D
Daniel P. Berrange 已提交
11216 11217
    virResetLastError();

K
Karel Zak 已提交
11218 11219
    return TRUE;
}
11220

K
Karel Zak 已提交
11221 11222 11223 11224
/*
 * Print usage
 */
static void
11225
vshUsage(void)
11226
{
11227
    const vshCmdDef *cmd;
L
Lai Jiangshan 已提交
11228 11229
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
11230 11231 11232 11233 11234 11235 11236 11237 11238
                      "  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"
                      "    -v | --version          program version\n\n"
L
Lai Jiangshan 已提交
11239
                      "  commands (non interactive mode):\n"), progname, progname);
11240 11241 11242

    for (cmd = commands; cmd->name; cmd++)
        fprintf(stdout,
E
Eric Blake 已提交
11243
                "    %-15s %s\n", cmd->name, _(vshCmddefGetInfo(cmd, "help")));
11244 11245 11246 11247

    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
11248 11249 11250 11251 11252 11253 11254
}

/*
 * argv[]:  virsh [options] [command]
 *
 */
static int
11255
vshParseArgv(vshControl *ctl, int argc, char **argv)
11256
{
11257 11258
    bool help = false;
    int arg;
K
Karel Zak 已提交
11259
    struct option opt[] = {
11260 11261 11262 11263 11264
        {"debug", 1, 0, 'd'},
        {"help", 0, 0, 'h'},
        {"quiet", 0, 0, 'q'},
        {"timing", 0, 0, 't'},
        {"version", 0, 0, 'v'},
K
Karel Zak 已提交
11265
        {"connect", 1, 0, 'c'},
11266
        {"readonly", 0, 0, 'r'},
11267
        {"log", 1, 0, 'l'},
K
Karel Zak 已提交
11268
        {0, 0, 0, 0}
11269 11270
    };

11271 11272 11273 11274
    /* 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. */
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vrl:", opt, NULL)) != -1) {
11275
        switch (arg) {
11276
        case 'd':
D
Daniel Veillard 已提交
11277
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
11278
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
11279 11280
                exit(EXIT_FAILURE);
            }
11281 11282
            break;
        case 'h':
11283
            help = true;
11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294
            break;
        case 'q':
            ctl->quiet = TRUE;
            break;
        case 't':
            ctl->timing = TRUE;
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
        case 'v':
11295 11296
            /* FIXME - list a copyright blurb, as in GNU programs?  */
            puts(VERSION);
11297
            exit(EXIT_SUCCESS);
11298 11299 11300
        case 'r':
            ctl->readonly = TRUE;
            break;
11301 11302 11303
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
11304
        default:
11305 11306
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
11307 11308 11309 11310
        }
    }

    if (help) {
11311 11312
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
11313 11314
            exit(EXIT_FAILURE);
        }
11315 11316 11317

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
11318
        exit(EXIT_SUCCESS);
11319 11320
    }

11321
    if (argc > optind) {
K
Karel Zak 已提交
11322 11323
        /* parse command */
        ctl->imode = FALSE;
11324 11325 11326
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
11327
        } else {
11328
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
11329 11330 11331 11332 11333
        }
    }
    return TRUE;
}

11334 11335 11336 11337
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
11338
    char *defaultConn;
K
Karel Zak 已提交
11339 11340
    int ret = TRUE;

11341 11342
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
11343
        /* failure to setup locale is not fatal */
11344 11345 11346
    }
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR)) {
        perror("bindtextdomain");
11347
        return -1;
11348 11349 11350
    }
    if (!textdomain(GETTEXT_PACKAGE)) {
        perror("textdomain");
11351
        return -1;
11352 11353
    }

11354
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
11355 11356 11357
        progname = argv[0];
    else
        progname++;
11358

K
Karel Zak 已提交
11359
    memset(ctl, 0, sizeof(vshControl));
11360
    ctl->imode = TRUE;          /* default is interactive mode */
11361
    ctl->log_fd = -1;           /* Initialize log file descriptor */
K
Karel Zak 已提交
11362

11363
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
11364
        ctl->name = vshStrdup(ctl, defaultConn);
11365 11366
    }

D
Daniel P. Berrange 已提交
11367 11368
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
11369
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
11370
    }
11371

D
Daniel P. Berrange 已提交
11372 11373
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
11374
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
11375
    }
11376

K
Karel Zak 已提交
11377
    if (!ctl->imode) {
11378
        ret = vshCommandRun(ctl, ctl->cmd);
11379
    } else {
K
Karel Zak 已提交
11380 11381
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
11382
            vshPrint(ctl,
11383
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
11384
                     progname);
J
Jim Meyering 已提交
11385
            vshPrint(ctl, "%s",
11386
                     _("Type:  'help' for help with commands\n"
11387
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
11388
        }
11389 11390 11391 11392 11393 11394

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
11395
        do {
11396
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
11397
            ctl->cmdstr =
11398
                vshReadline(ctl, prompt);
11399 11400
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
11401
            if (*ctl->cmdstr) {
11402
#if USE_READLINE
K
Karel Zak 已提交
11403
                add_history(ctl->cmdstr);
11404
#endif
11405
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
11406 11407
                    vshCommandRun(ctl, ctl->cmd);
            }
11408
            VIR_FREE(ctl->cmdstr);
11409
        } while (ctl->imode);
K
Karel Zak 已提交
11410

11411 11412
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
11413
    }
11414

K
Karel Zak 已提交
11415 11416
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
11417
}