virsh-domain.c 414.9 KB
Newer Older
1 2 3
/*
 * virsh-domain.c: Commands to manage domain
 *
4
 * Copyright (C) 2005, 2007-2016 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with this library.  If not, see
18 19 20
 * <http://www.gnu.org/licenses/>.
 */

E
Eric Blake 已提交
21 22
#include <config.h>
#include "virsh-domain.h"
23
#include "virsh-util.h"
E
Eric Blake 已提交
24 25 26 27 28 29 30 31 32 33 34 35

#include <fcntl.h>
#include <poll.h>
#include <signal.h>
#include <sys/time.h>

#include <libxml/parser.h>
#include <libxml/tree.h>
#include <libxml/xpath.h>
#include <libxml/xmlsave.h>

#include "internal.h"
36
#include "virbitmap.h"
37
#include "virbuffer.h"
E
Eric Blake 已提交
38 39
#include "c-ctype.h"
#include "conf/domain_conf.h"
40
#include "viralloc.h"
41
#include "vircommand.h"
E
Eric Blake 已提交
42
#include "virfile.h"
43
#include "virjson.h"
E
Eric Blake 已提交
44 45
#include "virkeycode.h"
#include "virmacaddr.h"
46
#include "virnetdevbandwidth.h"
47
#include "virprocess.h"
48
#include "virstring.h"
49
#include "virsh-console.h"
50
#include "virsh-domain-monitor.h"
51
#include "virerror.h"
52
#include "virtime.h"
E
Eric Blake 已提交
53
#include "virtypedparam.h"
54
#include "virxml.h"
55
#include "virsh-nodedev.h"
56
#include "viruri.h"
57
#include "vsh-table.h"
58
#include "virenum.h"
E
Eric Blake 已提交
59

60 61 62 63 64
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

65 66 67 68
#define VIRSH_COMMON_OPT_DOMAIN_PERSISTENT \
    {.name = "persistent", \
     .type = VSH_OT_BOOL, \
     .help = N_("make live change persistent") \
69
    }
70

71
#define VIRSH_COMMON_OPT_DOMAIN_CONFIG \
72
    VIRSH_COMMON_OPT_CONFIG(N_("affect next boot"))
73

74
#define VIRSH_COMMON_OPT_DOMAIN_LIVE \
75
    VIRSH_COMMON_OPT_LIVE(N_("affect running domain"))
76

77
#define VIRSH_COMMON_OPT_DOMAIN_CURRENT \
78
    VIRSH_COMMON_OPT_CURRENT(N_("affect current domain"))
79

80

81
static virDomainPtr
82
virshDomainDefine(virConnectPtr conn, const char *xml, unsigned int flags)
83 84 85 86 87 88 89 90
{
    virDomainPtr dom;
    if (flags) {
        dom = virDomainDefineXMLFlags(conn, xml, flags);
        /* If validate is the only flag, just drop it and
         * try again.
         */
        if (!dom) {
91
            if ((virGetLastErrorCode() == VIR_ERR_NO_SUPPORT) &&
92 93 94 95 96 97 98 99 100
                (flags == VIR_DOMAIN_DEFINE_VALIDATE))
                dom = virDomainDefineXML(conn, xml);
        }
    } else {
        dom = virDomainDefineXML(conn, xml);
    }
    return dom;
}

101
VIR_ENUM_DECL(virshDomainVcpuState);
102
VIR_ENUM_IMPL(virshDomainVcpuState,
103 104 105
              VIR_VCPU_LAST,
              N_("offline"),
              N_("running"),
106
              N_("blocked"));
107

108
static const char *
109
virshDomainVcpuStateToString(int state)
110
{
111
    const char *str = virshDomainVcpuStateTypeToString(state);
112
    return str ? _(str) : _("no state");
113 114
}

115 116 117 118 119 120
/*
 * Determine number of CPU nodes present by trying
 * virNodeGetCPUMap and falling back to virNodeGetInfo
 * if needed.
 */
static int
121
virshNodeGetCPUCount(virConnectPtr conn)
122 123 124 125 126 127 128
{
    int ret;
    virNodeInfo nodeinfo;

    if ((ret = virNodeGetCPUMap(conn, NULL, NULL, 0)) < 0) {
        /* fall back to nodeinfo */
        vshResetLibvirtError();
129
        if (virNodeGetInfo(conn, &nodeinfo) == 0)
130 131 132 133 134
            ret = VIR_NODEINFO_MAXCPUS(nodeinfo);
    }
    return ret;
}

135 136 137 138
/*
 * "attach-device" command
 */
static const vshCmdInfo info_attach_device[] = {
139 140 141 142 143 144 145
    {.name = "help",
     .data = N_("attach device from an XML file")
    },
    {.name = "desc",
     .data = N_("Attach device from an XML <file>.")
    },
    {.name = NULL}
146 147 148
};

static const vshCmdOptDef opts_attach_device[] = {
149
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
150
    VIRSH_COMMON_OPT_FILE(N_("XML file")),
151
    VIRSH_COMMON_OPT_DOMAIN_PERSISTENT,
152
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
153
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
154
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
155
    {.name = NULL}
156 157 158 159 160 161 162 163
};

static bool
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *from = NULL;
    char *buffer;
164 165
    int rv;
    bool ret = false;
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool persistent = vshCommandOptBool(cmd, "persistent");

    VSH_EXCLUSIVE_OPTIONS_VAR(persistent, current);

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config || persistent)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
181

182
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
183 184
        return false;

185 186
    if (vshCommandOptStringReq(ctl, cmd, "file", &from) < 0)
        goto cleanup;
187

188 189 190 191
    if (persistent &&
        virDomainIsActive(dom) == 1)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

E
Eric Blake 已提交
192 193
    if (virFileReadAll(from, VSH_MAX_XML_FILE, &buffer) < 0) {
        vshReportError(ctl);
194
        goto cleanup;
195 196
    }

197
    if (flags || current)
198
        rv = virDomainAttachDeviceFlags(dom, buffer, flags);
199
    else
200
        rv = virDomainAttachDevice(dom, buffer);
201

202 203
    VIR_FREE(buffer);

204
    if (rv < 0) {
205
        vshError(ctl, _("Failed to attach device from %s"), from);
206
        goto cleanup;
207 208
    }

P
Pino Toscano 已提交
209
    vshPrintExtra(ctl, "%s", _("Device attached successfully\n"));
210 211
    ret = true;

212
 cleanup:
213
    virshDomainFree(dom);
214
    return ret;
215 216 217 218 219 220
}

/*
 * "attach-disk" command
 */
static const vshCmdInfo info_attach_disk[] = {
221 222 223 224 225 226 227
    {.name = "help",
     .data = N_("attach disk device")
    },
    {.name = "desc",
     .data = N_("Attach new disk device.")
    },
    {.name = NULL}
228 229 230
};

static const vshCmdOptDef opts_attach_disk[] = {
231
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
232 233 234 235 236 237 238 239 240 241
    {.name = "source",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ | VSH_OFLAG_EMPTY_OK,
     .help = N_("source of disk device")
    },
    {.name = "target",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("target of disk device")
    },
242 243 244 245
    {.name = "targetbus",
     .type = VSH_OT_STRING,
     .help = N_("target bus of disk device")
    },
246 247 248 249 250 251 252 253
    {.name = "driver",
     .type = VSH_OT_STRING,
     .help = N_("driver of disk device")
    },
    {.name = "subdriver",
     .type = VSH_OT_STRING,
     .help = N_("subdriver of disk device")
    },
254 255 256 257
    {.name = "iothread",
     .type = VSH_OT_STRING,
     .help = N_("IOThread to be used by supported device")
    },
258 259 260 261
    {.name = "cache",
     .type = VSH_OT_STRING,
     .help = N_("cache mode of disk device")
    },
262 263 264 265
    {.name = "io",
     .type = VSH_OT_STRING,
     .help = N_("io policy of disk device")
    },
266 267 268 269
    {.name = "type",
     .type = VSH_OT_STRING,
     .help = N_("target device type")
    },
270 271 272 273
    {.name = "shareable",
     .type = VSH_OT_ALIAS,
     .help = "mode=shareable"
    },
274 275 276 277 278 279 280 281 282 283 284 285
    {.name = "mode",
     .type = VSH_OT_STRING,
     .help = N_("mode of device reading and writing")
    },
    {.name = "sourcetype",
     .type = VSH_OT_STRING,
     .help = N_("type of source (block|file)")
    },
    {.name = "serial",
     .type = VSH_OT_STRING,
     .help = N_("serial of disk device")
    },
286 287 288 289
    {.name = "wwn",
     .type = VSH_OT_STRING,
     .help = N_("wwn of disk device")
    },
H
Han Han 已提交
290 291 292 293
    {.name = "alias",
     .type = VSH_OT_STRING,
     .help = N_("custom alias name of disk device")
    },
294 295 296 297 298 299 300 301 302 303 304 305
    {.name = "rawio",
     .type = VSH_OT_BOOL,
     .help = N_("needs rawio capability")
    },
    {.name = "address",
     .type = VSH_OT_STRING,
     .help = N_("address of disk device")
    },
    {.name = "multifunction",
     .type = VSH_OT_BOOL,
     .help = N_("use multifunction pci under specified address")
    },
306 307 308 309
    {.name = "print-xml",
     .type = VSH_OT_BOOL,
     .help = N_("print XML document rather than attach the disk")
    },
310
    VIRSH_COMMON_OPT_DOMAIN_PERSISTENT,
311
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
312
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
313
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
314
    {.name = NULL}
315 316 317 318 319 320 321
};

enum {
    DISK_ADDR_TYPE_INVALID,
    DISK_ADDR_TYPE_PCI,
    DISK_ADDR_TYPE_SCSI,
    DISK_ADDR_TYPE_IDE,
322
    DISK_ADDR_TYPE_CCW,
323
    DISK_ADDR_TYPE_USB,
324
    DISK_ADDR_TYPE_SATA,
325 326 327 328 329 330 331 332 333 334 335 336
};

struct PCIAddress {
    unsigned int domain;
    unsigned int bus;
    unsigned int slot;
    unsigned int function;
};

struct SCSIAddress {
    unsigned int controller;
    unsigned int bus;
337
    unsigned long long unit;
338 339 340 341 342 343 344 345
};

struct IDEAddress {
    unsigned int controller;
    unsigned int bus;
    unsigned int unit;
};

346 347 348 349 350 351
struct CCWAddress {
    unsigned int cssid;
    unsigned int ssid;
    unsigned int devno;
};

352 353 354 355 356
struct USBAddress {
    unsigned int bus;
    unsigned int port;
};

357 358 359 360 361 362
struct SATAAddress {
    unsigned int controller;
    unsigned int bus;
    unsigned long long unit;
};

363 364 365 366 367 368
struct DiskAddress {
    int type;
    union {
        struct PCIAddress pci;
        struct SCSIAddress scsi;
        struct IDEAddress ide;
369
        struct CCWAddress ccw;
370
        struct USBAddress usb;
371
        struct SATAAddress sata;
372 373 374 375 376 377 378 379 380 381 382 383 384 385
    } addr;
};

static int str2PCIAddress(const char *str, struct PCIAddress *pciAddr)
{
    char *domain, *bus, *slot, *function;

    if (!pciAddr)
        return -1;
    if (!str)
        return -1;

    domain = (char *)str;

J
Ján Tomko 已提交
386
    if (virStrToLong_uip(domain, &bus, 16, &pciAddr->domain) != 0)
387 388 389
        return -1;

    bus++;
J
Ján Tomko 已提交
390
    if (virStrToLong_uip(bus, &slot, 16, &pciAddr->bus) != 0)
391 392 393
        return -1;

    slot++;
J
Ján Tomko 已提交
394
    if (virStrToLong_uip(slot, &function, 16, &pciAddr->slot) != 0)
395 396 397
        return -1;

    function++;
J
Ján Tomko 已提交
398
    if (virStrToLong_uip(function, NULL, 16, &pciAddr->function) != 0)
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
        return -1;

    return 0;
}

static int str2SCSIAddress(const char *str, struct SCSIAddress *scsiAddr)
{
    char *controller, *bus, *unit;

    if (!scsiAddr)
        return -1;
    if (!str)
        return -1;

    controller = (char *)str;

415
    if (virStrToLong_uip(controller, &bus, 10, &scsiAddr->controller) != 0)
416 417 418
        return -1;

    bus++;
419
    if (virStrToLong_uip(bus, &unit, 10, &scsiAddr->bus) != 0)
420 421 422
        return -1;

    unit++;
423
    if (virStrToLong_ullp(unit, NULL, 10, &scsiAddr->unit) != 0)
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
        return -1;

    return 0;
}

static int str2IDEAddress(const char *str, struct IDEAddress *ideAddr)
{
    char *controller, *bus, *unit;

    if (!ideAddr)
        return -1;
    if (!str)
        return -1;

    controller = (char *)str;

J
Ján Tomko 已提交
440
    if (virStrToLong_uip(controller, &bus, 10, &ideAddr->controller) != 0)
441 442 443
        return -1;

    bus++;
J
Ján Tomko 已提交
444
    if (virStrToLong_uip(bus, &unit, 10, &ideAddr->bus) != 0)
445 446 447
        return -1;

    unit++;
J
Ján Tomko 已提交
448
    if (virStrToLong_uip(unit, NULL, 10, &ideAddr->unit) != 0)
449 450 451 452 453
        return -1;

    return 0;
}

454 455 456 457 458 459 460 461 462 463 464
static int str2CCWAddress(const char *str, struct CCWAddress *ccwAddr)
{
    char *cssid, *ssid, *devno;

    if (!ccwAddr)
        return -1;
    if (!str)
        return -1;

    cssid = (char *)str;

J
Ján Tomko 已提交
465
    if (virStrToLong_uip(cssid, &ssid, 16, &ccwAddr->cssid) != 0)
466 467 468
        return -1;

    ssid++;
J
Ján Tomko 已提交
469
    if (virStrToLong_uip(ssid, &devno, 16, &ccwAddr->ssid) != 0)
470 471 472
        return -1;

    devno++;
J
Ján Tomko 已提交
473
    if (virStrToLong_uip(devno, NULL, 16, &ccwAddr->devno) != 0)
474 475 476 477 478
        return -1;

    return 0;
}

479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
static int str2USBAddress(const char *str, struct USBAddress *usbAddr)
{
    char *bus, *port;

    if (!usbAddr)
        return -1;
    if (!str)
        return -1;

    bus = (char *)str;

    if (virStrToLong_uip(bus, &port, 10, &usbAddr->bus) != 0)
        return -1;

    port++;
    if (virStrToLong_uip(port, NULL, 10, &usbAddr->port) != 0)
        return -1;

    return 0;
}

500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
static int str2SATAAddress(const char *str, struct SATAAddress *sataAddr)
{
    char *controller, *bus, *unit;

    if (!sataAddr)
        return -1;
    if (!str)
        return -1;

    controller = (char *)str;

    if (virStrToLong_uip(controller, &bus, 10, &sataAddr->controller) != 0)
        return -1;

    bus++;
    if (virStrToLong_uip(bus, &unit, 10, &sataAddr->bus) != 0)
        return -1;

    unit++;
    if (virStrToLong_ullp(unit, NULL, 10, &sataAddr->unit) != 0)
        return -1;

    return 0;
}

525 526 527
/* pci address pci:0000.00.0x0a.0 (domain:bus:slot:function)
 * ide disk address: ide:00.00.0 (controller:bus:unit)
 * scsi disk address: scsi:00.00.0 (controller:bus:unit)
528
 * ccw disk address: ccw:0xfe.0.0000 (cssid:ssid:devno)
529
 * usb disk address: usb:00.00 (bus:port)
530
 * sata disk address: sata:00.00.0 (controller:bus:unit)
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
 */

static int str2DiskAddress(const char *str, struct DiskAddress *diskAddr)
{
    char *type, *addr;

    if (!diskAddr)
        return -1;
    if (!str)
        return -1;

    type = (char *)str;
    addr = strchr(type, ':');
    if (!addr)
        return -1;

    if (STREQLEN(type, "pci", addr - type)) {
        diskAddr->type = DISK_ADDR_TYPE_PCI;
        return str2PCIAddress(addr + 1, &diskAddr->addr.pci);
    } else if (STREQLEN(type, "scsi", addr - type)) {
        diskAddr->type = DISK_ADDR_TYPE_SCSI;
        return str2SCSIAddress(addr + 1, &diskAddr->addr.scsi);
    } else if (STREQLEN(type, "ide", addr - type)) {
        diskAddr->type = DISK_ADDR_TYPE_IDE;
        return str2IDEAddress(addr + 1, &diskAddr->addr.ide);
556 557 558
    } else if (STREQLEN(type, "ccw", addr - type)) {
        diskAddr->type = DISK_ADDR_TYPE_CCW;
        return str2CCWAddress(addr + 1, &diskAddr->addr.ccw);
559 560 561
    } else if (STREQLEN(type, "usb", addr - type)) {
        diskAddr->type = DISK_ADDR_TYPE_USB;
        return str2USBAddress(addr + 1, &diskAddr->addr.usb);
562 563 564
    } else if (STREQLEN(type, "sata", addr - type)) {
        diskAddr->type = DISK_ADDR_TYPE_SATA;
        return str2SATAAddress(addr + 1, &diskAddr->addr.sata);
565 566 567 568 569 570 571 572 573 574 575
    }

    return -1;
}

static bool
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    const char *source = NULL, *target = NULL, *driver = NULL,
                *subdriver = NULL, *type = NULL, *mode = NULL,
576 577
                *iothread = NULL, *cache = NULL, *io = NULL,
                *serial = NULL, *straddr = NULL, *wwn = NULL,
H
Han Han 已提交
578
                *targetbus = NULL, *alias = NULL;
579 580 581
    struct DiskAddress diskAddr;
    bool isFile = false, functionReturn = false;
    int ret;
582
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
583 584
    const char *stype = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
585
    char *xml = NULL;
586
    struct stat st;
587 588 589 590 591 592 593 594 595 596 597 598 599 600
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool persistent = vshCommandOptBool(cmd, "persistent");

    VSH_EXCLUSIVE_OPTIONS_VAR(persistent, current);

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config || persistent)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
601

602 603 604 605 606 607
    if (vshCommandOptStringReq(ctl, cmd, "source", &source) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "target", &target) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "driver", &driver) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "type", &type) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "mode", &mode) < 0 ||
608
        vshCommandOptStringReq(ctl, cmd, "iothread", &iothread) < 0 ||
609
        vshCommandOptStringReq(ctl, cmd, "cache", &cache) < 0 ||
610
        vshCommandOptStringReq(ctl, cmd, "io", &io) < 0 ||
611
        vshCommandOptStringReq(ctl, cmd, "serial", &serial) < 0 ||
612
        vshCommandOptStringReq(ctl, cmd, "wwn", &wwn) < 0 ||
613
        vshCommandOptStringReq(ctl, cmd, "address", &straddr) < 0 ||
614
        vshCommandOptStringReq(ctl, cmd, "targetbus", &targetbus) < 0 ||
H
Han Han 已提交
615
        vshCommandOptStringReq(ctl, cmd, "alias", &alias) < 0 ||
616
        vshCommandOptStringReq(ctl, cmd, "sourcetype", &stype) < 0)
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
        goto cleanup;

    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap"))) {
            isFile = true;
        } else {
            if (source && !stat(source, &st))
                isFile = S_ISREG(st.st_mode) ? true : false;
        }
    } else if (STREQ(stype, "file")) {
        isFile = true;
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
    }

    if (mode) {
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
            goto cleanup;
        }
    }

641 642 643
    if (wwn && !virValidateWWN(wwn))
        goto cleanup;

644 645
    /* Make XML of disk */
    virBufferAsprintf(&buf, "<disk type='%s'",
646
                      isFile ? "file" : "block");
647 648 649 650 651
    if (type)
        virBufferAsprintf(&buf, " device='%s'", type);
    if (vshCommandOptBool(cmd, "rawio"))
        virBufferAddLit(&buf, " rawio='yes'");
    virBufferAddLit(&buf, ">\n");
652
    virBufferAdjustIndent(&buf, 2);
653

654
    if (driver || subdriver || iothread || cache || io) {
655
        virBufferAddLit(&buf, "<driver");
656 657 658 659 660

        if (driver)
            virBufferAsprintf(&buf, " name='%s'", driver);
        if (subdriver)
            virBufferAsprintf(&buf, " type='%s'", subdriver);
661 662
        if (iothread)
            virBufferAsprintf(&buf, " iothread='%s'", iothread);
663 664
        if (cache)
            virBufferAsprintf(&buf, " cache='%s'", cache);
665 666
        if (io)
            virBufferAsprintf(&buf, " io='%s'", io);
667 668 669 670 671

        virBufferAddLit(&buf, "/>\n");
    }

    if (source)
672 673
        virBufferAsprintf(&buf, "<source %s='%s'/>\n",
                          isFile ? "file" : "dev", source);
674 675 676 677 678
    virBufferAsprintf(&buf, "<target dev='%s'", target);
    if (targetbus)
        virBufferAsprintf(&buf, " bus='%s'", targetbus);
    virBufferAddLit(&buf, "/>\n");

679
    if (mode)
680
        virBufferAsprintf(&buf, "<%s/>\n", mode);
681 682

    if (serial)
683
        virBufferAsprintf(&buf, "<serial>%s</serial>\n", serial);
684

H
Han Han 已提交
685
    if (alias)
686
        virBufferAsprintf(&buf, "<alias name='%s'/>\n", alias);
H
Han Han 已提交
687

688
    if (wwn)
689
        virBufferAsprintf(&buf, "<wwn>%s</wwn>\n", wwn);
690

691 692 693 694 695 696 697 698 699
    if (straddr) {
        if (str2DiskAddress(straddr, &diskAddr) != 0) {
            vshError(ctl, _("Invalid address."));
            goto cleanup;
        }

        if (STRPREFIX((const char *)target, "vd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_PCI) {
                virBufferAsprintf(&buf,
700
                                  "<address type='pci' domain='0x%04x'"
701 702 703 704 705 706
                                  " bus ='0x%02x' slot='0x%02x' function='0x%0x'",
                                  diskAddr.addr.pci.domain, diskAddr.addr.pci.bus,
                                  diskAddr.addr.pci.slot, diskAddr.addr.pci.function);
                if (vshCommandOptBool(cmd, "multifunction"))
                    virBufferAddLit(&buf, " multifunction='on'");
                virBufferAddLit(&buf, "/>\n");
707 708 709 710 711 712
            } else if (diskAddr.type == DISK_ADDR_TYPE_CCW) {
                virBufferAsprintf(&buf,
                                  "<address type='ccw' cssid='0x%02x'"
                                  " ssid='0x%01x' devno='0x%04x' />\n",
                                  diskAddr.addr.ccw.cssid, diskAddr.addr.ccw.ssid,
                                  diskAddr.addr.ccw.devno);
713
            } else {
714 715
                vshError(ctl, "%s",
                         _("expecting a pci:0000.00.00.00 or ccw:00.0.0000 address."));
716 717 718 719 720
                goto cleanup;
            }
        } else if (STRPREFIX((const char *)target, "sd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_SCSI) {
                virBufferAsprintf(&buf,
721
                                  "<address type='drive' controller='%u'"
722
                                  " bus='%u' unit='%llu' />\n",
723 724
                                  diskAddr.addr.scsi.controller, diskAddr.addr.scsi.bus,
                                  diskAddr.addr.scsi.unit);
725 726 727 728
            } else if (diskAddr.type == DISK_ADDR_TYPE_USB) {
                virBufferAsprintf(&buf,
                                  "<address type='usb' bus='%u' port='%u' />\n",
                                  diskAddr.addr.usb.bus, diskAddr.addr.usb.port);
729 730 731 732 733 734
            } else if (diskAddr.type == DISK_ADDR_TYPE_SATA) {
                virBufferAsprintf(&buf,
                                  "<address type='drive' controller='%u'"
                                  " bus='%u' unit='%llu' />\n",
                                  diskAddr.addr.sata.controller, diskAddr.addr.sata.bus,
                                  diskAddr.addr.sata.unit);
735
            } else {
736 737
                vshError(ctl, "%s",
                _("expecting a scsi:00.00.00 or usb:00.00 or sata:00.00.00 address."));
738 739 740 741 742
                goto cleanup;
            }
        } else if (STRPREFIX((const char *)target, "hd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_IDE) {
                virBufferAsprintf(&buf,
743 744
                                  "<address type='drive' controller='%u'"
                                  " bus='%u' unit='%u' />\n",
745 746 747 748 749 750 751 752 753
                                  diskAddr.addr.ide.controller, diskAddr.addr.ide.bus,
                                  diskAddr.addr.ide.unit);
            } else {
                vshError(ctl, "%s", _("expecting an ide:00.00.00 address."));
                goto cleanup;
            }
        }
    }

754
    virBufferAdjustIndent(&buf, -2);
755 756 757 758
    virBufferAddLit(&buf, "</disk>\n");

    xml = virBufferContentAndReset(&buf);

759 760 761 762 763 764
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s", xml);
        functionReturn = true;
        goto cleanup;
    }

765
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
766 767 768 769 770 771
        goto cleanup;

    if (persistent &&
        virDomainIsActive(dom) == 1)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

772
    if (flags || current)
773
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
774
    else
775 776 777 778 779
        ret = virDomainAttachDevice(dom, xml);

    if (ret != 0) {
        vshError(ctl, "%s", _("Failed to attach disk"));
    } else {
P
Pino Toscano 已提交
780
        vshPrintExtra(ctl, "%s", _("Disk attached successfully\n"));
781 782 783 784
        functionReturn = true;
    }

 cleanup:
785
    VIR_FREE(xml);
786
    virshDomainFree(dom);
787 788 789 790 791 792 793 794
    virBufferFreeAndReset(&buf);
    return functionReturn;
}

/*
 * "attach-interface" command
 */
static const vshCmdInfo info_attach_interface[] = {
795 796 797 798 799 800 801
    {.name = "help",
     .data = N_("attach network interface")
    },
    {.name = "desc",
     .data = N_("Attach new network interface.")
    },
    {.name = NULL}
802 803 804
};

static const vshCmdOptDef opts_attach_interface[] = {
805
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
806 807 808 809 810 811 812 813 814 815 816
    {.name = "type",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("network interface type")
    },
    {.name = "source",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("source of network interface")
    },
    {.name = "target",
817
     .type = VSH_OT_STRING,
818 819 820
     .help = N_("target network name")
    },
    {.name = "mac",
821
     .type = VSH_OT_STRING,
822 823 824
     .help = N_("MAC address")
    },
    {.name = "script",
825
     .type = VSH_OT_STRING,
826 827 828
     .help = N_("script used to bridge network interface")
    },
    {.name = "model",
829
     .type = VSH_OT_STRING,
830 831
     .help = N_("model type")
    },
832 833 834 835
    {.name = "alias",
     .type = VSH_OT_STRING,
     .help = N_("custom alias name of interface device")
    },
836
    {.name = "inbound",
837
     .type = VSH_OT_STRING,
838 839 840
     .help = N_("control domain's incoming traffics")
    },
    {.name = "outbound",
841
     .type = VSH_OT_STRING,
842 843
     .help = N_("control domain's outgoing traffics")
    },
844
    VIRSH_COMMON_OPT_DOMAIN_PERSISTENT,
845
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
846
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
847
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
848 849 850 851
    {.name = "print-xml",
     .type = VSH_OT_BOOL,
     .help = N_("print XML document rather than attach the interface")
    },
852 853 854 855
    {.name = "managed",
     .type = VSH_OT_BOOL,
     .help = N_("libvirt will automatically detach/attach the device from/to host")
    },
856
    {.name = NULL}
857 858 859
};

/* parse inbound and outbound which are in the format of
860
 * 'average,peak,burst,floor', in which peak and burst are optional,
861
 * thus 'average,,burst' and 'average,peak' are also legal. */
862

863 864 865 866 867 868 869 870
#define VIRSH_PARSE_RATE_FIELD(index, name) \
    do { \
        if (index < ntok && \
            *tok[index] != '\0' && \
            virStrToLong_ullp(tok[index], NULL, 10, &rate->name) < 0) { \
            vshError(ctl, _("field '%s' is malformed"), #name); \
            goto cleanup; \
        } \
871 872 873
    } while (0)

static int
874 875 876
virshParseRateStr(vshControl *ctl,
                  const char *rateStr,
                  virNetDevBandwidthRatePtr rate)
877
{
878 879
    char **tok = NULL;
    size_t ntok;
M
Michal Privoznik 已提交
880
    int ret = -1;
881

882
    if (!(tok = virStringSplitCount(rateStr, ",", 0, &ntok)))
883 884
        return -1;

885 886 887
    if (ntok > 4) {
        vshError(ctl, _("Rate string '%s' has too many fields"), rateStr);
        goto cleanup;
888 889
    }

890 891 892 893
    VIRSH_PARSE_RATE_FIELD(0, average);
    VIRSH_PARSE_RATE_FIELD(1, peak);
    VIRSH_PARSE_RATE_FIELD(2, burst);
    VIRSH_PARSE_RATE_FIELD(3, floor);
894

M
Michal Privoznik 已提交
895 896
    ret = 0;
 cleanup:
897
    virStringListFree(tok);
M
Michal Privoznik 已提交
898
    return ret;
899 900
}

901
#undef VIRSH_PARSE_RATE_FIELD
902

903 904 905 906 907
static bool
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    const char *mac = NULL, *target = NULL, *script = NULL,
908
               *type = NULL, *source = NULL, *model = NULL,
909
               *inboundStr = NULL, *outboundStr = NULL, *alias = NULL;
910
    virNetDevBandwidthRate inbound, outbound;
911
    virDomainNetType typ;
912 913 914
    int ret;
    bool functionReturn = false;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
915
    char *xml = NULL;
916 917 918 919 920
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool persistent = vshCommandOptBool(cmd, "persistent");
921
    bool managed = vshCommandOptBool(cmd, "managed");
922 923 924 925 926 927 928 929 930 931

    VSH_EXCLUSIVE_OPTIONS_VAR(persistent, current);

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config || persistent)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
932

933 934 935 936 937 938
    if (vshCommandOptStringReq(ctl, cmd, "type", &type) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "source", &source) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "target", &target) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "mac", &mac) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "script", &script) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "model", &model) < 0 ||
939
        vshCommandOptStringReq(ctl, cmd, "alias", &alias) < 0 ||
940 941
        vshCommandOptStringReq(ctl, cmd, "inbound", &inboundStr) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "outbound", &outboundStr) < 0)
942 943 944
        goto cleanup;

    /* check interface type */
945
    if ((int)(typ = virDomainNetTypeFromString(type)) < 0) {
946 947 948 949 950 951 952
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
        goto cleanup;
    }

    if (inboundStr) {
        memset(&inbound, 0, sizeof(inbound));
953
        if (virshParseRateStr(ctl, inboundStr, &inbound) < 0)
954
            goto cleanup;
955 956
        if (!inbound.average && !inbound.floor) {
            vshError(ctl, _("either inbound average or floor is mandatory"));
957 958 959 960 961
            goto cleanup;
        }
    }
    if (outboundStr) {
        memset(&outbound, 0, sizeof(outbound));
962
        if (virshParseRateStr(ctl, outboundStr, &outbound) < 0)
963 964 965 966 967
            goto cleanup;
        if (outbound.average == 0) {
            vshError(ctl, _("outbound average is mandatory"));
            goto cleanup;
        }
968 969 970 971
        if (outbound.floor) {
            vshError(ctl, _("outbound floor is unsupported yet"));
            goto cleanup;
        }
972 973 974
    }

    /* Make XML of interface */
975 976 977 978 979 980
    virBufferAsprintf(&buf, "<interface type='%s'", type);

    if (managed)
        virBufferAddLit(&buf, " managed='yes'>\n");
    else
        virBufferAddLit(&buf, ">\n");
981
    virBufferAdjustIndent(&buf, 2);
982

983 984 985 986 987 988
    switch (typ) {
    case VIR_DOMAIN_NET_TYPE_NETWORK:
    case VIR_DOMAIN_NET_TYPE_BRIDGE:
        virBufferAsprintf(&buf, "<source %s='%s'/>\n",
                          virDomainNetTypeToString(typ), source);
        break;
989 990 991
    case VIR_DOMAIN_NET_TYPE_DIRECT:
        virBufferAsprintf(&buf, "<source dev='%s'/>\n", source);
        break;
992 993 994 995 996 997 998 999 1000 1001 1002 1003
    case VIR_DOMAIN_NET_TYPE_HOSTDEV:
    {
        struct PCIAddress pciAddr = {0, 0, 0, 0};

        if (str2PCIAddress(source, &pciAddr) < 0) {
            vshError(ctl, _("cannot parse pci address '%s' for network "
                            "interface"), source);
            goto cleanup;
        }

        virBufferAddLit(&buf, "<source>\n");
        virBufferAdjustIndent(&buf, 2);
1004 1005
        virBufferAsprintf(&buf, "<address type='pci' domain='0x%04x'"
                          " bus='0x%02x' slot='0x%02x' function='0x%d'/>\n",
1006 1007 1008 1009 1010 1011
                          pciAddr.domain, pciAddr.bus,
                          pciAddr.slot, pciAddr.function);
        virBufferAdjustIndent(&buf, -2);
        virBufferAddLit(&buf, "</source>\n");
        break;
    }
1012 1013 1014 1015 1016 1017 1018

    case VIR_DOMAIN_NET_TYPE_USER:
    case VIR_DOMAIN_NET_TYPE_ETHERNET:
    case VIR_DOMAIN_NET_TYPE_VHOSTUSER:
    case VIR_DOMAIN_NET_TYPE_SERVER:
    case VIR_DOMAIN_NET_TYPE_CLIENT:
    case VIR_DOMAIN_NET_TYPE_MCAST:
1019
    case VIR_DOMAIN_NET_TYPE_UDP:
1020 1021 1022 1023 1024 1025 1026
    case VIR_DOMAIN_NET_TYPE_INTERNAL:
    case VIR_DOMAIN_NET_TYPE_LAST:
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
        goto cleanup;
        break;
    }
1027 1028

    if (target != NULL)
1029
        virBufferAsprintf(&buf, "<target dev='%s'/>\n", target);
1030
    if (mac != NULL)
1031
        virBufferAsprintf(&buf, "<mac address='%s'/>\n", mac);
1032
    if (script != NULL)
1033
        virBufferAsprintf(&buf, "<script path='%s'/>\n", script);
1034
    if (model != NULL)
1035
        virBufferAsprintf(&buf, "<model type='%s'/>\n", model);
1036

1037 1038 1039
    if (alias != NULL)
        virBufferAsprintf(&buf, "<alias name='%s'/>\n", alias);

1040
    if (inboundStr || outboundStr) {
1041 1042
        virBufferAddLit(&buf, "<bandwidth>\n");
        virBufferAdjustIndent(&buf, 2);
1043 1044 1045 1046
        if (inboundStr && (inbound.average || inbound.floor)) {
            virBufferAddLit(&buf, "<inbound");
            if (inbound.average > 0)
                virBufferAsprintf(&buf, " average='%llu'", inbound.average);
1047 1048 1049 1050
            if (inbound.peak > 0)
                virBufferAsprintf(&buf, " peak='%llu'", inbound.peak);
            if (inbound.burst > 0)
                virBufferAsprintf(&buf, " burst='%llu'", inbound.burst);
1051 1052
            if (inbound.floor > 0)
                virBufferAsprintf(&buf, " floor='%llu'", inbound.floor);
1053
            virBufferAddLit(&buf, "/>\n");
1054 1055
        }
        if (outboundStr && outbound.average > 0) {
1056
            virBufferAsprintf(&buf, "<outbound average='%llu'", outbound.average);
1057 1058 1059 1060
            if (outbound.peak > 0)
                virBufferAsprintf(&buf, " peak='%llu'", outbound.peak);
            if (outbound.burst > 0)
                virBufferAsprintf(&buf, " burst='%llu'", outbound.burst);
1061
            virBufferAddLit(&buf, "/>\n");
1062
        }
1063 1064
        virBufferAdjustIndent(&buf, -2);
        virBufferAddLit(&buf, "</bandwidth>\n");
1065 1066
    }

1067
    virBufferAdjustIndent(&buf, -2);
1068 1069 1070 1071
    virBufferAddLit(&buf, "</interface>\n");

    xml = virBufferContentAndReset(&buf);

1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s", xml);
        functionReturn = true;
        goto cleanup;
    }

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        goto cleanup;

    if (persistent &&
        virDomainIsActive(dom) == 1)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

1085
    if (flags || current)
1086
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
1087
    else
1088 1089 1090 1091 1092
        ret = virDomainAttachDevice(dom, xml);

    if (ret != 0) {
        vshError(ctl, "%s", _("Failed to attach interface"));
    } else {
P
Pino Toscano 已提交
1093
        vshPrintExtra(ctl, "%s", _("Interface attached successfully\n"));
1094 1095 1096
        functionReturn = true;
    }

1097
 cleanup:
1098
    VIR_FREE(xml);
1099
    virshDomainFree(dom);
1100 1101 1102 1103 1104 1105 1106 1107
    virBufferFreeAndReset(&buf);
    return functionReturn;
}

/*
 * "autostart" command
 */
static const vshCmdInfo info_autostart[] = {
1108 1109 1110 1111 1112 1113 1114
    {.name = "help",
     .data = N_("autostart a domain")
    },
    {.name = "desc",
     .data = N_("Configure a domain to be automatically started at boot.")
    },
    {.name = NULL}
1115 1116 1117
};

static const vshCmdOptDef opts_autostart[] = {
1118
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_PERSISTENT),
1119 1120 1121 1122 1123
    {.name = "disable",
     .type = VSH_OT_BOOL,
     .help = N_("disable autostarting")
    },
    {.name = NULL}
1124 1125 1126 1127 1128 1129 1130 1131 1132
};

static bool
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name;
    int autostart;

1133
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
1134 1135 1136 1137 1138 1139 1140 1141 1142
        return false;

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
        if (autostart)
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
        else
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
1143
        virshDomainFree(dom);
1144 1145 1146 1147
        return false;
    }

    if (autostart)
P
Pino Toscano 已提交
1148
        vshPrintExtra(ctl, _("Domain %s marked as autostarted\n"), name);
1149
    else
P
Pino Toscano 已提交
1150
        vshPrintExtra(ctl, _("Domain %s unmarked as autostarted\n"), name);
1151

1152
    virshDomainFree(dom);
1153 1154 1155 1156 1157 1158 1159
    return true;
}

/*
 * "blkdeviotune" command
 */
static const vshCmdInfo info_blkdeviotune[] = {
1160 1161 1162 1163 1164 1165 1166
    {.name = "help",
     .data = N_("Set or query a block device I/O tuning parameters.")
    },
    {.name = "desc",
     .data = N_("Set or query disk I/O parameters such as block throttling.")
    },
    {.name = NULL}
1167 1168 1169
};

static const vshCmdOptDef opts_blkdeviotune[] = {
1170
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
1171 1172 1173
    {.name = "device",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
1174
     .completer = virshDomainDiskTargetCompleter,
1175 1176 1177 1178 1179 1180 1181 1182
     .help = N_("block device")
    },
    {.name = "total_bytes_sec",
     .type = VSH_OT_ALIAS,
     .help = "total-bytes-sec"
    },
    {.name = "total-bytes-sec",
     .type = VSH_OT_INT,
1183
     .help = N_("total throughput limit, as scaled integer (default bytes)")
1184 1185 1186 1187 1188 1189 1190
    },
    {.name = "read_bytes_sec",
     .type = VSH_OT_ALIAS,
     .help = "read-bytes-sec"
    },
    {.name = "read-bytes-sec",
     .type = VSH_OT_INT,
1191
     .help = N_("read throughput limit, as scaled integer (default bytes)")
1192 1193 1194 1195 1196 1197 1198
    },
    {.name = "write_bytes_sec",
     .type = VSH_OT_ALIAS,
     .help = "write-bytes-sec"
    },
    {.name = "write-bytes-sec",
     .type = VSH_OT_INT,
1199
     .help =  N_("write throughput limit, as scaled integer (default bytes)")
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
    },
    {.name = "total_iops_sec",
     .type = VSH_OT_ALIAS,
     .help = "total-iops-sec"
    },
    {.name = "total-iops-sec",
     .type = VSH_OT_INT,
     .help = N_("total I/O operations limit per second")
    },
    {.name = "read_iops_sec",
     .type = VSH_OT_ALIAS,
     .help = "read-iops-sec"
    },
    {.name = "read-iops-sec",
     .type = VSH_OT_INT,
     .help = N_("read I/O operations limit per second")
    },
    {.name = "write_iops_sec",
     .type = VSH_OT_ALIAS,
     .help = "write-iops-sec"
    },
    {.name = "write-iops-sec",
     .type = VSH_OT_INT,
     .help = N_("write I/O operations limit per second")
    },
1225 1226 1227 1228 1229 1230
    {.name = "total_bytes_sec_max",
     .type = VSH_OT_ALIAS,
     .help = "total-bytes-sec-max"
    },
    {.name = "total-bytes-sec-max",
     .type = VSH_OT_INT,
1231
     .help = N_("total max, as scaled integer (default bytes)")
1232 1233 1234 1235 1236 1237 1238
    },
    {.name = "read_bytes_sec_max",
     .type = VSH_OT_ALIAS,
     .help = "read-bytes-sec-max"
    },
    {.name = "read-bytes-sec-max",
     .type = VSH_OT_INT,
1239
     .help = N_("read max, as scaled integer (default bytes)")
1240 1241 1242 1243 1244 1245 1246
    },
    {.name = "write_bytes_sec_max",
     .type = VSH_OT_ALIAS,
     .help = "write-bytes-sec-max"
    },
    {.name = "write-bytes-sec-max",
     .type = VSH_OT_INT,
1247
     .help = N_("write max, as scaled integer (default bytes)")
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
    },
    {.name = "total_iops_sec_max",
     .type = VSH_OT_ALIAS,
     .help = "total-iops-sec-max"
    },
    {.name = "total-iops-sec-max",
     .type = VSH_OT_INT,
     .help = N_("total I/O operations max")
    },
    {.name = "read_iops_sec_max",
     .type = VSH_OT_ALIAS,
     .help = "read-iops-sec-max"
    },
    {.name = "read-iops-sec-max",
     .type = VSH_OT_INT,
     .help = N_("read I/O operations max")
    },
    {.name = "write_iops_sec_max",
     .type = VSH_OT_ALIAS,
     .help = "write-iops-sec-max"
    },
    {.name = "write-iops-sec-max",
     .type = VSH_OT_INT,
     .help = N_("write I/O operations max")
    },
    {.name = "size_iops_sec",
     .type = VSH_OT_ALIAS,
     .help = "size-iops-sec"
    },
    {.name = "size-iops-sec",
     .type = VSH_OT_INT,
     .help = N_("I/O size in bytes")
    },
1281
    {.name = "group_name",
1282 1283 1284 1285
     .type = VSH_OT_ALIAS,
     .help = "group-name"
    },
    {.name = "group-name",
1286 1287 1288
     .type = VSH_OT_STRING,
     .help = N_("group name to share I/O quota between multiple drives")
    },
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
    {.name = "total_bytes_sec_max_length",
     .type = VSH_OT_ALIAS,
     .help = "total-bytes-sec-max-length"
    },
    {.name = "total-bytes-sec-max-length",
     .type = VSH_OT_INT,
     .help = N_("duration in seconds to allow total max bytes")
    },
    {.name = "read_bytes_sec_max_length",
     .type = VSH_OT_ALIAS,
     .help = "read-bytes-sec-max-length"
    },
    {.name = "read-bytes-sec-max-length",
     .type = VSH_OT_INT,
     .help = N_("duration in seconds to allow read max bytes")
    },
    {.name = "write_bytes_sec_max_length",
     .type = VSH_OT_ALIAS,
     .help = "write-bytes-sec-max-length"
    },
    {.name = "write-bytes-sec-max-length",
     .type = VSH_OT_INT,
     .help = N_("duration in seconds to allow write max bytes")
    },
    {.name = "total_iops_sec_max_length",
     .type = VSH_OT_ALIAS,
     .help = "total-iops-sec-max-length"
    },
    {.name = "total-iops-sec-max-length",
     .type = VSH_OT_INT,
     .help = N_("duration in seconds to allow total I/O operations max")
    },
    {.name = "read_iops_sec_max_length",
     .type = VSH_OT_ALIAS,
     .help = "read-iops-sec-max-length"
    },
    {.name = "read-iops-sec-max-length",
     .type = VSH_OT_INT,
     .help = N_("duration in seconds to allow read I/O operations max")
    },
    {.name = "write_iops_sec_max_length",
     .type = VSH_OT_ALIAS,
     .help = "write-iops-sec-max-length"
    },
    {.name = "write-iops-sec-max-length",
     .type = VSH_OT_INT,
     .help = N_("duration in seconds to allow write I/O operations max")
    },
1337
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
1338
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
1339
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
1340
    {.name = NULL}
1341 1342 1343 1344 1345 1346 1347
};

static bool
cmdBlkdeviotune(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    const char *name, *disk;
1348
    const char *group_name = NULL;
1349
    unsigned long long value;
1350
    int nparams = 0;
1351
    int maxparams = 0;
1352
    virTypedParameterPtr params = NULL;
1353
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
1354
    size_t i;
1355 1356 1357 1358 1359 1360
    int rv = 0;
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool ret = false;

1361 1362 1363 1364 1365 1366 1367
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
1368

1369
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
1370 1371
        goto cleanup;

1372
    if (vshCommandOptStringReq(ctl, cmd, "device", &disk) < 0)
1373 1374
        goto cleanup;

1375 1376 1377 1378 1379 1380 1381 1382 1383
#define VSH_ADD_IOTUNE_SCALED(PARAM, CONST) \
    if ((rv = vshCommandOptScaledInt(ctl, cmd, #PARAM, &value, \
                                     1, ULLONG_MAX)) < 0) { \
        goto interror; \
    } else if (rv > 0) { \
        if (virTypedParamsAddULLong(&params, &nparams, &maxparams, \
                                    VIR_DOMAIN_BLOCK_IOTUNE_##CONST, \
                                    value) < 0) \
            goto save_error; \
1384
    }
1385 1386 1387 1388 1389 1390 1391 1392 1393

    VSH_ADD_IOTUNE_SCALED(total-bytes-sec, TOTAL_BYTES_SEC);
    VSH_ADD_IOTUNE_SCALED(read-bytes-sec, READ_BYTES_SEC);
    VSH_ADD_IOTUNE_SCALED(write-bytes-sec, WRITE_BYTES_SEC);
    VSH_ADD_IOTUNE_SCALED(total-bytes-sec-max, TOTAL_BYTES_SEC_MAX);
    VSH_ADD_IOTUNE_SCALED(read-bytes-sec-max, READ_BYTES_SEC_MAX);
    VSH_ADD_IOTUNE_SCALED(write-bytes-sec-max, WRITE_BYTES_SEC_MAX);
#undef VSH_ADD_IOTUNE_SCALED

1394 1395 1396 1397 1398 1399 1400 1401
#define VSH_ADD_IOTUNE(PARAM, CONST) \
    if ((rv = vshCommandOptULongLong(ctl, cmd, #PARAM, &value)) < 0) { \
        goto interror; \
    } else if (rv > 0) { \
        if (virTypedParamsAddULLong(&params, &nparams, &maxparams, \
                                    VIR_DOMAIN_BLOCK_IOTUNE_##CONST, \
                                    value) < 0) \
            goto save_error; \
1402
    }
1403 1404 1405 1406 1407 1408 1409 1410

    VSH_ADD_IOTUNE(total-iops-sec, TOTAL_IOPS_SEC);
    VSH_ADD_IOTUNE(read-iops-sec, READ_IOPS_SEC);
    VSH_ADD_IOTUNE(write-iops-sec, WRITE_IOPS_SEC);
    VSH_ADD_IOTUNE(total-iops-sec-max, TOTAL_IOPS_SEC_MAX);
    VSH_ADD_IOTUNE(read-iops-sec-max, READ_IOPS_SEC_MAX);
    VSH_ADD_IOTUNE(write-iops-sec-max, WRITE_IOPS_SEC_MAX);
    VSH_ADD_IOTUNE(size-iops-sec, SIZE_IOPS_SEC);
1411 1412 1413 1414 1415 1416 1417

    VSH_ADD_IOTUNE(total-bytes-sec-max-length, TOTAL_BYTES_SEC_MAX_LENGTH);
    VSH_ADD_IOTUNE(read-bytes-sec-max-length, READ_BYTES_SEC_MAX_LENGTH);
    VSH_ADD_IOTUNE(write-bytes-sec-max-length, WRITE_BYTES_SEC_MAX_LENGTH);
    VSH_ADD_IOTUNE(total-iops-sec-max-length, TOTAL_IOPS_SEC_MAX_LENGTH);
    VSH_ADD_IOTUNE(read-iops-sec-max-length, READ_IOPS_SEC_MAX_LENGTH);
    VSH_ADD_IOTUNE(write-iops-sec-max-length, WRITE_IOPS_SEC_MAX_LENGTH);
1418
#undef VSH_ADD_IOTUNE
1419

1420 1421
    if (vshCommandOptStringReq(ctl, cmd, "group-name", &group_name) < 0) {
        vshError(ctl, "%s", _("Unable to parse group-name parameter"));
1422
        goto cleanup;
1423 1424 1425
    }

    if (group_name) {
1426 1427 1428 1429 1430 1431 1432
        if (virTypedParamsAddString(&params, &nparams, &maxparams,
                                    VIR_DOMAIN_BLOCK_IOTUNE_GROUP_NAME,
                                    group_name) < 0)
            goto save_error;
    }


1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464
    if (nparams == 0) {
        if (virDomainGetBlockIoTune(dom, NULL, NULL, &nparams, flags) != 0) {
            vshError(ctl, "%s",
                     _("Unable to get number of block I/O throttle parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            ret = true;
            goto cleanup;
        }

        params = vshCalloc(ctl, nparams, sizeof(*params));

        if (virDomainGetBlockIoTune(dom, disk, params, &nparams, flags) != 0) {
            vshError(ctl, "%s",
                     _("Unable to get block I/O throttle parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            char *str = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
            VIR_FREE(str);
        }
    } else {
        if (virDomainSetBlockIoTune(dom, disk, params, nparams, flags) < 0)
            goto error;
    }

    ret = true;

1465
 cleanup:
1466
    virTypedParamsFree(params, nparams);
1467
    virshDomainFree(dom);
1468 1469
    return ret;

1470
 save_error:
1471
    vshSaveLibvirtError();
1472
 error:
1473 1474
    vshError(ctl, "%s", _("Unable to change block I/O throttle"));
    goto cleanup;
1475

1476
 interror:
1477 1478
    vshError(ctl, "%s", _("Unable to parse integer parameter"));
    goto cleanup;
1479 1480 1481 1482 1483 1484
}

/*
 * "blkiotune" command
 */
static const vshCmdInfo info_blkiotune[] = {
1485 1486 1487 1488 1489
    {.name = "help",
     .data = N_("Get or set blkio parameters")
    },
    {.name = "desc",
     .data = N_("Get or set the current blkio parameters for a guest"
1490 1491
                " domain.\n"
                "    To get the blkio parameters use following command: \n\n"
1492 1493 1494
                "    virsh # blkiotune <domain>")
    },
    {.name = NULL}
1495 1496 1497
};

static const vshCmdOptDef opts_blkiotune[] = {
1498
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
1499 1500
    {.name = "weight",
     .type = VSH_OT_INT,
1501
     .help = N_("IO Weight")
1502 1503 1504 1505 1506
    },
    {.name = "device-weights",
     .type = VSH_OT_STRING,
     .help = N_("per-device IO Weights, in the form of /path/to/device,weight,...")
    },
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
    {.name = "device-read-iops-sec",
     .type = VSH_OT_STRING,
     .help = N_("per-device read I/O limit per second, in the form of /path/to/device,read_iops_sec,...")
    },
    {.name = "device-write-iops-sec",
     .type = VSH_OT_STRING,
     .help = N_("per-device write I/O limit per second, in the form of /path/to/device,write_iops_sec,...")
    },
    {.name = "device-read-bytes-sec",
     .type = VSH_OT_STRING,
     .help = N_("per-device bytes read per second, in the form of /path/to/device,read_bytes_sec,...")
    },
    {.name = "device-write-bytes-sec",
     .type = VSH_OT_STRING,
     .help = N_("per-device bytes wrote per second, in the form of /path/to/device,write_bytes_sec,...")
    },
1523
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
1524
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
1525
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
1526
    {.name = NULL}
1527 1528 1529 1530 1531 1532 1533
};

static bool
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    const char *device_weight = NULL;
1534 1535 1536 1537
    const char *device_riops = NULL;
    const char *device_wiops = NULL;
    const char *device_rbps = NULL;
    const char *device_wbps = NULL;
1538 1539
    int weight = 0;
    int nparams = 0;
1540
    int maxparams = 0;
1541
    int rv = 0;
1542
    size_t i;
1543
    virTypedParameterPtr params = NULL;
1544
    bool ret = false;
1545
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
1546 1547 1548 1549
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");

1550 1551 1552 1553 1554 1555 1556
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
1557

1558
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
1559 1560
        return false;

1561
    if ((rv = vshCommandOptInt(ctl, cmd, "weight", &weight)) < 0) {
1562
        goto cleanup;
1563
    } else if (rv > 0) {
1564 1565 1566 1567
        if (weight <= 0) {
            vshError(ctl, _("Invalid value of %d for I/O weight"), weight);
            goto cleanup;
        }
1568 1569 1570
        if (virTypedParamsAddUInt(&params, &nparams, &maxparams,
                                  VIR_DOMAIN_BLKIO_WEIGHT, weight) < 0)
            goto save_error;
1571 1572
    }

1573
    rv = vshCommandOptStringQuiet(ctl, cmd, "device-weights", &device_weight);
1574
    if (rv < 0) {
1575
        vshError(ctl, "%s", _("Unable to parse string parameter"));
1576
        goto cleanup;
1577 1578 1579 1580 1581
    } else if (rv > 0) {
        if (virTypedParamsAddString(&params, &nparams, &maxparams,
                                    VIR_DOMAIN_BLKIO_DEVICE_WEIGHT,
                                    device_weight) < 0)
            goto save_error;
1582 1583
    }

1584
    rv = vshCommandOptStringQuiet(ctl, cmd, "device-read-iops-sec", &device_riops);
1585 1586 1587 1588 1589 1590 1591 1592 1593 1594
    if (rv < 0) {
        vshError(ctl, "%s", _("Unable to parse string parameter"));
        goto cleanup;
    } else if (rv > 0) {
        if (virTypedParamsAddString(&params, &nparams, &maxparams,
                                    VIR_DOMAIN_BLKIO_DEVICE_READ_IOPS,
                                    device_riops) < 0)
            goto save_error;
    }

1595
    rv = vshCommandOptStringQuiet(ctl, cmd, "device-write-iops-sec", &device_wiops);
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605
    if (rv < 0) {
        vshError(ctl, "%s", _("Unable to parse string parameter"));
        goto cleanup;
    } else if (rv > 0) {
        if (virTypedParamsAddString(&params, &nparams, &maxparams,
                                    VIR_DOMAIN_BLKIO_DEVICE_WRITE_IOPS,
                                    device_wiops) < 0)
            goto save_error;
    }

1606
    rv = vshCommandOptStringQuiet(ctl, cmd, "device-read-bytes-sec", &device_rbps);
1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
    if (rv < 0) {
        vshError(ctl, "%s", _("Unable to parse string parameter"));
        goto cleanup;
    } else if (rv > 0) {
        if (virTypedParamsAddString(&params, &nparams, &maxparams,
                                    VIR_DOMAIN_BLKIO_DEVICE_READ_BPS,
                                    device_rbps) < 0)
            goto save_error;
    }

1617
    rv = vshCommandOptStringQuiet(ctl, cmd, "device-write-bytes-sec", &device_wbps);
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627
    if (rv < 0) {
        vshError(ctl, "%s", _("Unable to parse string parameter"));
        goto cleanup;
    } else if (rv > 0) {
        if (virTypedParamsAddString(&params, &nparams, &maxparams,
                                   VIR_DOMAIN_BLKIO_DEVICE_WRITE_BPS,
                                   device_wbps) < 0)
            goto save_error;
    }

1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655
    if (nparams == 0) {
        /* get the number of blkio parameters */
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

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

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

        for (i = 0; i < nparams; i++) {
            char *str = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
            VIR_FREE(str);
        }
    } else {
        /* set the blkio parameters */
1656 1657
        if (virDomainSetBlkioParameters(dom, params, nparams, flags) < 0)
            goto error;
1658 1659 1660 1661
    }

    ret = true;

1662
 cleanup:
1663
    virTypedParamsFree(params, nparams);
1664
    virshDomainFree(dom);
1665
    return ret;
1666

1667
 save_error:
1668
    vshSaveLibvirtError();
1669
 error:
1670 1671
    vshError(ctl, "%s", _("Unable to change blkio parameters"));
    goto cleanup;
1672 1673 1674 1675
}


static void
1676 1677
virshPrintJobProgress(const char *label, unsigned long long remaining,
                      unsigned long long total)
1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698
{
    int progress;

    if (remaining == 0) {
        /* migration has completed */
        progress = 100;
    } else {
        /* use float to avoid overflow */
        progress = (int)(100.0 - remaining * 100.0 / total);
        if (progress >= 100) {
            /* migration has not completed, do not print [100 %] */
            progress = 99;
        }
    }

    /* see comments in vshError about why we must flush */
    fflush(stdout);
    fprintf(stderr, "\r%s: [%3d %%]", label, progress);
    fflush(stderr);
}

1699
static volatile sig_atomic_t intCaught;
E
Eric Blake 已提交
1700

J
Ján Tomko 已提交
1701 1702 1703
static void virshCatchInt(int sig G_GNUC_UNUSED,
                          siginfo_t *siginfo G_GNUC_UNUSED,
                          void *context G_GNUC_UNUSED)
E
Eric Blake 已提交
1704 1705 1706 1707
{
    intCaught = 1;
}

1708

1709 1710 1711
typedef struct _virshBlockJobWaitData virshBlockJobWaitData;
typedef virshBlockJobWaitData *virshBlockJobWaitDataPtr;
struct _virshBlockJobWaitData {
1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726
    vshControl *ctl;
    virDomainPtr dom;
    const char *dev;
    const char *job_name;

    bool verbose;
    unsigned int timeout;
    bool async_abort;

    int cb_id;
    int cb_id2;
    int status;
};


1727
static void
J
Ján Tomko 已提交
1728 1729
virshBlockJobStatusHandler(virConnectPtr conn G_GNUC_UNUSED,
                           virDomainPtr dom G_GNUC_UNUSED,
1730
                           const char *disk,
J
Ján Tomko 已提交
1731
                           int type G_GNUC_UNUSED,
1732 1733
                           int status,
                           void *opaque)
1734
{
1735
    virshBlockJobWaitDataPtr data = opaque;
1736 1737 1738 1739 1740 1741 1742

    if (STREQ_NULLABLE(disk, data->dev))
        data->status = status;
}


/**
1743
 * virshBlockJobWaitInit:
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753
 * @ctl: vsh control structure
 * @dom: domain object
 * @dev: block device name to wait for
 * @job_name: block job name to display in user-facing messages
 * @verbose: enable progress reporting
 * @timeout: number of milliseconds to wait before aborting the job
 * @async_abort: abort the job asynchronously
 *
 * Prepares virsh for waiting for completion of a block job. This function
 * registers event handlers for block job events and prepares the data structures
1754
 * for them. A call to virshBlockJobWait then waits for completion of the given
1755 1756 1757 1758 1759 1760
 * block job. This function should be tolerant to different versions of daemon
 * and the reporting capabilities of those.
 *
 * Returns the data structure that holds data needed for block job waiting or
 * NULL in case of error.
 */
1761 1762 1763 1764 1765 1766 1767 1768
static virshBlockJobWaitDataPtr
virshBlockJobWaitInit(vshControl *ctl,
                      virDomainPtr dom,
                      const char *dev,
                      const char *job_name,
                      bool verbose,
                      unsigned int timeout,
                      bool async_abort)
1769
{
1770 1771
    virshBlockJobWaitDataPtr ret;
    virshControlPtr priv = ctl->privData;
1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787

    if (VIR_ALLOC(ret) < 0)
        return NULL;

    ret->ctl = ctl;
    ret->dom = dom;
    ret->dev = dev;
    ret->job_name = job_name;

    ret->async_abort = async_abort;
    ret->timeout = timeout;
    ret->verbose = verbose;

    ret->status = -1;

    virConnectDomainEventGenericCallback cb =
1788
        VIR_DOMAIN_EVENT_CALLBACK(virshBlockJobStatusHandler);
1789

1790
    if ((ret->cb_id = virConnectDomainEventRegisterAny(priv->conn, dom,
1791 1792 1793 1794
                                                       VIR_DOMAIN_EVENT_ID_BLOCK_JOB,
                                                       cb, ret, NULL)) < 0)
        vshResetLibvirtError();

1795
    if ((ret->cb_id2 = virConnectDomainEventRegisterAny(priv->conn, dom,
1796 1797 1798 1799 1800 1801 1802 1803 1804
                                                        VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2,
                                                        cb, ret, NULL)) < 0)
        vshResetLibvirtError();

    return ret;
}


static void
1805
virshBlockJobWaitFree(virshBlockJobWaitDataPtr data)
1806
{
1807 1808
    virshControlPtr priv = NULL;

1809 1810 1811
    if (!data)
        return;

1812
    priv = data->ctl->privData;
1813
    if (data->cb_id >= 0)
1814
        virConnectDomainEventDeregisterAny(priv->conn, data->cb_id);
1815
    if (data->cb_id2 >= 0)
1816
        virConnectDomainEventDeregisterAny(priv->conn, data->cb_id2);
1817 1818 1819 1820 1821 1822

    VIR_FREE(data);
}


/**
1823 1824
 * virshBlockJobWait:
 * @data: private data initialized by virshBlockJobWaitInit
1825
 *
1826 1827 1828 1829
 * Waits for the block job to complete. This function prefers to wait for a
 * matching VIR_DOMAIN_EVENT_ID_BLOCK_JOB or VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2
 * event from libvirt; however, it has a fallback mode should either of these
 * events not be available.
1830
 *
1831 1832 1833 1834 1835 1836
 * This function returns values from the virConnectDomainEventBlockJobStatus
 * enum or -1 in case of an internal error.
 *
 * If the fallback mode is activated the returned event is
 * VIR_DOMAIN_BLOCK_JOB_COMPLETED if the block job vanishes or
 * VIR_DOMAIN_BLOCK_JOB_READY if the block job reaches 100%.
1837 1838
 */
static int
1839
virshBlockJobWait(virshBlockJobWaitDataPtr data)
1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855
{
    /* For two phase jobs like active commit or block copy, the marker reaches
     * 100% and an event fires. In case where virsh would not be able to match
     * the event to the given block job we will wait for the number of retries
     * before claiming that we entered synchronised phase */
    unsigned int retries = 5;

    struct sigaction sig_action;
    struct sigaction old_sig_action;
    sigset_t sigmask, oldsigmask;

    unsigned long long start = 0;
    unsigned long long curr = 0;

    unsigned int abort_flags = 0;
    int ret = -1;
1856
    virDomainBlockJobInfo info, last;
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868
    int result;

    if (!data)
        return 0;

    if (data->async_abort)
        abort_flags |= VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);

    intCaught = 0;
1869
    sig_action.sa_sigaction = virshCatchInt;
1870 1871 1872 1873 1874 1875
    sig_action.sa_flags = SA_SIGINFO;
    sigemptyset(&sig_action.sa_mask);
    sigaction(SIGINT, &sig_action, &old_sig_action);

    if (data->timeout && virTimeMillisNow(&start) < 0) {
        vshSaveLibvirtError();
1876
        goto cleanup;
1877 1878
    }

1879 1880
    last.cur = last.end = 0;

1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
    while (true) {
        pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
        result = virDomainGetBlockJobInfo(data->dom, data->dev, &info, 0);
        pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);

        if (result < 0) {
            vshError(data->ctl, _("failed to query job for disk %s"), data->dev);
            goto cleanup;
        }

1891 1892
        /* If either callback could be registered and we've got an event, we can
         * can end the waiting loop */
1893 1894
        if ((data->cb_id >= 0 || data->cb_id2 >= 0) && data->status != -1) {
            ret = data->status;
1895
            break;
1896 1897
        }

1898 1899 1900 1901 1902 1903 1904 1905
        /* Fallback behaviour is only needed if one or both callbacks could not
         * be registered */
        if (data->cb_id < 0 || data->cb_id2 < 0) {
            /* If the block job vanishes, synthesize a COMPLETED event */
            if (result == 0) {
                ret = VIR_DOMAIN_BLOCK_JOB_COMPLETED;
                break;
            }
1906

1907 1908 1909 1910 1911 1912 1913 1914
            /* If the block job hits 100%, wait a little while for a possible
             * event from libvirt unless both callbacks could not be registered
             * in order to synthesize our own READY event */
            if (info.end == info.cur &&
                ((data->cb_id < 0 && data->cb_id2 < 0) || --retries == 0)) {
                ret = VIR_DOMAIN_BLOCK_JOB_READY;
                break;
            }
1915 1916
        }

1917
        if (data->verbose && (info.cur != last.cur || info.end != last.end))
1918 1919
            virshPrintJobProgress(data->job_name, info.end - info.cur,
                                  info.end);
1920
        last = info;
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934

        if (data->timeout && virTimeMillisNow(&curr) < 0) {
            vshSaveLibvirtError();
            goto cleanup;
        }

        if (intCaught || (data->timeout && (curr - start > data->timeout))) {
            if (virDomainBlockJobAbort(data->dom, data->dev, abort_flags) < 0) {
                vshError(data->ctl, _("failed to abort job for disk '%s'"),
                         data->dev);
                goto cleanup;
            }

            ret = VIR_DOMAIN_BLOCK_JOB_CANCELED;
1935
            break;
1936 1937
        }

1938
        g_usleep(500 * 1000);
1939 1940 1941 1942 1943 1944
    }

    /* print 100% completed */
    if (data->verbose &&
        (ret == VIR_DOMAIN_BLOCK_JOB_COMPLETED ||
         ret == VIR_DOMAIN_BLOCK_JOB_READY))
1945
        virshPrintJobProgress(data->job_name, 0, 1);
1946

1947
 cleanup:
1948 1949
    sigaction(SIGINT, &old_sig_action, NULL);
    return ret;
1950 1951
}

1952

E
Eric Blake 已提交
1953 1954 1955
/*
 * "blockcommit" command
 */
1956
static const vshCmdInfo info_blockcommit[] = {
1957 1958 1959 1960 1961 1962 1963
    {.name = "help",
     .data = N_("Start a block commit operation.")
    },
    {.name = "desc",
     .data = N_("Commit changes from a snapshot down to its backing image.")
    },
    {.name = NULL}
E
Eric Blake 已提交
1964 1965
};

1966
static const vshCmdOptDef opts_blockcommit[] = {
1967
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
1968 1969 1970
    {.name = "path",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
1971
     .completer = virshDomainDiskTargetCompleter,
1972 1973 1974
     .help = N_("fully-qualified path of disk")
    },
    {.name = "bandwidth",
1975
     .type = VSH_OT_INT,
1976 1977 1978
     .help = N_("bandwidth limit in MiB/s")
    },
    {.name = "base",
1979
     .type = VSH_OT_STRING,
1980 1981 1982 1983 1984 1985 1986
     .help = N_("path of base file to commit into (default bottom of chain)")
    },
    {.name = "shallow",
     .type = VSH_OT_BOOL,
     .help = N_("use backing file of top as base")
    },
    {.name = "top",
1987
     .type = VSH_OT_STRING,
1988 1989
     .help = N_("path of top file to commit from (default top of chain)")
    },
1990 1991 1992 1993
    {.name = "active",
     .type = VSH_OT_BOOL,
     .help = N_("trigger two-stage active commit of top file")
    },
1994 1995 1996 1997 1998 1999
    {.name = "delete",
     .type = VSH_OT_BOOL,
     .help = N_("delete files that were successfully committed")
    },
    {.name = "wait",
     .type = VSH_OT_BOOL,
2000 2001
     .help = N_("wait for job to complete "
                "(with --active, wait for job to sync)")
2002 2003 2004 2005 2006 2007 2008
    },
    {.name = "verbose",
     .type = VSH_OT_BOOL,
     .help = N_("with --wait, display the progress")
    },
    {.name = "timeout",
     .type = VSH_OT_INT,
2009 2010 2011 2012 2013 2014 2015 2016 2017
     .help = N_("implies --wait, abort if copy exceeds timeout (in seconds)")
    },
    {.name = "pivot",
     .type = VSH_OT_BOOL,
     .help = N_("implies --active --wait, pivot when commit is synced")
    },
    {.name = "keep-overlay",
     .type = VSH_OT_BOOL,
     .help = N_("implies --active --wait, quit when commit is synced")
2018
    },
2019 2020 2021 2022
    {.name = "async",
     .type = VSH_OT_BOOL,
     .help = N_("with --wait, don't wait for cancel to finish")
    },
2023 2024 2025 2026
    {.name = "keep-relative",
     .type = VSH_OT_BOOL,
     .help = N_("keep the backing chain relatively referenced")
    },
2027 2028 2029 2030
    {.name = "bytes",
     .type = VSH_OT_BOOL,
     .help = N_("the bandwidth limit is in bytes/s rather than MiB/s")
    },
2031
    {.name = NULL}
E
Eric Blake 已提交
2032 2033 2034
};

static bool
2035
cmdBlockcommit(vshControl *ctl, const vshCmd *cmd)
E
Eric Blake 已提交
2036 2037 2038 2039
{
    virDomainPtr dom = NULL;
    bool ret = false;
    bool verbose = vshCommandOptBool(cmd, "verbose");
2040 2041 2042
    bool pivot = vshCommandOptBool(cmd, "pivot");
    bool finish = vshCommandOptBool(cmd, "keep-overlay");
    bool active = vshCommandOptBool(cmd, "active") || pivot || finish;
2043 2044
    bool blocking = vshCommandOptBool(cmd, "wait") || pivot || finish;
    bool async = vshCommandOptBool(cmd, "async");
2045
    bool bytes = vshCommandOptBool(cmd, "bytes");
E
Eric Blake 已提交
2046 2047
    int timeout = 0;
    const char *path = NULL;
2048 2049
    const char *base = NULL;
    const char *top = NULL;
E
Eric Blake 已提交
2050
    int abort_flags = 0;
2051 2052
    unsigned int flags = 0;
    unsigned long bandwidth = 0;
2053
    virshBlockJobWaitDataPtr bjWait = NULL;
2054

2055 2056
    VSH_EXCLUSIVE_OPTIONS("pivot", "keep-overlay");

2057 2058 2059 2060 2061 2062 2063 2064 2065
    if (vshCommandOptStringReq(ctl, cmd, "path", &path) < 0)
        return false;

    if (vshCommandOptStringReq(ctl, cmd, "base", &base) < 0)
        return false;

    if (vshCommandOptStringReq(ctl, cmd, "top", &top) < 0)
        return false;

2066
    if (vshBlockJobOptionBandwidth(ctl, cmd, bytes, &bandwidth) < 0)
2067 2068
        return false;

2069 2070 2071
    if (bytes)
        flags |= VIR_DOMAIN_BLOCK_COMMIT_BANDWIDTH_BYTES;

2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082
    if (vshCommandOptBool(cmd, "shallow"))
        flags |= VIR_DOMAIN_BLOCK_COMMIT_SHALLOW;

    if (vshCommandOptBool(cmd, "delete"))
        flags |= VIR_DOMAIN_BLOCK_COMMIT_DELETE;

    if (active)
        flags |= VIR_DOMAIN_BLOCK_COMMIT_ACTIVE;

   if (vshCommandOptBool(cmd, "keep-relative"))
        flags |= VIR_DOMAIN_BLOCK_COMMIT_RELATIVE;
E
Eric Blake 已提交
2083

2084 2085 2086 2087 2088 2089 2090 2091 2092 2093
    if (vshCommandOptTimeoutToMs(ctl, cmd, &timeout) < 0)
        return false;

    if (timeout)
        blocking = true;

    if (!blocking) {
        if (verbose) {
            vshError(ctl, "%s", _("--verbose requires at least one of --timeout, "
                                  "--wait, --pivot, or --keep-overlay"));
2094 2095
            return false;
        }
2096 2097 2098 2099

        if (async) {
            vshError(ctl, "%s", _("--async requires at least one of --timeout, "
                                  "--wait, --pivot, or --keep-overlay"));
2100
            return false;
2101 2102
        }
    }
E
Eric Blake 已提交
2103

2104 2105 2106
    if (async)
        abort_flags |= VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC;

2107
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
2108 2109
        return false;

2110
    if (blocking &&
2111 2112
        !(bjWait = virshBlockJobWaitInit(ctl, dom, path, _("Block commit"),
                                         verbose, timeout, async)))
2113
        goto cleanup;
2114

2115
    if (virDomainBlockCommit(dom, path, base, top, bandwidth, flags) < 0)
E
Eric Blake 已提交
2116 2117 2118
        goto cleanup;

    if (!blocking) {
2119
        if (active)
2120
            vshPrintExtra(ctl, "%s", _("Active Block Commit started"));
2121
        else
2122
            vshPrintExtra(ctl, "%s", _("Block Commit started"));
2123

E
Eric Blake 已提交
2124 2125 2126 2127
        ret = true;
        goto cleanup;
    }

2128
    /* Execution continues here only if --wait or friends were specified */
2129
    switch (virshBlockJobWait(bjWait)) {
2130 2131
        case -1:
            goto cleanup;
2132

2133
        case VIR_DOMAIN_BLOCK_JOB_CANCELED:
2134
            vshPrintExtra(ctl, "\n%s", _("Commit aborted"));
2135 2136
            goto cleanup;
            break;
E
Eric Blake 已提交
2137

2138
        case VIR_DOMAIN_BLOCK_JOB_FAILED:
2139
            vshError(ctl, "\n%s", _("Commit failed"));
E
Eric Blake 已提交
2140 2141 2142
            goto cleanup;
            break;

2143 2144
        case VIR_DOMAIN_BLOCK_JOB_READY:
        case VIR_DOMAIN_BLOCK_JOB_COMPLETED:
2145
            break;
2146
    }
E
Eric Blake 已提交
2147

2148 2149 2150
    if (active) {
        if (pivot) {
            abort_flags |= VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT;
E
Eric Blake 已提交
2151
            if (virDomainBlockJobAbort(dom, path, abort_flags) < 0) {
2152
                vshError(ctl, _("failed to pivot job for disk %s"), path);
E
Eric Blake 已提交
2153 2154 2155
                goto cleanup;
            }

2156
            vshPrintExtra(ctl, "\n%s", _("Successfully pivoted"));
2157 2158 2159 2160 2161
        } else if (finish) {
            if (virDomainBlockJobAbort(dom, path, abort_flags) < 0) {
                vshError(ctl, _("failed to finish job for disk %s"), path);
                goto cleanup;
            }
2162

2163 2164
            vshPrintExtra(ctl, "\n%s", _("Commit complete, overlay "
                                         "image kept"));
2165
        } else {
2166
            vshPrintExtra(ctl, "\n%s", _("Now in synchronized phase"));
2167
        }
2168
    } else {
2169
        vshPrintExtra(ctl, "\n%s", _("Commit complete"));
2170
    }
E
Eric Blake 已提交
2171 2172

    ret = true;
2173
 cleanup:
2174
    virshDomainFree(dom);
2175
    virshBlockJobWaitFree(bjWait);
E
Eric Blake 已提交
2176 2177 2178
    return ret;
}

2179 2180 2181
/*
 * "blockcopy" command
 */
2182
static const vshCmdInfo info_blockcopy[] = {
2183 2184 2185 2186
    {.name = "help",
     .data = N_("Start a block copy operation.")
    },
    {.name = "desc",
2187
     .data = N_("Copy a disk backing image chain to dest.")
2188 2189
    },
    {.name = NULL}
2190 2191
};

2192
static const vshCmdOptDef opts_blockcopy[] = {
2193
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
2194 2195 2196
    {.name = "path",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
2197
     .completer = virshDomainDiskTargetCompleter,
E
Eric Blake 已提交
2198
     .help = N_("fully-qualified path of source disk")
2199 2200
    },
    {.name = "dest",
2201
     .type = VSH_OT_STRING,
2202 2203 2204
     .help = N_("path of the copy to create")
    },
    {.name = "bandwidth",
2205
     .type = VSH_OT_INT,
2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216
     .help = N_("bandwidth limit in MiB/s")
    },
    {.name = "shallow",
     .type = VSH_OT_BOOL,
     .help = N_("make the copy share a backing chain")
    },
    {.name = "reuse-external",
     .type = VSH_OT_BOOL,
     .help = N_("reuse existing destination")
    },
    {.name = "raw",
E
Eric Blake 已提交
2217 2218
     .type = VSH_OT_ALIAS,
     .help = "format=raw"
2219
    },
2220 2221 2222 2223
    {.name = "blockdev",
     .type = VSH_OT_BOOL,
     .help = N_("copy destination is block device instead of regular file")
    },
2224 2225 2226 2227 2228 2229 2230 2231 2232 2233
    {.name = "wait",
     .type = VSH_OT_BOOL,
     .help = N_("wait for job to reach mirroring phase")
    },
    {.name = "verbose",
     .type = VSH_OT_BOOL,
     .help = N_("with --wait, display the progress")
    },
    {.name = "timeout",
     .type = VSH_OT_INT,
E
Eric Blake 已提交
2234
     .help = N_("implies --wait, abort if copy exceeds timeout (in seconds)")
2235 2236 2237
    },
    {.name = "pivot",
     .type = VSH_OT_BOOL,
E
Eric Blake 已提交
2238
     .help = N_("implies --wait, pivot when mirroring starts")
2239 2240 2241
    },
    {.name = "finish",
     .type = VSH_OT_BOOL,
E
Eric Blake 已提交
2242
     .help = N_("implies --wait, quit when mirroring starts")
2243 2244 2245 2246 2247
    },
    {.name = "async",
     .type = VSH_OT_BOOL,
     .help = N_("with --wait, don't wait for cancel to finish")
    },
E
Eric Blake 已提交
2248
    {.name = "xml",
2249
     .type = VSH_OT_STRING,
E
Eric Blake 已提交
2250 2251 2252
     .help = N_("filename containing XML description of the copy destination")
    },
    {.name = "format",
2253
     .type = VSH_OT_STRING,
E
Eric Blake 已提交
2254 2255 2256 2257 2258 2259 2260 2261 2262 2263
     .help = N_("format of the destination file")
    },
    {.name = "granularity",
     .type = VSH_OT_INT,
     .help = N_("power-of-two granularity to use during the copy")
    },
    {.name = "buf-size",
     .type = VSH_OT_INT,
     .help = N_("maximum amount of in-flight data during the copy")
    },
2264 2265 2266 2267
    {.name = "bytes",
     .type = VSH_OT_BOOL,
     .help = N_("the bandwidth limit is in bytes/s rather than MiB/s")
    },
2268 2269 2270 2271
    {.name = "transient-job",
     .type = VSH_OT_BOOL,
     .help = N_("the copy job is not persisted if VM is turned off")
    },
2272
    {.name = NULL}
2273 2274 2275
};

static bool
2276
cmdBlockcopy(vshControl *ctl, const vshCmd *cmd)
2277 2278
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
2279 2280
    const char *dest = NULL;
    const char *format = NULL;
2281
    unsigned long bandwidth = 0;
E
Eric Blake 已提交
2282 2283 2284
    unsigned int granularity = 0;
    unsigned long long buf_size = 0;
    unsigned int flags = 0;
2285 2286 2287 2288
    bool ret = false;
    bool verbose = vshCommandOptBool(cmd, "verbose");
    bool pivot = vshCommandOptBool(cmd, "pivot");
    bool finish = vshCommandOptBool(cmd, "finish");
E
Eric Blake 已提交
2289
    bool blockdev = vshCommandOptBool(cmd, "blockdev");
2290 2291
    bool blocking = vshCommandOptBool(cmd, "wait") || finish || pivot;
    bool async = vshCommandOptBool(cmd, "async");
2292
    bool bytes = vshCommandOptBool(cmd, "bytes");
2293
    bool transientjob = vshCommandOptBool(cmd, "transient-job");
2294 2295 2296
    int timeout = 0;
    const char *path = NULL;
    int abort_flags = 0;
E
Eric Blake 已提交
2297 2298 2299
    const char *xml = NULL;
    char *xmlstr = NULL;
    virTypedParameterPtr params = NULL;
2300
    virshBlockJobWaitDataPtr bjWait = NULL;
E
Eric Blake 已提交
2301
    int nparams = 0;
2302

2303 2304
    if (vshCommandOptStringReq(ctl, cmd, "path", &path) < 0)
        return false;
2305
    if (vshCommandOptStringReq(ctl, cmd, "dest", &dest) < 0)
E
Eric Blake 已提交
2306
        return false;
2307
    if (vshCommandOptStringReq(ctl, cmd, "xml", &xml) < 0)
E
Eric Blake 已提交
2308
        return false;
2309
    if (vshCommandOptStringReq(ctl, cmd, "format", &format) < 0)
E
Eric Blake 已提交
2310
        return false;
2311
    if (vshBlockJobOptionBandwidth(ctl, cmd, bytes, &bandwidth) < 0)
2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322
        return false;
    if (vshCommandOptUInt(ctl, cmd, "granularity", &granularity) < 0)
        return false;
    if (vshCommandOptULongLong(ctl, cmd, "buf-size", &buf_size) < 0)
        return false;
    /* Exploit that some VIR_DOMAIN_BLOCK_REBASE_* and
     * VIR_DOMAIN_BLOCK_COPY_* flags have the same values.  */
    if (vshCommandOptBool(cmd, "shallow"))
        flags |= VIR_DOMAIN_BLOCK_REBASE_SHALLOW;
    if (vshCommandOptBool(cmd, "reuse-external"))
        flags |= VIR_DOMAIN_BLOCK_REBASE_REUSE_EXT;
2323 2324
    if (transientjob)
        flags |= VIR_DOMAIN_BLOCK_COPY_TRANSIENT_JOB;
2325 2326 2327 2328 2329 2330 2331 2332
    if (vshCommandOptTimeoutToMs(ctl, cmd, &timeout) < 0)
        return false;

    if (timeout)
        blocking = true;

    if (async)
        abort_flags |= VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC;
E
Eric Blake 已提交
2333 2334 2335 2336

    VSH_EXCLUSIVE_OPTIONS_VAR(dest, xml);
    VSH_EXCLUSIVE_OPTIONS_VAR(format, xml);
    VSH_EXCLUSIVE_OPTIONS_VAR(blockdev, xml);
2337
    VSH_EXCLUSIVE_OPTIONS_VAR(pivot, finish);
2338

2339 2340 2341 2342 2343 2344 2345 2346 2347
    if (!dest && !xml) {
        vshError(ctl, "%s", _("need either --dest or --xml"));
        return false;
    }

    if (!blocking) {
        if (verbose) {
            vshError(ctl, "%s", _("--verbose requires at least one of --timeout, "
                                  "--wait, --pivot, or --finish"));
2348 2349
            return false;
        }
2350 2351 2352 2353

        if (async) {
            vshError(ctl, "%s", _("--async requires at least one of --timeout, "
                                  "--wait, --pivot, or --finish"));
2354
            return false;
2355 2356
        }
    }
2357

2358
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
2359 2360
        goto cleanup;

2361
    if (blocking &&
2362 2363
        !(bjWait = virshBlockJobWaitInit(ctl, dom, path, _("Block Copy"),
                                         verbose, timeout, async)))
2364 2365
        goto cleanup;

E
Eric Blake 已提交
2366
    if (xml) {
2367
        if (virFileReadAll(xml, VSH_MAX_XML_FILE, &xmlstr) < 0) {
E
Eric Blake 已提交
2368 2369 2370 2371
            vshReportError(ctl);
            goto cleanup;
        }
    }
2372

2373 2374
    if (granularity || buf_size || (format && STRNEQ(format, "raw")) || xml ||
        transientjob) {
E
Eric Blake 已提交
2375 2376 2377 2378
        /* New API */
        if (bandwidth || granularity || buf_size) {
            params = vshCalloc(ctl, 3, sizeof(*params));
            if (bandwidth) {
2379 2380 2381 2382 2383 2384 2385 2386 2387 2388
                if (!bytes) {
                    /* bandwidth is ulong MiB/s, but the typed parameter is
                     * ullong bytes/s; make sure we don't overflow */
                    unsigned long long limit = MIN(ULONG_MAX, ULLONG_MAX >> 20);
                    if (bandwidth > limit) {
                        vshError(ctl, _("bandwidth must be less than %llu"), limit);
                        goto cleanup;
                    }

                    bandwidth <<= 20ULL;
E
Eric Blake 已提交
2389 2390 2391 2392
                }
                if (virTypedParameterAssign(&params[nparams++],
                                            VIR_DOMAIN_BLOCK_COPY_BANDWIDTH,
                                            VIR_TYPED_PARAM_ULLONG,
2393
                                            bandwidth) < 0)
E
Eric Blake 已提交
2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
                    goto cleanup;
            }
            if (granularity &&
                virTypedParameterAssign(&params[nparams++],
                                        VIR_DOMAIN_BLOCK_COPY_GRANULARITY,
                                        VIR_TYPED_PARAM_UINT,
                                        granularity) < 0)
                goto cleanup;
            if (buf_size &&
                virTypedParameterAssign(&params[nparams++],
                                        VIR_DOMAIN_BLOCK_COPY_BUF_SIZE,
                                        VIR_TYPED_PARAM_ULLONG,
                                        buf_size) < 0)
                goto cleanup;
        }

        if (!xmlstr) {
            virBuffer buf = VIR_BUFFER_INITIALIZER;
            virBufferAsprintf(&buf, "<disk type='%s'>\n",
                              blockdev ? "block" : "file");
            virBufferAdjustIndent(&buf, 2);
            virBufferAsprintf(&buf, "<source %s", blockdev ? "dev" : "file");
            virBufferEscapeString(&buf, "='%s'/>\n", dest);
            virBufferEscapeString(&buf, "<driver type='%s'/>\n", format);
            virBufferAdjustIndent(&buf, -2);
            virBufferAddLit(&buf, "</disk>\n");
            xmlstr = virBufferContentAndReset(&buf);
        }

        if (virDomainBlockCopy(dom, path, xmlstr, params, nparams, flags) < 0)
            goto cleanup;
    } else {
        /* Old API */
        flags |= VIR_DOMAIN_BLOCK_REBASE_COPY;
2428
        if (blockdev)
E
Eric Blake 已提交
2429 2430 2431
            flags |= VIR_DOMAIN_BLOCK_REBASE_COPY_DEV;
        if (STREQ_NULLABLE(format, "raw"))
            flags |= VIR_DOMAIN_BLOCK_REBASE_COPY_RAW;
2432 2433
        if (bytes)
            flags |= VIR_DOMAIN_BLOCK_REBASE_BANDWIDTH_BYTES;
E
Eric Blake 已提交
2434 2435 2436 2437

        if (virDomainBlockRebase(dom, path, dest, bandwidth, flags) < 0)
            goto cleanup;
    }
2438 2439

    if (!blocking) {
2440
        vshPrintExtra(ctl, "%s", _("Block Copy started"));
2441 2442 2443 2444
        ret = true;
        goto cleanup;
    }

2445
    /* Execution continues here only if --wait or friends were specified */
2446
    switch (virshBlockJobWait(bjWait)) {
2447
        case -1:
2448
            goto cleanup;
2449

2450
        case VIR_DOMAIN_BLOCK_JOB_CANCELED:
2451
            vshPrintExtra(ctl, "\n%s", _("Copy aborted"));
2452
            goto cleanup;
2453
            break;
E
Eric Blake 已提交
2454

2455
        case VIR_DOMAIN_BLOCK_JOB_FAILED:
2456
            vshError(ctl, "\n%s", _("Copy failed"));
2457
            goto cleanup;
2458 2459
            break;

2460 2461 2462
        case VIR_DOMAIN_BLOCK_JOB_READY:
        case VIR_DOMAIN_BLOCK_JOB_COMPLETED:
            break;
2463 2464
    }

2465
    if (pivot) {
2466 2467 2468 2469 2470
        abort_flags |= VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT;
        if (virDomainBlockJobAbort(dom, path, abort_flags) < 0) {
            vshError(ctl, _("failed to pivot job for disk %s"), path);
            goto cleanup;
        }
2471

2472
        vshPrintExtra(ctl, "\n%s", _("Successfully pivoted"));
2473 2474 2475 2476 2477 2478
    } else if (finish) {
        if (virDomainBlockJobAbort(dom, path, abort_flags) < 0) {
            vshError(ctl, _("failed to finish job for disk %s"), path);
            goto cleanup;
        }

2479
        vshPrintExtra(ctl, "\n%s", _("Successfully copied"));
2480
    } else {
2481
        vshPrintExtra(ctl, "\n%s", _("Now in mirroring phase"));
2482
    }
2483 2484

    ret = true;
2485

2486
 cleanup:
E
Eric Blake 已提交
2487 2488
    VIR_FREE(xmlstr);
    virTypedParamsFree(params, nparams);
2489
    virshDomainFree(dom);
2490
    virshBlockJobWaitFree(bjWait);
2491 2492 2493 2494 2495 2496
    return ret;
}

/*
 * "blockjob" command
 */
2497
static const vshCmdInfo info_blockjob[] = {
2498 2499 2500 2501 2502 2503 2504
    {.name = "help",
     .data = N_("Manage active block operations")
    },
    {.name = "desc",
     .data = N_("Query, adjust speed, or cancel active block operations.")
    },
    {.name = NULL}
2505 2506
};

2507
static const vshCmdOptDef opts_blockjob[] = {
2508
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
2509 2510 2511
    {.name = "path",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
2512
     .completer = virshDomainDiskTargetCompleter,
2513 2514 2515 2516 2517 2518 2519 2520
     .help = N_("fully-qualified path of disk")
    },
    {.name = "abort",
     .type = VSH_OT_BOOL,
     .help = N_("abort the active job on the specified disk")
    },
    {.name = "async",
     .type = VSH_OT_BOOL,
2521
     .help = N_("implies --abort; request but don't wait for job end")
2522 2523 2524
    },
    {.name = "pivot",
     .type = VSH_OT_BOOL,
2525
     .help = N_("implies --abort; conclude and pivot a copy or commit job")
2526 2527 2528 2529 2530
    },
    {.name = "info",
     .type = VSH_OT_BOOL,
     .help = N_("get active job information for the specified disk")
    },
2531 2532
    {.name = "bytes",
     .type = VSH_OT_BOOL,
2533
     .help = N_("get/set bandwidth in bytes rather than MiB/s")
2534
    },
2535 2536 2537 2538
    {.name = "raw",
     .type = VSH_OT_BOOL,
     .help = N_("implies --info; output details rather than human summary")
    },
2539
    {.name = "bandwidth",
2540 2541
     .type = VSH_OT_INT,
     .help = N_("set the bandwidth limit in MiB/s")
2542 2543
    },
    {.name = NULL}
2544 2545
};

2546
VIR_ENUM_DECL(virshDomainBlockJob);
2547
VIR_ENUM_IMPL(virshDomainBlockJob,
2548 2549 2550 2551
              VIR_DOMAIN_BLOCK_JOB_TYPE_LAST,
              N_("Unknown job"),
              N_("Block Pull"),
              N_("Block Copy"),
2552
              N_("Block Commit"),
2553
              N_("Active Block Commit"));
2554 2555

static const char *
2556
virshDomainBlockJobToString(int type)
2557
{
2558
    const char *str = virshDomainBlockJobTypeToString(type);
2559 2560 2561
    return str ? _(str) : _("Unknown job");
}

2562

2563
static bool
2564 2565 2566 2567 2568
virshBlockJobInfo(vshControl *ctl,
                  virDomainPtr dom,
                  const char *path,
                  bool raw,
                  bool bytes)
2569 2570
{
    virDomainBlockJobInfo info;
2571
    virshControlPtr priv = ctl->privData;
2572 2573
    unsigned long long speed;
    unsigned int flags = 0;
2574
    int rc = -1;
2575

2576 2577
    /* If bytes were requested, or if raw mode is not forcing a MiB/s
     * query and cache can't prove failure, then query bytes/sec.  */
2578
    if (bytes || !(raw || priv->blockJobNoBytes)) {
2579 2580 2581 2582 2583 2584
        flags |= VIR_DOMAIN_BLOCK_JOB_INFO_BANDWIDTH_BYTES;
        rc = virDomainGetBlockJobInfo(dom, path, &info, flags);
        if (rc < 0) {
            /* Check for particular errors, let all the rest be fatal. */
            switch (last_error->code) {
            case VIR_ERR_INVALID_ARG:
2585
                priv->blockJobNoBytes = true;
2586
                G_GNUC_FALLTHROUGH;
2587 2588 2589 2590 2591 2592
            case VIR_ERR_OVERFLOW:
                if (!bytes && !raw) {
                    /* try again with MiB/s, unless forcing bytes */
                    vshResetLibvirtError();
                    break;
                }
2593
                G_GNUC_FALLTHROUGH;
2594
            default:
2595
                return false;
2596 2597 2598 2599 2600 2601 2602 2603
            }
        }
        speed = info.bandwidth;
    }
    /* If we don't already have a query result, query for MiB/s */
    if (rc < 0) {
        flags &= ~VIR_DOMAIN_BLOCK_JOB_INFO_BANDWIDTH_BYTES;
        if ((rc = virDomainGetBlockJobInfo(dom, path, &info, flags)) < 0)
2604
            return false;
2605 2606 2607 2608 2609 2610 2611
        speed = info.bandwidth;
        /* Scale to bytes/s unless in raw mode */
        if (!raw) {
            speed <<= 20;
            if (speed >> 20 != info.bandwidth) {
                vshError(ctl, _("overflow in converting %ld MiB/s to bytes\n"),
                         info.bandwidth);
2612
                return false;
2613 2614 2615 2616
            }
        }
    }

2617
    if (rc == 0) {
2618
        if (!raw)
2619
            vshPrintExtra(ctl, _("No current block job for %s"), path);
2620
        return true;
2621
    }
2622

2623 2624
    if (raw) {
        vshPrint(ctl, _(" type=%s\n bandwidth=%lu\n cur=%llu\n end=%llu\n"),
2625
                 virshDomainBlockJobTypeToString(info.type),
2626 2627
                 info.bandwidth, info.cur, info.end);
    } else {
2628 2629
        virshPrintJobProgress(virshDomainBlockJobToString(info.type),
                              info.end - info.cur, info.end);
2630 2631 2632 2633 2634 2635
        if (speed) {
            const char *unit;
            double val = vshPrettyCapacity(speed, &unit);
            vshPrint(ctl, _("    Bandwidth limit: %llu bytes/s (%-.3lf %s/s)"),
                     speed, val, unit);
        }
2636 2637
        vshPrint(ctl, "\n");
    }
2638

2639
    return true;
2640 2641 2642
}


2643
static bool
2644 2645 2646
virshBlockJobSetSpeed(vshControl *ctl,
                      const vshCmd *cmd,
                      virDomainPtr dom,
2647 2648
                      const char *path,
                      bool bytes)
2649 2650
{
    unsigned long bandwidth;
2651
    unsigned int flags = 0;
2652

2653 2654 2655 2656
    if (bytes)
        flags |= VIR_DOMAIN_BLOCK_JOB_SPEED_BANDWIDTH_BYTES;

    if (vshBlockJobOptionBandwidth(ctl, cmd, bytes, &bandwidth) < 0)
2657 2658
        return false;

2659
    if (virDomainBlockJobSetSpeed(dom, path, bandwidth, flags) < 0)
2660 2661 2662 2663 2664 2665
        return false;

    return true;
}


2666
static bool
2667 2668 2669 2670
virshBlockJobAbort(virDomainPtr dom,
                   const char *path,
                   bool pivot,
                   bool async)
2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685
{
    unsigned int flags = 0;

    if (async)
        flags |= VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC;
    if (pivot)
        flags |= VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT;

    if (virDomainBlockJobAbort(dom, path, flags) < 0)
        return false;

    return true;
}


2686
static bool
2687
cmdBlockjob(vshControl *ctl, const vshCmd *cmd)
2688 2689 2690 2691
{
    bool ret = false;
    bool raw = vshCommandOptBool(cmd, "raw");
    bool bytes = vshCommandOptBool(cmd, "bytes");
2692 2693 2694 2695
    bool abortMode = vshCommandOptBool(cmd, "abort");
    bool pivot = vshCommandOptBool(cmd, "pivot");
    bool async = vshCommandOptBool(cmd, "async");
    bool info = vshCommandOptBool(cmd, "info");
2696 2697 2698 2699
    bool bandwidth = vshCommandOptBool(cmd, "bandwidth");
    virDomainPtr dom = NULL;
    const char *path;

2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712
    VSH_EXCLUSIVE_OPTIONS("raw", "abort");
    VSH_EXCLUSIVE_OPTIONS_VAR(raw, pivot);
    VSH_EXCLUSIVE_OPTIONS_VAR(raw, async);
    VSH_EXCLUSIVE_OPTIONS_VAR(raw, bandwidth);

    VSH_EXCLUSIVE_OPTIONS("info", "abort");
    VSH_EXCLUSIVE_OPTIONS_VAR(info, pivot);
    VSH_EXCLUSIVE_OPTIONS_VAR(info, async);
    VSH_EXCLUSIVE_OPTIONS_VAR(info, bandwidth);

    VSH_EXCLUSIVE_OPTIONS("bytes", "abort");
    VSH_EXCLUSIVE_OPTIONS_VAR(bytes, pivot);
    VSH_EXCLUSIVE_OPTIONS_VAR(bytes, async);
2713

2714
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
2715 2716 2717 2718 2719 2720
        goto cleanup;

    /* XXX Allow path to be optional to list info on all devices at once */
    if (vshCommandOptStringReq(ctl, cmd, "path", &path) < 0)
        goto cleanup;

2721
    if (bandwidth)
2722
        ret = virshBlockJobSetSpeed(ctl, cmd, dom, path, bytes);
2723
    else if (abortMode || pivot || async)
2724
        ret = virshBlockJobAbort(dom, path, pivot, async);
2725
    else
2726
        ret = virshBlockJobInfo(ctl, dom, path, raw, bytes);
2727

2728
 cleanup:
2729
    virshDomainFree(dom);
2730
    return ret;
2731 2732 2733 2734 2735
}

/*
 * "blockpull" command
 */
2736
static const vshCmdInfo info_blockpull[] = {
2737 2738 2739 2740 2741 2742 2743
    {.name = "help",
     .data = N_("Populate a disk from its backing image.")
    },
    {.name = "desc",
     .data = N_("Populate a disk from its backing image.")
    },
    {.name = NULL}
2744 2745
};

2746
static const vshCmdOptDef opts_blockpull[] = {
2747
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
2748 2749 2750
    {.name = "path",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
2751
     .completer = virshDomainDiskTargetCompleter,
2752 2753 2754
     .help = N_("fully-qualified path of disk")
    },
    {.name = "bandwidth",
2755
     .type = VSH_OT_INT,
2756 2757 2758
     .help = N_("bandwidth limit in MiB/s")
    },
    {.name = "base",
2759
     .type = VSH_OT_STRING,
2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777
     .help = N_("path of backing file in chain for a partial pull")
    },
    {.name = "wait",
     .type = VSH_OT_BOOL,
     .help = N_("wait for job to finish")
    },
    {.name = "verbose",
     .type = VSH_OT_BOOL,
     .help = N_("with --wait, display the progress")
    },
    {.name = "timeout",
     .type = VSH_OT_INT,
     .help = N_("with --wait, abort if pull exceeds timeout (in seconds)")
    },
    {.name = "async",
     .type = VSH_OT_BOOL,
     .help = N_("with --wait, don't wait for cancel to finish")
    },
2778 2779 2780 2781
    {.name = "keep-relative",
     .type = VSH_OT_BOOL,
     .help = N_("keep the backing chain relatively referenced")
    },
2782 2783 2784 2785
    {.name = "bytes",
     .type = VSH_OT_BOOL,
     .help = N_("the bandwidth limit is in bytes/s rather than MiB/s")
    },
2786
    {.name = NULL}
2787 2788 2789
};

static bool
2790
cmdBlockpull(vshControl *ctl, const vshCmd *cmd)
2791 2792 2793 2794 2795
{
    virDomainPtr dom = NULL;
    bool ret = false;
    bool blocking = vshCommandOptBool(cmd, "wait");
    bool verbose = vshCommandOptBool(cmd, "verbose");
2796
    bool async = vshCommandOptBool(cmd, "async");
2797
    bool bytes = vshCommandOptBool(cmd, "bytes");
2798 2799
    int timeout = 0;
    const char *path = NULL;
2800 2801 2802
    const char *base = NULL;
    unsigned long bandwidth = 0;
    unsigned int flags = 0;
2803
    virshBlockJobWaitDataPtr bjWait = NULL;
2804

2805 2806 2807
    VSH_REQUIRE_OPTION("verbose", "wait");
    VSH_REQUIRE_OPTION("async", "wait");

2808 2809 2810 2811 2812 2813
    if (vshCommandOptStringReq(ctl, cmd, "path", &path) < 0)
        return false;

    if (vshCommandOptStringReq(ctl, cmd, "base", &base) < 0)
        return false;

2814
    if (vshBlockJobOptionBandwidth(ctl, cmd, bytes, &bandwidth) < 0)
2815 2816
        return false;

2817 2818 2819
    if (vshCommandOptTimeoutToMs(ctl, cmd, &timeout) < 0)
        return false;

2820 2821
    if (vshCommandOptBool(cmd, "keep-relative"))
        flags |= VIR_DOMAIN_BLOCK_REBASE_RELATIVE;
2822

2823
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
2824 2825
        return false;

2826
    if (blocking &&
2827 2828
        !(bjWait = virshBlockJobWaitInit(ctl, dom, path, _("Block Pull"),
                                         verbose, timeout, async)))
2829
        goto cleanup;
2830

2831
    if (base || flags) {
2832 2833 2834
        if (bytes)
            flags |= VIR_DOMAIN_BLOCK_REBASE_BANDWIDTH_BYTES;

2835 2836 2837
        if (virDomainBlockRebase(dom, path, base, bandwidth, flags) < 0)
            goto cleanup;
    } else {
2838 2839 2840 2841
        if (bytes)
            flags |= VIR_DOMAIN_BLOCK_PULL_BANDWIDTH_BYTES;

        if (virDomainBlockPull(dom, path, bandwidth, flags) < 0)
2842 2843
            goto cleanup;
    }
2844 2845

    if (!blocking) {
2846
        vshPrintExtra(ctl, "%s", _("Block Pull started"));
2847 2848 2849 2850
        ret = true;
        goto cleanup;
    }

2851
    /* Execution continues here only if --wait or friends were specified */
2852
    switch (virshBlockJobWait(bjWait)) {
2853 2854
        case -1:
            goto cleanup;
2855

2856
        case VIR_DOMAIN_BLOCK_JOB_CANCELED:
2857
            vshPrintExtra(ctl, "\n%s", _("Pull aborted"));
2858 2859 2860
            goto cleanup;
            break;

2861
        case VIR_DOMAIN_BLOCK_JOB_FAILED:
2862
            vshError(ctl, "\n%s", _("Pull failed"));
2863 2864
            goto cleanup;
            break;
2865

2866 2867
        case VIR_DOMAIN_BLOCK_JOB_READY:
        case VIR_DOMAIN_BLOCK_JOB_COMPLETED:
2868
            vshPrintExtra(ctl, "\n%s", _("Pull complete"));
2869
            break;
2870 2871 2872
    }

    ret = true;
2873

2874
 cleanup:
2875
    virshDomainFree(dom);
2876
    virshBlockJobWaitFree(bjWait);
2877 2878 2879 2880 2881 2882
    return ret;
}

/*
 * "blockresize" command
 */
2883
static const vshCmdInfo info_blockresize[] = {
2884 2885 2886 2887 2888 2889 2890
    {.name = "help",
     .data = N_("Resize block device of domain.")
    },
    {.name = "desc",
     .data = N_("Resize block device of domain.")
    },
    {.name = NULL}
2891 2892
};

2893
static const vshCmdOptDef opts_blockresize[] = {
2894
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
2895 2896 2897
    {.name = "path",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
2898
     .completer = virshDomainDiskTargetCompleter,
2899 2900 2901 2902 2903 2904 2905 2906
     .help = N_("Fully-qualified path of block device")
    },
    {.name = "size",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ,
     .help = N_("New size of the block device, as scaled integer (default KiB)")
    },
    {.name = NULL}
2907 2908 2909
};

static bool
2910
cmdBlockresize(vshControl *ctl, const vshCmd *cmd)
2911 2912 2913 2914 2915
{
    virDomainPtr dom;
    const char *path = NULL;
    unsigned long long size = 0;
    unsigned int flags = 0;
E
Eric Blake 已提交
2916
    bool ret = false;
2917

2918
    if (vshCommandOptStringReq(ctl, cmd, "path", (const char **) &path) < 0)
2919 2920
        return false;

2921
    if (vshCommandOptScaledInt(ctl, cmd, "size", &size, 1024, ULLONG_MAX) < 0)
2922 2923 2924 2925 2926 2927 2928 2929
        return false;

    /* Prefer the older interface of KiB.  */
    if (size % 1024 == 0)
        size /= 1024;
    else
        flags |= VIR_DOMAIN_BLOCK_RESIZE_BYTES;

2930
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
2931 2932 2933 2934 2935
        return false;

    if (virDomainBlockResize(dom, path, size, flags) < 0) {
        vshError(ctl, _("Failed to resize block device '%s'"), path);
    } else {
P
Pino Toscano 已提交
2936
        vshPrintExtra(ctl, _("Block device '%s' is resized"), path);
2937 2938 2939
        ret = true;
    }

2940
    virshDomainFree(dom);
2941 2942 2943 2944 2945 2946 2947 2948
    return ret;
}

#ifndef WIN32
/*
 * "console" command
 */
static const vshCmdInfo info_console[] = {
2949 2950 2951 2952 2953 2954 2955
    {.name = "help",
     .data = N_("connect to the guest console")
    },
    {.name = "desc",
     .data = N_("Connect the virtual serial console for the guest")
    },
    {.name = NULL}
2956 2957 2958
};

static const vshCmdOptDef opts_console[] = {
2959
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
2960
    {.name = "devname", /* sc_prohibit_devname */
2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972
     .type = VSH_OT_STRING,
     .help = N_("character device name")
    },
    {.name = "force",
     .type = VSH_OT_BOOL,
     .help =  N_("force console connection (disconnect already connected sessions)")
    },
    {.name = "safe",
     .type = VSH_OT_BOOL,
     .help =  N_("only connect if safe console handling is supported")
    },
    {.name = NULL}
2973 2974 2975 2976 2977 2978 2979 2980
};

static bool
cmdRunConsole(vshControl *ctl, virDomainPtr dom,
              const char *name,
              unsigned int flags)
{
    int state;
2981
    virshControlPtr priv = ctl->privData;
2982

2983
    if ((state = virshDomainState(ctl, dom, NULL)) < 0) {
2984
        vshError(ctl, "%s", _("Unable to get domain status"));
2985
        return false;
2986 2987 2988 2989
    }

    if (state == VIR_DOMAIN_SHUTOFF) {
        vshError(ctl, "%s", _("The domain is not running"));
2990
        return false;
2991 2992 2993 2994
    }

    if (!isatty(STDIN_FILENO)) {
        vshError(ctl, "%s", _("Cannot run interactive console without a controlling TTY"));
2995
        return false;
2996 2997 2998
    }

    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
2999
    vshPrintExtra(ctl, _("Escape character is %s\n"), priv->escapeChar);
3000
    fflush(stdout);
3001
    if (virshRunConsole(ctl, dom, name, flags) == 0)
3002
        return true;
3003

3004
    return false;
3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016
}

static bool
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = false;
    bool force = vshCommandOptBool(cmd, "force");
    bool safe = vshCommandOptBool(cmd, "safe");
    unsigned int flags = 0;
    const char *name = NULL;

3017
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
3018 3019
        return false;

3020
    if (vshCommandOptStringReq(ctl, cmd, "devname", &name) < 0) /* sc_prohibit_devname */
3021 3022 3023 3024 3025 3026 3027 3028 3029
        goto cleanup;

    if (force)
        flags |= VIR_DOMAIN_CONSOLE_FORCE;
    if (safe)
        flags |= VIR_DOMAIN_CONSOLE_SAFE;

    ret = cmdRunConsole(ctl, dom, name, flags);

3030
 cleanup:
3031
    virshDomainFree(dom);
3032 3033
    return ret;
}
3034
#endif /* WIN32 */
3035 3036 3037 3038

/* "domif-setlink" command
 */
static const vshCmdInfo info_domif_setlink[] = {
3039 3040 3041 3042 3043 3044 3045 3046
    {.name = "help",
     .data = N_("set link state of a virtual interface")
    },
    {.name = "desc",
     .data = N_("Set link state of a domain's virtual interface. This command "
                "wraps usage of update-device command.")
    },
    {.name = NULL}
3047 3048 3049
};

static const vshCmdOptDef opts_domif_setlink[] = {
3050
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
3051 3052 3053
    {.name = "interface",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
3054
     .completer = virshDomainInterfaceCompleter,
3055 3056 3057 3058 3059
     .help = N_("interface device (MAC Address)")
    },
    {.name = "state",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
3060
     .completer = virshDomainInterfaceStateCompleter,
3061 3062 3063 3064 3065 3066
     .help = N_("new state of the device")
    },
    {.name = "persistent",
     .type = VSH_OT_ALIAS,
     .help = "config"
    },
3067
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
3068
    {.name = NULL}
3069 3070 3071 3072 3073 3074 3075 3076
};

static bool
cmdDomIfSetLink(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *iface;
    const char *state;
3077
    char *value;
3078 3079 3080 3081 3082 3083
    virMacAddr macaddr;
    const char *element;
    const char *attr;
    bool config;
    bool ret = false;
    unsigned int flags = 0;
3084
    unsigned int xmlflags = 0;
3085
    size_t i;
3086 3087 3088 3089
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlNodePtr cur = NULL;
3090
    char *xml_buf = NULL;
3091

3092
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
3093 3094
        return false;

3095 3096
    if (vshCommandOptStringReq(ctl, cmd, "interface", &iface) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "state", &state) < 0)
3097 3098 3099 3100 3101 3102 3103 3104 3105
        goto cleanup;

    config = vshCommandOptBool(cmd, "config");

    if (STRNEQ(state, "up") && STRNEQ(state, "down")) {
        vshError(ctl, _("invalid link state '%s'"), state);
        goto cleanup;
    }

3106
    if (config) {
3107
        flags = VIR_DOMAIN_AFFECT_CONFIG;
3108 3109
        xmlflags |= VIR_DOMAIN_XML_INACTIVE;
    } else {
3110
        flags = VIR_DOMAIN_AFFECT_LIVE;
3111
    }
3112 3113 3114 3115

    if (virDomainIsActive(dom) == 0)
        flags = VIR_DOMAIN_AFFECT_CONFIG;

3116
    if (virshDomainGetXMLFromDom(ctl, dom, xmlflags, &xml, &ctxt) < 0)
3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139
        goto cleanup;

    obj = xmlXPathEval(BAD_CAST "/domain/devices/interface", ctxt);
    if (obj == NULL || obj->type != XPATH_NODESET ||
        obj->nodesetval == NULL || obj->nodesetval->nodeNr == 0) {
        vshError(ctl, _("Failed to extract interface information or no interfaces found"));
        goto cleanup;
    }

    if (virMacAddrParse(iface, &macaddr) == 0) {
        element = "mac";
        attr = "address";
    } else {
        element = "target";
        attr = "dev";
    }

    /* find interface with matching mac addr */
    for (i = 0; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;

        while (cur) {
            if (cur->type == XML_ELEMENT_NODE &&
3140
                virXMLNodeNameEqual(cur, element)) {
3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155
                value = virXMLPropString(cur, attr);

                if (STRCASEEQ(value, iface)) {
                    VIR_FREE(value);
                    goto hit;
                }
                VIR_FREE(value);
            }
            cur = cur->next;
        }
    }

    vshError(ctl, _("interface (%s: %s) not found"), element, iface);
    goto cleanup;

3156
 hit:
3157 3158 3159 3160 3161 3162
    /* find and modify/add link state node */
    /* try to find <link> element */
    cur = obj->nodesetval->nodeTab[i]->children;

    while (cur) {
        if (cur->type == XML_ELEMENT_NODE &&
3163
            virXMLNodeNameEqual(cur, "link")) {
3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184
            /* found, just modify the property */
            xmlSetProp(cur, BAD_CAST "state", BAD_CAST state);

            break;
        }
        cur = cur->next;
    }

    if (!cur) {
        /* element <link> not found, add one */
        cur = xmlNewChild(obj->nodesetval->nodeTab[i],
                          NULL,
                          BAD_CAST "link",
                          NULL);
        if (!cur)
            goto cleanup;

        if (xmlNewProp(cur, BAD_CAST "state", BAD_CAST state) == NULL)
            goto cleanup;
    }

3185 3186
    if (!(xml_buf = virXMLNodeToString(xml, obj->nodesetval->nodeTab[i]))) {
        vshSaveLibvirtError();
3187 3188 3189 3190
        vshError(ctl, _("Failed to create XML"));
        goto cleanup;
    }

3191
    if (virDomainUpdateDeviceFlags(dom, xml_buf, flags) < 0) {
3192 3193 3194
        vshError(ctl, _("Failed to update interface link state"));
        goto cleanup;
    } else {
P
Pino Toscano 已提交
3195
        vshPrintExtra(ctl, "%s", _("Device updated successfully\n"));
3196 3197 3198
        ret = true;
    }

3199
 cleanup:
3200 3201 3202
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
3203
    VIR_FREE(xml_buf);
3204
    virshDomainFree(dom);
3205 3206 3207 3208 3209 3210 3211

    return ret;
}

/* "domiftune" command
 */
static const vshCmdInfo info_domiftune[] = {
3212 3213 3214 3215 3216 3217 3218
    {.name = "help",
     .data = N_("get/set parameters of a virtual interface")
    },
    {.name = "desc",
     .data = N_("Get/set parameters of a domain's virtual interface.")
    },
    {.name = NULL}
3219 3220 3221
};

static const vshCmdOptDef opts_domiftune[] = {
3222
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
3223 3224 3225
    {.name = "interface",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
3226
     .completer = virshDomainInterfaceCompleter,
3227 3228 3229
     .help = N_("interface device (MAC Address)")
    },
    {.name = "inbound",
3230
     .type = VSH_OT_STRING,
3231 3232 3233
     .help = N_("control domain's incoming traffics")
    },
    {.name = "outbound",
3234
     .type = VSH_OT_STRING,
3235 3236
     .help = N_("control domain's outgoing traffics")
    },
3237
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
3238
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
3239
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
3240
    {.name = NULL}
3241 3242 3243 3244 3245 3246 3247 3248
};

static bool
cmdDomIftune(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name = NULL, *device = NULL,
               *inboundStr = NULL, *outboundStr = NULL;
3249
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
3250
    int nparams = 0;
3251
    int maxparams = 0;
3252 3253 3254 3255 3256 3257
    virTypedParameterPtr params = NULL;
    bool ret = false;
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    virNetDevBandwidthRate inbound, outbound;
3258
    size_t i;
3259

3260 3261 3262 3263 3264 3265 3266
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
3267

3268
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
3269 3270
        return false;

3271
    if (vshCommandOptStringReq(ctl, cmd, "interface", &device) < 0)
3272
        goto cleanup;
3273

3274
    if (vshCommandOptStringReq(ctl, cmd, "inbound", &inboundStr) < 0 ||
3275
        vshCommandOptStringReq(ctl, cmd, "outbound", &outboundStr) < 0)
3276 3277 3278 3279 3280 3281
        goto cleanup;

    memset(&inbound, 0, sizeof(inbound));
    memset(&outbound, 0, sizeof(outbound));

    if (inboundStr) {
3282
        if (virshParseRateStr(ctl, inboundStr, &inbound) < 0)
3283
            goto cleanup;
3284 3285 3286 3287 3288 3289 3290 3291
        /* we parse the rate as unsigned long long, but the API
         * only accepts UINT */
        if (inbound.average > UINT_MAX || inbound.peak > UINT_MAX ||
            inbound.burst > UINT_MAX) {
            vshError(ctl, _("inbound rate larger than maximum %u"),
                     UINT_MAX);
            goto cleanup;
        }
3292 3293 3294 3295

        if ((!inbound.average && (inbound.burst || inbound.peak)) &&
            !inbound.floor) {
            vshError(ctl, _("either inbound average or floor is mandatory"));
3296 3297
            goto cleanup;
        }
3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314

        if (virTypedParamsAddUInt(&params, &nparams, &maxparams,
                                  VIR_DOMAIN_BANDWIDTH_IN_AVERAGE,
                                  inbound.average) < 0)
            goto save_error;

        if (inbound.peak &&
            virTypedParamsAddUInt(&params, &nparams, &maxparams,
                                  VIR_DOMAIN_BANDWIDTH_IN_PEAK,
                                  inbound.peak) < 0)
            goto save_error;

        if (inbound.burst &&
            virTypedParamsAddUInt(&params, &nparams, &maxparams,
                                  VIR_DOMAIN_BANDWIDTH_IN_BURST,
                                  inbound.burst) < 0)
            goto save_error;
3315 3316 3317 3318 3319 3320

        if (inbound.floor &&
            virTypedParamsAddUInt(&params, &nparams, &maxparams,
                                  VIR_DOMAIN_BANDWIDTH_IN_FLOOR,
                                  inbound.floor) < 0)
            goto save_error;
3321
    }
3322

3323
    if (outboundStr) {
3324
        if (virshParseRateStr(ctl, outboundStr, &outbound) < 0)
3325
            goto cleanup;
3326 3327 3328 3329 3330 3331
        if (outbound.average > UINT_MAX || outbound.peak > UINT_MAX ||
            outbound.burst > UINT_MAX) {
            vshError(ctl, _("outbound rate larger than maximum %u"),
                     UINT_MAX);
            goto cleanup;
        }
3332
        if (outbound.average == 0 && (outbound.burst || outbound.peak)) {
3333 3334
            vshError(ctl, _("outbound average is mandatory"));
            goto cleanup;
3335 3336 3337 3338 3339
        }

        if (outbound.floor) {
            vshError(ctl, _("outbound floor is unsupported yet"));
            goto cleanup;
3340
        }
3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357

        if (virTypedParamsAddUInt(&params, &nparams, &maxparams,
                                  VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE,
                                  outbound.average) < 0)
            goto save_error;

        if (outbound.peak &&
            virTypedParamsAddUInt(&params, &nparams, &maxparams,
                                  VIR_DOMAIN_BANDWIDTH_OUT_PEAK,
                                  outbound.peak) < 0)
            goto save_error;

        if (outbound.burst &&
            virTypedParamsAddUInt(&params, &nparams, &maxparams,
                                  VIR_DOMAIN_BANDWIDTH_OUT_BURST,
                                  outbound.burst) < 0)
            goto save_error;
3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386
    }

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

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

        /* get all interface parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
        if (virDomainGetInterfaceParameters(dom, device, params, &nparams, flags) != 0) {
            vshError(ctl, "%s", _("Unable to get interface parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            char *str = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
            VIR_FREE(str);
        }
    } else {
3387 3388 3389
        if (virDomainSetInterfaceParameters(dom, device, params,
                                            nparams, flags) != 0)
            goto error;
3390 3391 3392 3393
    }

    ret = true;

3394
 cleanup:
3395
    virTypedParamsFree(params, nparams);
3396
    virshDomainFree(dom);
3397
    return ret;
3398

3399
 save_error:
3400
    vshSaveLibvirtError();
3401
 error:
3402 3403
    vshError(ctl, "%s", _("Unable to set interface parameters"));
    goto cleanup;
3404 3405 3406 3407 3408 3409
}

/*
 * "suspend" command
 */
static const vshCmdInfo info_suspend[] = {
3410 3411 3412 3413 3414 3415 3416
    {.name = "help",
     .data = N_("suspend a domain")
    },
    {.name = "desc",
     .data = N_("Suspend a running domain.")
    },
    {.name = NULL}
3417 3418 3419
};

static const vshCmdOptDef opts_suspend[] = {
3420
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_RUNNING),
3421
    {.name = NULL}
3422 3423 3424 3425 3426 3427 3428 3429 3430
};

static bool
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name;
    bool ret = true;

3431
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
3432 3433 3434
        return false;

    if (virDomainSuspend(dom) == 0) {
P
Pino Toscano 已提交
3435
        vshPrintExtra(ctl, _("Domain %s suspended\n"), name);
3436 3437 3438 3439 3440
    } else {
        vshError(ctl, _("Failed to suspend domain %s"), name);
        ret = false;
    }

3441
    virshDomainFree(dom);
3442 3443 3444 3445 3446 3447 3448
    return ret;
}

/*
 * "dompmsuspend" command
 */
static const vshCmdInfo info_dom_pm_suspend[] = {
3449 3450 3451 3452 3453 3454
    {.name = "help",
     .data = N_("suspend a domain gracefully using power management "
                "functions")
    },
    {.name = "desc",
     .data = N_("Suspends a running domain using guest OS's power management. "
3455
                "(Note: This requires a guest agent configured and running in "
3456 3457 3458
                "the guest OS).")
    },
    {.name = NULL}
3459 3460 3461
};

static const vshCmdOptDef opts_dom_pm_suspend[] = {
3462
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_RUNNING),
3463
    {.name = "target",
3464
     .type = VSH_OT_DATA,
3465 3466 3467 3468 3469
     .flags = VSH_OFLAG_REQ,
     .help = N_("mem(Suspend-to-RAM), "
                "disk(Suspend-to-Disk), "
                "hybrid(Hybrid-Suspend)")
    },
M
Martin Kletzander 已提交
3470 3471 3472 3473 3474
    {.name = "duration",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ_OPT,
     .help = N_("duration in seconds")
    },
3475
    {.name = NULL}
3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487
};

static bool
cmdDomPMSuspend(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name;
    bool ret = false;
    const char *target = NULL;
    unsigned int suspendTarget;
    unsigned long long duration = 0;

3488
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
3489 3490
        return false;

3491
    if (vshCommandOptULongLong(ctl, cmd, "duration", &duration) < 0)
3492 3493
        goto cleanup;

3494
    if (vshCommandOptStringReq(ctl, cmd, "target", &target) < 0)
3495 3496
        goto cleanup;

3497
    if (STREQ(target, "mem")) {
3498
        suspendTarget = VIR_NODE_SUSPEND_TARGET_MEM;
3499
    } else if (STREQ(target, "disk")) {
3500
        suspendTarget = VIR_NODE_SUSPEND_TARGET_DISK;
3501
    } else if (STREQ(target, "hybrid")) {
3502
        suspendTarget = VIR_NODE_SUSPEND_TARGET_HYBRID;
3503
    } else {
3504 3505 3506 3507 3508 3509 3510 3511 3512 3513
        vshError(ctl, "%s", _("Invalid target"));
        goto cleanup;
    }

    if (virDomainPMSuspendForDuration(dom, suspendTarget, duration, 0) < 0) {
        vshError(ctl, _("Domain %s could not be suspended"),
                 virDomainGetName(dom));
        goto cleanup;
    }

P
Pino Toscano 已提交
3514
    vshPrintExtra(ctl, _("Domain %s successfully suspended"),
3515 3516 3517 3518
             virDomainGetName(dom));

    ret = true;

3519
 cleanup:
3520
    virshDomainFree(dom);
3521 3522 3523 3524 3525 3526 3527 3528
    return ret;
}

/*
 * "dompmwakeup" command
 */

static const vshCmdInfo info_dom_pm_wakeup[] = {
3529 3530 3531 3532 3533 3534 3535 3536
    {.name = "help",
     .data = N_("wakeup a domain from pmsuspended state")
    },
    {.name = "desc",
     .data = N_("Wakeup a domain that was previously suspended "
                "by power management.")
    },
    {.name = NULL}
3537 3538 3539
};

static const vshCmdOptDef opts_dom_pm_wakeup[] = {
3540
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_OTHER),
3541
    {.name = NULL}
3542 3543 3544 3545 3546 3547 3548 3549 3550 3551
};

static bool
cmdDomPMWakeup(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name;
    bool ret = false;
    unsigned int flags = 0;

3552
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
3553 3554 3555 3556 3557 3558 3559 3560
        return false;

    if (virDomainPMWakeup(dom, flags) < 0) {
        vshError(ctl, _("Domain %s could not be woken up"),
                 virDomainGetName(dom));
        goto cleanup;
    }

P
Pino Toscano 已提交
3561 3562
    vshPrintExtra(ctl, _("Domain %s successfully woken up"),
                  virDomainGetName(dom));
3563 3564 3565

    ret = true;

3566
 cleanup:
3567
    virshDomainFree(dom);
3568 3569 3570 3571 3572 3573 3574
    return ret;
}

/*
 * "undefine" command
 */
static const vshCmdInfo info_undefine[] = {
3575 3576 3577 3578 3579 3580 3581
    {.name = "help",
     .data = N_("undefine a domain")
    },
    {.name = "desc",
     .data = N_("Undefine an inactive domain, or convert persistent to transient.")
    },
    {.name = NULL}
3582 3583 3584
};

static const vshCmdOptDef opts_undefine[] = {
3585
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_PERSISTENT),
3586 3587 3588 3589 3590
    {.name = "managed-save",
     .type = VSH_OT_BOOL,
     .help = N_("remove domain managed state file")
    },
    {.name = "storage",
3591
     .type = VSH_OT_STRING,
3592 3593 3594 3595 3596 3597 3598
     .help = N_("remove associated storage volumes (comma separated list of "
                "targets or source paths) (see domblklist)")
    },
    {.name = "remove-all-storage",
     .type = VSH_OT_BOOL,
     .help = N_("remove all associated storage volumes (use with caution)")
    },
3599
    {.name = "delete-snapshots",
3600 3601 3602 3603
     .type = VSH_OT_ALIAS,
     .help = "delete-storage-volume-snapshots"
    },
    {.name = "delete-storage-volume-snapshots",
3604 3605 3606 3607
     .type = VSH_OT_BOOL,
     .help = N_("delete snapshots associated with volume(s), requires "
                "--remove-all-storage (must be supported by storage driver)")
    },
3608 3609 3610 3611 3612 3613
    {.name = "wipe-storage",
     .type = VSH_OT_BOOL,
     .help = N_("wipe data on the removed volumes")
    },
    {.name = "snapshots-metadata",
     .type = VSH_OT_BOOL,
3614
     .help = N_("remove all domain snapshot metadata (vm must be inactive)")
3615
    },
3616 3617 3618 3619
    {.name = "checkpoints-metadata",
     .type = VSH_OT_BOOL,
     .help = N_("remove all domain checkpoint metadata (vm must be inactive)")
    },
3620 3621 3622 3623
    {.name = "nvram",
     .type = VSH_OT_BOOL,
     .help = N_("remove nvram file, if inactive")
    },
3624 3625 3626 3627
    {.name = "keep-nvram",
     .type = VSH_OT_BOOL,
     .help = N_("keep nvram file, if inactive")
    },
3628
    {.name = NULL}
3629 3630
};

3631 3632 3633 3634
typedef struct {
    virStorageVolPtr vol;
    char *source;
    char *target;
3635
} virshUndefineVolume;
3636

3637 3638 3639 3640 3641 3642 3643 3644
static bool
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = false;
    const char *name = NULL;
    /* Flags to attempt.  */
    unsigned int flags = 0;
3645
    unsigned int vol_flags = 0;
3646 3647 3648
    /* User-requested actions.  */
    bool managed_save = vshCommandOptBool(cmd, "managed-save");
    bool snapshots_metadata = vshCommandOptBool(cmd, "snapshots-metadata");
3649
    bool checkpoints_metadata = vshCommandOptBool(cmd, "checkpoints-metadata");
3650 3651
    bool wipe_storage = vshCommandOptBool(cmd, "wipe-storage");
    bool remove_all_storage = vshCommandOptBool(cmd, "remove-all-storage");
3652
    bool delete_snapshots = vshCommandOptBool(cmd, "delete-snapshots");
3653
    bool nvram = vshCommandOptBool(cmd, "nvram");
3654
    bool keep_nvram = vshCommandOptBool(cmd, "keep-nvram");
3655 3656 3657 3658 3659 3660 3661 3662 3663 3664
    /* Positive if these items exist.  */
    int has_managed_save = 0;
    int has_snapshots_metadata = 0;
    int has_snapshots = 0;
    /* True if undefine will not strand data, even on older servers.  */
    bool managed_save_safe = false;
    bool snapshots_safe = false;
    int rc = -1;
    int running;
    /* list of volumes to remove along with this domain */
3665 3666 3667
    const char *vol_string = NULL;  /* string containing volumes to delete */
    char **vol_list = NULL;         /* tokenized vol_string */
    int nvol_list = 0;
3668
    virshUndefineVolume *vols = NULL; /* info about the volumes to delete*/
3669 3670 3671 3672 3673
    size_t nvols = 0;
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr *vol_nodes = NULL;   /* XML nodes of volumes of the guest */
    int nvol_nodes;
3674 3675
    char *source = NULL;
    char *target = NULL;
3676
    char *pool = NULL;
3677 3678
    size_t i;
    size_t j;
3679
    virshControlPtr priv = ctl->privData;
3680

3681
    VSH_REQUIRE_OPTION("delete-snapshots", "remove-all-storage");
3682
    VSH_EXCLUSIVE_OPTIONS("nvram", "keep-nvram");
3683

3684
    ignore_value(vshCommandOptStringQuiet(ctl, cmd, "storage", &vol_string));
3685

3686 3687 3688 3689 3690 3691 3692
    if (!(vol_string || remove_all_storage) && wipe_storage) {
        vshError(ctl,
                 _("'--wipe-storage' requires '--storage <string>' or "
                   "'--remove-all-storage'"));
        return false;
    }

3693 3694 3695
    if (delete_snapshots)
        vol_flags |= VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS;

3696 3697 3698 3699 3700 3701 3702 3703
    if (managed_save) {
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
        managed_save_safe = true;
    }
    if (snapshots_metadata) {
        flags |= VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
3704 3705
    if (checkpoints_metadata)
        flags |= VIR_DOMAIN_UNDEFINE_CHECKPOINTS_METADATA;
3706
    if (nvram)
3707
        flags |= VIR_DOMAIN_UNDEFINE_NVRAM;
3708 3709
    if (keep_nvram)
        flags |= VIR_DOMAIN_UNDEFINE_KEEP_NVRAM;
3710

3711
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
3712 3713 3714 3715 3716 3717
        return false;

    /* Do some flag manipulation.  The goal here is to disable bits
     * from flags to reduce the likelihood of a server rejecting
     * unknown flag bits, as well as to track conditions which are
     * safe by default for the given hypervisor and server version.  */
3718 3719 3720
    if ((running = virDomainIsActive(dom)) < 0)
        goto error;

3721 3722 3723 3724 3725 3726
    if (!running) {
        /* Undefine with snapshots only fails for inactive domains,
         * and managed save only exists on inactive domains; if
         * running, then we don't want to remove anything.  */
        has_managed_save = virDomainHasManagedSaveImage(dom, 0);
        if (has_managed_save < 0) {
3727 3728
            if (last_error->code != VIR_ERR_NO_SUPPORT)
                goto error;
3729
            vshResetLibvirtError();
3730 3731 3732 3733 3734
            has_managed_save = 0;
        }

        has_snapshots = virDomainSnapshotNum(dom, 0);
        if (has_snapshots < 0) {
3735 3736
            if (last_error->code != VIR_ERR_NO_SUPPORT)
                goto error;
3737
            vshResetLibvirtError();
3738 3739 3740 3741 3742 3743 3744 3745
            has_snapshots = 0;
        }
        if (has_snapshots) {
            has_snapshots_metadata
                = virDomainSnapshotNum(dom, VIR_DOMAIN_SNAPSHOT_LIST_METADATA);
            if (has_snapshots_metadata < 0) {
                /* The server did not know the new flag, assume that all
                   snapshots have metadata.  */
3746
                vshResetLibvirtError();
3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758
                has_snapshots_metadata = has_snapshots;
            } else {
                /* The server knew the new flag, all aspects of
                 * undefineFlags are safe.  */
                managed_save_safe = snapshots_safe = true;
            }
        }
    }
    if (!has_managed_save) {
        flags &= ~VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
        managed_save_safe = true;
    }
3759
    if (has_snapshots == 0)
3760 3761 3762 3763 3764 3765 3766
        snapshots_safe = true;
    if (has_snapshots_metadata == 0) {
        flags &= ~VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }

    /* Stash domain description for later use */
3767
    if (vol_string || remove_all_storage) {
3768
        if (running) {
3769 3770 3771
            vshError(ctl,
                     _("Storage volume deletion is supported only on "
                       "stopped domains"));
3772 3773 3774
            goto cleanup;
        }

3775 3776 3777
        if (vol_string && remove_all_storage) {
            vshError(ctl,
                     _("Specified both --storage and --remove-all-storage"));
3778 3779 3780
            goto cleanup;
        }

3781
        if (virshDomainGetXMLFromDom(ctl, dom, 0, &doc, &ctxt) < 0)
3782
            goto cleanup;
3783

C
Chen Hanxiao 已提交
3784
        /* tokenize the string from user and save its parts into an array */
3785 3786
        if (vol_string &&
            (nvol_list = vshStringToArray(vol_string, &vol_list)) < 0)
3787 3788
            goto error;

3789 3790 3791
        if ((nvol_nodes = virXPathNodeSet("./devices/disk", ctxt,
                                          &vol_nodes)) < 0)
            goto error;
3792

3793
        for (i = 0; i < nvol_nodes; i++) {
3794
            ctxt->node = vol_nodes[i];
3795
            virshUndefineVolume vol;
3796 3797
            VIR_FREE(source);
            VIR_FREE(target);
3798
            VIR_FREE(pool);
3799 3800 3801 3802 3803 3804 3805 3806 3807

            /* get volume source and target paths */
            if (!(target = virXPathString("string(./target/@dev)", ctxt)))
                goto error;

            if (!(source = virXPathString("string("
                                          "./source/@file|"
                                          "./source/@dir|"
                                          "./source/@name|"
3808 3809
                                          "./source/@dev|"
                                          "./source/@volume)", ctxt)))
3810
                continue;
3811

3812 3813
            pool = virXPathString("string(./source/@pool)", ctxt);

3814
            /* lookup if volume was selected by user */
3815 3816 3817 3818 3819 3820 3821
            if (vol_list) {
                bool found = false;
                for (j = 0; j < nvol_list; j++) {
                    if (STREQ_NULLABLE(vol_list[j], target) ||
                        STREQ_NULLABLE(vol_list[j], source)) {
                        VIR_FREE(vol_list[j]);
                        found = true;
3822 3823 3824
                        break;
                    }
                }
3825
                if (!found)
3826 3827 3828
                    continue;
            }

3829 3830 3831 3832
            if (pool) {
                virStoragePoolPtr storagepool = NULL;

                if (!source) {
3833
                    vshError(ctl,
3834 3835 3836 3837 3838
                             _("Missing storage volume name for disk '%s'"),
                             target);
                    continue;
                }

3839
                if (!(storagepool = virStoragePoolLookupByName(priv->conn,
3840
                                                               pool))) {
3841
                    vshError(ctl,
3842 3843 3844 3845 3846 3847 3848 3849 3850 3851
                             _("Storage pool '%s' for volume '%s' not found."),
                             pool, target);
                    vshResetLibvirtError();
                    continue;
                }

                vol.vol = virStorageVolLookupByName(storagepool, source);
                virStoragePoolFree(storagepool);

            } else {
3852
               vol.vol = virStorageVolLookupByPath(priv->conn, source);
3853 3854 3855
            }

            if (!vol.vol) {
3856
                vshError(ctl,
3857 3858
                         _("Storage volume '%s'(%s) is not managed by libvirt. "
                           "Remove it manually.\n"), target, source);
3859
                vshResetLibvirtError();
3860 3861
                continue;
            }
3862 3863 3864

            vol.source = source;
            vol.target = target;
3865 3866
            source = NULL;
            target = NULL;
3867 3868
            if (VIR_APPEND_ELEMENT(vols, nvols, vol) < 0)
                goto cleanup;
3869 3870 3871
        }

        /* print volumes specified by user that were not found in domain definition */
3872 3873 3874 3875 3876 3877 3878 3879
        if (vol_list) {
            bool found = false;
            for (i = 0; i < nvol_list; i++) {
                if (vol_list[i]) {
                    vshError(ctl,
                             _("Volume '%s' was not found in domain's "
                               "definition.\n"), vol_list[i]);
                    found = true;
3880 3881 3882
                }
            }

3883
            if (found)
3884 3885
                goto cleanup;
        }
3886 3887 3888 3889 3890 3891 3892
    }

    /* Generally we want to try the new API first.  However, while
     * virDomainUndefineFlags was introduced at the same time as
     * VIR_DOMAIN_UNDEFINE_MANAGED_SAVE in 0.9.4, the
     * VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA flag was not present
     * until 0.9.5; skip to piecewise emulation if we couldn't prove
3893 3894 3895 3896 3897
     * above that the new API is safe.
     * Moreover, only the newer UndefineFlags() API understands
     * the VIR_DOMAIN_UNDEFINE_NVRAM flag. So if user has
     * specified --nvram we must use the Flags() API. */
    if ((managed_save_safe && snapshots_safe) || nvram) {
3898
        rc = virDomainUndefineFlags(dom, flags);
3899 3900 3901
        if (rc == 0 || nvram ||
            (last_error->code != VIR_ERR_NO_SUPPORT &&
             last_error->code != VIR_ERR_INVALID_ARG))
3902
            goto out;
3903
        vshResetLibvirtError();
3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915
    }

    /* The new API is unsupported or unsafe; fall back to doing things
     * piecewise.  */
    if (has_managed_save) {
        if (!managed_save) {
            vshError(ctl, "%s",
                     _("Refusing to undefine while domain managed save "
                       "image exists"));
            goto cleanup;
        }
        if (virDomainManagedSaveRemove(dom, 0) < 0) {
E
Eric Blake 已提交
3916
            vshReportError(ctl);
3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933
            goto cleanup;
        }
    }

    /* No way to emulate deletion of just snapshot metadata
     * without support for the newer flags.  Oh well.  */
    if (has_snapshots_metadata) {
        vshError(ctl,
                 snapshots_metadata ?
                 _("Unable to remove metadata of %d snapshots") :
                 _("Refusing to undefine while %d snapshots exist"),
                 has_snapshots_metadata);
        goto cleanup;
    }

    rc = virDomainUndefine(dom);

3934
 out:
3935
    if (rc == 0) {
P
Pino Toscano 已提交
3936
        vshPrintExtra(ctl, _("Domain %s has been undefined\n"), name);
3937 3938 3939 3940 3941 3942 3943
        ret = true;
    } else {
        vshError(ctl, _("Failed to undefine domain %s"), name);
        goto cleanup;
    }

    /* try to undefine storage volumes associated with this domain, if it's requested */
3944
    if (nvols) {
3945
        for (i = 0; i < nvols; i++) {
3946
            if (wipe_storage) {
P
Pino Toscano 已提交
3947 3948
                vshPrintExtra(ctl, _("Wiping volume '%s'(%s) ... "),
                              vols[i].target, vols[i].source);
3949
                fflush(stdout);
3950
                if (virStorageVolWipe(vols[i].vol, 0) < 0) {
3951
                    vshError(ctl, _("Failed! Volume not removed."));
3952
                    ret = false;
3953 3954
                    continue;
                } else {
P
Pino Toscano 已提交
3955
                    vshPrintExtra(ctl, _("Done.\n"));
3956 3957 3958 3959
                }
            }

            /* delete the volume */
3960
            if (virStorageVolDelete(vols[i].vol, vol_flags) < 0) {
3961
                vshError(ctl, _("Failed to remove storage volume '%s'(%s)"),
3962
                         vols[i].target, vols[i].source);
3963 3964
                ret = false;
            } else {
P
Pino Toscano 已提交
3965 3966
                vshPrintExtra(ctl, _("Volume '%s'(%s) removed.\n"),
                              vols[i].target, vols[i].source);
3967 3968 3969 3970
            }
        }
    }

3971
 cleanup:
3972 3973
    VIR_FREE(source);
    VIR_FREE(target);
3974
    VIR_FREE(pool);
3975
    for (i = 0; i < nvols; i++) {
3976 3977 3978 3979
        VIR_FREE(vols[i].source);
        VIR_FREE(vols[i].target);
        if (vols[i].vol)
            virStorageVolFree(vols[i].vol);
3980
    }
3981 3982 3983 3984 3985
    VIR_FREE(vols);

    for (i = 0; i < nvol_list; i++)
        VIR_FREE(vol_list[i]);
    VIR_FREE(vol_list);
3986

3987 3988 3989
    VIR_FREE(vol_nodes);
    xmlFreeDoc(doc);
    xmlXPathFreeContext(ctxt);
3990
    virshDomainFree(dom);
3991
    return ret;
3992

3993
 error:
E
Eric Blake 已提交
3994
    vshReportError(ctl);
3995
    goto cleanup;
3996 3997 3998 3999 4000 4001
}

/*
 * "start" command
 */
static const vshCmdInfo info_start[] = {
4002 4003 4004 4005 4006
    {.name = "help",
     .data = N_("start a (previously defined) inactive domain")
    },
    {.name = "desc",
     .data = N_("Start a domain, either from the last managedsave\n"
4007
                "    state, or via a fresh boot if no managedsave state\n"
4008 4009 4010
                "    is present.")
    },
    {.name = NULL}
4011 4012 4013
};

static const vshCmdOptDef opts_start[] = {
4014 4015
    VIRSH_COMMON_OPT_DOMAIN(N_("name of the inactive domain"),
                            VIR_CONNECT_LIST_DOMAINS_SHUTOFF),
4016
#ifndef WIN32
4017 4018 4019 4020
    {.name = "console",
     .type = VSH_OT_BOOL,
     .help = N_("attach to console after creation")
    },
4021
#endif
4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037
    {.name = "paused",
     .type = VSH_OT_BOOL,
     .help = N_("leave the guest paused after creation")
    },
    {.name = "autodestroy",
     .type = VSH_OT_BOOL,
     .help = N_("automatically destroy the guest when virsh disconnects")
    },
    {.name = "bypass-cache",
     .type = VSH_OT_BOOL,
     .help = N_("avoid file system cache when loading")
    },
    {.name = "force-boot",
     .type = VSH_OT_BOOL,
     .help = N_("force fresh boot by discarding any managed save")
    },
4038 4039 4040 4041
    {.name = "pass-fds",
     .type = VSH_OT_STRING,
     .help = N_("pass file descriptors N,M,... to the guest")
    },
4042
    {.name = NULL}
4043 4044
};

4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059
static int
cmdStartGetFDs(vshControl *ctl,
               const vshCmd *cmd,
               size_t *nfdsret,
               int **fdsret)
{
    const char *fdopt;
    char **fdlist = NULL;
    int *fds = NULL;
    size_t nfds = 0;
    size_t i;

    *nfdsret = 0;
    *fdsret = NULL;

4060
    if (vshCommandOptStringQuiet(ctl, cmd, "pass-fds", &fdopt) <= 0)
4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080
        return 0;

    if (!(fdlist = virStringSplit(fdopt, ",", -1))) {
        vshError(ctl, _("Unable to split FD list '%s'"), fdopt);
        return -1;
    }

    for (i = 0; fdlist[i] != NULL; i++) {
        int fd;
        if (virStrToLong_i(fdlist[i], NULL, 10, &fd) < 0) {
            vshError(ctl, _("Unable to parse FD number '%s'"), fdlist[i]);
            goto error;
        }
        if (VIR_EXPAND_N(fds, nfds, 1) < 0) {
            vshError(ctl, "%s", _("Unable to allocate FD list"));
            goto error;
        }
        fds[nfds - 1] = fd;
    }

4081
    virStringListFree(fdlist);
4082 4083 4084 4085 4086

    *fdsret = fds;
    *nfdsret = nfds;
    return 0;

4087
 error:
4088
    virStringListFree(fdlist);
4089 4090 4091 4092
    VIR_FREE(fds);
    return -1;
}

4093 4094 4095 4096 4097 4098 4099 4100 4101 4102
static bool
cmdStart(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = false;
#ifndef WIN32
    bool console = vshCommandOptBool(cmd, "console");
#endif
    unsigned int flags = VIR_DOMAIN_NONE;
    int rc;
4103 4104
    size_t nfds = 0;
    int *fds = NULL;
4105

4106 4107
    if (!(dom = virshCommandOptDomainBy(ctl, cmd, NULL,
                                        VIRSH_BYNAME | VIRSH_BYUUID)))
4108 4109 4110 4111
        return false;

    if (virDomainGetID(dom) != (unsigned int)-1) {
        vshError(ctl, "%s", _("Domain is already active"));
4112
        goto cleanup;
4113 4114
    }

4115
    if (cmdStartGetFDs(ctl, cmd, &nfds, &fds) < 0)
4116
        goto cleanup;
4117

4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_START_BYPASS_CACHE;
    if (vshCommandOptBool(cmd, "force-boot"))
        flags |= VIR_DOMAIN_START_FORCE_BOOT;

    /* We can emulate force boot, even for older servers that reject it.  */
    if (flags & VIR_DOMAIN_START_FORCE_BOOT) {
4129 4130 4131
        if ((nfds ?
             virDomainCreateWithFiles(dom, nfds, fds, flags) :
             virDomainCreateWithFlags(dom, flags)) == 0)
4132 4133 4134
            goto started;
        if (last_error->code != VIR_ERR_NO_SUPPORT &&
            last_error->code != VIR_ERR_INVALID_ARG) {
E
Eric Blake 已提交
4135
            vshReportError(ctl);
4136 4137
            goto cleanup;
        }
4138
        vshResetLibvirtError();
4139 4140 4141
        rc = virDomainHasManagedSaveImage(dom, 0);
        if (rc < 0) {
            /* No managed save image to remove */
4142
            vshResetLibvirtError();
4143 4144
        } else if (rc > 0) {
            if (virDomainManagedSaveRemove(dom, 0) < 0) {
E
Eric Blake 已提交
4145
                vshReportError(ctl);
4146 4147 4148 4149 4150 4151 4152
                goto cleanup;
            }
        }
        flags &= ~VIR_DOMAIN_START_FORCE_BOOT;
    }

    /* Prefer older API unless we have to pass a flag.  */
4153 4154 4155
    if ((nfds ? virDomainCreateWithFiles(dom, nfds, fds, flags) :
         (flags ? virDomainCreateWithFlags(dom, flags)
          : virDomainCreate(dom))) < 0) {
4156 4157 4158 4159
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
        goto cleanup;
    }

4160
 started:
P
Pino Toscano 已提交
4161 4162
    vshPrintExtra(ctl, _("Domain %s started\n"),
                  virDomainGetName(dom));
4163 4164 4165 4166 4167 4168 4169
#ifndef WIN32
    if (console && !cmdRunConsole(ctl, dom, NULL, 0))
        goto cleanup;
#endif

    ret = true;

4170
 cleanup:
4171
    virshDomainFree(dom);
4172
    VIR_FREE(fds);
4173 4174 4175 4176 4177 4178 4179
    return ret;
}

/*
 * "save" command
 */
static const vshCmdInfo info_save[] = {
4180 4181 4182 4183 4184 4185 4186
    {.name = "help",
     .data = N_("save a domain state to a file")
    },
    {.name = "desc",
     .data = N_("Save the RAM state of a running domain.")
    },
    {.name = NULL}
4187 4188 4189
};

static const vshCmdOptDef opts_save[] = {
4190
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
4191
    VIRSH_COMMON_OPT_FILE(N_("where to save the data")),
M
Martin Kletzander 已提交
4192 4193 4194 4195
    {.name = "bypass-cache",
     .type = VSH_OT_BOOL,
     .help = N_("avoid file system cache when saving")
    },
4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212
    {.name = "xml",
     .type = VSH_OT_STRING,
     .help = N_("filename containing updated XML for the target")
    },
    {.name = "running",
     .type = VSH_OT_BOOL,
     .help = N_("set domain to be running on restore")
    },
    {.name = "paused",
     .type = VSH_OT_BOOL,
     .help = N_("set domain to be paused on restore")
    },
    {.name = "verbose",
     .type = VSH_OT_BOOL,
     .help = N_("display the progress of save")
    },
    {.name = NULL}
4213 4214 4215 4216 4217
};

static void
doSave(void *opaque)
{
4218
    virshCtrlData *data = opaque;
4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
    char ret = '1';
    virDomainPtr dom = NULL;
    const char *name = NULL;
    const char *to = NULL;
    unsigned int flags = 0;
    const char *xmlfile = NULL;
    char *xml = NULL;
    sigset_t sigmask, oldsigmask;

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

4235
    if (vshCommandOptStringReq(ctl, cmd, "file", &to) < 0)
4236 4237 4238 4239 4240 4241 4242 4243 4244
        goto out;

    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;

4245
    if (vshCommandOptStringReq(ctl, cmd, "xml", &xmlfile) < 0)
4246 4247
        goto out;

4248
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
4249 4250 4251
        goto out;

    if (xmlfile &&
4252
        virFileReadAll(xmlfile, VSH_MAX_XML_FILE, &xml) < 0) {
4253
        vshReportError(ctl);
4254
        goto out;
4255
    }
4256 4257 4258 4259 4260 4261 4262 4263 4264 4265

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
         : virDomainSave(dom, to)) < 0) {
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
        goto out;
    }

    ret = '0';

4266
 out:
4267
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
4268
 out_sig:
4269
    virshDomainFree(dom);
4270 4271 4272 4273
    VIR_FREE(xml);
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

4274 4275
typedef void (*jobWatchTimeoutFunc)(vshControl *ctl, virDomainPtr dom,
                                    void *opaque);
E
Eric Blake 已提交
4276

E
Eric Blake 已提交
4277
static bool
4278 4279 4280 4281 4282 4283 4284 4285
virshWatchJob(vshControl *ctl,
              virDomainPtr dom,
              bool verbose,
              int pipe_fd,
              int timeout_ms,
              jobWatchTimeoutFunc timeout_func,
              void *opaque,
              const char *label)
E
Eric Blake 已提交
4286 4287 4288
{
    struct sigaction sig_action;
    struct sigaction old_sig_action;
4289 4290
    struct pollfd pollfd[2] = {{.fd = pipe_fd, .events = POLLIN, .revents = 0},
                               {.fd = STDIN_FILENO, .events = POLLIN, .revents = 0}};
E
Eric Blake 已提交
4291 4292 4293 4294 4295 4296
    struct timeval start, curr;
    virDomainJobInfo jobinfo;
    int ret = -1;
    char retchar;
    bool functionReturn = false;
    sigset_t sigmask, oldsigmask;
4297
    bool jobStarted = false;
4298
    nfds_t npollfd = 2;
E
Eric Blake 已提交
4299 4300 4301 4302 4303

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);

    intCaught = 0;
4304
    sig_action.sa_sigaction = virshCatchInt;
E
Eric Blake 已提交
4305 4306 4307 4308
    sig_action.sa_flags = SA_SIGINFO;
    sigemptyset(&sig_action.sa_mask);
    sigaction(SIGINT, &sig_action, &old_sig_action);

4309 4310 4311 4312
    /* don't poll on STDIN if we are not using a terminal */
    if (!vshTTYAvailable(ctl))
        npollfd = 1;

E
Eric Blake 已提交
4313 4314
    GETTIMEOFDAY(&start);
    while (1) {
4315
        ret = poll((struct pollfd *)&pollfd, npollfd, 500);
E
Eric Blake 已提交
4316
        if (ret > 0) {
4317 4318
            if (pollfd[1].revents & POLLIN &&
                saferead(STDIN_FILENO, &retchar, sizeof(retchar)) > 0) {
4319
                if (vshTTYIsInterruptCharacter(ctl, retchar))
4320
                    virDomainAbortJob(dom);
4321
                continue;
4322 4323 4324
            }

            if (pollfd[0].revents & POLLIN &&
E
Eric Blake 已提交
4325 4326 4327 4328
                saferead(pipe_fd, &retchar, sizeof(retchar)) > 0 &&
                retchar == '0') {
                if (verbose) {
                    /* print [100 %] */
4329
                    virshPrintJobProgress(label, 0, 1);
E
Eric Blake 已提交
4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341
                }
                break;
            }
            goto cleanup;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                }
4342
                continue;
E
Eric Blake 已提交
4343 4344 4345 4346 4347
            }
            goto cleanup;
        }

        GETTIMEOFDAY(&curr);
4348 4349 4350
        if (timeout_ms && (((int)(curr.tv_sec - start.tv_sec)  * 1000 +
                            (int)(curr.tv_usec - start.tv_usec) / 1000) >
                           timeout_ms)) {
E
Eric Blake 已提交
4351 4352 4353 4354
            /* suspend the domain when migration timeouts. */
            vshDebug(ctl, VSH_ERR_DEBUG, "%s timeout", label);
            if (timeout_func)
                (timeout_func)(ctl, dom, opaque);
4355
            timeout_ms = 0;
E
Eric Blake 已提交
4356 4357
        }

4358
        if (verbose || !jobStarted) {
E
Eric Blake 已提交
4359 4360 4361
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
4362
            if (ret == 0) {
4363
                if (verbose && jobinfo.dataTotal > 0)
4364 4365
                    virshPrintJobProgress(label, jobinfo.dataRemaining,
                                          jobinfo.dataTotal);
4366 4367 4368 4369 4370 4371 4372 4373 4374 4375

                if (!jobStarted &&
                    (jobinfo.type == VIR_DOMAIN_JOB_BOUNDED ||
                     jobinfo.type == VIR_DOMAIN_JOB_UNBOUNDED)) {
                    vshTTYDisableInterrupt(ctl);
                    jobStarted = true;
                }
            } else {
                vshResetLibvirtError();
            }
E
Eric Blake 已提交
4376 4377 4378 4379 4380
        }
    }

    functionReturn = true;

4381
 cleanup:
E
Eric Blake 已提交
4382
    sigaction(SIGINT, &old_sig_action, NULL);
4383
    vshTTYRestore(ctl);
E
Eric Blake 已提交
4384 4385 4386
    return functionReturn;
}

4387 4388 4389 4390 4391 4392 4393 4394
static bool
cmdSave(vshControl *ctl, const vshCmd *cmd)
{
    bool ret = false;
    virDomainPtr dom = NULL;
    int p[2] = {-1. -1};
    virThread workerThread;
    bool verbose = false;
4395
    virshCtrlData data;
4396 4397 4398
    const char *to = NULL;
    const char *name = NULL;

4399
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
4400 4401
        return false;

4402
    if (vshCommandOptStringReq(ctl, cmd, "file", &to) < 0)
4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420
        goto cleanup;

    if (vshCommandOptBool(cmd, "verbose"))
        verbose = true;

    if (pipe(p) < 0)
        goto cleanup;

    data.ctl = ctl;
    data.cmd = cmd;
    data.writefd = p[1];

    if (virThreadCreate(&workerThread,
                        true,
                        doSave,
                        &data) < 0)
        goto cleanup;

4421
    ret = virshWatchJob(ctl, dom, verbose, p[0], 0, NULL, NULL, _("Save"));
4422 4423 4424 4425

    virThreadJoin(&workerThread);

    if (ret)
P
Pino Toscano 已提交
4426
        vshPrintExtra(ctl, _("\nDomain %s saved to %s\n"), name, to);
4427

4428
 cleanup:
4429
    virshDomainFree(dom);
4430 4431 4432 4433 4434 4435 4436
    return ret;
}

/*
 * "save-image-dumpxml" command
 */
static const vshCmdInfo info_save_image_dumpxml[] = {
4437 4438 4439 4440 4441 4442 4443
    {.name = "help",
     .data = N_("saved state domain information in XML")
    },
    {.name = "desc",
     .data = N_("Dump XML of domain information for a saved state file to stdout.")
    },
    {.name = NULL}
4444 4445 4446
};

static const vshCmdOptDef opts_save_image_dumpxml[] = {
4447
    VIRSH_COMMON_OPT_FILE(N_("saved state file to read")),
4448 4449 4450 4451 4452
    {.name = "security-info",
     .type = VSH_OT_BOOL,
     .help = N_("include security sensitive information in XML dump")
    },
    {.name = NULL}
4453 4454 4455 4456 4457 4458 4459 4460 4461
};

static bool
cmdSaveImageDumpxml(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
    unsigned int flags = 0;
    char *xml = NULL;
4462
    virshControlPtr priv = ctl->privData;
4463 4464 4465 4466

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;

4467
    if (vshCommandOptStringReq(ctl, cmd, "file", &file) < 0)
4468 4469
        return false;

4470
    xml = virDomainSaveImageGetXMLDesc(priv->conn, file, flags);
4471 4472 4473 4474 4475 4476
    if (!xml)
        goto cleanup;

    vshPrint(ctl, "%s", xml);
    ret = true;

4477
 cleanup:
4478 4479 4480 4481 4482 4483 4484 4485
    VIR_FREE(xml);
    return ret;
}

/*
 * "save-image-define" command
 */
static const vshCmdInfo info_save_image_define[] = {
4486 4487 4488 4489 4490 4491 4492
    {.name = "help",
     .data = N_("redefine the XML for a domain's saved state file")
    },
    {.name = "desc",
     .data = N_("Replace the domain XML associated with a saved state file")
    },
    {.name = NULL}
4493 4494 4495
};

static const vshCmdOptDef opts_save_image_define[] = {
4496
    VIRSH_COMMON_OPT_FILE(N_("saved state file to modify")),
4497
    {.name = "xml",
4498
     .type = VSH_OT_DATA,
4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510
     .flags = VSH_OFLAG_REQ,
     .help = N_("filename containing updated XML for the target")
    },
    {.name = "running",
     .type = VSH_OT_BOOL,
     .help = N_("set domain to be running on restore")
    },
    {.name = "paused",
     .type = VSH_OT_BOOL,
     .help = N_("set domain to be paused on restore")
    },
    {.name = NULL}
4511 4512 4513 4514 4515 4516 4517 4518 4519 4520
};

static bool
cmdSaveImageDefine(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
    const char *xmlfile = NULL;
    char *xml = NULL;
    unsigned int flags = 0;
4521
    virshControlPtr priv = ctl->privData;
4522 4523 4524 4525 4526 4527

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;

4528
    if (vshCommandOptStringReq(ctl, cmd, "file", &file) < 0)
4529 4530
        return false;

4531
    if (vshCommandOptStringReq(ctl, cmd, "xml", &xmlfile) < 0)
4532 4533
        return false;

4534
    if (virFileReadAll(xmlfile, VSH_MAX_XML_FILE, &xml) < 0)
4535 4536
        goto cleanup;

4537
    if (virDomainSaveImageDefineXML(priv->conn, file, xml, flags) < 0) {
4538 4539 4540 4541
        vshError(ctl, _("Failed to update %s"), file);
        goto cleanup;
    }

P
Pino Toscano 已提交
4542
    vshPrintExtra(ctl, _("State file %s updated.\n"), file);
4543 4544
    ret = true;

4545
 cleanup:
4546 4547 4548 4549 4550 4551 4552 4553
    VIR_FREE(xml);
    return ret;
}

/*
 * "save-image-edit" command
 */
static const vshCmdInfo info_save_image_edit[] = {
4554 4555 4556 4557 4558 4559 4560
    {.name = "help",
     .data = N_("edit XML for a domain's saved state file")
    },
    {.name = "desc",
     .data = N_("Edit the domain XML associated with a saved state file")
    },
    {.name = NULL}
4561 4562 4563
};

static const vshCmdOptDef opts_save_image_edit[] = {
4564
    VIRSH_COMMON_OPT_FILE(N_("saved state file to edit")),
4565 4566 4567 4568 4569 4570 4571 4572 4573
    {.name = "running",
     .type = VSH_OT_BOOL,
     .help = N_("set domain to be running on restore")
    },
    {.name = "paused",
     .type = VSH_OT_BOOL,
     .help = N_("set domain to be paused on restore")
    },
    {.name = NULL}
4574 4575 4576 4577 4578 4579 4580 4581 4582
};

static bool
cmdSaveImageEdit(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
    unsigned int getxml_flags = VIR_DOMAIN_XML_SECURE;
    unsigned int define_flags = 0;
4583
    virshControlPtr priv = ctl->privData;
4584 4585 4586 4587 4588 4589 4590 4591 4592 4593

    if (vshCommandOptBool(cmd, "running"))
        define_flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        define_flags |= VIR_DOMAIN_SAVE_PAUSED;

    /* Normally, we let the API reject mutually exclusive flags.
     * However, in the edit cycle, we let the user retry if the define
     * step fails, but the define step will always fail on invalid
     * flags, so we reject it up front to avoid looping.  */
4594
    VSH_EXCLUSIVE_OPTIONS("running", "paused");
4595

4596
    if (vshCommandOptStringReq(ctl, cmd, "file", &file) < 0)
4597 4598 4599
        return false;

#define EDIT_GET_XML \
4600
    virDomainSaveImageGetXMLDesc(priv->conn, file, getxml_flags)
4601 4602 4603 4604 4605 4606
#define EDIT_NOT_CHANGED \
    do { \
        vshPrintExtra(ctl, _("Saved image %s XML configuration " \
                             "not changed.\n"), file); \
        ret = true; \
        goto edit_cleanup; \
4607
    } while (0)
4608
#define EDIT_DEFINE \
4609
    (virDomainSaveImageDefineXML(priv->conn, file, doc_edited, define_flags) == 0)
4610 4611
#include "virsh-edit.c"

4612
    vshPrintExtra(ctl, _("State file %s edited.\n"), file);
4613 4614
    ret = true;

4615
 cleanup:
4616 4617 4618 4619 4620 4621 4622
    return ret;
}

/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
4623 4624 4625 4626 4627
    {.name = "help",
     .data = N_("managed save of a domain state")
    },
    {.name = "desc",
     .data = N_("Save and destroy a running domain, so it can be restarted from\n"
4628 4629
                "    the same state at a later time.  When the virsh 'start'\n"
                "    command is next run for the domain, it will automatically\n"
4630 4631 4632
                "    be started from this saved state.")
    },
    {.name = NULL}
4633 4634 4635
};

static const vshCmdOptDef opts_managedsave[] = {
4636
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
M
Martin Kletzander 已提交
4637 4638 4639 4640
    {.name = "bypass-cache",
     .type = VSH_OT_BOOL,
     .help = N_("avoid file system cache when saving")
    },
4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653
    {.name = "running",
     .type = VSH_OT_BOOL,
     .help = N_("set domain to be running on next start")
    },
    {.name = "paused",
     .type = VSH_OT_BOOL,
     .help = N_("set domain to be paused on next start")
    },
    {.name = "verbose",
     .type = VSH_OT_BOOL,
     .help = N_("display the progress of save")
    },
    {.name = NULL}
4654 4655 4656 4657 4658 4659
};

static void
doManagedsave(void *opaque)
{
    char ret = '1';
4660
    virshCtrlData *data = opaque;
4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
    virDomainPtr dom = NULL;
    const char *name;
    unsigned int flags = 0;
    sigset_t sigmask, oldsigmask;

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

    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;

4680
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
4681 4682 4683 4684 4685 4686 4687 4688
        goto out;

    if (virDomainManagedSave(dom, flags) < 0) {
        vshError(ctl, _("Failed to save domain %s state"), name);
        goto out;
    }

    ret = '0';
4689
 out:
4690
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
4691
 out_sig:
4692
    virshDomainFree(dom);
4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

static bool
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int p[2] = { -1, -1};
    bool ret = false;
    bool verbose = false;
    const char *name = NULL;
4704
    virshCtrlData data;
4705 4706
    virThread workerThread;

4707
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725
        return false;

    if (vshCommandOptBool(cmd, "verbose"))
        verbose = true;

    if (pipe(p) < 0)
        goto cleanup;

    data.ctl = ctl;
    data.cmd = cmd;
    data.writefd = p[1];

    if (virThreadCreate(&workerThread,
                        true,
                        doManagedsave,
                        &data) < 0)
        goto cleanup;

4726 4727
    ret = virshWatchJob(ctl, dom, verbose, p[0], 0,
                        NULL, NULL, _("Managedsave"));
4728 4729 4730 4731

    virThreadJoin(&workerThread);

    if (ret)
P
Pino Toscano 已提交
4732
        vshPrintExtra(ctl, _("\nDomain %s state saved by libvirt\n"), name);
4733

4734
 cleanup:
4735
    virshDomainFree(dom);
4736 4737 4738 4739 4740 4741 4742 4743 4744
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
    return ret;
}

/*
 * "managedsave-remove" command
 */
static const vshCmdInfo info_managedsaveremove[] = {
4745 4746 4747 4748 4749 4750 4751
    {.name = "help",
     .data = N_("Remove managed save of a domain")
    },
    {.name = "desc",
     .data = N_("Remove an existing managed save state file from a domain")
    },
    {.name = NULL}
4752 4753 4754
};

static const vshCmdOptDef opts_managedsaveremove[] = {
4755
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
4756
    {.name = NULL}
4757 4758 4759 4760 4761 4762 4763 4764 4765 4766
};

static bool
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name;
    bool ret = false;
    int hassave;

4767
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782
        return false;

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
        goto cleanup;
    }

    if (hassave) {
        if (virDomainManagedSaveRemove(dom, 0) < 0) {
            vshError(ctl, _("Failed to remove managed save image for domain %s"),
                     name);
            goto cleanup;
        }
        else
P
Pino Toscano 已提交
4783
            vshPrintExtra(ctl, _("Removed managedsave image for domain %s"), name);
4784 4785
    }
    else
P
Pino Toscano 已提交
4786 4787
        vshPrintExtra(ctl, _("Domain %s has no manage save image; removal skipped"),
                      name);
4788 4789 4790

    ret = true;

4791
 cleanup:
4792
    virshDomainFree(dom);
4793 4794 4795
    return ret;
}

4796 4797 4798 4799
/*
 * "managedsave-edit" command
 */
static const vshCmdInfo info_managed_save_edit[] = {
4800 4801 4802 4803 4804 4805 4806
    {.name = "help",
     .data = N_("edit XML for a domain's managed save state file")
    },
    {.name = "desc",
     .data = N_("Edit the domain XML associated with the managed save state file")
    },
    {.name = NULL}
4807 4808 4809
};

static const vshCmdOptDef opts_managed_save_edit[] = {
4810
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841
    {.name = "running",
     .type = VSH_OT_BOOL,
     .help = N_("set domain to be running on start")
    },
    {.name = "paused",
     .type = VSH_OT_BOOL,
     .help = N_("set domain to be paused on start")
    },
    {.name = NULL}
};

static bool
cmdManagedSaveEdit(vshControl *ctl, const vshCmd *cmd)
{
    bool ret = false;
    virDomainPtr dom = NULL;
    unsigned int getxml_flags = VIR_DOMAIN_XML_SECURE;
    unsigned int define_flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        define_flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        define_flags |= VIR_DOMAIN_SAVE_PAUSED;

    VSH_EXCLUSIVE_OPTIONS("running", "paused");

    dom = virshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

#define EDIT_GET_XML virDomainManagedSaveGetXMLDesc(dom, getxml_flags)
4842 4843
#define EDIT_NOT_CHANGED \
    do { \
4844
        vshPrintExtra(ctl, _("Managed save image of domain %s XML configuration " \
4845 4846 4847
                             "not changed.\n"), virDomainGetName(dom)); \
        ret = true; \
        goto edit_cleanup; \
4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861
    } while (0)
#define EDIT_DEFINE \
    (virDomainManagedSaveDefineXML(dom, doc_edited, define_flags) == 0)
#include "virsh-edit.c"

    vshPrintExtra(ctl, _("Managed save image of Domain %s XML configuration edited.\n"),
                  virDomainGetName(dom));
    ret = true;

 cleanup:
    virshDomainFree(dom);
    return ret;
}

4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875
/*
 * "managedsave-dumpxml" command
 */
static const vshCmdInfo info_managed_save_dumpxml[] = {
   {.name = "help",
    .data = N_("Domain information of managed save state file in XML")
   },
   {.name = "desc",
    .data = N_("Dump XML of domain information for a managed save state file to stdout.")
   },
   {.name = NULL}
};

static const vshCmdOptDef opts_managed_save_dumpxml[] = {
4876
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909
    {.name = "security-info",
     .type = VSH_OT_BOOL,
     .help = N_("include security sensitive information in XML dump")
    },
    {.name = NULL}
};

static bool
cmdManagedSaveDumpxml(vshControl *ctl, const vshCmd *cmd)
{
    bool ret = false;
    virDomainPtr dom = NULL;
    unsigned int flags = 0;
    char *xml = NULL;

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        goto cleanup;

    if (!(xml = virDomainManagedSaveGetXMLDesc(dom, flags)))
        goto cleanup;

    vshPrint(ctl, "%s", xml);
    ret = true;

 cleanup:
    virshDomainFree(dom);
    VIR_FREE(xml);
    return ret;
}

4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923
/*
 * "managedsave-define" command
 */
static const vshCmdInfo info_managed_save_define[] = {
    {.name = "help",
     .data = N_("redefine the XML for a domain's managed save state file")
    },
    {.name = "desc",
     .data = N_("Replace the domain XML associated with a managed save state file")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_managed_save_define[] = {
4924
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981
    {.name = "xml",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("filename containing updated XML for the target")
    },
    {.name = "running",
     .type = VSH_OT_BOOL,
     .help = N_("set domain to be running on start")
    },
    {.name = "paused",
     .type = VSH_OT_BOOL,
     .help = N_("set domain to be paused on start")
    },
    {.name = NULL}
};

static bool
cmdManagedSaveDefine(vshControl *ctl, const vshCmd *cmd)
{
    bool ret = false;
    virDomainPtr dom = NULL;
    const char *xmlfile = NULL;
    char *xml = NULL;
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;

    VSH_EXCLUSIVE_OPTIONS("running", "paused");

    if (vshCommandOptStringReq(ctl, cmd, "xml", &xmlfile) < 0)
        return false;

    if (virFileReadAll(xmlfile, VSH_MAX_XML_FILE, &xml) < 0)
        return false;

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        goto cleanup;

    if (virDomainManagedSaveDefineXML(dom, xml, flags) < 0) {
        vshError(ctl, _("Failed to update %s XML configuration"),
                        virDomainGetName(dom));
        goto cleanup;
    }

    vshPrintExtra(ctl, _("Managed save state file of domain %s updated.\n"),
                         virDomainGetName(dom));
    ret = true;

 cleanup:
    virshDomainFree(dom);
    VIR_FREE(xml);
    return ret;
}

4982 4983 4984 4985
/*
 * "schedinfo" command
 */
static const vshCmdInfo info_schedinfo[] = {
4986 4987 4988 4989 4990 4991 4992
    {.name = "help",
     .data = N_("show/set scheduler parameters")
    },
    {.name = "desc",
     .data = N_("Show/Set scheduler parameters.")
    },
    {.name = NULL}
4993 4994 4995
};

static const vshCmdOptDef opts_schedinfo[] = {
4996
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
4997 4998
    {.name = "weight",
     .type = VSH_OT_INT,
4999
     .flags = VSH_OFLAG_REQ_OPT,
5000 5001 5002 5003
     .help = N_("weight for XEN_CREDIT")
    },
    {.name = "cap",
     .type = VSH_OT_INT,
5004
     .flags = VSH_OFLAG_REQ_OPT,
5005 5006
     .help = N_("cap for XEN_CREDIT")
    },
5007
    VIRSH_COMMON_OPT_CURRENT(N_("get/set current scheduler info")),
5008
    VIRSH_COMMON_OPT_CONFIG(N_("get/set value to be used on next boot")),
5009
    VIRSH_COMMON_OPT_LIVE(N_("get/set value from running domain")),
5010 5011 5012 5013 5014
    {.name = "set",
     .type = VSH_OT_ARGV,
     .flags = VSH_OFLAG_NONE,
     .help = N_("parameter=value")
    },
5015
    {.name = NULL}
5016 5017
};

5018 5019 5020 5021 5022 5023 5024 5025 5026
static int
cmdSchedInfoUpdateOne(vshControl *ctl,
                      virTypedParameterPtr src_params, int nsrc_params,
                      virTypedParameterPtr *params,
                      int *nparams, int *maxparams,
                      const char *field, const char *value)
{
    virTypedParameterPtr param;
    int ret = -1;
5027
    size_t i;
5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038

    for (i = 0; i < nsrc_params; i++) {
        param = &(src_params[i]);

        if (STRNEQ(field, param->field))
            continue;

        if (virTypedParamsAddFromString(params, nparams, maxparams,
                                        field, param->type,
                                        value) < 0) {
            vshSaveLibvirtError();
5039
            return -1;
5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050
        }
        ret = 0;
        break;
    }

    if (ret < 0)
        vshError(ctl, _("invalid scheduler option: %s"), field);

    return ret;
}

5051 5052
static int
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
5053 5054
                   virTypedParameterPtr src_params, int nsrc_params,
                   virTypedParameterPtr *update_params)
5055
{
5056 5057
    char *set_field = NULL;
    char *set_val = NULL;
5058 5059
    const char *val = NULL;
    const vshCmdOpt *opt = NULL;
5060 5061
    virTypedParameterPtr params = NULL;
    int nparams = 0;
5062
    int maxparams = 0;
5063 5064 5065
    int ret = -1;
    int rv;

5066
    while ((opt = vshCommandOptArgv(ctl, cmd, opt))) {
J
Ján Tomko 已提交
5067
        set_field = g_strdup(opt->data);
5068
        if (!(set_val = strchr(set_field, '='))) {
5069 5070
            vshError(ctl, "%s", _("Invalid syntax for --set, "
                                  "expecting name=value"));
5071
            goto cleanup;
5072
        }
5073 5074 5075 5076

        *set_val = '\0';
        set_val++;

5077 5078 5079 5080
        if (cmdSchedInfoUpdateOne(ctl, src_params, nsrc_params,
                                  &params, &nparams, &maxparams,
                                  set_field, set_val) < 0)
            goto cleanup;
5081

5082 5083
        VIR_FREE(set_field);
    }
5084

5085 5086 5087 5088 5089 5090 5091
    rv = vshCommandOptStringReq(ctl, cmd, "cap", &val);
    if (rv < 0 ||
        (val &&
         cmdSchedInfoUpdateOne(ctl, src_params, nsrc_params,
                               &params, &nparams, &maxparams,
                               "cap", val) < 0))
        goto cleanup;
5092

5093 5094 5095 5096 5097 5098 5099
    rv = vshCommandOptStringReq(ctl, cmd, "weight", &val);
    if (rv < 0 ||
        (val &&
         cmdSchedInfoUpdateOne(ctl, src_params, nsrc_params,
                               &params, &nparams, &maxparams,
                               "weight", val) < 0))
        goto cleanup;
5100

5101
    ret = nparams;
5102
    *update_params = params;
5103 5104
    params = NULL;

5105
 cleanup:
5106
    VIR_FREE(set_field);
5107
    virTypedParamsFree(params, nparams);
5108
    return ret;
5109 5110 5111 5112 5113 5114 5115 5116
}

static bool
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
    virTypedParameterPtr params = NULL;
5117
    virTypedParameterPtr updates = NULL;
5118
    int nparams = 0;
5119
    int nupdates = 0;
5120 5121
    size_t i;
    int ret;
5122
    bool ret_val = false;
5123
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
5124 5125 5126 5127
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");

5128 5129 5130 5131 5132 5133 5134
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
5135

5136
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
5137 5138 5139 5140 5141
        return false;

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
    if (schedulertype != NULL) {
P
Peter Krempa 已提交
5142
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), schedulertype);
5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167
        VIR_FREE(schedulertype);
    } else {
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
        goto cleanup;
    }

    if (nparams) {
        params = vshMalloc(ctl, sizeof(*params) * nparams);

        memset(params, 0, sizeof(*params) * nparams);
        if (flags || current) {
            /* We cannot query both live and config at once, so settle
               on current in that case.  If we are setting, then the
               two values should match when we re-query; otherwise, we
               report the error later.  */
            ret = virDomainGetSchedulerParametersFlags(dom, params, &nparams,
                                                       ((live && config) ? 0
                                                        : flags));
        } else {
            ret = virDomainGetSchedulerParameters(dom, params, &nparams);
        }
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
5168 5169 5170
        if ((nupdates = cmdSchedInfoUpdate(ctl, cmd, params, nparams,
                                           &updates)) < 0)
            goto cleanup;
5171 5172

        /* Update parameters & refresh data */
5173
        if (nupdates > 0) {
5174
            if (flags || current)
5175 5176
                ret = virDomainSetSchedulerParametersFlags(dom, updates,
                                                           nupdates, flags);
5177
            else
5178 5179
                ret = virDomainSetSchedulerParameters(dom, updates, nupdates);

5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209
            if (ret == -1)
                goto cleanup;

            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
            if (ret == -1)
                goto cleanup;
        } else {
            /* When not doing --set, --live and --config do not mix.  */
            if (live && config) {
                vshError(ctl, "%s",
                         _("cannot query both live and config at once"));
                goto cleanup;
            }
        }

        ret_val = true;
        for (i = 0; i < nparams; i++) {
            char *str = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
            VIR_FREE(str);
        }
    }

 cleanup:
5210 5211
    virTypedParamsFree(params, nparams);
    virTypedParamsFree(updates, nupdates);
5212
    virshDomainFree(dom);
5213 5214 5215 5216 5217 5218 5219
    return ret_val;
}

/*
 * "restore" command
 */
static const vshCmdInfo info_restore[] = {
5220 5221 5222 5223 5224 5225 5226
    {.name = "help",
     .data = N_("restore a domain from a saved state in a file")
    },
    {.name = "desc",
     .data = N_("Restore a domain.")
    },
    {.name = NULL}
5227 5228 5229
};

static const vshCmdOptDef opts_restore[] = {
5230
    VIRSH_COMMON_OPT_FILE(N_("the state to restore")),
5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247
    {.name = "bypass-cache",
     .type = VSH_OT_BOOL,
     .help = N_("avoid file system cache when restoring")
    },
    {.name = "xml",
     .type = VSH_OT_STRING,
     .help = N_("filename containing updated XML for the target")
    },
    {.name = "running",
     .type = VSH_OT_BOOL,
     .help = N_("restore domain into running state")
    },
    {.name = "paused",
     .type = VSH_OT_BOOL,
     .help = N_("restore domain into paused state")
    },
    {.name = NULL}
5248 5249 5250 5251 5252 5253 5254 5255 5256 5257
};

static bool
cmdRestore(vshControl *ctl, const vshCmd *cmd)
{
    const char *from = NULL;
    bool ret = false;
    unsigned int flags = 0;
    const char *xmlfile = NULL;
    char *xml = NULL;
5258
    virshControlPtr priv = ctl->privData;
5259

5260
    if (vshCommandOptStringReq(ctl, cmd, "file", &from) < 0)
5261 5262 5263 5264 5265 5266 5267 5268 5269
        return false;

    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;

5270
    if (vshCommandOptStringReq(ctl, cmd, "xml", &xmlfile) < 0)
5271 5272 5273
        return false;

    if (xmlfile &&
5274
        virFileReadAll(xmlfile, VSH_MAX_XML_FILE, &xml) < 0)
5275 5276 5277
        goto cleanup;

    if (((flags || xml)
5278 5279
         ? virDomainRestoreFlags(priv->conn, from, xml, flags)
         : virDomainRestore(priv->conn, from)) < 0) {
5280 5281 5282 5283
        vshError(ctl, _("Failed to restore domain from %s"), from);
        goto cleanup;
    }

P
Pino Toscano 已提交
5284
    vshPrintExtra(ctl, _("Domain restored from %s\n"), from);
5285 5286
    ret = true;

5287
 cleanup:
5288 5289 5290 5291 5292 5293 5294 5295
    VIR_FREE(xml);
    return ret;
}

/*
 * "dump" command
 */
static const vshCmdInfo info_dump[] = {
5296 5297 5298 5299 5300 5301 5302
    {.name = "help",
     .data = N_("dump the core of a domain to a file for analysis")
    },
    {.name = "desc",
     .data = N_("Core dump a domain.")
    },
    {.name = NULL}
5303 5304 5305
};

static const vshCmdOptDef opts_dump[] = {
5306
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
5307
    VIRSH_COMMON_OPT_FILE(N_("where to dump the core")),
5308
    VIRSH_COMMON_OPT_LIVE(N_("perform a live core dump if supported")),
5309 5310 5311 5312 5313 5314
    {.name = "crash",
     .type = VSH_OT_BOOL,
     .help = N_("crash the domain after core dump")
    },
    {.name = "bypass-cache",
     .type = VSH_OT_BOOL,
5315
     .help = N_("avoid file system cache when dumping")
5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328
    },
    {.name = "reset",
     .type = VSH_OT_BOOL,
     .help = N_("reset the domain after core dump")
    },
    {.name = "verbose",
     .type = VSH_OT_BOOL,
     .help = N_("display the progress of dump")
    },
    {.name = "memory-only",
     .type = VSH_OT_BOOL,
     .help = N_("dump domain's memory only")
    },
5329
    {.name = "format",
5330
     .type = VSH_OT_STRING,
5331 5332
     .help = N_("specify the format of memory-only dump")
    },
5333
    {.name = NULL}
5334 5335 5336 5337 5338 5339
};

static void
doDump(void *opaque)
{
    char ret = '1';
5340
    virshCtrlData *data = opaque;
5341 5342 5343 5344 5345 5346 5347
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
    virDomainPtr dom = NULL;
    sigset_t sigmask, oldsigmask;
    const char *name = NULL;
    const char *to = NULL;
    unsigned int flags = 0;
5348 5349
    const char *format = NULL;
    unsigned int dumpformat = VIR_DOMAIN_CORE_DUMP_FORMAT_RAW;
5350 5351 5352 5353 5354 5355

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

5356
    if (vshCommandOptStringReq(ctl, cmd, "file", &to) < 0)
5357 5358
        goto out;

5359
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372
        goto out;

    if (vshCommandOptBool(cmd, "live"))
        flags |= VIR_DUMP_LIVE;
    if (vshCommandOptBool(cmd, "crash"))
        flags |= VIR_DUMP_CRASH;
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DUMP_BYPASS_CACHE;
    if (vshCommandOptBool(cmd, "reset"))
        flags |= VIR_DUMP_RESET;
    if (vshCommandOptBool(cmd, "memory-only"))
        flags |= VIR_DUMP_MEMORY_ONLY;

5373 5374 5375 5376 5377 5378
    if (vshCommandOptBool(cmd, "format")) {
        if (!(flags & VIR_DUMP_MEMORY_ONLY)) {
            vshError(ctl, "%s", _("--format only works with --memory-only"));
            goto out;
        }

5379
        if (vshCommandOptStringQuiet(ctl, cmd, "format", &format) > 0) {
5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406
            if (STREQ(format, "kdump-zlib")) {
                dumpformat = VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_ZLIB;
            } else if (STREQ(format, "kdump-lzo")) {
                dumpformat = VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_LZO;
            } else if (STREQ(format, "kdump-snappy")) {
                dumpformat = VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_SNAPPY;
            } else if (STREQ(format, "elf")) {
                dumpformat = VIR_DOMAIN_CORE_DUMP_FORMAT_RAW;
            } else {
                vshError(ctl, _("format '%s' is not supported, expecting "
                                "'kdump-zlib', 'kdump-lzo', 'kdump-snappy' "
                                "or 'elf'"), format);
                goto out;
            }
        }
    }

    if (dumpformat != VIR_DOMAIN_CORE_DUMP_FORMAT_RAW) {
        if (virDomainCoreDumpWithFormat(dom, to, dumpformat, flags) < 0) {
            vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
            goto out;
        }
    } else {
        if (virDomainCoreDump(dom, to, flags) < 0) {
            vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
            goto out;
        }
5407 5408 5409
    }

    ret = '0';
5410
 out:
5411
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
5412
 out_sig:
5413
    if (dom)
5414
        virshDomainFree(dom);
5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

static bool
cmdDump(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int p[2] = { -1, -1};
    bool ret = false;
    bool verbose = false;
    const char *name = NULL;
    const char *to = NULL;
5427
    virshCtrlData data;
5428 5429
    virThread workerThread;

5430
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
5431 5432
        return false;

5433
    if (vshCommandOptStringReq(ctl, cmd, "file", &to) < 0)
5434
        goto cleanup;
5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451

    if (vshCommandOptBool(cmd, "verbose"))
        verbose = true;

    if (pipe(p) < 0)
        goto cleanup;

    data.ctl = ctl;
    data.cmd = cmd;
    data.writefd = p[1];

    if (virThreadCreate(&workerThread,
                        true,
                        doDump,
                        &data) < 0)
        goto cleanup;

5452
    ret = virshWatchJob(ctl, dom, verbose, p[0], 0, NULL, NULL, _("Dump"));
5453 5454 5455 5456

    virThreadJoin(&workerThread);

    if (ret)
P
Pino Toscano 已提交
5457
        vshPrintExtra(ctl, _("\nDomain %s dumped to %s\n"), name, to);
5458

5459
 cleanup:
5460
    virshDomainFree(dom);
5461 5462 5463 5464 5465 5466
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
    return ret;
}

static const vshCmdInfo info_screenshot[] = {
5467 5468 5469 5470 5471 5472 5473 5474
    {.name = "help",
     .data = N_("take a screenshot of a current domain console and store it "
                "into a file")
    },
    {.name = "desc",
     .data = N_("screenshot of a current domain console")
    },
    {.name = NULL}
5475 5476 5477
};

static const vshCmdOptDef opts_screenshot[] = {
5478
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
5479
    {.name = "file",
5480
     .type = VSH_OT_STRING,
5481 5482 5483 5484 5485 5486 5487
     .help = N_("where to store the screenshot")
    },
    {.name = "screen",
     .type = VSH_OT_INT,
     .help = N_("ID of a screen to take screenshot of")
    },
    {.name = NULL}
5488 5489 5490 5491 5492 5493
};

/**
 * Generate string: '<domain name>-<timestamp>[<extension>]'
 */
static char *
5494
virshGenFileName(vshControl *ctl, virDomainPtr dom, const char *mime)
5495 5496
{
    char timestr[100];
5497
    time_t cur_time;
5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512
    struct tm time_info;
    const char *ext = NULL;
    char *ret = NULL;

    if (!dom) {
        vshError(ctl, "%s", _("Invalid domain supplied"));
        return NULL;
    }

    if (STREQ(mime, "image/x-portable-pixmap"))
        ext = ".ppm";
    else if (STREQ(mime, "image/png"))
        ext = ".png";
    /* add mime type here */

5513
    time(&cur_time);
5514
    localtime_r(&cur_time, &time_info);
5515 5516
    strftime(timestr, sizeof(timestr), "%Y-%m-%d-%H:%M:%S", &time_info);

5517 5518
    ret = g_strdup_printf("%s-%s%s", virDomainGetName(dom), timestr,
                          NULLSTR_EMPTY(ext));
5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532

    return ret;
}

static bool
cmdScreenshot(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name = NULL;
    char *file = NULL;
    int fd = -1;
    virStreamPtr st = NULL;
    unsigned int screen = 0;
    unsigned int flags = 0; /* currently unused */
E
Eric Blake 已提交
5533
    bool ret = false;
5534 5535 5536
    bool created = false;
    bool generated = false;
    char *mime = NULL;
5537
    virshControlPtr priv = ctl->privData;
5538

5539
    if (vshCommandOptStringReq(ctl, cmd, "file", (const char **) &file) < 0)
5540 5541
        return false;

5542
    if (vshCommandOptUInt(ctl, cmd, "screen", &screen) < 0)
5543 5544
        return false;

5545
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
5546 5547
        return false;

5548
    if (!(st = virStreamNew(priv->conn, 0)))
5549
        goto cleanup;
5550 5551 5552 5553 5554 5555 5556 5557

    mime = virDomainScreenshot(dom, st, screen, flags);
    if (!mime) {
        vshError(ctl, _("could not take a screenshot of %s"), name);
        goto cleanup;
    }

    if (!file) {
5558
        if (!(file = virshGenFileName(ctl, dom, mime)))
5559
            goto cleanup;
5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572
        generated = true;
    }

    if ((fd = open(file, O_WRONLY|O_CREAT|O_EXCL, 0666)) < 0) {
        if (errno != EEXIST ||
            (fd = open(file, O_WRONLY|O_TRUNC, 0666)) < 0) {
            vshError(ctl, _("cannot create file %s"), file);
            goto cleanup;
        }
    } else {
        created = true;
    }

5573
    if (virStreamRecvAll(st, virshStreamSink, &fd) < 0) {
5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587
        vshError(ctl, _("could not receive data from domain %s"), name);
        goto cleanup;
    }

    if (VIR_CLOSE(fd) < 0) {
        vshError(ctl, _("cannot close file %s"), file);
        goto cleanup;
    }

    if (virStreamFinish(st) < 0) {
        vshError(ctl, _("cannot close stream on domain %s"), name);
        goto cleanup;
    }

P
Pino Toscano 已提交
5588
    vshPrintExtra(ctl, _("Screenshot saved to %s, with type of %s"), file, mime);
5589 5590
    ret = true;

5591
 cleanup:
5592 5593 5594 5595
    if (!ret && created)
        unlink(file);
    if (generated)
        VIR_FREE(file);
5596
    virshDomainFree(dom);
5597 5598 5599 5600 5601 5602 5603
    if (st)
        virStreamFree(st);
    VIR_FORCE_CLOSE(fd);
    VIR_FREE(mime);
    return ret;
}

5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617
/*
 * "set-lifecycle-action" command
 */
static const vshCmdInfo info_setLifecycleAction[] = {
    {.name = "help",
     .data = N_("change lifecycle actions")
    },
    {.name = "desc",
     .data = N_("Change lifecycle actions for the guest domain.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_setLifecycleAction[] = {
5618
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
5619
    {.name = "type",
5620
     .type = VSH_OT_DATA,
5621 5622 5623 5624
     .flags = VSH_OFLAG_REQ,
     .help = N_("lifecycle type to modify")
    },
    {.name = "action",
5625
     .type = VSH_OT_DATA,
5626 5627 5628 5629 5630 5631 5632 5633 5634
     .flags = VSH_OFLAG_REQ,
     .help = N_("lifecycle action to set")
    },
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
    {.name = NULL}
};

5635 5636
VIR_ENUM_IMPL(virDomainLifecycle,
              VIR_DOMAIN_LIFECYCLE_LAST,
5637 5638
              "poweroff",
              "reboot",
5639
              "crash");
5640

5641 5642
VIR_ENUM_IMPL(virDomainLifecycleAction,
              VIR_DOMAIN_LIFECYCLE_ACTION_LAST,
5643 5644 5645 5646 5647
              "destroy",
              "restart",
              "rename-restart",
              "preserve",
              "coredump-destroy",
5648
              "coredump-restart");
5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701

static bool
cmdSetLifecycleAction(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = true;
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
    const char *typeStr;
    const char *actionStr;
    unsigned int type;
    unsigned int action;
    unsigned int flags = 0;
    int tmpVal;

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

    if (vshCommandOptStringReq(ctl, cmd, "type", &typeStr) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "action", &actionStr) < 0) {
        return false;
    }

    if ((tmpVal = virDomainLifecycleTypeFromString(typeStr)) < 0) {
        vshError(ctl, _("Invalid lifecycle type '%s'."), typeStr);
        return false;
    }
    type = tmpVal;

    if ((tmpVal = virDomainLifecycleActionTypeFromString(actionStr)) < 0) {
        vshError(ctl, _("Invalid lifecycle action '%s'."), actionStr);
        return false;
    }
    action = tmpVal;

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    if (virDomainSetLifecycleAction(dom, type, action, flags) < 0) {
        vshError(ctl, "%s", _("Unable to change lifecycle action."));
        ret = false;
    }

    virshDomainFree(dom);
    return ret;
}

5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715
/*
 * "set-user-password" command
 */
static const vshCmdInfo info_set_user_password[] = {
    {.name = "help",
     .data = N_("set the user password inside the domain")
    },
    {.name = "desc",
     .data = N_("changes the password of the specified user inside the domain")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_set_user_password[] = {
5716
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752
    {.name = "user",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("the username")
    },
    {.name = "password",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("the new password")
    },
    {.name = "encrypted",
     .type = VSH_OT_BOOL,
     .help = N_("the password is already encrypted")
    },
    {.name = NULL}
};

static bool
cmdSetUserPassword(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name;
    const char *password = NULL;
    const char *user = NULL;
    unsigned int flags = 0;
    bool ret = false;

    if (vshCommandOptBool(cmd, "encrypted"))
        flags = VIR_DOMAIN_PASSWORD_ENCRYPTED;

    if (vshCommandOptStringReq(ctl, cmd, "user", &user) < 0)
        return false;

    if (vshCommandOptStringReq(ctl, cmd, "password", &password) < 0)
        return false;

5753
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
5754 5755 5756 5757 5758
        return false;

    if (virDomainSetUserPassword(dom, user, password, flags) < 0)
        goto cleanup;

P
Pino Toscano 已提交
5759
    vshPrintExtra(ctl, _("Password set successfully for %s in %s"), user, name);
5760 5761 5762
    ret = true;

 cleanup:
5763
    virshDomainFree(dom);
5764 5765
    return ret;
}
5766 5767 5768 5769
/*
 * "resume" command
 */
static const vshCmdInfo info_resume[] = {
5770 5771 5772 5773 5774 5775 5776
    {.name = "help",
     .data = N_("resume a domain")
    },
    {.name = "desc",
     .data = N_("Resume a previously suspended domain.")
    },
    {.name = NULL}
5777 5778 5779
};

static const vshCmdOptDef opts_resume[] = {
5780
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_PAUSED),
5781
    {.name = NULL}
5782 5783 5784 5785 5786 5787 5788 5789 5790
};

static bool
cmdResume(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = true;
    const char *name;

5791
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
5792 5793 5794
        return false;

    if (virDomainResume(dom) == 0) {
P
Pino Toscano 已提交
5795
        vshPrintExtra(ctl, _("Domain %s resumed\n"), name);
5796 5797 5798 5799 5800
    } else {
        vshError(ctl, _("Failed to resume domain %s"), name);
        ret = false;
    }

5801
    virshDomainFree(dom);
5802 5803 5804 5805 5806 5807 5808
    return ret;
}

/*
 * "shutdown" command
 */
static const vshCmdInfo info_shutdown[] = {
5809 5810 5811 5812 5813 5814 5815
    {.name = "help",
     .data = N_("gracefully shutdown a domain")
    },
    {.name = "desc",
     .data = N_("Run shutdown in the target domain.")
    },
    {.name = NULL}
5816 5817 5818
};

static const vshCmdOptDef opts_shutdown[] = {
5819
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
5820 5821
    {.name = "mode",
     .type = VSH_OT_STRING,
5822
     .completer = virshDomainShutdownModeCompleter,
5823
     .help = N_("shutdown mode: acpi|agent|initctl|signal|paravirt")
5824 5825
    },
    {.name = NULL}
5826 5827 5828 5829 5830
};

static bool
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
{
5831 5832
    virDomainPtr dom = NULL;
    bool ret = false;
5833 5834 5835 5836
    const char *name;
    const char *mode = NULL;
    int flags = 0;
    int rv;
5837
    char **modes = NULL, **tmp;
5838

5839
    if (vshCommandOptStringReq(ctl, cmd, "mode", &mode) < 0)
5840 5841
        return false;

5842
    if (mode && !(modes = virStringSplit(mode, ",", 0))) {
5843 5844 5845 5846 5847
        vshError(ctl, "%s", _("Cannot parse mode string"));
        return false;
    }

    tmp = modes;
5848
    while (tmp && *tmp) {
5849
        mode = *tmp;
5850 5851 5852 5853
        if (STREQ(mode, "acpi")) {
            flags |= VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN;
        } else if (STREQ(mode, "agent")) {
            flags |= VIR_DOMAIN_SHUTDOWN_GUEST_AGENT;
5854 5855 5856 5857
        } else if (STREQ(mode, "initctl")) {
            flags |= VIR_DOMAIN_SHUTDOWN_INITCTL;
        } else if (STREQ(mode, "signal")) {
            flags |= VIR_DOMAIN_SHUTDOWN_SIGNAL;
5858 5859
        } else if (STREQ(mode, "paravirt")) {
            flags |= VIR_DOMAIN_SHUTDOWN_PARAVIRT;
5860
        } else {
5861
            vshError(ctl, _("Unknown mode %s value, expecting "
5862 5863
                            "'acpi', 'agent', 'initctl', 'signal', "
                            "or 'paravirt'"), mode);
5864
            goto cleanup;
5865
        }
5866
        tmp++;
5867 5868
    }

5869
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
5870
        goto cleanup;
5871 5872 5873 5874 5875 5876

    if (flags)
        rv = virDomainShutdownFlags(dom, flags);
    else
        rv = virDomainShutdown(dom);
    if (rv == 0) {
P
Pino Toscano 已提交
5877
        vshPrintExtra(ctl, _("Domain %s is being shutdown\n"), name);
5878 5879
    } else {
        vshError(ctl, _("Failed to shutdown domain %s"), name);
5880
        goto cleanup;
5881 5882
    }

5883
    ret = true;
5884
 cleanup:
5885
    virshDomainFree(dom);
5886
    virStringListFree(modes);
5887 5888 5889 5890 5891 5892 5893
    return ret;
}

/*
 * "reboot" command
 */
static const vshCmdInfo info_reboot[] = {
5894 5895 5896 5897 5898 5899 5900
    {.name = "help",
     .data = N_("reboot a domain")
    },
    {.name = "desc",
     .data = N_("Run a reboot command in the target domain.")
    },
    {.name = NULL}
5901 5902 5903
};

static const vshCmdOptDef opts_reboot[] = {
5904
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
5905 5906
    {.name = "mode",
     .type = VSH_OT_STRING,
5907
     .completer = virshDomainShutdownModeCompleter,
5908
     .help = N_("shutdown mode: acpi|agent|initctl|signal|paravirt")
5909 5910
    },
    {.name = NULL}
5911 5912 5913 5914 5915
};

static bool
cmdReboot(vshControl *ctl, const vshCmd *cmd)
{
5916 5917
    virDomainPtr dom = NULL;
    bool ret = false;
5918 5919 5920
    const char *name;
    const char *mode = NULL;
    int flags = 0;
5921
    char **modes = NULL, **tmp;
5922

5923
    if (vshCommandOptStringReq(ctl, cmd, "mode", &mode) < 0)
5924 5925
        return false;

5926
    if (mode && !(modes = virStringSplit(mode, ",", 0))) {
5927 5928 5929 5930 5931
        vshError(ctl, "%s", _("Cannot parse mode string"));
        return false;
    }

    tmp = modes;
5932
    while (tmp && *tmp) {
5933
        mode = *tmp;
5934
        if (STREQ(mode, "acpi")) {
5935
            flags |= VIR_DOMAIN_REBOOT_ACPI_POWER_BTN;
5936
        } else if (STREQ(mode, "agent")) {
5937
            flags |= VIR_DOMAIN_REBOOT_GUEST_AGENT;
5938 5939 5940 5941
        } else if (STREQ(mode, "initctl")) {
            flags |= VIR_DOMAIN_REBOOT_INITCTL;
        } else if (STREQ(mode, "signal")) {
            flags |= VIR_DOMAIN_REBOOT_SIGNAL;
5942 5943
        } else if (STREQ(mode, "paravirt")) {
            flags |= VIR_DOMAIN_REBOOT_PARAVIRT;
5944
        } else {
5945
            vshError(ctl, _("Unknown mode %s value, expecting "
5946 5947
                            "'acpi', 'agent', 'initctl', 'signal' "
                            "or 'paravirt'"), mode);
5948
            goto cleanup;
5949
        }
5950
        tmp++;
5951 5952
    }

5953
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
5954
        goto cleanup;
5955 5956

    if (virDomainReboot(dom, flags) == 0) {
P
Pino Toscano 已提交
5957
        vshPrintExtra(ctl, _("Domain %s is being rebooted\n"), name);
5958 5959
    } else {
        vshError(ctl, _("Failed to reboot domain %s"), name);
5960
        goto cleanup;
5961 5962
    }

5963
    ret = true;
5964
 cleanup:
5965
    virshDomainFree(dom);
5966
    virStringListFree(modes);
5967 5968 5969 5970 5971 5972 5973
    return ret;
}

/*
 * "reset" command
 */
static const vshCmdInfo info_reset[] = {
5974 5975 5976 5977 5978 5979 5980
    {.name = "help",
     .data = N_("reset a domain")
    },
    {.name = "desc",
     .data = N_("Reset the target domain as if by power button")
    },
    {.name = NULL}
5981 5982 5983
};

static const vshCmdOptDef opts_reset[] = {
5984
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
5985
    {.name = NULL}
5986 5987 5988 5989 5990 5991 5992 5993 5994
};

static bool
cmdReset(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = true;
    const char *name;

5995
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
5996 5997 5998
        return false;

    if (virDomainReset(dom, 0) == 0) {
P
Pino Toscano 已提交
5999
        vshPrintExtra(ctl, _("Domain %s was reset\n"), name);
6000 6001 6002 6003 6004
    } else {
        vshError(ctl, _("Failed to reset domain %s"), name);
        ret = false;
    }

6005
    virshDomainFree(dom);
6006 6007 6008 6009 6010 6011 6012
    return ret;
}

/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
6013 6014 6015 6016 6017 6018 6019
    {.name = "help",
     .data = N_("domain job information")
    },
    {.name = "desc",
     .data = N_("Returns information about jobs running on a domain.")
    },
    {.name = NULL}
6020 6021 6022
};

static const vshCmdOptDef opts_domjobinfo[] = {
6023
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
6024 6025 6026 6027
    {.name = "completed",
     .type = VSH_OT_BOOL,
     .help = N_("return statistics of a recently completed job")
    },
6028 6029 6030 6031
    {.name = "keep-completed",
     .type = VSH_OT_BOOL,
     .help = N_("don't destroy statistics of a recently completed job when reading")
    },
6032 6033 6034 6035
    {.name = "anystats",
     .type = VSH_OT_BOOL,
     .help = N_("print statistics for any kind of job (even failed ones)")
    },
6036 6037 6038 6039
    {.name = "rawstats",
     .type = VSH_OT_BOOL,
     .help = N_("print the raw data returned by libvirt")
    },
6040
    {.name = NULL}
6041 6042
};

6043
VIR_ENUM_DECL(virshDomainJob);
6044
VIR_ENUM_IMPL(virshDomainJob,
6045 6046 6047 6048 6049 6050
              VIR_DOMAIN_JOB_LAST,
              N_("None"),
              N_("Bounded"),
              N_("Unbounded"),
              N_("Completed"),
              N_("Failed"),
6051
              N_("Cancelled"));
6052 6053

static const char *
6054
virshDomainJobToString(int type)
6055
{
6056
    const char *str = virshDomainJobTypeToString(type);
6057 6058 6059
    return str ? _(str) : _("unknown");
}

6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070
VIR_ENUM_DECL(virshDomainJobOperation);
VIR_ENUM_IMPL(virshDomainJobOperation,
              VIR_DOMAIN_JOB_OPERATION_LAST,
              N_("Unknown"),
              N_("Start"),
              N_("Save"),
              N_("Restore"),
              N_("Incoming migration"),
              N_("Outgoing migration"),
              N_("Snapshot"),
              N_("Snapshot revert"),
6071
              N_("Dump"));
6072 6073 6074 6075 6076 6077 6078 6079

static const char *
virshDomainJobOperationToString(int op)
{
    const char *str = virshDomainJobOperationTypeToString(op);
    return str ? _(str) : _("unknown");
}

6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115

static int
virshDomainJobStatsToDomainJobInfo(virTypedParameterPtr params,
                                   int nparams,
                                   virDomainJobInfo *info)
{
    if (virTypedParamsGetULLong(params, nparams, VIR_DOMAIN_JOB_TIME_ELAPSED,
                                &info->timeElapsed) < 0 ||
        virTypedParamsGetULLong(params, nparams, VIR_DOMAIN_JOB_TIME_REMAINING,
                                &info->timeRemaining) < 0 ||
        virTypedParamsGetULLong(params, nparams, VIR_DOMAIN_JOB_DATA_TOTAL,
                                &info->dataTotal) < 0 ||
        virTypedParamsGetULLong(params, nparams, VIR_DOMAIN_JOB_DATA_PROCESSED,
                                &info->dataProcessed) < 0 ||
        virTypedParamsGetULLong(params, nparams, VIR_DOMAIN_JOB_DATA_REMAINING,
                                &info->dataRemaining) < 0 ||
        virTypedParamsGetULLong(params, nparams, VIR_DOMAIN_JOB_MEMORY_TOTAL,
                                &info->memTotal) < 0 ||
        virTypedParamsGetULLong(params, nparams, VIR_DOMAIN_JOB_MEMORY_PROCESSED,
                                &info->memProcessed) < 0 ||
        virTypedParamsGetULLong(params, nparams, VIR_DOMAIN_JOB_MEMORY_REMAINING,
                                &info->memRemaining) < 0 ||
        virTypedParamsGetULLong(params, nparams, VIR_DOMAIN_JOB_DISK_TOTAL,
                                &info->fileTotal) < 0 ||
        virTypedParamsGetULLong(params, nparams, VIR_DOMAIN_JOB_DISK_PROCESSED,
                                &info->fileProcessed) < 0 ||
        virTypedParamsGetULLong(params, nparams, VIR_DOMAIN_JOB_DISK_REMAINING,
                                &info->fileRemaining) < 0) {
        vshSaveLibvirtError();
        return -1;
    }

    return 0;
}


6116 6117 6118 6119 6120
static bool
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
6121 6122 6123 6124 6125 6126
    bool ret = false;
    const char *unit;
    double val;
    virTypedParameterPtr params = NULL;
    int nparams = 0;
    unsigned long long value;
6127
    unsigned int flags = 0;
6128
    int ivalue;
6129
    int op;
6130
    int rc;
6131 6132
    size_t i;
    bool rawstats = vshCommandOptBool(cmd, "rawstats");
6133

6134 6135
    VSH_REQUIRE_OPTION("keep-completed", "completed");

6136
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
6137 6138
        return false;

6139 6140 6141
    if (vshCommandOptBool(cmd, "completed"))
        flags |= VIR_DOMAIN_JOB_STATS_COMPLETED;

6142 6143 6144
    if (vshCommandOptBool(cmd, "keep-completed"))
        flags |= VIR_DOMAIN_JOB_STATS_KEEP_COMPLETED;

6145
    memset(&info, 0, sizeof(info));
6146

6147
    rc = virDomainGetJobStats(dom, &info.type, &params, &nparams, flags);
6148
    if (rc == 0) {
6149 6150
        if (virshDomainJobStatsToDomainJobInfo(params, nparams, &info) < 0)
            goto cleanup;
6151
    } else if (last_error->code == VIR_ERR_NO_SUPPORT) {
6152 6153 6154
        if (flags != 0 || rawstats) {
            vshError(ctl, "%s",
                     _("Optional flags or --rawstats are not supported by the daemon"));
6155 6156
            goto cleanup;
        }
6157 6158 6159 6160 6161 6162
        vshDebug(ctl, VSH_ERR_DEBUG, "detailed statistics not supported\n");
        vshResetLibvirtError();
        rc = virDomainGetJobInfo(dom, &info);
    }
    if (rc < 0)
        goto cleanup;
6163

6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175
    if (rawstats) {
        vshPrint(ctl, "Job type: %d\n\n", info.type);

        for (i = 0; i < nparams; i++) {
            g_autofree char *par = virTypedParameterToString(&params[i]);
            vshPrint(ctl, "%s: %s\n", params[i].field, NULLSTR(par));
        }

        ret = true;
        goto cleanup;
    }

6176
    vshPrint(ctl, "%-17s %-12s\n", _("Job type:"),
6177
             virshDomainJobToString(info.type));
6178 6179

    if (info.type == VIR_DOMAIN_JOB_NONE) {
6180
        ret = true;
6181 6182 6183
        goto cleanup;
    }

6184 6185 6186 6187 6188 6189 6190 6191
    op = VIR_DOMAIN_JOB_OPERATION_UNKNOWN;
    if ((rc = virTypedParamsGetInt(params, nparams,
                                   VIR_DOMAIN_JOB_OPERATION, &op)) < 0)
        goto save_error;

    vshPrint(ctl, "%-17s %-12s\n", _("Operation:"),
             virshDomainJobOperationToString(op));

6192 6193
    if (!vshCommandOptBool(cmd, "anystats") &&
        info.type != VIR_DOMAIN_JOB_BOUNDED &&
6194 6195 6196 6197 6198 6199 6200
        info.type != VIR_DOMAIN_JOB_UNBOUNDED &&
        (!(flags & VIR_DOMAIN_JOB_STATS_COMPLETED) ||
         info.type != VIR_DOMAIN_JOB_COMPLETED)) {
        ret = true;
        goto cleanup;
    }

6201
    vshPrint(ctl, "%-17s %-12llu ms\n", _("Time elapsed:"), info.timeElapsed);
6202 6203 6204 6205 6206 6207 6208 6209 6210
    if ((rc = virTypedParamsGetULLong(params, nparams,
                                      VIR_DOMAIN_JOB_TIME_ELAPSED_NET,
                                      &value)) < 0) {
        goto save_error;
    } else if (rc) {
        vshPrint(ctl, "%-17s %-12llu ms\n", _("Time elapsed w/o network:"),
                 value);
    }

6211
    if (info.type == VIR_DOMAIN_JOB_BOUNDED)
6212 6213
        vshPrint(ctl, "%-17s %-12llu ms\n", _("Time remaining:"),
                 info.timeRemaining);
6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230

    if (info.dataTotal || info.dataRemaining || info.dataProcessed) {
        val = vshPrettyCapacity(info.dataProcessed, &unit);
        vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
        val = vshPrettyCapacity(info.dataRemaining, &unit);
        vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
        val = vshPrettyCapacity(info.dataTotal, &unit);
        vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
    }

    if (info.memTotal || info.memRemaining || info.memProcessed) {
        val = vshPrettyCapacity(info.memProcessed, &unit);
        vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
        val = vshPrettyCapacity(info.memRemaining, &unit);
        vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
        val = vshPrettyCapacity(info.memTotal, &unit);
        vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
6231 6232 6233 6234 6235 6236 6237 6238 6239 6240

        if ((rc = virTypedParamsGetULLong(params, nparams,
                                          VIR_DOMAIN_JOB_MEMORY_BPS,
                                          &value)) < 0) {
            goto save_error;
        } else if (rc && value) {
            val = vshPrettyCapacity(value, &unit);
            vshPrint(ctl, "%-17s %-.3lf %s/s\n",
                     _("Memory bandwidth:"), val, unit);
        }
6241 6242 6243 6244 6245 6246 6247 6248 6249

        if ((rc = virTypedParamsGetULLong(params, nparams,
                                          VIR_DOMAIN_JOB_MEMORY_DIRTY_RATE,
                                          &value)) < 0) {
            goto save_error;
        } else if (rc) {
            vshPrint(ctl, "%-17s %-12llu pages/s\n", _("Dirty rate:"), value);
        }

6250 6251 6252 6253 6254 6255 6256 6257
        if ((rc = virTypedParamsGetULLong(params, nparams,
                                          VIR_DOMAIN_JOB_MEMORY_PAGE_SIZE,
                                          &value)) < 0) {
            goto save_error;
        } else if (rc) {
            vshPrint(ctl, "%-17s %-12llu bytes\n", _("Page size:"), value);
        }

6258 6259 6260 6261 6262 6263 6264
        if ((rc = virTypedParamsGetULLong(params, nparams,
                                          VIR_DOMAIN_JOB_MEMORY_ITERATION,
                                          &value)) < 0) {
            goto save_error;
        } else if (rc) {
            vshPrint(ctl, "%-17s %-12llu\n", _("Iteration:"), value);
        }
6265 6266 6267 6268 6269 6270 6271 6272

        if ((rc = virTypedParamsGetULLong(params, nparams,
                                          VIR_DOMAIN_JOB_MEMORY_POSTCOPY_REQS,
                                          &value)) < 0) {
            goto save_error;
        } else if (rc) {
            vshPrint(ctl, "%-17s %-12llu\n", _("Postcopy requests:"), value);
        }
6273 6274 6275 6276 6277 6278 6279 6280 6281
    }

    if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
        val = vshPrettyCapacity(info.fileProcessed, &unit);
        vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
        val = vshPrettyCapacity(info.fileRemaining, &unit);
        vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
        val = vshPrettyCapacity(info.fileTotal, &unit);
        vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
6282 6283 6284 6285 6286 6287 6288 6289 6290 6291

        if ((rc = virTypedParamsGetULLong(params, nparams,
                                          VIR_DOMAIN_JOB_DISK_BPS,
                                          &value)) < 0) {
            goto save_error;
        } else if (rc && value) {
            val = vshPrettyCapacity(value, &unit);
            vshPrint(ctl, "%-17s %-.3lf %s/s\n",
                     _("File bandwidth:"), val, unit);
        }
6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321
    }

    if ((rc = virTypedParamsGetULLong(params, nparams,
                                      VIR_DOMAIN_JOB_MEMORY_CONSTANT,
                                      &value)) < 0) {
        goto save_error;
    } else if (rc) {
        vshPrint(ctl, "%-17s %-12llu\n", _("Constant pages:"), value);
    }
    if ((rc = virTypedParamsGetULLong(params, nparams,
                                      VIR_DOMAIN_JOB_MEMORY_NORMAL,
                                      &value)) < 0) {
        goto save_error;
    } else if (rc) {
        vshPrint(ctl, "%-17s %-12llu\n", _("Normal pages:"), value);
    }
    if ((rc = virTypedParamsGetULLong(params, nparams,
                                      VIR_DOMAIN_JOB_MEMORY_NORMAL_BYTES,
                                      &value)) < 0) {
        goto save_error;
    } else if (rc) {
        val = vshPrettyCapacity(value, &unit);
        vshPrint(ctl, "%-17s %-.3lf %s\n", _("Normal data:"), val, unit);
    }

    if ((rc = virTypedParamsGetULLong(params, nparams,
                                      VIR_DOMAIN_JOB_DOWNTIME,
                                      &value)) < 0) {
        goto save_error;
    } else if (rc) {
6322 6323 6324 6325 6326 6327 6328
        if (info.type == VIR_DOMAIN_JOB_COMPLETED) {
            vshPrint(ctl, "%-17s %-12llu ms\n",
                     _("Total downtime:"), value);
        } else {
            vshPrint(ctl, "%-17s %-12llu ms\n",
                     _("Expected downtime:"), value);
        }
6329 6330
    }

6331 6332 6333 6334 6335 6336 6337
    if ((rc = virTypedParamsGetULLong(params, nparams,
                                      VIR_DOMAIN_JOB_DOWNTIME_NET,
                                      &value)) < 0)
        goto save_error;
    else if (rc)
        vshPrint(ctl, "%-17s %-12llu ms\n", _("Downtime w/o network:"), value);

6338 6339 6340 6341 6342 6343 6344
    if ((rc = virTypedParamsGetULLong(params, nparams,
                                      VIR_DOMAIN_JOB_SETUP_TIME,
                                      &value)) < 0)
        goto save_error;
    else if (rc)
        vshPrint(ctl, "%-17s %-12llu ms\n", _("Setup time:"), value);

6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380
    if ((rc = virTypedParamsGetULLong(params, nparams,
                                      VIR_DOMAIN_JOB_COMPRESSION_CACHE,
                                      &value)) < 0) {
        goto save_error;
    } else if (rc) {
        val = vshPrettyCapacity(value, &unit);
        vshPrint(ctl, "%-17s %-.3lf %s\n", _("Compression cache:"), val, unit);
    }
    if ((rc = virTypedParamsGetULLong(params, nparams,
                                      VIR_DOMAIN_JOB_COMPRESSION_BYTES,
                                      &value)) < 0) {
        goto save_error;
    } else if (rc) {
        val = vshPrettyCapacity(value, &unit);
        vshPrint(ctl, "%-17s %-.3lf %s\n", _("Compressed data:"), val, unit);
    }
    if ((rc = virTypedParamsGetULLong(params, nparams,
                                      VIR_DOMAIN_JOB_COMPRESSION_PAGES,
                                      &value)) < 0) {
        goto save_error;
    } else if (rc) {
        vshPrint(ctl, "%-17s %-13llu\n", _("Compressed pages:"), value);
    }
    if ((rc = virTypedParamsGetULLong(params, nparams,
                                      VIR_DOMAIN_JOB_COMPRESSION_CACHE_MISSES,
                                      &value)) < 0) {
        goto save_error;
    } else if (rc) {
        vshPrint(ctl, "%-17s %-13llu\n", _("Compression cache misses:"), value);
    }
    if ((rc = virTypedParamsGetULLong(params, nparams,
                                      VIR_DOMAIN_JOB_COMPRESSION_OVERFLOW,
                                      &value)) < 0) {
        goto save_error;
    } else if (rc) {
        vshPrint(ctl, "%-17s %-13llu\n", _("Compression overflows:"), value);
6381
    }
6382

6383 6384 6385 6386 6387 6388 6389 6390
    if ((rc = virTypedParamsGetInt(params, nparams,
                                   VIR_DOMAIN_JOB_AUTO_CONVERGE_THROTTLE,
                                   &ivalue)) < 0) {
        goto save_error;
    } else if (rc) {
        vshPrint(ctl, "%-17s %-13d\n", _("Auto converge throttle:"), ivalue);
    }

6391 6392
    ret = true;

6393
 cleanup:
6394
    virshDomainFree(dom);
6395
    virTypedParamsFree(params, nparams);
6396
    return ret;
6397

6398
 save_error:
6399 6400
    vshSaveLibvirtError();
    goto cleanup;
6401 6402 6403 6404 6405 6406
}

/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
6407 6408 6409 6410 6411 6412 6413
    {.name = "help",
     .data = N_("abort active domain job")
    },
    {.name = "desc",
     .data = N_("Aborts the currently running domain job")
    },
    {.name = NULL}
6414 6415 6416
};

static const vshCmdOptDef opts_domjobabort[] = {
6417
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
6418
    {.name = NULL}
6419 6420 6421 6422 6423 6424 6425 6426
};

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

6427
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
6428 6429 6430 6431 6432
        return false;

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

6433
    virshDomainFree(dom);
6434 6435 6436 6437 6438 6439 6440
    return ret;
}

/*
 * "vcpucount" command
 */
static const vshCmdInfo info_vcpucount[] = {
6441 6442 6443 6444 6445 6446 6447
    {.name = "help",
     .data = N_("domain vcpu counts")
    },
    {.name = "desc",
     .data = N_("Returns the number of virtual CPUs used by the domain.")
    },
    {.name = NULL}
6448 6449 6450
};

static const vshCmdOptDef opts_vcpucount[] = {
6451
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
6452 6453
    {.name = "maximum",
     .type = VSH_OT_BOOL,
6454
     .help = N_("get maximum count of vcpus")
6455 6456 6457 6458 6459
    },
    {.name = "active",
     .type = VSH_OT_BOOL,
     .help = N_("get number of currently active vcpus")
    },
6460
    VIRSH_COMMON_OPT_LIVE(N_("get value from running domain")),
6461
    VIRSH_COMMON_OPT_CONFIG(N_("get value to be used on next boot")),
6462
    VIRSH_COMMON_OPT_CURRENT(N_("get value according to current domain state")),
6463
    {.name = "guest",
6464
     .type = VSH_OT_BOOL,
6465
     .help = N_("retrieve vcpu count from the guest instead of the hypervisor")
6466
    },
6467
    {.name = NULL}
6468 6469
};

6470 6471 6472 6473 6474 6475 6476 6477 6478 6479
/**
 * Collect the number of vCPUs for a guest possibly with fallback means.
 *
 * Returns the count of vCPUs for a domain and certain flags. Returns -2 in case
 * of error. If @checkState is true, in case live stats can't be collected when
 * the domain is inactive or persistent stats can't be collected if domain is
 * transient -1 is returned and no error is reported.
 */

static int
6480 6481 6482 6483
virshCPUCountCollect(vshControl *ctl,
                     virDomainPtr dom,
                     unsigned int flags,
                     bool checkState)
6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503
{
    int ret = -2;
    virDomainInfo info;
    int count;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;

    if (checkState &&
        ((flags & VIR_DOMAIN_AFFECT_LIVE && virDomainIsActive(dom) < 1) ||
         (flags & VIR_DOMAIN_AFFECT_CONFIG && virDomainIsPersistent(dom) < 1)))
        return -1;

    /* In all cases, try the new API first; if it fails because we are talking
     * to an older daemon, generally we try a fallback API before giving up.
     * --current requires the new API, since we don't know whether the domain is
     *  running or inactive. */
    if ((count = virDomainGetVcpusFlags(dom, flags)) >= 0)
        return count;

    /* fallback code */
6504 6505 6506
    if (!(last_error->code == VIR_ERR_NO_SUPPORT ||
          last_error->code == VIR_ERR_INVALID_ARG))
        goto cleanup;
6507

6508 6509 6510 6511
    if (flags & VIR_DOMAIN_VCPU_GUEST) {
        vshError(ctl, "%s", _("Failed to retrieve vCPU count from the guest"));
        goto cleanup;
    }
6512

6513 6514 6515
    if (!(flags & (VIR_DOMAIN_AFFECT_LIVE | VIR_DOMAIN_AFFECT_CONFIG)) &&
        virDomainIsActive(dom) == 1)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
6516

6517
    vshResetLibvirtError();
6518

6519 6520
    if (flags & VIR_DOMAIN_AFFECT_LIVE) {
        if (flags & VIR_DOMAIN_VCPU_MAXIMUM) {
6521
            count = virDomainGetMaxVcpus(dom);
6522 6523 6524
        } else {
           if (virDomainGetInfo(dom, &info) < 0)
               goto cleanup;
6525

6526 6527 6528
           count = info.nrVirtCpu;
        }
    } else {
6529 6530
        if (virshDomainGetXMLFromDom(ctl, dom, VIR_DOMAIN_XML_INACTIVE,
                                     &xml, &ctxt) < 0)
6531 6532
            goto cleanup;

6533
        if (flags & VIR_DOMAIN_VCPU_MAXIMUM) {
6534
            if (virXPathInt("string(/domain/vcpu)", ctxt, &count) < 0) {
6535 6536 6537 6538
                vshError(ctl, "%s", _("Failed to retrieve maximum vcpu count"));
                goto cleanup;
            }
        } else {
6539
            if (virXPathInt("string(/domain/vcpu/@current)", ctxt, &count) < 0) {
6540 6541 6542 6543 6544
                vshError(ctl, "%s", _("Failed to retrieve current vcpu count"));
                goto cleanup;
            }
        }
    }
6545 6546

    ret = count;
6547
 cleanup:
6548 6549 6550 6551 6552 6553
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);

    return ret;
}

6554 6555 6556 6557
static bool
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
6558
    bool ret = false;
6559 6560 6561 6562 6563
    bool maximum = vshCommandOptBool(cmd, "maximum");
    bool active = vshCommandOptBool(cmd, "active");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
6564 6565
    bool guest = vshCommandOptBool(cmd, "guest");
    bool all = maximum + active + current + config + live + guest == 0;
6566
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
6567 6568 6569 6570 6571 6572 6573

    /* Backwards compatibility: prior to 0.9.4,
     * VIR_DOMAIN_AFFECT_CURRENT was unsupported, and --current meant
     * the opposite of --maximum.  Translate the old '--current
     * --live' into the new '--active --live', while treating the new
     * '--maximum --current' correctly rather than rejecting it as
     * '--maximum --active'.  */
6574
    if (!maximum && !active && current)
6575 6576
        current = false;

6577
    VSH_EXCLUSIVE_OPTIONS_VAR(live, config)
6578 6579 6580
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);
    VSH_EXCLUSIVE_OPTIONS_VAR(active, maximum);
6581
    VSH_EXCLUSIVE_OPTIONS_VAR(guest, config);
6582 6583 6584 6585 6586 6587 6588

    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (maximum)
        flags |= VIR_DOMAIN_VCPU_MAXIMUM;
6589 6590
    if (guest)
        flags |= VIR_DOMAIN_VCPU_GUEST;
6591

6592
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
6593 6594
        return false;

6595
    if (all) {
6596 6597 6598 6599 6600 6601 6602 6603 6604 6605
        int conf_max = virshCPUCountCollect(ctl, dom,
                                            VIR_DOMAIN_AFFECT_CONFIG |
                                            VIR_DOMAIN_VCPU_MAXIMUM, true);
        int conf_cur = virshCPUCountCollect(ctl, dom,
                                            VIR_DOMAIN_AFFECT_CONFIG, true);
        int live_max = virshCPUCountCollect(ctl, dom,
                                            VIR_DOMAIN_AFFECT_LIVE |
                                            VIR_DOMAIN_VCPU_MAXIMUM, true);
        int live_cur = virshCPUCountCollect(ctl, dom,
                                            VIR_DOMAIN_AFFECT_LIVE, true);
6606

6607 6608
        if (conf_max == -2 || conf_cur == -2 || live_max == -2 || live_cur ==  -2)
            goto cleanup;
6609

6610 6611 6612 6613 6614 6615 6616
#define PRINT_COUNT(VAR, WHICH, STATE) if (VAR > 0) \
    vshPrint(ctl, "%-12s %-12s %3d\n", WHICH, STATE, VAR)
        PRINT_COUNT(conf_max, _("maximum"), _("config"));
        PRINT_COUNT(live_max, _("maximum"), _("live"));
        PRINT_COUNT(conf_cur, _("current"), _("config"));
        PRINT_COUNT(live_cur, _("current"), _("live"));
#undef PRINT_COUNT
6617

6618
    } else {
6619
        int count = virshCPUCountCollect(ctl, dom, flags, false);
6620

6621 6622
        if (count < 0)
            goto cleanup;
6623

6624
        vshPrint(ctl, "%d\n", count);
6625 6626
    }

6627
    ret = true;
6628

6629
 cleanup:
6630
    virshDomainFree(dom);
6631 6632 6633 6634 6635 6636 6637
    return ret;
}

/*
 * "vcpuinfo" command
 */
static const vshCmdInfo info_vcpuinfo[] = {
6638 6639 6640 6641 6642 6643 6644
    {.name = "help",
     .data = N_("detailed domain vcpu information")
    },
    {.name = "desc",
     .data = N_("Returns basic information about the domain virtual CPUs.")
    },
    {.name = NULL}
6645 6646 6647
};

static const vshCmdOptDef opts_vcpuinfo[] = {
6648
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
6649 6650 6651 6652
    {.name = "pretty",
     .type = VSH_OT_BOOL,
     .help = N_("return human readable output")
    },
6653
    {.name = NULL}
6654 6655
};

6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668

static int
virshVcpuinfoPrintAffinity(vshControl *ctl,
                           const unsigned char *cpumap,
                           int maxcpu,
                           bool pretty)
{
    char *str = NULL;
    size_t i;
    int ret = -1;

    vshPrint(ctl, "%-15s ", _("CPU Affinity:"));
    if (pretty) {
6669
        if (!(str = virBitmapDataFormat(cpumap, VIR_CPU_MAPLEN(maxcpu))))
6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685
            goto cleanup;
        vshPrint(ctl, _("%s (out of %d)"), str, maxcpu);
    } else {
        for (i = 0; i < maxcpu; i++)
            vshPrint(ctl, "%c", VIR_CPU_USED(cpumap, i) ? 'y' : '-');
    }
    vshPrint(ctl, "\n");

    ret = 0;

 cleanup:
    VIR_FREE(str);
    return ret;
}


6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706
static virBitmapPtr
virshDomainGetVcpuBitmap(vshControl *ctl,
                         virDomainPtr dom,
                         bool inactive)
{
    unsigned int flags = 0;
    virBitmapPtr ret = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr *nodes = NULL;
    xmlNodePtr old;
    int nnodes;
    size_t i;
    unsigned int curvcpus = 0;
    unsigned int maxvcpus = 0;
    unsigned int vcpuid;
    char *online = NULL;

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;

6707
    if (virshDomainGetXMLFromDom(ctl, dom, flags, &xml, &ctxt) < 0)
6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762
        goto cleanup;

    if (virXPathUInt("string(/domain/vcpu)", ctxt, &maxvcpus) < 0) {
        vshError(ctl, "%s", _("Failed to retrieve maximum vcpu count"));
        goto cleanup;
    }

    ignore_value(virXPathUInt("string(/domain/vcpu/@current)", ctxt, &curvcpus));

    if (curvcpus == 0)
        curvcpus = maxvcpus;

    if (!(ret = virBitmapNew(maxvcpus)))
        goto cleanup;

    if ((nnodes = virXPathNodeSet("/domain/vcpus/vcpu", ctxt, &nodes)) <= 0) {
        /* if the specific vcpu state is missing provide a fallback */
        for (i = 0; i < curvcpus; i++)
            ignore_value(virBitmapSetBit(ret, i));

        goto cleanup;
    }

    old = ctxt->node;

    for (i = 0; i < nnodes; i++) {
        ctxt->node = nodes[i];

        if (virXPathUInt("string(@id)", ctxt, &vcpuid) < 0 ||
            !(online = virXPathString("string(@enabled)", ctxt)))
            continue;

        if (STREQ(online, "yes"))
            ignore_value(virBitmapSetBit(ret, vcpuid));

        VIR_FREE(online);
    }

    ctxt->node = old;

    if (virBitmapCountBits(ret) != curvcpus) {
        vshError(ctl, "%s", _("Failed to retrieve vcpu state bitmap"));
        virBitmapFree(ret);
        ret = NULL;
    }

 cleanup:
    VIR_FREE(online);
    VIR_FREE(nodes);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    return ret;
}


6763 6764 6765 6766 6767 6768 6769 6770 6771
static bool
virshVcpuinfoInactive(vshControl *ctl,
                      virDomainPtr dom,
                      int maxcpu,
                      bool pretty)
{
    unsigned char *cpumaps = NULL;
    size_t cpumaplen;
    int ncpus;
6772 6773
    virBitmapPtr vcpus = NULL;
    ssize_t nextvcpu = -1;
6774
    bool ret = false;
6775 6776 6777 6778
    bool first = true;

    if (!(vcpus = virshDomainGetVcpuBitmap(ctl, dom, true)))
        goto cleanup;
6779 6780

    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
6781
    cpumaps = vshMalloc(ctl, virBitmapSize(vcpus) * cpumaplen);
6782

6783
    if ((ncpus = virDomainGetVcpuPinInfo(dom, virBitmapSize(vcpus),
6784 6785 6786 6787
                                         cpumaps, cpumaplen,
                                         VIR_DOMAIN_AFFECT_CONFIG)) < 0)
        goto cleanup;

6788 6789
    while ((nextvcpu = virBitmapNextSetBit(vcpus, nextvcpu)) >= 0) {
        if (!first)
6790
            vshPrint(ctl, "\n");
6791
        first = false;
6792

6793
        vshPrint(ctl, "%-15s %zd\n", _("VCPU:"), nextvcpu);
6794 6795 6796 6797
        vshPrint(ctl, "%-15s %s\n", _("CPU:"), _("N/A"));
        vshPrint(ctl, "%-15s %s\n", _("State:"), _("N/A"));
        vshPrint(ctl, "%-15s %s\n", _("CPU time"), _("N/A"));

6798 6799
        if (virshVcpuinfoPrintAffinity(ctl,
                                       VIR_GET_CPUMAP(cpumaps, cpumaplen, nextvcpu),
6800 6801 6802 6803 6804 6805 6806
                                       maxcpu, pretty) < 0)
            goto cleanup;
    }

    ret = true;

 cleanup:
6807
    virBitmapFree(vcpus);
6808 6809 6810 6811 6812
    VIR_FREE(cpumaps);
    return ret;
}


6813 6814 6815 6816 6817
static bool
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainInfo info;
    virDomainPtr dom;
J
Ján Tomko 已提交
6818 6819
    virVcpuInfoPtr cpuinfo = NULL;
    unsigned char *cpumaps = NULL;
6820 6821
    int ncpus, maxcpu;
    size_t cpumaplen;
J
Ján Tomko 已提交
6822
    bool ret = false;
6823
    bool pretty = vshCommandOptBool(cmd, "pretty");
6824
    int n;
6825
    virshControlPtr priv = ctl->privData;
6826

6827
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
6828 6829
        return false;

6830
    if ((maxcpu = virshNodeGetCPUCount(priv->conn)) < 0)
J
Ján Tomko 已提交
6831
        goto cleanup;
6832

J
Ján Tomko 已提交
6833 6834
    if (virDomainGetInfo(dom, &info) != 0)
        goto cleanup;
6835 6836 6837 6838 6839 6840 6841

    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);

    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
6842 6843 6844 6845
                                   cpumaps, cpumaplen)) < 0) {
        if (info.state != VIR_DOMAIN_SHUTOFF)
            goto cleanup;

6846 6847
        vshResetLibvirtError();

6848
        /* for offline VMs we can return pinning information */
6849
        ret = virshVcpuinfoInactive(ctl, dom, maxcpu, pretty);
6850
        goto cleanup;
6851 6852 6853
    }

    for (n = 0; n < ncpus; n++) {
6854 6855 6856 6857 6858 6859
        vshPrint(ctl, "%-15s %d\n", _("VCPU:"), cpuinfo[n].number);
        vshPrint(ctl, "%-15s %d\n", _("CPU:"), cpuinfo[n].cpu);
        vshPrint(ctl, "%-15s %s\n", _("State:"),
                 virshDomainVcpuStateToString(cpuinfo[n].state));
        if (cpuinfo[n].cpuTime != 0) {
            double cpuUsed = cpuinfo[n].cpuTime;
6860

6861
            cpuUsed /= 1000000000.0;
6862

6863
            vshPrint(ctl, "%-15s %.1lfs\n", _("CPU time:"), cpuUsed);
6864
        }
6865

6866 6867 6868 6869
        if (virshVcpuinfoPrintAffinity(ctl, VIR_GET_CPUMAP(cpumaps, cpumaplen, n),
                                       maxcpu, pretty) < 0)
            goto cleanup;

6870 6871
        if (n < (ncpus - 1))
            vshPrint(ctl, "\n");
6872 6873
    }

J
Ján Tomko 已提交
6874 6875 6876
    ret = true;

 cleanup:
6877 6878
    VIR_FREE(cpumaps);
    VIR_FREE(cpuinfo);
6879
    virshDomainFree(dom);
6880 6881 6882 6883 6884 6885 6886
    return ret;
}

/*
 * "vcpupin" command
 */
static const vshCmdInfo info_vcpupin[] = {
6887 6888 6889 6890 6891 6892 6893
    {.name = "help",
     .data = N_("control or query domain vcpu affinity")
    },
    {.name = "desc",
     .data = N_("Pin domain VCPUs to host physical CPUs.")
    },
    {.name = NULL}
6894 6895 6896
};

static const vshCmdOptDef opts_vcpupin[] = {
6897
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
6898 6899 6900 6901 6902
    {.name = "vcpu",
     .type = VSH_OT_INT,
     .help = N_("vcpu number")
    },
    {.name = "cpulist",
6903
     .type = VSH_OT_STRING,
6904 6905 6906
     .flags = VSH_OFLAG_EMPTY_OK,
     .help = N_("host cpu number(s) to set, or omit option to query")
    },
6907
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
6908
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
6909
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
6910
    {.name = NULL}
6911 6912
};

H
Hu Tao 已提交
6913 6914 6915 6916
/*
 * Helper function to print vcpupin info.
 */
static bool
6917 6918 6919
virshPrintPinInfo(vshControl *ctl,
                  unsigned char *cpumap,
                  size_t cpumaplen)
H
Hu Tao 已提交
6920
{
J
Ján Tomko 已提交
6921
    char *str = NULL;
H
Hu Tao 已提交
6922

6923
    if (!(str = virBitmapDataFormat(cpumap, cpumaplen)))
H
Hu Tao 已提交
6924 6925
        return false;

J
Ján Tomko 已提交
6926 6927
    vshPrint(ctl, "%s", str);
    VIR_FREE(str);
H
Hu Tao 已提交
6928 6929 6930
    return true;
}

6931 6932 6933 6934 6935 6936 6937 6938 6939 6940

static bool
virshVcpuPinQuery(vshControl *ctl,
                  virDomainPtr dom,
                  unsigned int vcpu,
                  bool got_vcpu,
                  int maxcpu,
                  unsigned int flags)
{
    unsigned char *cpumap = NULL;
6941
    unsigned int countFlags = flags | VIR_DOMAIN_VCPU_MAXIMUM;
6942 6943 6944 6945
    int cpumaplen;
    size_t i;
    int ncpus;
    bool ret = false;
6946
    vshTablePtr table = NULL;
6947

6948
    if ((ncpus = virshCPUCountCollect(ctl, dom, countFlags, true)) < 0) {
6949 6950 6951 6952 6953 6954
        if (ncpus == -1) {
            if (flags & VIR_DOMAIN_AFFECT_LIVE)
                vshError(ctl, "%s", _("cannot get vcpupin for offline domain"));
            else
                vshError(ctl, "%s", _("cannot get vcpupin for transient domain"));
        }
6955
        goto cleanup;
6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968
    }

    if (got_vcpu && vcpu >= ncpus) {
        if (flags & VIR_DOMAIN_AFFECT_LIVE ||
            (!(flags & VIR_DOMAIN_AFFECT_CONFIG) &&
             virDomainIsActive(dom) == 1))
            vshError(ctl,
                     _("vcpu %d is out of range of live cpu count %d"),
                     vcpu, ncpus);
        else
            vshError(ctl,
                     _("vcpu %d is out of range of persistent cpu count %d"),
                     vcpu, ncpus);
6969
        goto cleanup;
6970 6971 6972 6973 6974 6975
    }

    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumap = vshMalloc(ctl, ncpus * cpumaplen);
    if ((ncpus = virDomainGetVcpuPinInfo(dom, ncpus, cpumap,
                                         cpumaplen, flags)) >= 0) {
6976 6977 6978 6979
        table = vshTableNew(_("VCPU"), _("CPU Affinity"), NULL);
        if (!table)
            goto cleanup;

6980
        for (i = 0; i < ncpus; i++) {
6981 6982
            g_autofree char *pinInfo = NULL;
            g_autofree char *vcpuStr = NULL;
6983 6984 6985
            if (got_vcpu && i != vcpu)
                continue;

6986 6987
            if (!(pinInfo = virBitmapDataFormat(VIR_GET_CPUMAP(cpumap, cpumaplen, i),
                                                cpumaplen)))
6988 6989
                goto cleanup;

6990
            vcpuStr = g_strdup_printf("%zu", i);
6991 6992 6993

            if (vshTableRowAppend(table, vcpuStr, pinInfo, NULL) < 0)
                goto cleanup;
6994
        }
6995 6996

        vshTablePrintToStdout(table, ctl);
6997 6998
    }

6999 7000 7001
    ret = true;
 cleanup:
    vshTableFree(table);
7002
    VIR_FREE(cpumap);
7003 7004 7005 7006
    return ret;
}


7007
static unsigned char *
7008 7009
virshParseCPUList(vshControl *ctl, int *cpumaplen,
                  const char *cpulist, int maxcpu)
7010 7011
{
    unsigned char *cpumap = NULL;
J
Ján Tomko 已提交
7012
    virBitmapPtr map = NULL;
7013

J
Ján Tomko 已提交
7014 7015 7016 7017 7018
    if (cpulist[0] == 'r') {
        if (!(map = virBitmapNew(maxcpu)))
            return NULL;
        virBitmapSetAll(map);
    } else {
7019
        if (virBitmapParse(cpulist, &map, 1024) < 0 ||
7020 7021 7022 7023 7024 7025 7026 7027 7028 7029
            virBitmapIsAllClear(map)) {
            vshError(ctl, _("Invalid cpulist '%s'"), cpulist);
            goto cleanup;
        }
        int lastcpu = virBitmapLastSetBit(map);
        if (lastcpu >= maxcpu) {
            vshError(ctl, _("CPU %d in cpulist '%s' exceed the maxcpu %d"),
                     lastcpu, cpulist, maxcpu);
            goto cleanup;
        }
7030 7031
    }

J
Ján Tomko 已提交
7032 7033
    if (virBitmapToData(map, &cpumap, cpumaplen) < 0)
        goto cleanup;
7034

7035
 cleanup:
J
Ján Tomko 已提交
7036 7037
    virBitmapFree(map);
    return cpumap;
7038 7039
}

7040 7041 7042 7043
static bool
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
7044
    unsigned int vcpu = 0;
7045
    const char *cpulist = NULL;
7046
    bool ret = false;
7047
    unsigned char *cpumap = NULL;
J
Ján Tomko 已提交
7048
    int cpumaplen;
7049
    int maxcpu;
7050 7051 7052
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
7053
    int got_vcpu;
7054
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
7055
    virshControlPtr priv = ctl->privData;
7056

7057 7058 7059 7060 7061 7062 7063
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
7064

7065
    if (vshCommandOptStringReq(ctl, cmd, "cpulist", &cpulist) < 0)
7066 7067
        return false;

P
Pavel Hrdina 已提交
7068 7069
    if (!cpulist)
        VSH_EXCLUSIVE_OPTIONS_VAR(live, config);
7070

7071
    if ((got_vcpu = vshCommandOptUInt(ctl, cmd, "vcpu", &vcpu)) < 0)
P
Pavel Hrdina 已提交
7072
        return false;
7073

7074
    /* In pin mode, "vcpu" is necessary */
P
Pavel Hrdina 已提交
7075
    if (cpulist && got_vcpu == 0) {
7076
        vshError(ctl, "%s", _("vcpupin: Missing vCPU number in pin mode."));
P
Pavel Hrdina 已提交
7077
        return false;
7078 7079
    }

7080
    if ((maxcpu = virshNodeGetCPUCount(priv->conn)) < 0)
P
Pavel Hrdina 已提交
7081
        return false;
7082

7083
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
P
Pavel Hrdina 已提交
7084 7085
        return false;

7086
    /* Query mode: show CPU affinity information then exit.*/
P
Pavel Hrdina 已提交
7087
    if (!cpulist) {
7088 7089 7090
        ret = virshVcpuPinQuery(ctl, dom, vcpu, got_vcpu, maxcpu, flags);
        goto cleanup;
    }
7091

7092 7093 7094
    /* Pin mode: pinning specified vcpu to specified physical cpus*/
    if (!(cpumap = virshParseCPUList(ctl, &cpumaplen, cpulist, maxcpu)))
        goto cleanup;
J
Ján Tomko 已提交
7095

7096 7097 7098 7099
    /* use old API without any explicit flags */
    if (flags == VIR_DOMAIN_AFFECT_CURRENT && !current) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0)
            goto cleanup;
7100
    } else {
7101
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0)
7102
            goto cleanup;
7103
    }
7104
    ret = true;
7105

7106
 cleanup:
7107
    VIR_FREE(cpumap);
7108
    virshDomainFree(dom);
7109 7110 7111
    return ret;
}

H
Hu Tao 已提交
7112 7113 7114 7115
/*
 * "emulatorpin" command
 */
static const vshCmdInfo info_emulatorpin[] = {
7116 7117 7118 7119 7120 7121 7122
    {.name = "help",
     .data = N_("control or query domain emulator affinity")
    },
    {.name = "desc",
     .data = N_("Pin domain emulator threads to host physical CPUs.")
    },
    {.name = NULL}
H
Hu Tao 已提交
7123 7124 7125
};

static const vshCmdOptDef opts_emulatorpin[] = {
7126
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
7127
    {.name = "cpulist",
7128
     .type = VSH_OT_STRING,
7129 7130 7131
     .flags = VSH_OFLAG_EMPTY_OK,
     .help = N_("host cpu number(s) to set, or omit option to query")
    },
7132
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
7133
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
7134
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
7135
    {.name = NULL}
H
Hu Tao 已提交
7136 7137 7138 7139 7140 7141 7142
};

static bool
cmdEmulatorPin(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *cpulist = NULL;
7143
    bool ret = false;
H
Hu Tao 已提交
7144
    unsigned char *cpumap = NULL;
J
Ján Tomko 已提交
7145
    int cpumaplen;
7146
    int maxcpu;
H
Hu Tao 已提交
7147 7148 7149 7150
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
    bool query = false; /* Query mode if no cpulist */
7151
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
7152
    virshControlPtr priv = ctl->privData;
H
Hu Tao 已提交
7153

7154 7155 7156 7157 7158 7159 7160 7161 7162 7163
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
    /* none of the options were specified */
    if (!current && !live && !config)
        flags = -1;
H
Hu Tao 已提交
7164

7165
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
H
Hu Tao 已提交
7166 7167
        return false;

7168
    if (vshCommandOptStringReq(ctl, cmd, "cpulist", &cpulist) < 0) {
7169
        virshDomainFree(dom);
H
Hu Tao 已提交
7170 7171 7172 7173
        return false;
    }
    query = !cpulist;

7174
    if ((maxcpu = virshNodeGetCPUCount(priv->conn)) < 0) {
7175
        virshDomainFree(dom);
H
Hu Tao 已提交
7176 7177 7178 7179 7180 7181 7182 7183 7184 7185
        return false;
    }

    /* Query mode: show CPU affinity information then exit.*/
    if (query) {
        /* When query mode and neither "live", "config" nor "current"
         * is specified, set VIR_DOMAIN_AFFECT_CURRENT as flags */
        if (flags == -1)
            flags = VIR_DOMAIN_AFFECT_CURRENT;

J
Ján Tomko 已提交
7186
        cpumaplen = VIR_CPU_MAPLEN(maxcpu);
J
Ján Tomko 已提交
7187 7188
        cpumap = vshMalloc(ctl, cpumaplen);
        if (virDomainGetEmulatorPinInfo(dom, cpumap,
H
Hu Tao 已提交
7189
                                        cpumaplen, flags) >= 0) {
7190 7191 7192
            vshPrintExtra(ctl, "%s %s\n", _("emulator:"), _("CPU Affinity"));
            vshPrintExtra(ctl, "----------------------------------\n");
            vshPrintExtra(ctl, "       *: ");
7193
            ret = virshPrintPinInfo(ctl, cpumap, cpumaplen);
H
Hu Tao 已提交
7194 7195 7196 7197 7198 7199
            vshPrint(ctl, "\n");
        }
        goto cleanup;
    }

    /* Pin mode: pinning emulator threads to specified physical cpus*/
7200
    if (!(cpumap = virshParseCPUList(ctl, &cpumaplen, cpulist, maxcpu)))
7201
        goto cleanup;
H
Hu Tao 已提交
7202 7203 7204 7205 7206

    if (flags == -1)
        flags = VIR_DOMAIN_AFFECT_LIVE;

    if (virDomainPinEmulator(dom, cpumap, cpumaplen, flags) != 0)
7207
        goto cleanup;
H
Hu Tao 已提交
7208

7209
    ret = true;
7210
 cleanup:
H
Hu Tao 已提交
7211
    VIR_FREE(cpumap);
7212
    virshDomainFree(dom);
H
Hu Tao 已提交
7213 7214 7215
    return ret;
}

7216 7217 7218 7219
/*
 * "setvcpus" command
 */
static const vshCmdInfo info_setvcpus[] = {
7220 7221 7222 7223 7224 7225 7226
    {.name = "help",
     .data = N_("change number of virtual CPUs")
    },
    {.name = "desc",
     .data = N_("Change the number of virtual CPUs in the guest domain.")
    },
    {.name = NULL}
7227 7228 7229
};

static const vshCmdOptDef opts_setvcpus[] = {
7230
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
7231 7232 7233 7234 7235 7236 7237 7238 7239
    {.name = "count",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ,
     .help = N_("number of virtual CPUs")
    },
    {.name = "maximum",
     .type = VSH_OT_BOOL,
     .help = N_("set maximum limit on next boot")
    },
7240
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
7241
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
7242
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
7243 7244 7245 7246
    {.name = "guest",
     .type = VSH_OT_BOOL,
     .help = N_("modify cpu state in the guest")
    },
7247 7248 7249 7250
    {.name = "hotpluggable",
     .type = VSH_OT_BOOL,
     .help = N_("make added vcpus hot(un)pluggable")
    },
7251
    {.name = NULL}
7252 7253 7254 7255 7256 7257
};

static bool
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
7258
    unsigned int count = 0;
7259
    bool ret = false;
7260 7261 7262 7263
    bool maximum = vshCommandOptBool(cmd, "maximum");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
7264
    bool guest = vshCommandOptBool(cmd, "guest");
7265
    bool hotpluggable = vshCommandOptBool(cmd, "hotpluggable");
7266
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
7267

7268 7269
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);
7270
    VSH_EXCLUSIVE_OPTIONS_VAR(guest, config);
7271

7272 7273
    VSH_REQUIRE_OPTION_VAR(maximum, config);

7274 7275 7276 7277
    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
7278 7279
    if (guest)
        flags |= VIR_DOMAIN_VCPU_GUEST;
7280 7281
    if (maximum)
        flags |= VIR_DOMAIN_VCPU_MAXIMUM;
7282 7283
    if (hotpluggable)
        flags |= VIR_DOMAIN_VCPU_HOTPLUGGABLE;
7284

7285
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
7286 7287
        return false;

7288
    if (vshCommandOptUInt(ctl, cmd, "count", &count) < 0)
7289 7290
        goto cleanup;

7291 7292 7293 7294 7295
    if (count == 0) {
        vshError(ctl, _("Can't set 0 processors for a VM"));
        goto cleanup;
    }

7296 7297
    /* none of the options were specified */
    if (!current && flags == 0) {
7298 7299
        if (virDomainSetVcpus(dom, count) != 0)
            goto cleanup;
7300
    } else {
7301 7302
        if (virDomainSetVcpusFlags(dom, count, flags) < 0)
            goto cleanup;
7303 7304
    }

7305 7306
    ret = true;

7307
 cleanup:
7308
    virshDomainFree(dom);
7309 7310 7311
    return ret;
}

7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327

/*
 * "guestvcpus" command
 */
static const vshCmdInfo info_guestvcpus[] = {
    {.name = "help",
     .data = N_("query or modify state of vcpu in the guest (via agent)")
    },
    {.name = "desc",
     .data = N_("Use the guest agent to query or set cpu state from guest's "
                "point of view")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_guestvcpus[] = {
7328
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363
    {.name = "cpulist",
     .type = VSH_OT_STRING,
     .help = N_("list of cpus to enable or disable")
    },
    {.name = "enable",
     .type = VSH_OT_BOOL,
     .help = N_("enable cpus specified by cpulist")
    },
    {.name = "disable",
     .type = VSH_OT_BOOL,
     .help = N_("disable cpus specified by cpulist")
    },
    {.name = NULL}
};

static bool
cmdGuestvcpus(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool enable = vshCommandOptBool(cmd, "enable");
    bool disable = vshCommandOptBool(cmd, "disable");
    virTypedParameterPtr params = NULL;
    unsigned int nparams = 0;
    const char *cpulist = NULL;
    int state = 0;
    size_t i;
    bool ret = false;

    VSH_EXCLUSIVE_OPTIONS_VAR(enable, disable);
    VSH_REQUIRE_OPTION("enable", "cpulist");
    VSH_REQUIRE_OPTION("disable", "cpulist");

    if (vshCommandOptStringReq(ctl, cmd, "cpulist", &cpulist))
        return false;

7364
    if (cpulist && !(enable || disable)) {
7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393
        vshError(ctl, _("One of options --enable or --disable is required by "
                        "option --cpulist"));
        return false;
    }

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    if (enable)
        state = 1;

    if (cpulist) {
        if (virDomainSetGuestVcpus(dom, cpulist, state, 0) < 0)
            goto cleanup;
    } else {
        if (virDomainGetGuestVcpus(dom, &params, &nparams, 0) < 0)
            goto cleanup;

        for (i = 0; i < nparams; i++) {
            char *str = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
            VIR_FREE(str);
        }
    }

    ret = true;

 cleanup:
    virTypedParamsFree(params, nparams);
7394
    virshDomainFree(dom);
7395 7396 7397 7398
    return ret;
}


7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412
/*
 * "setvcpu" command
 */
static const vshCmdInfo info_setvcpu[] = {
    {.name = "help",
     .data = N_("attach/detach vcpu or groups of threads")
    },
    {.name = "desc",
     .data = N_("Add or remove vcpus")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_setvcpu[] = {
7413
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475
    {.name = "vcpulist",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("ids of vcpus to manipulate")
    },
    {.name = "enable",
     .type = VSH_OT_BOOL,
     .help = N_("enable cpus specified by cpumap")
    },
    {.name = "disable",
     .type = VSH_OT_BOOL,
     .help = N_("disable cpus specified by cpumap")
    },
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
    {.name = NULL}
};

static bool
cmdSetvcpu(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool enable = vshCommandOptBool(cmd, "enable");
    bool disable = vshCommandOptBool(cmd, "disable");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    const char *vcpulist = NULL;
    int state = 0;
    bool ret = false;
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;

    VSH_EXCLUSIVE_OPTIONS_VAR(enable, disable);

    VSH_EXCLUSIVE_OPTIONS("current", "live");
    VSH_EXCLUSIVE_OPTIONS("current", "config");

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

    if (!(enable || disable)) {
        vshError(ctl, "%s", _("one of --enable, --disable is required"));
        return false;
    }

    if (vshCommandOptStringReq(ctl, cmd, "vcpulist", &vcpulist))
        return false;

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    if (enable)
        state = 1;

    if (virDomainSetVcpu(dom, vcpulist, state, flags) < 0)
        goto cleanup;

    ret = true;

 cleanup:
7476
    virshDomainFree(dom);
7477 7478 7479 7480
    return ret;
}


7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495
/*
 * "domblkthreshold" command
 */
static const vshCmdInfo info_domblkthreshold[] = {
    {.name = "help",
     .data = N_("set the threshold for block-threshold event for a given block "
                "device or it's backing chain element")
    },
    {.name = "desc",
     .data = N_("set threshold for block-threshold event for a block device")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_domblkthreshold[] = {
7496
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
7497 7498 7499
    {.name = "dev",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
7500
     .completer = virshDomainDiskTargetCompleter,
7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534
     .help = N_("device to set threshold for")
    },
    {.name = "threshold",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ,
     .help = N_("threshold as a scaled number (by default bytes)")
    },
    {.name = NULL}
};

static bool
cmdDomblkthreshold(vshControl *ctl, const vshCmd *cmd)
{
    unsigned long long threshold;
    const char *dev = NULL;
    virDomainPtr dom;
    bool ret = false;

    if (vshCommandOptStringReq(ctl, cmd, "dev", &dev))
        return false;

    if (vshCommandOptScaledInt(ctl, cmd, "threshold",
                               &threshold, 1, ULLONG_MAX) < 0)
        return false;

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    if (virDomainSetBlockThreshold(dom, dev, threshold, 0) < 0)
        goto cleanup;

    ret = true;

 cleanup:
7535
    virshDomainFree(dom);
7536 7537 7538 7539
    return ret;
}


J
John Ferlan 已提交
7540
/*
7541
 * "iothreadinfo" command
J
John Ferlan 已提交
7542
 */
7543
static const vshCmdInfo info_iothreadinfo[] = {
J
John Ferlan 已提交
7544 7545 7546 7547 7548 7549 7550 7551
    {.name = "help",
     .data = N_("view domain IOThreads")
    },
    {.name = "desc",
     .data = N_("Returns basic information about the domain IOThreads.")
    },
    {.name = NULL}
};
7552
static const vshCmdOptDef opts_iothreadinfo[] = {
7553
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
7554
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
7555
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
7556
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
J
John Ferlan 已提交
7557 7558 7559 7560
    {.name = NULL}
};

static bool
7561
cmdIOThreadInfo(vshControl *ctl, const vshCmd *cmd)
J
John Ferlan 已提交
7562 7563 7564 7565 7566
{
    virDomainPtr dom;
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
7567
    size_t niothreads = 0;
7568
    virDomainIOThreadInfoPtr *info = NULL;
J
John Ferlan 已提交
7569 7570
    size_t i;
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
7571
    vshTablePtr table = NULL;
7572
    bool ret = false;
7573
    int rc;
J
John Ferlan 已提交
7574 7575 7576 7577 7578 7579 7580 7581 7582

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

7583
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
J
John Ferlan 已提交
7584 7585
        return false;

7586
    if ((rc = virDomainGetIOThreadInfo(dom, &info, flags)) < 0) {
J
John Ferlan 已提交
7587 7588 7589
        vshError(ctl, _("Unable to get domain IOThreads information"));
        goto cleanup;
    }
7590
    niothreads = rc;
J
John Ferlan 已提交
7591 7592

    if (niothreads == 0) {
7593
        ret = true;
J
John Ferlan 已提交
7594 7595 7596 7597
        vshPrintExtra(ctl, _("No IOThreads found for the domain"));
        goto cleanup;
    }

7598 7599 7600 7601
    table = vshTableNew(_("IOThread ID"), _("CPU Affinity"), NULL);
    if (!table)
        goto cleanup;

J
John Ferlan 已提交
7602
    for (i = 0; i < niothreads; i++) {
7603 7604
        g_autofree char *pinInfo = NULL;
        g_autofree char *iothreadIdStr = NULL;
J
John Ferlan 已提交
7605

7606
        iothreadIdStr = g_strdup_printf("%u", info[i]->iothread_id);
7607 7608 7609 7610 7611

        ignore_value(pinInfo = virBitmapDataFormat(info[i]->cpumap, info[i]->cpumaplen));

        if (vshTableRowAppend(table, iothreadIdStr, pinInfo ? pinInfo : "", NULL) < 0)
            goto cleanup;
J
John Ferlan 已提交
7612
    }
7613 7614

    vshTablePrintToStdout(table, ctl);
J
John Ferlan 已提交
7615

7616 7617
    ret = true;

J
John Ferlan 已提交
7618
 cleanup:
7619 7620 7621 7622
    for (i = 0; i < niothreads; i++)
        virDomainIOThreadInfoFree(info[i]);
    VIR_FREE(info);
    vshTableFree(table);
7623
    virshDomainFree(dom);
7624
    return ret;
J
John Ferlan 已提交
7625 7626
}

J
John Ferlan 已提交
7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640
/*
 * "iothreadpin" command
 */
static const vshCmdInfo info_iothreadpin[] = {
    {.name = "help",
     .data = N_("control domain IOThread affinity")
    },
    {.name = "desc",
     .data = N_("Pin domain IOThreads to host physical CPUs.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_iothreadpin[] = {
7641
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
J
John Ferlan 已提交
7642 7643 7644 7645 7646 7647 7648 7649 7650 7651
    {.name = "iothread",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ,
     .help = N_("IOThread ID number")
    },
    {.name = "cpulist",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("host cpu number(s) to set")
    },
7652
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
7653
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
7654
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
J
John Ferlan 已提交
7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669
    {.name = NULL}
};

static bool
cmdIOThreadPin(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *cpulist = NULL;
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
    unsigned int iothread_id = 0;
    int maxcpu;
    bool ret = false;
    unsigned char *cpumap = NULL;
J
Ján Tomko 已提交
7670
    int cpumaplen;
J
John Ferlan 已提交
7671
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
7672
    virshControlPtr priv = ctl->privData;
J
John Ferlan 已提交
7673 7674 7675 7676 7677 7678 7679 7680 7681

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

7682
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
J
John Ferlan 已提交
7683 7684
        return false;

7685
    if (vshCommandOptUInt(ctl, cmd, "iothread", &iothread_id) < 0)
J
John Ferlan 已提交
7686 7687
        goto cleanup;

7688
    if (vshCommandOptStringReq(ctl, cmd, "cpulist", &cpulist) < 0)
J
John Ferlan 已提交
7689 7690
        goto cleanup;

7691
    if ((maxcpu = virshNodeGetCPUCount(priv->conn)) < 0)
J
John Ferlan 已提交
7692 7693
        goto cleanup;

7694
    if (!(cpumap = virshParseCPUList(ctl, &cpumaplen, cpulist, maxcpu)))
J
John Ferlan 已提交
7695 7696 7697 7698 7699 7700 7701 7702 7703 7704
        goto cleanup;

    if (virDomainPinIOThread(dom, iothread_id,
                             cpumap, cpumaplen, flags) != 0)
        goto cleanup;

    ret = true;

 cleanup:
    VIR_FREE(cpumap);
7705
    virshDomainFree(dom);
J
John Ferlan 已提交
7706 7707 7708
    return ret;
}

7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722
/*
 * "iothreadadd" command
 */
static const vshCmdInfo info_iothreadadd[] = {
    {.name = "help",
     .data = N_("add an IOThread to the guest domain")
    },
    {.name = "desc",
     .data = N_("Add an IOThread to the guest domain.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_iothreadadd[] = {
7723
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
7724 7725 7726 7727 7728
    {.name = "id",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ,
     .help = N_("iothread for the new IOThread")
    },
7729
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
7730
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
7731
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753
    {.name = NULL}
};

static bool
cmdIOThreadAdd(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int iothread_id = 0;
    bool ret = false;
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

7754
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
7755 7756
        return false;

7757
    if (vshCommandOptInt(ctl, cmd, "id", &iothread_id) < 0)
7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769
        goto cleanup;
    if (iothread_id <= 0) {
        vshError(ctl, _("Invalid IOThread id value: '%d'"), iothread_id);
        goto cleanup;
    }

    if (virDomainAddIOThread(dom, iothread_id, flags) < 0)
        goto cleanup;

    ret = true;

 cleanup:
7770
    virshDomainFree(dom);
7771 7772 7773
    return ret;
}

J
John Ferlan 已提交
7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877

 /*
 * "iothreadset" command
 */
static const vshCmdInfo info_iothreadset[] = {
    {.name = "help",
     .data = N_("modifies an existing IOThread of the guest domain")
    },
    {.name = "desc",
     .data = N_("Modifies an existing IOThread of the guest domain.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_iothreadset[] = {
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
    {.name = "id",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ,
     .help = N_("iothread id of existing IOThread")
    },
    {.name = "poll-max-ns",
     .type = VSH_OT_INT,
     .help = N_("set the maximum IOThread polling time in ns")
    },
    {.name = "poll-grow",
     .type = VSH_OT_INT,
     .help = N_("set the value to increase the IOThread polling time")
    },
    {.name = "poll-shrink",
     .type = VSH_OT_INT,
     .help = N_("set the value for reduction of the IOThread polling time ")
    },
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
    {.name = NULL}
};

static bool
cmdIOThreadSet(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int id = 0;
    bool ret = false;
    bool live = vshCommandOptBool(cmd, "live");
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
    virTypedParameterPtr params = NULL;
    int nparams = 0;
    int maxparams = 0;
    unsigned long long poll_max;
    unsigned int poll_val;
    int rc;

    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    if (vshCommandOptInt(ctl, cmd, "id", &id) < 0)
        goto cleanup;
    if (id <= 0) {
        vshError(ctl, _("Invalid IOThread id value: '%d'"), id);
        goto cleanup;
    }

    poll_val = 0;
    if ((rc = vshCommandOptULongLong(ctl, cmd, "poll-max-ns", &poll_max)) < 0)
        goto cleanup;
    if (rc > 0 && virTypedParamsAddULLong(&params, &nparams, &maxparams,
                                          VIR_DOMAIN_IOTHREAD_POLL_MAX_NS,
                                          poll_max) < 0)
        goto save_error;

#define VSH_IOTHREAD_SET_UINT_PARAMS(opt, param) \
    poll_val = 0; \
    if ((rc = vshCommandOptUInt(ctl, cmd, opt, &poll_val)) < 0) \
        goto cleanup; \
    if (rc > 0 && \
        virTypedParamsAddUInt(&params, &nparams, &maxparams, \
                              param, poll_val) < 0) \
        goto save_error;

    VSH_IOTHREAD_SET_UINT_PARAMS("poll-grow", VIR_DOMAIN_IOTHREAD_POLL_GROW)
    VSH_IOTHREAD_SET_UINT_PARAMS("poll-shrink", VIR_DOMAIN_IOTHREAD_POLL_SHRINK)

#undef VSH_IOTHREAD_SET_UINT_PARAMS

    if (virDomainSetIOThreadParams(dom, id, params, nparams, flags) < 0)
        goto cleanup;

    ret = true;

 cleanup:
    virTypedParamsFree(params, nparams);
    virshDomainFree(dom);
    return ret;

 save_error:
    vshSaveLibvirtError();
    goto cleanup;
}


7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891
/*
 * "iothreaddel" command
 */
static const vshCmdInfo info_iothreaddel[] = {
    {.name = "help",
     .data = N_("delete an IOThread from the guest domain")
    },
    {.name = "desc",
     .data = N_("Delete an IOThread from the guest domain.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_iothreaddel[] = {
7892
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
7893 7894 7895 7896 7897
    {.name = "id",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ,
     .help = N_("iothread_id for the IOThread to delete")
    },
7898
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
7899
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
7900
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922
    {.name = NULL}
};

static bool
cmdIOThreadDel(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int iothread_id = 0;
    bool ret = false;
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

7923
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
7924 7925
        return false;

7926
    if (vshCommandOptInt(ctl, cmd, "id", &iothread_id) < 0)
7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938
        goto cleanup;
    if (iothread_id <= 0) {
        vshError(ctl, _("Invalid IOThread id value: '%d'"), iothread_id);
        goto cleanup;
    }

    if (virDomainDelIOThread(dom, iothread_id, flags) < 0)
        goto cleanup;

    ret = true;

 cleanup:
7939
    virshDomainFree(dom);
7940 7941 7942
    return ret;
}

7943 7944 7945 7946
/*
 * "cpu-stats" command
 */
static const vshCmdInfo info_cpu_stats[] = {
7947 7948 7949 7950 7951 7952
    {.name = "help",
     .data = N_("show domain cpu statistics")
    },
    {.name = "desc",
     .data = N_("Display per-CPU and total statistics about the domain's CPUs")
    },
7953
    {.name = NULL}
7954 7955 7956
};

static const vshCmdOptDef opts_cpu_stats[] = {
7957
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969
    {.name = "total",
     .type = VSH_OT_BOOL,
     .help = N_("Show total statistics only")
    },
    {.name = "start",
     .type = VSH_OT_INT,
     .help = N_("Show statistics from this CPU")
    },
    {.name = "count",
     .type = VSH_OT_INT,
     .help = N_("Number of shown CPUs at most")
    },
7970
    {.name = NULL}
7971 7972
};

7973 7974 7975 7976 7977 7978
static void
vshCPUStatsPrintField(vshControl *ctl,
                      virTypedParameterPtr param)
{
    vshPrint(ctl, "\t%-12s ", param->field);
    if ((STREQ(param->field, VIR_DOMAIN_CPU_STATS_CPUTIME) ||
7979
         STREQ(param->field, VIR_DOMAIN_CPU_STATS_VCPUTIME) ||
7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992
         STREQ(param->field, VIR_DOMAIN_CPU_STATS_USERTIME) ||
         STREQ(param->field, VIR_DOMAIN_CPU_STATS_SYSTEMTIME)) &&
        param->type == VIR_TYPED_PARAM_ULLONG) {
        vshPrint(ctl, "%9lld.%09lld seconds\n",
                 param->value.ul / 1000000000,
                 param->value.ul % 1000000000);
    } else {
        char *s = vshGetTypedParamValue(ctl, param);
        vshPrint(ctl, "%s\n", s);
        VIR_FREE(s);
    }
}

7993 7994 7995 7996 7997
static bool
cmdCPUStats(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    virTypedParameterPtr params = NULL;
7998
    int max_id, cpu = 0, show_count = -1, nparams = 0, stats_per_cpu;
7999
    size_t i, j;
8000
    bool show_total = false, show_per_cpu = false;
8001
    bool ret = false;
8002
    int rv = 0;
8003

8004
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
8005 8006 8007
        return false;

    show_total = vshCommandOptBool(cmd, "total");
8008

8009
    if ((rv = vshCommandOptInt(ctl, cmd, "start", &cpu)) < 0) {
8010 8011 8012 8013 8014 8015
        goto cleanup;
    } else if (rv > 0) {
        if (cpu < 0) {
            vshError(ctl, "%s", _("Invalid value for start CPU"));
            goto cleanup;
        }
8016
        show_per_cpu = true;
8017 8018
    }

8019
    if ((rv = vshCommandOptInt(ctl, cmd, "count", &show_count)) < 0) {
8020 8021 8022 8023 8024 8025
        goto cleanup;
    } else if (rv > 0) {
        if (show_count < 0) {
            vshError(ctl, "%s", _("Invalid value for number of CPUs to show"));
            goto cleanup;
        }
8026
        show_per_cpu = true;
8027
    }
8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038

    /* default show per_cpu and total */
    if (!show_total && !show_per_cpu) {
        show_total = true;
        show_per_cpu = true;
    }

    if (!show_per_cpu) /* show total stats only */
        goto do_show_total;

    /* get number of cpus on the node */
8039
    if ((max_id = virDomainGetCPUStats(dom, NULL, 0, 0, 0, 0)) < 0)
8040
        goto failed_stats;
8041 8042 8043 8044 8045 8046 8047

    if (cpu >= max_id) {
        vshError(ctl, "Start CPU %d is out of range (min: 0, max: %d)",
                 cpu, max_id - 1);
        goto cleanup;
    }

8048 8049 8050
    if (show_count < 0 || show_count > max_id) {
        if (show_count > max_id)
            vshPrint(ctl, _("Only %d CPUs available to show\n"), max_id);
8051
        show_count = max_id - cpu;
8052
    }
8053 8054

    /* get percpu information */
8055
    if ((nparams = virDomainGetCPUStats(dom, NULL, 0, 0, 1, 0)) < 0)
8056 8057 8058 8059
        goto failed_stats;

    if (!nparams) {
        vshPrint(ctl, "%s", _("No per-CPU stats available"));
8060 8061 8062
        if (show_total)
            goto do_show_total;
        goto cleanup;
8063 8064 8065
    }

    if (VIR_ALLOC_N(params, nparams * MIN(show_count, 128)) < 0)
8066
        goto cleanup;
8067 8068 8069 8070

    while (show_count) {
        int ncpus = MIN(show_count, 128);

8071
        if (virDomainGetCPUStats(dom, params, nparams, cpu, ncpus, 0) < 0)
8072 8073 8074 8075 8076
            goto failed_stats;

        for (i = 0; i < ncpus; i++) {
            if (params[i * nparams].type == 0) /* this cpu is not in the map */
                continue;
8077
            vshPrint(ctl, "CPU%zu:\n", cpu + i);
8078

8079 8080
            for (j = 0; j < nparams; j++)
                vshCPUStatsPrintField(ctl, params + (i * nparams + j));
8081 8082 8083
        }
        cpu += ncpus;
        show_count -= ncpus;
8084
        virTypedParamsClear(params, nparams * ncpus);
8085 8086 8087
    }
    VIR_FREE(params);

8088 8089
    if (!show_total) {
        ret = true;
8090
        goto cleanup;
8091
    }
8092

8093
 do_show_total:
8094
    /* get supported num of parameter for total statistics */
8095
    if ((nparams = virDomainGetCPUStats(dom, NULL, 0, -1, 1, 0)) < 0)
8096 8097 8098 8099 8100 8101 8102
        goto failed_stats;

    if (!nparams) {
        vshPrint(ctl, "%s", _("No total stats available"));
        goto cleanup;
    }

8103
    if (VIR_ALLOC_N(params, nparams) < 0)
8104
        goto cleanup;
8105 8106

    /* passing start_cpu == -1 gives us domain's total status */
8107
    if ((stats_per_cpu = virDomainGetCPUStats(dom, params, nparams,
8108
                                              -1, 1, 0)) < 0)
8109 8110 8111
        goto failed_stats;

    vshPrint(ctl, _("Total:\n"));
8112 8113
    for (i = 0; i < stats_per_cpu; i++)
        vshCPUStatsPrintField(ctl, params + i);
8114 8115

    ret = true;
8116

8117
 cleanup:
8118
    virTypedParamsFree(params, nparams);
8119
    virshDomainFree(dom);
8120
    return ret;
8121

8122
 failed_stats:
8123 8124 8125
    vshError(ctl, _("Failed to retrieve CPU statistics for domain '%s'"),
             virDomainGetName(dom));
    goto cleanup;
8126 8127 8128 8129 8130 8131
}

/*
 * "create" command
 */
static const vshCmdInfo info_create[] = {
8132 8133 8134 8135 8136 8137 8138
    {.name = "help",
     .data = N_("create a domain from an XML file")
    },
    {.name = "desc",
     .data = N_("Create a domain.")
    },
    {.name = NULL}
8139 8140 8141
};

static const vshCmdOptDef opts_create[] = {
8142
    VIRSH_COMMON_OPT_FILE(N_("file containing an XML domain description")),
8143
#ifndef WIN32
8144 8145 8146 8147
    {.name = "console",
     .type = VSH_OT_BOOL,
     .help = N_("attach to console after creation")
    },
8148
#endif
8149 8150 8151 8152 8153 8154 8155 8156
    {.name = "paused",
     .type = VSH_OT_BOOL,
     .help = N_("leave the guest paused after creation")
    },
    {.name = "autodestroy",
     .type = VSH_OT_BOOL,
     .help = N_("automatically destroy the guest when virsh disconnects")
    },
8157 8158 8159 8160
    {.name = "pass-fds",
     .type = VSH_OT_STRING,
     .help = N_("pass file descriptors N,M,... to the guest")
    },
8161 8162 8163 8164
    {.name = "validate",
     .type = VSH_OT_BOOL,
     .help = N_("validate the XML against the schema")
    },
8165
    {.name = NULL}
8166 8167 8168 8169 8170 8171 8172
};

static bool
cmdCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *from = NULL;
8173
    bool ret = false;
8174 8175 8176 8177
    char *buffer;
#ifndef WIN32
    bool console = vshCommandOptBool(cmd, "console");
#endif
8178
    unsigned int flags = 0;
8179 8180
    size_t nfds = 0;
    int *fds = NULL;
8181
    virshControlPtr priv = ctl->privData;
8182

8183
    if (vshCommandOptStringReq(ctl, cmd, "file", &from) < 0)
8184 8185
        return false;

E
Eric Blake 已提交
8186
    if (virFileReadAll(from, VSH_MAX_XML_FILE, &buffer) < 0)
8187 8188
        return false;

8189
    if (cmdStartGetFDs(ctl, cmd, &nfds, &fds) < 0)
8190
        goto cleanup;
8191

8192 8193 8194 8195
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
8196 8197
    if (vshCommandOptBool(cmd, "validate"))
        flags |= VIR_DOMAIN_START_VALIDATE;
8198

8199
    if (nfds)
8200
        dom = virDomainCreateXMLWithFiles(priv->conn, buffer, nfds, fds, flags);
8201
    else
8202
        dom = virDomainCreateXML(priv->conn, buffer, flags);
8203

8204
    if (!dom) {
8205
        vshError(ctl, _("Failed to create domain from %s"), from);
8206
        goto cleanup;
8207
    }
8208

P
Pino Toscano 已提交
8209 8210
    vshPrintExtra(ctl, _("Domain %s created from %s\n"),
                  virDomainGetName(dom), from);
8211 8212 8213 8214
#ifndef WIN32
    if (console)
        cmdRunConsole(ctl, dom, NULL, 0);
#endif
8215
    virshDomainFree(dom);
8216 8217
    ret = true;

8218
 cleanup:
8219
    VIR_FREE(buffer);
8220
    VIR_FREE(fds);
8221 8222 8223 8224 8225 8226 8227
    return ret;
}

/*
 * "define" command
 */
static const vshCmdInfo info_define[] = {
8228 8229 8230 8231 8232 8233 8234
    {.name = "help",
     .data = N_("define (but don't start) a domain from an XML file")
    },
    {.name = "desc",
     .data = N_("Define a domain.")
    },
    {.name = NULL}
8235 8236 8237
};

static const vshCmdOptDef opts_define[] = {
8238
    VIRSH_COMMON_OPT_FILE(N_("file containing an XML domain description")),
8239 8240 8241 8242
    {.name = "validate",
     .type = VSH_OT_BOOL,
     .help = N_("validate the XML against the schema")
    },
8243
    {.name = NULL}
8244 8245 8246 8247 8248 8249 8250 8251 8252
};

static bool
cmdDefine(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *from = NULL;
    bool ret = true;
    char *buffer;
8253
    unsigned int flags = 0;
8254
    virshControlPtr priv = ctl->privData;
8255

8256
    if (vshCommandOptStringReq(ctl, cmd, "file", &from) < 0)
8257 8258
        return false;

8259 8260 8261
    if (vshCommandOptBool(cmd, "validate"))
        flags |= VIR_DOMAIN_DEFINE_VALIDATE;

E
Eric Blake 已提交
8262
    if (virFileReadAll(from, VSH_MAX_XML_FILE, &buffer) < 0)
8263 8264
        return false;

8265
    if (flags)
8266
        dom = virDomainDefineXMLFlags(priv->conn, buffer, flags);
8267
    else
8268
        dom = virDomainDefineXML(priv->conn, buffer);
8269 8270 8271
    VIR_FREE(buffer);

    if (dom != NULL) {
P
Pino Toscano 已提交
8272 8273
        vshPrintExtra(ctl, _("Domain %s defined from %s\n"),
                      virDomainGetName(dom), from);
8274
        virshDomainFree(dom);
8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285
    } else {
        vshError(ctl, _("Failed to define domain from %s"), from);
        ret = false;
    }
    return ret;
}

/*
 * "destroy" command
 */
static const vshCmdInfo info_destroy[] = {
8286 8287 8288 8289 8290 8291 8292
    {.name = "help",
     .data = N_("destroy (stop) a domain")
    },
    {.name = "desc",
     .data = N_("Forcefully stop a given domain, but leave its resources intact.")
    },
    {.name = NULL}
8293 8294 8295
};

static const vshCmdOptDef opts_destroy[] = {
8296
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
8297 8298 8299 8300 8301
    {.name = "graceful",
     .type = VSH_OT_BOOL,
     .help = N_("terminate gracefully")
    },
    {.name = NULL}
8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312
};

static bool
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = true;
    const char *name;
    unsigned int flags = 0;
    int result;

8313
    if (!(dom = virshCommandOptDomain(ctl, cmd, &name)))
8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324
        return false;

    if (vshCommandOptBool(cmd, "graceful"))
       flags |= VIR_DOMAIN_DESTROY_GRACEFUL;

    if (flags)
       result = virDomainDestroyFlags(dom, VIR_DOMAIN_DESTROY_GRACEFUL);
    else
       result = virDomainDestroy(dom);

    if (result == 0) {
P
Pino Toscano 已提交
8325
        vshPrintExtra(ctl, _("Domain %s destroyed\n"), name);
8326 8327 8328 8329 8330
    } else {
        vshError(ctl, _("Failed to destroy domain %s"), name);
        ret = false;
    }

8331
    virshDomainFree(dom);
8332 8333 8334 8335 8336 8337 8338
    return ret;
}

/*
 * "desc" command for managing domain description and title
 */
static const vshCmdInfo info_desc[] = {
8339 8340 8341 8342
    {.name = "help",
     .data = N_("show or set domain's description or title")
    },
    {.name = "desc",
A
Andrea Bolognani 已提交
8343 8344
     .data = N_("Allows setting or modifying the description or title of "
                "a domain.")
8345 8346
    },
    {.name = NULL}
8347 8348 8349
};

static const vshCmdOptDef opts_desc[] = {
8350
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
8351
    VIRSH_COMMON_OPT_LIVE(N_("modify/get running state")),
8352
    VIRSH_COMMON_OPT_CONFIG(N_("modify/get persistent configuration")),
8353
    VIRSH_COMMON_OPT_CURRENT(N_("modify/get current state configuration")),
8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366
    {.name = "title",
     .type = VSH_OT_BOOL,
     .help = N_("modify/get the title instead of description")
    },
    {.name = "edit",
     .type = VSH_OT_BOOL,
     .help = N_("open an editor to modify the description")
    },
    {.name = "new-desc",
     .type = VSH_OT_ARGV,
     .help = N_("message")
    },
    {.name = NULL}
8367 8368 8369
};

static bool
8370
cmdDesc(vshControl *ctl, const vshCmd *cmd)
8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390
{
    virDomainPtr dom;
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");

    bool title = vshCommandOptBool(cmd, "title");
    bool edit = vshCommandOptBool(cmd, "edit");

    int state;
    int type;
    char *desc = NULL;
    char *desc_edited = NULL;
    char *tmp = NULL;
    char *tmpstr;
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool ret = false;
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;

8391 8392 8393 8394 8395 8396 8397
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
8398

8399
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
8400 8401
        return false;

8402
    if ((state = virshDomainState(ctl, dom, NULL)) < 0)
8403 8404 8405 8406 8407 8408 8409
        goto cleanup;

    if (title)
        type = VIR_DOMAIN_METADATA_TITLE;
    else
        type = VIR_DOMAIN_METADATA_DESCRIPTION;

8410 8411 8412 8413 8414
    while ((opt = vshCommandOptArgv(ctl, cmd, opt)))
        virBufferAsprintf(&buf, "%s ", opt->data);

    virBufferTrim(&buf, " ", -1);

8415 8416 8417 8418
    desc = virBufferContentAndReset(&buf);

    if (edit || desc) {
        if (!desc) {
8419
                desc = virshGetDomainDescription(ctl, dom, title,
8420 8421 8422 8423 8424 8425 8426
                                           config?VIR_DOMAIN_XML_INACTIVE:0);
                if (!desc)
                    goto cleanup;
        }

        if (edit) {
            /* Create and open the temporary file. */
E
Eric Blake 已提交
8427
            if (!(tmp = vshEditWriteToTempFile(ctl, desc)))
8428 8429 8430
                goto cleanup;

            /* Start the editor. */
E
Eric Blake 已提交
8431
            if (vshEditFile(ctl, tmp) == -1)
8432 8433 8434
                goto cleanup;

            /* Read back the edited file. */
E
Eric Blake 已提交
8435
            if (!(desc_edited = vshEditReadBackFile(ctl, tmp)))
8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447
                goto cleanup;

            /* strip a possible newline at the end of file; some
             * editors enforce a newline, this makes editing the title
             * more convenient */
            if (title &&
                (tmpstr = strrchr(desc_edited, '\n')) &&
                *(tmpstr+1) == '\0')
                *tmpstr = '\0';

            /* Compare original XML with edited.  Has it changed at all? */
            if (STREQ(desc, desc_edited)) {
P
Pino Toscano 已提交
8448 8449 8450
                vshPrintExtra(ctl, "%s",
                              title ? _("Domain title not changed\n") :
                                      _("Domain description not changed\n"));
8451 8452 8453 8454 8455
                ret = true;
                goto cleanup;
            }

            VIR_FREE(desc);
8456
            desc = g_steal_pointer(&desc_edited);
8457 8458 8459 8460
        }

        if (virDomainSetMetadata(dom, type, desc, NULL, NULL, flags) < 0) {
            vshError(ctl, "%s",
8461 8462
                     title ? _("Failed to set new domain title") :
                             _("Failed to set new domain description"));
8463 8464
            goto cleanup;
        }
P
Pino Toscano 已提交
8465 8466 8467
        vshPrintExtra(ctl, "%s",
                      title ? _("Domain title updated successfully") :
                              _("Domain description updated successfully"));
8468
    } else {
8469
        desc = virshGetDomainDescription(ctl, dom, title,
8470 8471 8472 8473 8474 8475 8476
                                       config?VIR_DOMAIN_XML_INACTIVE:0);
        if (!desc)
            goto cleanup;

        if (strlen(desc) > 0)
            vshPrint(ctl, "%s", desc);
        else
P
Pino Toscano 已提交
8477 8478 8479 8480
            vshPrintExtra(ctl,
                          title ? _("No title for domain: %s") :
                                  _("No description for domain: %s"),
                          virDomainGetName(dom));
8481 8482 8483
    }

    ret = true;
8484
 cleanup:
8485 8486 8487 8488 8489 8490
    VIR_FREE(desc_edited);
    VIR_FREE(desc);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
8491
    virshDomainFree(dom);
8492 8493 8494
    return ret;
}

8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506

static const vshCmdInfo info_metadata[] = {
    {.name = "help",
     .data = N_("show or set domain's custom XML metadata")
    },
    {.name = "desc",
     .data = N_("Shows or modifies the XML metadata of a domain.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_metadata[] = {
8507
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
M
Martin Kletzander 已提交
8508 8509 8510 8511 8512
    {.name = "uri",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("URI of the namespace")
    },
8513
    VIRSH_COMMON_OPT_LIVE(N_("modify/get running state")),
8514
    VIRSH_COMMON_OPT_CONFIG(N_("modify/get persistent configuration")),
8515
    VIRSH_COMMON_OPT_CURRENT(N_("modify/get current state configuration")),
8516 8517 8518 8519 8520
    {.name = "edit",
     .type = VSH_OT_BOOL,
     .help = N_("use an editor to change the metadata")
    },
    {.name = "key",
8521
     .type = VSH_OT_STRING,
8522 8523 8524
     .help = N_("key to be used as a namespace identifier"),
    },
    {.name = "set",
8525
     .type = VSH_OT_STRING,
8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537
     .help = N_("new metadata to set"),
    },
    {.name = "remove",
     .type = VSH_OT_BOOL,
     .help = N_("remove the metadata corresponding to an uri")
    },
    {.name = NULL}
};


/* helper to add new metadata using the --edit option */
static char *
8538
virshDomainGetEditMetadata(vshControl *ctl G_GNUC_UNUSED,
8539 8540 8541
                           virDomainPtr dom,
                           const char *uri,
                           unsigned int flags)
8542 8543 8544 8545 8546 8547
{
    char *ret;

    if (!(ret = virDomainGetMetadata(dom, VIR_DOMAIN_METADATA_ELEMENT,
                                     uri, flags))) {
        vshResetLibvirtError();
8548
        ret = g_strdup("\n");
8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562
    }

    return ret;
}


static bool
cmdMetadata(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
    bool edit = vshCommandOptBool(cmd, "edit");
8563
    bool rem = vshCommandOptBool(cmd, "remove");
8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580
    const char *set = NULL;
    const char *uri = NULL;
    const char *key = NULL;
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
    bool ret = false;

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);
    VSH_EXCLUSIVE_OPTIONS("edit", "set");
    VSH_EXCLUSIVE_OPTIONS("remove", "set");
    VSH_EXCLUSIVE_OPTIONS("remove", "edit");

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

8581
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594
        return false;

    if (vshCommandOptStringReq(ctl, cmd, "uri", &uri) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "key", &key) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "set", &set) < 0)
        goto cleanup;

    if ((set || edit) && !key) {
        vshError(ctl, "%s",
                 _("namespace key is required when modifying metadata"));
        goto cleanup;
    }

8595
    if (set || rem) {
8596 8597 8598 8599
        if (virDomainSetMetadata(dom, VIR_DOMAIN_METADATA_ELEMENT,
                                 set, key, uri, flags))
            goto cleanup;

8600
        if (rem)
P
Pino Toscano 已提交
8601
            vshPrintExtra(ctl, "%s\n", _("Metadata removed"));
8602
        else
P
Pino Toscano 已提交
8603
            vshPrintExtra(ctl, "%s\n", _("Metadata modified"));
8604 8605
    } else if (edit) {
#define EDIT_GET_XML \
8606
        virshDomainGetEditMetadata(ctl, dom, uri, flags)
8607 8608
#define EDIT_NOT_CHANGED \
        do { \
P
Pino Toscano 已提交
8609
            vshPrintExtra(ctl, "%s", _("Metadata not changed")); \
8610 8611
            ret = true; \
            goto edit_cleanup; \
8612 8613
        } while (0)

8614
#define EDIT_DEFINE \
8615 8616 8617 8618
        (virDomainSetMetadata(dom, VIR_DOMAIN_METADATA_ELEMENT, doc_edited, \
                              key, uri, flags) == 0)
#include "virsh-edit.c"

P
Pino Toscano 已提交
8619
        vshPrintExtra(ctl, "%s\n", _("Metadata modified"));
8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632
    } else {
        char *data;
        /* get */
        if (!(data = virDomainGetMetadata(dom, VIR_DOMAIN_METADATA_ELEMENT,
                                          uri, flags)))
            goto cleanup;

        vshPrint(ctl, "%s\n", data);
        VIR_FREE(data);
    }

    ret = true;

8633
 cleanup:
8634
    virshDomainFree(dom);
8635 8636 8637 8638
    return ret;
}


8639 8640 8641 8642
/*
 * "inject-nmi" command
 */
static const vshCmdInfo info_inject_nmi[] = {
8643 8644 8645 8646 8647 8648 8649
    {.name = "help",
     .data = N_("Inject NMI to the guest")
    },
    {.name = "desc",
     .data = N_("Inject NMI to the guest domain.")
    },
    {.name = NULL}
8650 8651 8652
};

static const vshCmdOptDef opts_inject_nmi[] = {
8653
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
8654
    {.name = NULL}
8655 8656 8657 8658 8659
};

static bool
cmdInjectNMI(vshControl *ctl, const vshCmd *cmd)
{
J
Ján Tomko 已提交
8660
    g_autoptr(virshDomain) dom = NULL;
8661

8662
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
8663 8664 8665
        return false;

    if (virDomainInjectNMI(dom, 0) < 0)
8666
        return false;
8667

8668
    return true;
8669 8670 8671 8672 8673 8674
}

/*
 * "send-key" command
 */
static const vshCmdInfo info_send_key[] = {
8675 8676 8677 8678 8679 8680 8681
    {.name = "help",
     .data = N_("Send keycodes to the guest")
    },
    {.name = "desc",
     .data = N_("Send keycodes (integers or symbolic names) to the guest")
    },
    {.name = NULL}
8682 8683 8684
};

static const vshCmdOptDef opts_send_key[] = {
8685
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701
    {.name = "codeset",
     .type = VSH_OT_STRING,
     .flags = VSH_OFLAG_REQ_OPT,
     .help = N_("the codeset of keycodes, default:linux")
    },
    {.name = "holdtime",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ_OPT,
     .help = N_("the time (in milliseconds) how long the keys will be held")
    },
    {.name = "keycode",
     .type = VSH_OT_ARGV,
     .flags = VSH_OFLAG_REQ,
     .help = N_("the key code")
    },
    {.name = NULL}
8702 8703 8704
};

static int
8705
virshKeyCodeGetInt(const char *key_name)
8706 8707 8708
{
    unsigned int val;

J
Ján Tomko 已提交
8709
    if (virStrToLong_uip(key_name, NULL, 0, &val) < 0 || val > 0xffff)
8710 8711 8712 8713 8714 8715 8716 8717
        return -1;
    return val;
}

static bool
cmdSendKey(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
8718
    bool ret = false;
8719 8720
    const char *codeset_option;
    int codeset;
8721
    unsigned int holdtime = 0;
8722 8723 8724 8725 8726
    int count = 0;
    const vshCmdOpt *opt = NULL;
    int keycode;
    unsigned int keycodes[VIR_DOMAIN_SEND_KEY_MAX_KEYS];

8727
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
8728 8729
        return false;

8730
    if (vshCommandOptStringQuiet(ctl, cmd, "codeset", &codeset_option) <= 0)
8731 8732
        codeset_option = "linux";

8733
    if (vshCommandOptUInt(ctl, cmd, "holdtime", &holdtime) < 0)
8734
        goto cleanup;
8735

8736 8737 8738 8739 8740
    /* The qnum codeset was originally called rfb, so we need to keep
     * accepting the old name for backwards compatibility reasons */
    if (STREQ(codeset_option, "rfb"))
        codeset_option = "qnum";

8741
    codeset = virKeycodeSetTypeFromString(codeset_option);
P
Peter Krempa 已提交
8742
    if (codeset < 0) {
8743 8744 8745 8746
        vshError(ctl, _("unknown codeset: '%s'"), codeset_option);
        goto cleanup;
    }

8747
    while ((opt = vshCommandOptArgv(ctl, cmd, opt))) {
8748 8749 8750 8751 8752
        if (count == VIR_DOMAIN_SEND_KEY_MAX_KEYS) {
            vshError(ctl, _("too many keycodes"));
            goto cleanup;
        }

8753
        if ((keycode = virshKeyCodeGetInt(opt->data)) < 0) {
M
Michal Privoznik 已提交
8754
            if ((keycode = virKeycodeValueFromString(codeset, opt->data)) < 0) {
8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766
                vshError(ctl, _("invalid keycode: '%s'"), opt->data);
                goto cleanup;
            }
        }

        keycodes[count] = keycode;
        count++;
    }

    if (!(virDomainSendKey(dom, codeset, holdtime, keycodes, count, 0) < 0))
        ret = true;

8767
 cleanup:
8768
    virshDomainFree(dom);
8769 8770 8771
    return ret;
}

8772 8773 8774 8775
/*
 * "send-process-signal" command
 */
static const vshCmdInfo info_send_process_signal[] = {
8776 8777 8778 8779 8780 8781 8782
    {.name = "help",
     .data = N_("Send signals to processes")
    },
    {.name = "desc",
     .data = N_("Send signals to processes in the guest")
    },
    {.name = NULL}
8783 8784 8785
};

static const vshCmdOptDef opts_send_process_signal[] = {
8786
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797
    {.name = "pid",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("the process ID")
    },
    {.name = "signame",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("the signal number or name")
    },
    {.name = NULL}
8798 8799
};

8800
VIR_ENUM_DECL(virDomainProcessSignal);
8801 8802
VIR_ENUM_IMPL(virDomainProcessSignal,
              VIR_DOMAIN_PROCESS_SIGNAL_LAST,
8803 8804 8805 8806 8807
               "nop",    "hup",  "int",  "quit",  "ill", /* 0-4 */
              "trap",   "abrt",  "bus",   "fpe", "kill", /* 5-9 */
              "usr1",   "segv", "usr2",  "pipe", "alrm", /* 10-14 */
              "term", "stkflt", "chld",  "cont", "stop", /* 15-19 */
              "tstp",   "ttin", "ttou",   "urg", "xcpu", /* 20-24 */
8808
              "xfsz", "vtalrm", "prof", "winch", "poll", /* 25-29 */
8809 8810 8811 8812 8813 8814
               "pwr",    "sys",  "rt0",   "rt1",  "rt2", /* 30-34 */
               "rt3",    "rt4",  "rt5",   "rt6",  "rt7", /* 35-39 */
               "rt8",    "rt9", "rt10",  "rt11", "rt12", /* 40-44 */
              "rt13",   "rt14", "rt15",  "rt16", "rt17", /* 45-49 */
              "rt18",   "rt19", "rt20",  "rt21", "rt22", /* 50-54 */
              "rt23",   "rt24", "rt25",  "rt26", "rt27", /* 55-59 */
8815
              "rt28",   "rt29", "rt30",  "rt31", "rt32"); /* 60-64 */
8816

J
Ján Tomko 已提交
8817
static int getSignalNumber(const char *signame)
8818 8819 8820
{
    size_t i;
    int signum;
J
Ján Tomko 已提交
8821
    g_autofree char *str = g_strdup(signame);
8822
    char *p = str;
8823

8824
    for (i = 0; signame[i]; i++)
8825
        p[i] = c_tolower(signame[i]);
8826

8827
    if (virStrToLong_i(p, NULL, 10, &signum) >= 0)
8828
        return signum;
8829

8830 8831 8832 8833
    if (STRPREFIX(p, "sig_"))
        p += 4;
    else if (STRPREFIX(p, "sig"))
        p += 3;
8834

8835
    return virDomainProcessSignalTypeFromString(p);
8836 8837 8838 8839 8840
}

static bool
cmdSendProcessSignal(vshControl *ctl, const vshCmd *cmd)
{
J
Ján Tomko 已提交
8841
    g_autoptr(virshDomain) dom = NULL;
8842 8843 8844 8845
    const char *signame;
    long long pid_value;
    int signum;

8846
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
8847 8848
        return false;

8849
    if (vshCommandOptLongLong(ctl, cmd, "pid", &pid_value) < 0)
8850
        return false;
8851

8852
    if (vshCommandOptStringReq(ctl, cmd, "signame", &signame) < 0)
8853
        return false;
8854

J
Ján Tomko 已提交
8855
    if ((signum = getSignalNumber(signame)) < 0) {
8856
        vshError(ctl, _("malformed signal name: %s"), signame);
8857
        return false;
8858 8859 8860
    }

    if (virDomainSendProcessSignal(dom, pid_value, signum, 0) < 0)
8861
        return false;
8862

8863
    return true;
8864 8865
}

8866 8867 8868 8869
/*
 * "setmem" command
 */
static const vshCmdInfo info_setmem[] = {
8870 8871 8872 8873 8874 8875 8876
    {.name = "help",
     .data = N_("change memory allocation")
    },
    {.name = "desc",
     .data = N_("Change the current memory allocation in the guest domain.")
    },
    {.name = NULL}
8877 8878 8879
};

static const vshCmdOptDef opts_setmem[] = {
8880
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
8881 8882 8883 8884 8885 8886 8887 8888 8889
    {.name = "kilobytes",
     .type = VSH_OT_ALIAS,
     .help = "size"
    },
    {.name = "size",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ,
     .help = N_("new memory size, as scaled integer (default KiB)")
    },
8890
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
8891
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
8892
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
8893
    {.name = NULL}
8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906
};

static bool
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    unsigned long long bytes = 0;
    unsigned long long max;
    unsigned long kibibytes = 0;
    bool ret = true;
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
8907
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
8908

8909 8910 8911 8912 8913 8914 8915 8916 8917 8918
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
    /* none of the options were specified */
    if (!current && !live && !config)
        flags = -1;
8919

8920
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
8921 8922 8923 8924 8925 8926 8927 8928
        return false;

    /* The API expects 'unsigned long' KiB, so depending on whether we
     * are 32-bit or 64-bit determines the maximum we can use.  */
    if (sizeof(kibibytes) < sizeof(max))
        max = 1024ull * ULONG_MAX;
    else
        max = ULONG_MAX;
8929
    if (vshCommandOptScaledInt(ctl, cmd, "size", &bytes, 1024, max) < 0) {
8930
        virshDomainFree(dom);
8931 8932 8933 8934 8935
        return false;
    }
    kibibytes = VIR_DIV_UP(bytes, 1024);

    if (flags == -1) {
8936
        if (virDomainSetMemory(dom, kibibytes) != 0)
8937 8938
            ret = false;
    } else {
8939
        if (virDomainSetMemoryFlags(dom, kibibytes, flags) < 0)
8940 8941 8942
            ret = false;
    }

8943
    virshDomainFree(dom);
8944 8945 8946 8947 8948 8949 8950
    return ret;
}

/*
 * "setmaxmem" command
 */
static const vshCmdInfo info_setmaxmem[] = {
8951 8952 8953 8954 8955 8956 8957
    {.name = "help",
     .data = N_("change maximum memory limit")
    },
    {.name = "desc",
     .data = N_("Change the maximum memory allocation limit in the guest domain.")
    },
    {.name = NULL}
8958 8959 8960
};

static const vshCmdOptDef opts_setmaxmem[] = {
8961
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
8962 8963 8964 8965 8966 8967 8968 8969 8970
    {.name = "kilobytes",
     .type = VSH_OT_ALIAS,
     .help = "size"
    },
    {.name = "size",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ,
     .help = N_("new maximum memory size, as scaled integer (default KiB)")
    },
8971
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
8972
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
8973
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
8974
    {.name = NULL}
8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987
};

static bool
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    unsigned long long bytes = 0;
    unsigned long long max;
    unsigned long kibibytes = 0;
    bool ret = true;
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
8988
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT | VIR_DOMAIN_MEM_MAXIMUM;
8989

8990 8991 8992 8993 8994 8995 8996 8997 8998 8999
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
    /* none of the options were specified */
    if (!current && !live && !config)
        flags = -1;
9000

9001
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
9002 9003 9004 9005 9006 9007 9008 9009
        return false;

    /* The API expects 'unsigned long' KiB, so depending on whether we
     * are 32-bit or 64-bit determines the maximum we can use.  */
    if (sizeof(kibibytes) < sizeof(max))
        max = 1024ull * ULONG_MAX;
    else
        max = ULONG_MAX;
9010
    if (vshCommandOptScaledInt(ctl, cmd, "size", &bytes, 1024, max) < 0) {
9011
        virshDomainFree(dom);
9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027
        return false;
    }
    kibibytes = VIR_DIV_UP(bytes, 1024);

    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kibibytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
            ret = false;
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kibibytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
            ret = false;
        }
    }

9028
    virshDomainFree(dom);
9029 9030 9031 9032 9033 9034 9035
    return ret;
}

/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
9036 9037 9038 9039 9040
    {.name = "help",
     .data = N_("Get or set memory parameters")
    },
    {.name = "desc",
     .data = N_("Get or set the current memory parameters for a guest"
9041 9042
                " domain.\n"
                "    To get the memory parameters use following command: \n\n"
9043 9044 9045
                "    virsh # memtune <domain>")
    },
    {.name = NULL}
9046 9047 9048
};

static const vshCmdOptDef opts_memtune[] = {
9049
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065
    {.name = "hard-limit",
     .type = VSH_OT_INT,
     .help = N_("Max memory, as scaled integer (default KiB)")
    },
    {.name = "soft-limit",
     .type = VSH_OT_INT,
     .help = N_("Memory during contention, as scaled integer (default KiB)")
    },
    {.name = "swap-hard-limit",
     .type = VSH_OT_INT,
     .help = N_("Max memory plus swap, as scaled integer (default KiB)")
    },
    {.name = "min-guarantee",
     .type = VSH_OT_INT,
     .help = N_("Min guaranteed memory, as scaled integer (default KiB)")
    },
9066
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
9067
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
9068
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
9069
    {.name = NULL}
9070 9071
};

9072
/**
9073
 * virshMemtuneGetSize
9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087
 *
 * @cmd: pointer to vshCmd
 * @name: name of a parameter for which we would like to get a value
 * @value: pointer to variable where the value will be stored
 *
 * This function will parse virsh command line in order to load a value of
 * specified parameter. If the value is -1 we will handle it as unlimited and
 * use VIR_DOMAIN_MEMORY_PARAM_UNLIMITED instead.
 *
 * Returns:
 *  >0 if option found and valid
 *  0 if option not found and not required
 *  <0 in all other cases
 */
9088
static int
9089 9090
virshMemtuneGetSize(vshControl *ctl, const vshCmd *cmd,
                    const char *name, long long *value)
9091 9092 9093 9094 9095 9096
{
    int ret;
    unsigned long long tmp;
    const char *str;
    char *end;

9097
    ret = vshCommandOptStringQuiet(ctl, cmd, name, &str);
9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109
    if (ret <= 0)
        return ret;
    if (virStrToLong_ll(str, &end, 10, value) < 0)
        return -1;
    if (*value < 0) {
        *value = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
        return 1;
    }
    tmp = *value;
    if (virScaleInteger(&tmp, end, 1024, LLONG_MAX) < 0)
        return -1;
    *value = VIR_DIV_UP(tmp, 1024);
9110
    return 1;
9111 9112 9113 9114 9115 9116
}

static bool
cmdMemtune(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
9117
    long long tmpVal;
9118
    int nparams = 0;
9119
    int maxparams = 0;
9120
    int rc;
9121
    size_t i;
9122
    virTypedParameterPtr params = NULL;
9123
    bool ret = false;
9124
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
9125 9126 9127 9128
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");

9129 9130 9131 9132 9133 9134 9135
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
9136

9137
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
9138 9139
        return false;

9140 9141 9142 9143 9144 9145 9146 9147 9148
#define PARSE_MEMTUNE_PARAM(NAME, FIELD) \
    if ((rc = virshMemtuneGetSize(ctl, cmd, NAME, &tmpVal)) < 0) { \
        vshError(ctl, _("Unable to parse integer parameter %s"), NAME); \
        goto cleanup; \
    } \
    if (rc == 1) { \
        if (virTypedParamsAddULLong(&params, &nparams, &maxparams, \
                                    FIELD, tmpVal) < 0) \
            goto save_error; \
9149
    }
9150 9151


9152 9153 9154 9155
    PARSE_MEMTUNE_PARAM("hard-limit", VIR_DOMAIN_MEMORY_HARD_LIMIT);
    PARSE_MEMTUNE_PARAM("soft-limit", VIR_DOMAIN_MEMORY_SOFT_LIMIT);
    PARSE_MEMTUNE_PARAM("swap-hard-limit", VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT);
    PARSE_MEMTUNE_PARAM("min-guarantee", VIR_DOMAIN_MEMORY_MIN_GUARANTEE);
9156

9157
#undef PARSE_MEMTUNE_PARAM
9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194

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

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

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

        for (i = 0; i < nparams; i++) {
            if (params[i].type == VIR_TYPED_PARAM_ULLONG &&
                params[i].value.ul == VIR_DOMAIN_MEMORY_PARAM_UNLIMITED) {
                vshPrint(ctl, "%-15s: %s\n", params[i].field, _("unlimited"));
            } else {
                char *str = vshGetTypedParamValue(ctl, &params[i]);
                vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
                VIR_FREE(str);
            }
        }
    } else {
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
            goto error;
    }

9195 9196
    ret = true;

9197
 cleanup:
9198
    virTypedParamsFree(params, nparams);
9199
    virshDomainFree(dom);
9200 9201
    return ret;

9202
 save_error:
9203
    vshSaveLibvirtError();
9204
 error:
9205 9206 9207 9208
    vshError(ctl, "%s", _("Unable to change memory parameters"));
    goto cleanup;
}

9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225
/*
 * "perf" command
 */
static const vshCmdInfo info_perf[] = {
    {.name = "help",
        .data = N_("Get or set perf event")
    },
    {.name = "desc",
        .data = N_("Get or set the current perf events for a guest"
                   " domain.\n"
                   "    To get the perf events list use following command: \n\n"
                   "    virsh # perf <domain>")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_perf[] = {
9226
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
9227 9228 9229 9230 9231 9232 9233 9234
    {.name = "enable",
     .type = VSH_OT_STRING,
     .help = N_("perf events which will be enabled")
    },
    {.name = "disable",
     .type = VSH_OT_STRING,
     .help = N_("perf events which will be disabled")
    },
9235 9236 9237
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
9238 9239 9240 9241
    {.name = NULL}
};

static int
9242
virshParseEventStr(const char *event,
9243 9244 9245 9246 9247 9248 9249 9250 9251
                   bool state,
                   virTypedParameterPtr *params,
                   int *nparams,
                   int *maxparams)
{
    char **tok = NULL;
    size_t i, ntok;
    int ret = -1;

9252
    if (!(tok = virStringSplitCount(event, ",", 0, &ntok)))
9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263
        return -1;

    for (i = 0; i < ntok; i++) {
        if ((*tok[i] != '\0') &&
            virTypedParamsAddBoolean(params, nparams,
                                     maxparams, tok[i], state) < 0)
            goto cleanup;
    }

    ret = 0;
 cleanup:
9264
    virStringListFree(tok);
9265 9266 9267
    return ret;
}

9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282
static void
virshPrintPerfStatus(vshControl *ctl, virTypedParameterPtr params, int nparams)
{
    size_t i;

    for (i = 0; i < nparams; i++) {
        if (params[i].type == VIR_TYPED_PARAM_BOOLEAN &&
            params[i].value.b) {
            vshPrintExtra(ctl, "%-15s: %s\n", params[i].field, _("enabled"));
        } else {
            vshPrintExtra(ctl, "%-15s: %s\n", params[i].field, _("disabled"));
        }
    }
}

9283 9284 9285 9286 9287 9288 9289 9290 9291
static bool
cmdPerf(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int nparams = 0;
    int maxparams = 0;
    virTypedParameterPtr params = NULL;
    bool ret = false;
    const char *enable = NULL, *disable = NULL;
9292
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
9304 9305 9306 9307 9308

    if (vshCommandOptStringReq(ctl, cmd, "enable", &enable) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "disable", &disable) < 0)
        return false;

P
Peter Krempa 已提交
9309 9310 9311
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

9312 9313
    if (enable && virshParseEventStr(enable, true, &params,
                                     &nparams, &maxparams) < 0)
9314 9315
        goto cleanup;

9316 9317
    if (disable && virshParseEventStr(disable, false, &params,
                                      &nparams, &maxparams) < 0)
9318 9319 9320
        goto cleanup;

    if (nparams == 0) {
9321
        if (virDomainGetPerfEvents(dom, &params, &nparams, flags) != 0) {
9322 9323 9324
            vshError(ctl, "%s", _("Unable to get perf events"));
            goto cleanup;
        }
9325
        virshPrintPerfStatus(ctl, params, nparams);
9326
    } else {
9327 9328 9329
        if (virDomainSetPerfEvents(dom, params, nparams, flags) != 0) {
            vshError(ctl, "%s", _("Unable to enable/disable perf events"));
            goto cleanup;
9330 9331
        } else {
            virshPrintPerfStatus(ctl, params, nparams);
9332
        }
9333 9334 9335 9336 9337
    }

    ret = true;
 cleanup:
    virTypedParamsFree(params, nparams);
9338
    virshDomainFree(dom);
9339 9340 9341 9342
    return ret;
}


9343 9344 9345 9346
/*
 * "numatune" command
 */
static const vshCmdInfo info_numatune[] = {
9347 9348 9349 9350 9351
    {.name = "help",
     .data = N_("Get or set numa parameters")
    },
    {.name = "desc",
     .data = N_("Get or set the current numa parameters for a guest"
9352 9353
                " domain.\n"
                "    To get the numa parameters use following command: \n\n"
9354 9355 9356
                "    virsh # numatune <domain>")
    },
    {.name = NULL}
9357 9358 9359
};

static const vshCmdOptDef opts_numatune[] = {
9360
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
9361
    {.name = "mode",
9362
     .type = VSH_OT_STRING,
9363 9364
     .help = N_("NUMA mode, one of strict, preferred and interleave \n"
                "or a number from the virDomainNumatuneMemMode enum")
9365 9366
    },
    {.name = "nodeset",
9367
     .type = VSH_OT_STRING,
9368 9369
     .help = N_("NUMA node selections to set")
    },
9370
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
9371
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
9372
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
9373
    {.name = NULL}
9374 9375 9376 9377 9378 9379 9380
};

static bool
cmdNumatune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int nparams = 0;
9381
    int maxparams = 0;
9382
    size_t i;
9383
    virTypedParameterPtr params = NULL;
9384 9385
    const char *nodeset = NULL;
    bool ret = false;
9386
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
9387 9388 9389 9390 9391
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    const char *mode = NULL;

9392 9393 9394 9395 9396 9397 9398
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
9399

9400
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
9401 9402
        return false;

9403
    if (vshCommandOptStringReq(ctl, cmd, "nodeset", &nodeset) < 0)
9404
        goto cleanup;
9405

9406 9407 9408 9409 9410
    if (nodeset &&
        virTypedParamsAddString(&params, &nparams, &maxparams,
                                VIR_DOMAIN_NUMA_NODESET, nodeset) < 0)
        goto save_error;

9411
    if (vshCommandOptStringReq(ctl, cmd, "mode", &mode) < 0)
9412
        goto cleanup;
9413

9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427
    if (mode) {
        int m;
        /* Accept string or integer, in case server understands newer
         * integer than what strings we were compiled with
         */
        if ((m = virDomainNumatuneMemModeTypeFromString(mode)) < 0 &&
            virStrToLong_i(mode, NULL, 0, &m) < 0) {
            vshError(ctl, _("Invalid mode: %s"), mode);
            goto cleanup;
        }

        if (virTypedParamsAddInt(&params, &nparams, &maxparams,
                                 VIR_DOMAIN_NUMA_MODE, m) < 0)
            goto save_error;
9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463
    }

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

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

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

        for (i = 0; i < nparams; i++) {
            if (params[i].type == VIR_TYPED_PARAM_INT &&
                STREQ(params[i].field, VIR_DOMAIN_NUMA_MODE)) {
                vshPrint(ctl, "%-15s: %s\n", params[i].field,
                         virDomainNumatuneMemModeTypeToString(params[i].value.i));
            } else {
                char *str = vshGetTypedParamValue(ctl, &params[i]);
                vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
                VIR_FREE(str);
            }
        }
    } else {
        if (virDomainSetNumaParameters(dom, params, nparams, flags) != 0)
9464
            goto error;
9465 9466
    }

9467 9468
    ret = true;

9469
 cleanup:
9470
    virTypedParamsFree(params, nparams);
9471
    virshDomainFree(dom);
9472
    return ret;
9473

9474
 save_error:
9475
    vshSaveLibvirtError();
9476
 error:
9477 9478
    vshError(ctl, "%s", _("Unable to change numa parameters"));
    goto cleanup;
9479 9480
}

9481 9482 9483 9484
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
9485 9486 9487 9488 9489 9490 9491
    {.name = "help",
     .data = N_("QEMU Monitor Command")
    },
    {.name = "desc",
     .data = N_("QEMU Monitor Command")
    },
    {.name = NULL}
9492 9493 9494
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
9495
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509
    {.name = "hmp",
     .type = VSH_OT_BOOL,
     .help = N_("command is in human monitor protocol")
    },
    {.name = "pretty",
     .type = VSH_OT_BOOL,
     .help = N_("pretty-print any qemu monitor protocol output")
    },
    {.name = "cmd",
     .type = VSH_OT_ARGV,
     .flags = VSH_OFLAG_REQ,
     .help = N_("command")
    },
    {.name = NULL}
9510 9511 9512 9513 9514
};

static bool
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
J
Ján Tomko 已提交
9515
    g_autoptr(virshDomain) dom = NULL;
9516 9517
    g_autofree char *monitor_cmd = NULL;
    g_autofree char *result = NULL;
9518 9519 9520 9521
    unsigned int flags = 0;
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

9522 9523
    VSH_EXCLUSIVE_OPTIONS("hmp", "pretty");

9524 9525 9526 9527 9528 9529 9530
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    while ((opt = vshCommandOptArgv(ctl, cmd, opt)))
        virBufferAsprintf(&buf, "%s ", opt->data);

    virBufferTrim(&buf, " ", -1);
9531 9532 9533

    monitor_cmd = virBufferContentAndReset(&buf);

9534
    if (vshCommandOptBool(cmd, "hmp"))
9535 9536 9537
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
9538
        return false;
9539 9540 9541

    if (vshCommandOptBool(cmd, "pretty")) {
        char *tmp;
9542
        if ((tmp = virJSONStringReformat(result, true))) {
9543 9544
            VIR_FREE(result);
            result = tmp;
9545
            virTrimSpaces(result, NULL);
9546 9547 9548 9549 9550
        } else {
            vshResetLibvirtError();
        }
    }
    vshPrint(ctl, "%s\n", result);
9551
    return true;
9552 9553
}

E
Eric Blake 已提交
9554 9555 9556 9557
/*
 * "qemu-monitor-event" command
 */

9558
struct virshQemuEventData {
E
Eric Blake 已提交
9559 9560 9561
    vshControl *ctl;
    bool loop;
    bool pretty;
9562
    bool timestamp;
E
Eric Blake 已提交
9563 9564
    int count;
};
9565
typedef struct virshQemuEventData virshQemuEventData;
E
Eric Blake 已提交
9566 9567

static void
J
Ján Tomko 已提交
9568
virshEventQemuPrint(virConnectPtr conn G_GNUC_UNUSED,
J
Jiri Denemark 已提交
9569 9570 9571 9572 9573 9574
                    virDomainPtr dom,
                    const char *event,
                    long long seconds,
                    unsigned int micros,
                    const char *details,
                    void *opaque)
E
Eric Blake 已提交
9575
{
9576
    virshQemuEventData *data = opaque;
E
Eric Blake 已提交
9577 9578 9579 9580 9581 9582 9583 9584 9585 9586
    virJSONValuePtr pretty = NULL;
    char *str = NULL;

    if (!data->loop && data->count)
        return;
    if (data->pretty && details) {
        pretty = virJSONValueFromString(details);
        if (pretty && (str = virJSONValueToString(pretty, true)))
            details = str;
    }
9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600

    if (data->timestamp) {
        char timestamp[VIR_TIME_STRING_BUFLEN];

        if (virTimeStringNowRaw(timestamp) < 0)
            timestamp[0] = '\0';

        vshPrint(data->ctl, "%s: event %s for domain %s: %s\n",
                 timestamp, event, virDomainGetName(dom), NULLSTR(details));
    } else {
        vshPrint(data->ctl, "event %s at %lld.%06u for domain %s: %s\n",
                 event, seconds, micros, virDomainGetName(dom), NULLSTR(details));
    }

E
Eric Blake 已提交
9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618
    data->count++;
    if (!data->loop)
        vshEventDone(data->ctl);

    VIR_FREE(str);
}

static const vshCmdInfo info_qemu_monitor_event[] = {
    {.name = "help",
     .data = N_("QEMU Monitor Events")
    },
    {.name = "desc",
     .data = N_("Listen for QEMU Monitor Events")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_qemu_monitor_event[] = {
9619
    VIRSH_COMMON_OPT_DOMAIN_OT_STRING(N_("filter by domain name, id or uuid"),
9620
                                      0, 0),
E
Eric Blake 已提交
9621
    {.name = "event",
9622
     .type = VSH_OT_STRING,
E
Eric Blake 已提交
9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636
     .help = N_("filter by event name")
    },
    {.name = "pretty",
     .type = VSH_OT_BOOL,
     .help = N_("pretty-print any JSON output")
    },
    {.name = "loop",
     .type = VSH_OT_BOOL,
     .help = N_("loop until timeout or interrupt, rather than one-shot")
    },
    {.name = "timeout",
     .type = VSH_OT_INT,
     .help = N_("timeout seconds")
    },
9637 9638 9639 9640 9641 9642 9643 9644
    {.name = "regex",
     .type = VSH_OT_BOOL,
     .help = N_("treat event as a regex rather than literal filter")
    },
    {.name = "no-case",
     .type = VSH_OT_BOOL,
     .help = N_("treat event case-insensitively")
    },
9645 9646 9647 9648
    {.name = "timestamp",
     .type = VSH_OT_BOOL,
     .help = N_("show timestamp for each printed event")
    },
E
Eric Blake 已提交
9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660
    {.name = NULL}
};

static bool
cmdQemuMonitorEvent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    unsigned int flags = 0;
    int eventId = -1;
    int timeout = 0;
    const char *event = NULL;
9661 9662
    virshQemuEventData data;
    virshControlPtr priv = ctl->privData;
E
Eric Blake 已提交
9663

9664 9665 9666 9667 9668
    if (vshCommandOptBool(cmd, "regex"))
        flags |= VIR_CONNECT_DOMAIN_QEMU_MONITOR_EVENT_REGISTER_REGEX;
    if (vshCommandOptBool(cmd, "no-case"))
        flags |= VIR_CONNECT_DOMAIN_QEMU_MONITOR_EVENT_REGISTER_NOCASE;

E
Eric Blake 已提交
9669 9670 9671
    data.ctl = ctl;
    data.loop = vshCommandOptBool(cmd, "loop");
    data.pretty = vshCommandOptBool(cmd, "pretty");
9672
    data.timestamp = vshCommandOptBool(cmd, "timestamp");
E
Eric Blake 已提交
9673 9674 9675
    data.count = 0;
    if (vshCommandOptTimeoutToMs(ctl, cmd, &timeout) < 0)
        return false;
9676
    if (vshCommandOptStringReq(ctl, cmd, "event", &event) < 0)
E
Eric Blake 已提交
9677 9678 9679
        return false;

    if (vshCommandOptBool(cmd, "domain"))
9680 9681 9682
        if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
            goto cleanup;

E
Eric Blake 已提交
9683 9684 9685
    if (vshEventStart(ctl, timeout) < 0)
        goto cleanup;

9686
    if ((eventId = virConnectDomainQemuMonitorEventRegister(priv->conn, dom,
E
Eric Blake 已提交
9687
                                                            event,
J
Jiri Denemark 已提交
9688
                                                            virshEventQemuPrint,
E
Eric Blake 已提交
9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707
                                                            &data, NULL,
                                                            flags)) < 0)
        goto cleanup;
    switch (vshEventWait(ctl)) {
    case VSH_EVENT_INTERRUPT:
        vshPrint(ctl, _("event loop interrupted\n"));
        break;
    case VSH_EVENT_TIMEOUT:
        vshPrint(ctl, _("event loop timed out\n"));
        break;
    case VSH_EVENT_DONE:
        break;
    default:
        goto cleanup;
    }
    vshPrint(ctl, _("events received: %d\n"), data.count);
    if (data.count)
        ret = true;

9708
 cleanup:
E
Eric Blake 已提交
9709 9710
    vshEventCleanup(ctl);
    if (eventId >= 0 &&
9711
        virConnectDomainQemuMonitorEventDeregister(priv->conn, eventId) < 0)
E
Eric Blake 已提交
9712
        ret = false;
9713
    virshDomainFree(dom);
E
Eric Blake 已提交
9714 9715 9716 9717

    return ret;
}

9718 9719 9720 9721
/*
 * "qemu-attach" command
 */
static const vshCmdInfo info_qemu_attach[] = {
9722 9723 9724 9725 9726 9727 9728
    {.name = "help",
     .data = N_("QEMU Attach")
    },
    {.name = "desc",
     .data = N_("QEMU Attach")
    },
    {.name = NULL}
9729 9730 9731
};

static const vshCmdOptDef opts_qemu_attach[] = {
9732 9733 9734 9735 9736 9737
    {.name = "pid",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("pid")
    },
    {.name = NULL}
9738 9739 9740 9741 9742 9743 9744 9745
};

static bool
cmdQemuAttach(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    unsigned int flags = 0;
    unsigned int pid_value; /* API uses unsigned int, not pid_t */
9746
    virshControlPtr priv = ctl->privData;
9747

9748
    if (vshCommandOptUInt(ctl, cmd, "pid", &pid_value) <= 0)
9749
        return false;
9750

9751
    if (!(dom = virDomainQemuAttach(priv->conn, pid_value, flags))) {
9752
        vshError(ctl, _("Failed to attach to pid %u"), pid_value);
9753
        return false;
9754 9755
    }

P
Pino Toscano 已提交
9756 9757
    vshPrintExtra(ctl, _("Domain %s attached to pid %u\n"),
                  virDomainGetName(dom), pid_value);
9758
    virshDomainFree(dom);
9759
    return true;
9760 9761 9762 9763 9764 9765
}

/*
 * "qemu-agent-command" command
 */
static const vshCmdInfo info_qemu_agent_command[] = {
9766 9767 9768 9769 9770 9771 9772
    {.name = "help",
     .data = N_("QEMU Guest Agent Command")
    },
    {.name = "desc",
     .data = N_("Run an arbitrary qemu guest agent command; use at your own risk")
    },
    {.name = NULL}
9773 9774 9775
};

static const vshCmdOptDef opts_qemu_agent_command[] = {
9776
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789
    {.name = "timeout",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ_OPT,
     .help = N_("timeout seconds. must be positive.")
    },
    {.name = "async",
     .type = VSH_OT_BOOL,
     .help = N_("execute command without waiting for timeout")
    },
    {.name = "block",
     .type = VSH_OT_BOOL,
     .help = N_("execute command without timeout")
    },
9790 9791 9792 9793
    {.name = "pretty",
     .type = VSH_OT_BOOL,
     .help = N_("pretty-print the output")
    },
9794 9795 9796 9797 9798 9799
    {.name = "cmd",
     .type = VSH_OT_ARGV,
     .flags = VSH_OFLAG_REQ,
     .help = N_("command")
    },
    {.name = NULL}
9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813
};

static bool
cmdQemuAgentCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    char *guest_agent_cmd = NULL;
    char *result = NULL;
    int timeout = VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT;
    int judge = 0;
    unsigned int flags = 0;
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
9814
    virJSONValuePtr pretty = NULL;
9815

9816
    dom = virshCommandOptDomain(ctl, cmd, NULL);
9817 9818 9819
    if (dom == NULL)
        goto cleanup;

9820 9821 9822 9823 9824
    while ((opt = vshCommandOptArgv(ctl, cmd, opt)))
        virBufferAsprintf(&buf, "%s ", opt->data);

    virBufferTrim(&buf, " ", -1);

9825 9826
    guest_agent_cmd = virBufferContentAndReset(&buf);

9827
    judge = vshCommandOptInt(ctl, cmd, "timeout", &timeout);
9828
    if (judge < 0)
9829
        goto cleanup;
9830
    else if (judge > 0)
9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849
        judge = 1;
    if (judge && timeout < 1) {
        vshError(ctl, "%s", _("timeout must be positive"));
        goto cleanup;
    }

    if (vshCommandOptBool(cmd, "async")) {
        timeout = VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT;
        judge++;
    }
    if (vshCommandOptBool(cmd, "block")) {
        timeout = VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK;
        judge++;
    }

    if (judge > 1) {
        vshError(ctl, "%s", _("timeout, async and block options are exclusive"));
        goto cleanup;
    }
9850

9851
    result = virDomainQemuAgentCommand(dom, guest_agent_cmd, timeout, flags);
9852 9853
    if (!result)
        goto cleanup;
9854

9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865
    if (vshCommandOptBool(cmd, "pretty")) {
        char *tmp;
        pretty = virJSONValueFromString(result);
        if (pretty && (tmp = virJSONValueToString(pretty, true))) {
            VIR_FREE(result);
            result = tmp;
        } else {
            vshResetLibvirtError();
        }
    }

9866
    vshPrint(ctl, "%s\n", result);
9867 9868 9869

    ret = true;

9870
 cleanup:
9871 9872
    VIR_FREE(result);
    VIR_FREE(guest_agent_cmd);
9873
    virshDomainFree(dom);
9874 9875 9876 9877

    return ret;
}

9878 9879 9880 9881
/*
 * "lxc-enter-namespace" namespace
 */
static const vshCmdInfo info_lxc_enter_namespace[] = {
9882 9883 9884 9885
    {.name = "help",
     .data = N_("LXC Guest Enter Namespace")
    },
    {.name = "desc",
9886
     .data = N_("Run an arbitrary command in a lxc guest namespace; use at your own risk")
9887 9888
    },
    {.name = NULL}
9889 9890 9891
};

static const vshCmdOptDef opts_lxc_enter_namespace[] = {
9892
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
9893 9894 9895 9896 9897 9898 9899
    {.name = "noseclabel",
     .type = VSH_OT_BOOL,
     .help = N_("Do not change process security label")
    },
    {.name = "cmd",
     .type = VSH_OT_ARGV,
     .flags = VSH_OFLAG_REQ,
9900
     .help = N_("command to run")
9901 9902
    },
    {.name = NULL}
9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916
};

static bool
cmdLxcEnterNamespace(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    const vshCmdOpt *opt = NULL;
    char **cmdargv = NULL;
    size_t ncmdargv = 0;
    pid_t pid;
    int nfdlist;
    int *fdlist;
    size_t i;
9917 9918 9919
    bool setlabel = true;
    virSecurityModelPtr secmodel = NULL;
    virSecurityLabelPtr seclabel = NULL;
9920
    virshControlPtr priv = ctl->privData;
9921

9922
    dom = virshCommandOptDomain(ctl, cmd, NULL);
9923 9924 9925
    if (dom == NULL)
        goto cleanup;

9926 9927 9928
    if (vshCommandOptBool(cmd, "noseclabel"))
        setlabel = false;

9929
    while ((opt = vshCommandOptArgv(ctl, cmd, opt))) {
9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944
        if (VIR_EXPAND_N(cmdargv, ncmdargv, 1) < 0) {
            vshError(ctl, _("%s: %d: failed to allocate argv"),
                     __FILE__, __LINE__);
        }
        cmdargv[ncmdargv-1] = opt->data;
    }
    if (VIR_EXPAND_N(cmdargv, ncmdargv, 1) < 0) {
        vshError(ctl, _("%s: %d: failed to allocate argv"),
                 __FILE__, __LINE__);
    }
    cmdargv[ncmdargv - 1] = NULL;

    if ((nfdlist = virDomainLxcOpenNamespace(dom, &fdlist, 0)) < 0)
        goto cleanup;

9945 9946 9947 9948 9949 9950 9951 9952 9953
    if (setlabel) {
        if (VIR_ALLOC(secmodel) < 0) {
            vshError(ctl, "%s", _("Failed to allocate security model"));
            goto cleanup;
        }
        if (VIR_ALLOC(seclabel) < 0) {
            vshError(ctl, "%s", _("Failed to allocate security label"));
            goto cleanup;
        }
9954
        if (virNodeGetSecurityModel(priv->conn, secmodel) < 0)
9955 9956 9957 9958 9959
            goto cleanup;
        if (virDomainGetSecurityLabel(dom, seclabel) < 0)
            goto cleanup;
    }

9960
    /* Fork once because we don't want to affect
E
Eric Blake 已提交
9961 9962
     * virsh's namespace itself, and because user namespace
     * can only be changed in single-threaded process
9963
     */
E
Eric Blake 已提交
9964
    if ((pid = virFork()) < 0)
9965 9966
        goto cleanup;
    if (pid == 0) {
9967 9968
        int status;

9969 9970 9971 9972 9973
        if (setlabel &&
            virDomainLxcEnterSecurityLabel(secmodel,
                                           seclabel,
                                           NULL,
                                           0) < 0)
9974
            _exit(EXIT_CANCELED);
9975

9976 9977 9978
        if (virDomainLxcEnterCGroup(dom, 0) < 0)
            _exit(EXIT_CANCELED);

9979 9980 9981 9982 9983 9984
        if (virDomainLxcEnterNamespace(dom,
                                       nfdlist,
                                       fdlist,
                                       NULL,
                                       NULL,
                                       0) < 0)
9985
            _exit(EXIT_CANCELED);
9986 9987 9988 9989

        /* Fork a second time because entering the
         * pid namespace only takes effect after fork
         */
E
Eric Blake 已提交
9990
        if ((pid = virFork()) < 0)
9991
            _exit(EXIT_CANCELED);
9992 9993
        if (pid == 0) {
            execv(cmdargv[0], cmdargv);
9994
            _exit(errno == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
9995
        }
9996 9997 9998
        if (virProcessWait(pid, &status, true) < 0)
            _exit(EXIT_CANNOT_INVOKE);
        virProcessExitWithStatus(status);
9999
    } else {
10000
        for (i = 0; i < nfdlist; i++)
10001 10002
            VIR_FORCE_CLOSE(fdlist[i]);
        VIR_FREE(fdlist);
10003 10004
        if (virProcessWait(pid, NULL, false) < 0) {
            vshReportError(ctl);
10005
            goto cleanup;
10006
        }
10007 10008 10009 10010
    }

    ret = true;

10011
 cleanup:
10012 10013
    VIR_FREE(seclabel);
    VIR_FREE(secmodel);
10014
    virshDomainFree(dom);
10015 10016 10017 10018
    VIR_FREE(cmdargv);
    return ret;
}

10019 10020 10021 10022
/*
 * "dumpxml" command
 */
static const vshCmdInfo info_dumpxml[] = {
10023 10024 10025 10026 10027 10028 10029
    {.name = "help",
     .data = N_("domain information in XML")
    },
    {.name = "desc",
     .data = N_("Output the domain information as an XML dump to stdout.")
    },
    {.name = NULL}
10030 10031 10032
};

static const vshCmdOptDef opts_dumpxml[] = {
10033
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050
    {.name = "inactive",
     .type = VSH_OT_BOOL,
     .help = N_("show inactive defined XML")
    },
    {.name = "security-info",
     .type = VSH_OT_BOOL,
     .help = N_("include security sensitive information in XML dump")
    },
    {.name = "update-cpu",
     .type = VSH_OT_BOOL,
     .help = N_("update guest CPU according to host CPU")
    },
    {.name = "migratable",
     .type = VSH_OT_BOOL,
     .help = N_("provide XML suitable for migrations")
    },
    {.name = NULL}
10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062
};

static bool
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = true;
    char *dump;
    unsigned int flags = 0;
    bool inactive = vshCommandOptBool(cmd, "inactive");
    bool secure = vshCommandOptBool(cmd, "security-info");
    bool update = vshCommandOptBool(cmd, "update-cpu");
10063
    bool migratable = vshCommandOptBool(cmd, "migratable");
10064 10065 10066 10067 10068 10069 10070

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
10071 10072
    if (migratable)
        flags |= VIR_DOMAIN_XML_MIGRATABLE;
10073

10074
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
10075 10076 10077 10078 10079 10080 10081 10082 10083 10084
        return false;

    dump = virDomainGetXMLDesc(dom, flags);
    if (dump != NULL) {
        vshPrint(ctl, "%s", dump);
        VIR_FREE(dump);
    } else {
        ret = false;
    }

10085
    virshDomainFree(dom);
10086 10087 10088 10089 10090 10091 10092
    return ret;
}

/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
10093 10094 10095 10096 10097 10098 10099
    {.name = "help",
     .data = N_("Convert native config to domain XML")
    },
    {.name = "desc",
     .data = N_("Convert native guest configuration format to domain XML format.")
    },
    {.name = NULL}
10100 10101 10102
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113
    {.name = "format",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("source config data format")
    },
    {.name = "config",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("config data file to import from")
    },
    {.name = NULL}
10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124
};

static bool
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
    bool ret = true;
    const char *format = NULL;
    const char *configFile = NULL;
    char *configData;
    char *xmlData;
    unsigned int flags = 0;
10125
    virshControlPtr priv = ctl->privData;
10126

10127 10128
    if (vshCommandOptStringReq(ctl, cmd, "format", &format) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "config", &configFile) < 0)
10129 10130
        return false;

10131
    if (virFileReadAll(configFile, VSH_MAX_XML_FILE, &configData) < 0)
10132 10133
        return false;

10134
    xmlData = virConnectDomainXMLFromNative(priv->conn, format, configData, flags);
10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149
    if (xmlData != NULL) {
        vshPrint(ctl, "%s", xmlData);
        VIR_FREE(xmlData);
    } else {
        ret = false;
    }

    VIR_FREE(configData);
    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
10150 10151 10152 10153 10154 10155 10156
    {.name = "help",
     .data = N_("Convert domain XML to native config")
    },
    {.name = "desc",
     .data = N_("Convert domain XML config to a native guest configuration format.")
    },
    {.name = NULL}
10157 10158 10159
};

static const vshCmdOptDef opts_domxmltonative[] = {
10160 10161 10162 10163 10164
    {.name = "format",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("target config data type format")
    },
10165
    VIRSH_COMMON_OPT_DOMAIN_OT_STRING_FULL(VSH_OFLAG_REQ_OPT, 0),
10166
    {.name = "xml",
10167
     .type = VSH_OT_STRING,
10168 10169 10170
     .help = N_("xml data file to export from")
    },
    {.name = NULL}
10171 10172 10173 10174 10175
};

static bool
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
10176
    bool ret = false;
10177 10178
    const char *format = NULL;
    const char *xmlFile = NULL;
10179 10180
    char *configData = NULL;
    char *xmlData = NULL;
10181
    unsigned int flags = 0;
10182
    virshControlPtr priv = ctl->privData;
10183
    virDomainPtr dom = NULL;
10184

10185 10186
    if (vshCommandOptStringReq(ctl, cmd, "format", &format) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "xml", &xmlFile) < 0)
10187 10188
        return false;

10189
    VSH_EXCLUSIVE_OPTIONS("domain", "xml");
10190

10191 10192 10193 10194 10195 10196 10197 10198 10199
    if (vshCommandOptBool(cmd, "domain") &&
        (!(dom = virshCommandOptDomain(ctl, cmd, NULL))))
            return false;

    if (dom) {
        xmlData = virDomainGetXMLDesc(dom, flags);
    } else if (xmlFile) {
        if (virFileReadAll(xmlFile, VSH_MAX_XML_FILE, &xmlData) < 0)
            goto cleanup;
10200
    } else {
10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214
        vshError(ctl, "%s", _("need either domain or domain XML"));
        goto cleanup;
    }

    if (!xmlData) {
        vshError(ctl, "%s", _("failed to retrieve XML"));
        goto cleanup;
    }

    if (!(configData = virConnectDomainXMLToNative(priv->conn, format, xmlData, flags))) {
        goto cleanup;
    } else {
        vshPrint(ctl, "%s", configData);
        ret = true;
10215 10216
    }

10217 10218
 cleanup:
    virshDomainFree(dom);
10219
    VIR_FREE(xmlData);
10220
    VIR_FREE(configData);
10221 10222 10223 10224 10225 10226 10227
    return ret;
}

/*
 * "domname" command
 */
static const vshCmdInfo info_domname[] = {
10228 10229 10230 10231 10232 10233 10234
    {.name = "help",
     .data = N_("convert a domain id or UUID to domain name")
    },
    {.name = "desc",
     .data = ""
    },
    {.name = NULL}
10235 10236 10237
};

static const vshCmdOptDef opts_domname[] = {
10238
    VIRSH_COMMON_OPT_DOMAIN(N_("domain id or uuid"), 0),
10239
    {.name = NULL}
10240 10241 10242 10243 10244 10245 10246
};

static bool
cmdDomname(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;

10247 10248
    if (!(dom = virshCommandOptDomainBy(ctl, cmd, NULL,
                                        VIRSH_BYID|VIRSH_BYUUID)))
10249 10250 10251
        return false;

    vshPrint(ctl, "%s\n", virDomainGetName(dom));
10252
    virshDomainFree(dom);
10253 10254 10255
    return true;
}

10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269
/*
 * "domrename" command
 */
static const vshCmdInfo info_domrename[] = {
    {.name = "help",
     .data = N_("rename a domain")
    },
    {.name = "desc",
     .data = "Rename an inactive domain."
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_domrename[] = {
10270 10271
    VIRSH_COMMON_OPT_DOMAIN(N_("domain name or uuid"),
                            VIR_CONNECT_LIST_DOMAINS_INACTIVE),
10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286
    {.name = "new-name",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("new domain name")
    },
    {.name = NULL}
};

static bool
cmdDomrename(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *new_name = NULL;
    bool ret = false;

10287
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
10288 10289 10290 10291 10292 10293 10294 10295
        return ret;

    if (vshCommandOptStringReq(ctl, cmd, "new-name", &new_name) < 0)
        goto cleanup;

    if (virDomainRename(dom, new_name, 0) < 0)
        goto cleanup;

P
Pino Toscano 已提交
10296
    vshPrintExtra(ctl, "Domain successfully renamed\n");
10297 10298 10299
    ret = true;

 cleanup:
10300
    virshDomainFree(dom);
10301
    return ret;
10302 10303
}

10304 10305 10306 10307
/*
 * "domid" command
 */
static const vshCmdInfo info_domid[] = {
10308 10309 10310 10311 10312 10313 10314
    {.name = "help",
     .data = N_("convert a domain name or UUID to domain id")
    },
    {.name = "desc",
     .data = ""
    },
    {.name = NULL}
10315 10316 10317
};

static const vshCmdOptDef opts_domid[] = {
10318 10319
    VIRSH_COMMON_OPT_DOMAIN(N_("domain name or uuid"),
                            VIR_CONNECT_LIST_DOMAINS_ACTIVE),
10320
    {.name = NULL}
10321 10322 10323 10324 10325 10326 10327 10328
};

static bool
cmdDomid(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    unsigned int id;

10329 10330
    if (!(dom = virshCommandOptDomainBy(ctl, cmd, NULL,
                                        VIRSH_BYNAME|VIRSH_BYUUID)))
10331 10332 10333 10334 10335 10336 10337
        return false;

    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
        vshPrint(ctl, "%s\n", "-");
    else
        vshPrint(ctl, "%d\n", id);
10338
    virshDomainFree(dom);
10339 10340 10341 10342 10343 10344 10345
    return true;
}

/*
 * "domuuid" command
 */
static const vshCmdInfo info_domuuid[] = {
10346 10347 10348 10349 10350 10351 10352
    {.name = "help",
     .data = N_("convert a domain name or id to domain UUID")
    },
    {.name = "desc",
     .data = ""
    },
    {.name = NULL}
10353 10354 10355
};

static const vshCmdOptDef opts_domuuid[] = {
10356
    VIRSH_COMMON_OPT_DOMAIN(N_("domain id or name"), 0),
10357
    {.name = NULL}
10358 10359 10360 10361 10362 10363 10364 10365
};

static bool
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    char uuid[VIR_UUID_STRING_BUFLEN];

10366 10367
    if (!(dom = virshCommandOptDomainBy(ctl, cmd, NULL,
                                        VIRSH_BYNAME|VIRSH_BYID)))
10368 10369 10370 10371 10372 10373 10374
        return false;

    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
        vshError(ctl, "%s", _("failed to get domain UUID"));

10375
    virshDomainFree(dom);
10376 10377 10378 10379 10380 10381 10382
    return true;
}

/*
 * "migrate" command
 */
static const vshCmdInfo info_migrate[] = {
10383 10384 10385 10386 10387 10388 10389
    {.name = "help",
     .data = N_("migrate domain to another host")
    },
    {.name = "desc",
     .data = N_("Migrate domain to another host.  Add --live for live migration.")
    },
    {.name = NULL}
10390 10391 10392
};

static const vshCmdOptDef opts_migrate[] = {
10393
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
M
Martin Kletzander 已提交
10394 10395 10396 10397 10398
    {.name = "desturi",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("connection URI of the destination host as seen from the client(normal migration) or source(p2p migration)")
    },
10399
    VIRSH_COMMON_OPT_LIVE(N_("live migration")),
10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441
    {.name = "offline",
     .type = VSH_OT_BOOL,
     .help = N_("offline migration")
    },
    {.name = "p2p",
     .type = VSH_OT_BOOL,
     .help = N_("peer-2-peer migration")
    },
    {.name = "direct",
     .type = VSH_OT_BOOL,
     .help = N_("direct migration")
    },
    {.name = "tunneled",
     .type = VSH_OT_ALIAS,
     .help = "tunnelled"
    },
    {.name = "tunnelled",
     .type = VSH_OT_BOOL,
     .help = N_("tunnelled migration")
    },
    {.name = "persistent",
     .type = VSH_OT_BOOL,
     .help = N_("persist VM on destination")
    },
    {.name = "undefinesource",
     .type = VSH_OT_BOOL,
     .help = N_("undefine VM on source")
    },
    {.name = "suspend",
     .type = VSH_OT_BOOL,
     .help = N_("do not restart the domain on the destination host")
    },
    {.name = "copy-storage-all",
     .type = VSH_OT_BOOL,
     .help = N_("migration with non-shared storage with full disk copy")
    },
    {.name = "copy-storage-inc",
     .type = VSH_OT_BOOL,
     .help = N_("migration with non-shared storage with incremental copy (same base image shared between source and destination)")
    },
    {.name = "change-protection",
     .type = VSH_OT_BOOL,
10442
     .help = N_("prevent any configuration changes to domain until migration ends")
10443 10444 10445 10446 10447 10448 10449 10450 10451
    },
    {.name = "unsafe",
     .type = VSH_OT_BOOL,
     .help = N_("force migration even if it may be unsafe")
    },
    {.name = "verbose",
     .type = VSH_OT_BOOL,
     .help = N_("display the progress of migration")
    },
10452 10453 10454 10455
    {.name = "compressed",
     .type = VSH_OT_BOOL,
     .help = N_("compress repeated pages during live migration")
    },
10456 10457 10458 10459
    {.name = "auto-converge",
     .type = VSH_OT_BOOL,
     .help = N_("force convergence during live migration")
    },
10460 10461
    {.name = "rdma-pin-all",
     .type = VSH_OT_BOOL,
10462
     .help = N_("pin all memory before starting RDMA live migration")
10463
    },
10464 10465 10466 10467
    {.name = "abort-on-error",
     .type = VSH_OT_BOOL,
     .help = N_("abort on soft errors during migration")
    },
10468 10469 10470 10471
    {.name = "postcopy",
     .type = VSH_OT_BOOL,
     .help = N_("enable post-copy migration; switch to it using migrate-postcopy command")
    },
10472 10473 10474 10475
    {.name = "postcopy-after-precopy",
     .type = VSH_OT_BOOL,
     .help = N_("automatically switch to post-copy migration after one pass of pre-copy")
    },
10476
    {.name = "migrateuri",
10477
     .type = VSH_OT_STRING,
10478 10479
     .help = N_("migration URI, usually can be omitted")
    },
10480
    {.name = "graphicsuri",
10481
     .type = VSH_OT_STRING,
10482 10483
     .help = N_("graphics URI to be used for seamless graphics migration")
    },
10484
    {.name = "listen-address",
10485
     .type = VSH_OT_STRING,
10486 10487
     .help = N_("listen address that destination should bind to for incoming migration")
    },
10488
    {.name = "dname",
10489
     .type = VSH_OT_STRING,
10490 10491 10492 10493
     .help = N_("rename to new name during migration (if supported)")
    },
    {.name = "timeout",
     .type = VSH_OT_INT,
10494 10495 10496 10497 10498 10499 10500 10501 10502 10503
     .help = N_("run action specified by --timeout-* option (suspend by "
                "default) if live migration exceeds timeout (in seconds)")
    },
    {.name = "timeout-suspend",
     .type = VSH_OT_BOOL,
     .help = N_("suspend the guest after timeout")
    },
    {.name = "timeout-postcopy",
     .type = VSH_OT_BOOL,
     .help = N_("switch to post-copy after timeout")
10504 10505 10506 10507 10508
    },
    {.name = "xml",
     .type = VSH_OT_STRING,
     .help = N_("filename containing updated XML for the target")
    },
10509 10510 10511 10512
    {.name = "migrate-disks",
     .type = VSH_OT_STRING,
     .help = N_("comma separated list of disks to be migrated")
    },
10513 10514 10515 10516
    {.name = "disks-port",
     .type = VSH_OT_INT,
     .help = N_("port to use by target server for incoming disks migration")
    },
10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536
    {.name = "comp-methods",
     .type = VSH_OT_STRING,
     .help = N_("comma separated list of compression methods to be used")
    },
    {.name = "comp-mt-level",
     .type = VSH_OT_INT,
     .help = N_("compress level for multithread compression")
    },
    {.name = "comp-mt-threads",
     .type = VSH_OT_INT,
     .help = N_("number of compression threads for multithread compression")
    },
    {.name = "comp-mt-dthreads",
     .type = VSH_OT_INT,
     .help = N_("number of decompression threads for multithread compression")
    },
    {.name = "comp-xbzrle-cache",
     .type = VSH_OT_INT,
     .help = N_("page cache size for xbzrle compression")
    },
10537 10538 10539 10540 10541 10542 10543 10544
    {.name = "auto-converge-initial",
     .type = VSH_OT_INT,
     .help = N_("initial CPU throttling rate for auto-convergence")
    },
    {.name = "auto-converge-increment",
     .type = VSH_OT_INT,
     .help = N_("CPU throttling rate increment for auto-convergence")
    },
10545 10546 10547 10548
    {.name = "persistent-xml",
     .type = VSH_OT_STRING,
     .help = N_("filename containing updated persistent XML for the target")
    },
10549 10550 10551 10552
    {.name = "tls",
     .type = VSH_OT_BOOL,
     .help = N_("use TLS for migration")
    },
10553 10554 10555 10556
    {.name = "postcopy-bandwidth",
     .type = VSH_OT_INT,
     .help = N_("post-copy migration bandwidth limit in MiB/s")
    },
10557 10558 10559 10560 10561 10562 10563 10564
    {.name = "parallel",
     .type = VSH_OT_BOOL,
     .help = N_("enable parallel migration")
    },
    {.name = "parallel-connections",
     .type = VSH_OT_INT,
     .help = N_("number of connections for parallel migration")
    },
10565
    {.name = "bandwidth",
10566
     .type = VSH_OT_INT,
10567
     .help = N_("migration bandwidth limit in MiB/s")
10568
    },
10569
    {.name = NULL}
10570 10571 10572 10573 10574 10575 10576 10577
};

static void
doMigrate(void *opaque)
{
    char ret = '1';
    virDomainPtr dom = NULL;
    const char *desturi = NULL;
10578
    const char *opt = NULL;
10579
    int disksPort = 0;
10580
    unsigned int flags = 0;
10581
    virshCtrlData *data = opaque;
10582 10583 10584
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
    sigset_t sigmask, oldsigmask;
10585 10586 10587
    virTypedParameterPtr params = NULL;
    int nparams = 0;
    int maxparams = 0;
10588 10589 10590
    int intOpt = 0;
    unsigned long long ullOpt = 0;
    int rv;
10591
    virConnectPtr dconn = data->dconn;
10592 10593 10594 10595 10596 10597

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

10598
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
10599 10600
        goto out;

10601
    if (vshCommandOptStringReq(ctl, cmd, "desturi", &desturi) < 0)
10602 10603
        goto out;

10604 10605 10606 10607 10608 10609 10610
    if (vshCommandOptStringReq(ctl, cmd, "migrateuri", &opt) < 0)
        goto out;
    if (opt &&
        virTypedParamsAddString(&params, &nparams, &maxparams,
                                VIR_MIGRATE_PARAM_URI, opt) < 0)
        goto save_error;

10611 10612 10613 10614 10615 10616 10617
    if (vshCommandOptStringReq(ctl, cmd, "graphicsuri", &opt) < 0)
        goto out;
    if (opt &&
        virTypedParamsAddString(&params, &nparams, &maxparams,
                                VIR_MIGRATE_PARAM_GRAPHICS_URI, opt) < 0)
        goto save_error;

10618 10619 10620 10621 10622 10623
    if (vshCommandOptStringReq(ctl, cmd, "listen-address", &opt) < 0)
        goto out;
    if (opt &&
        virTypedParamsAddString(&params, &nparams, &maxparams,
                                VIR_MIGRATE_PARAM_LISTEN_ADDRESS, opt) < 0)
        goto save_error;
10624 10625 10626 10627 10628 10629 10630

    if (vshCommandOptInt(ctl, cmd, "disks-port", &disksPort) < 0)
        goto out;
    if (disksPort &&
        virTypedParamsAddInt(&params, &nparams, &maxparams,
                             VIR_MIGRATE_PARAM_DISKS_PORT, disksPort) < 0)
        goto save_error;
10631

10632 10633 10634 10635 10636 10637 10638
    if (vshCommandOptStringReq(ctl, cmd, "dname", &opt) < 0)
        goto out;
    if (opt &&
        virTypedParamsAddString(&params, &nparams, &maxparams,
                                VIR_MIGRATE_PARAM_DEST_NAME, opt) < 0)
        goto save_error;

10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657
    if (vshCommandOptStringReq(ctl, cmd, "migrate-disks", &opt) < 0)
        goto out;
    if (opt) {
        char **val = NULL;

        val = virStringSplit(opt, ",", 0);

        if (virTypedParamsAddStringList(&params,
                                        &nparams,
                                        &maxparams,
                                        VIR_MIGRATE_PARAM_MIGRATE_DISKS,
                                        (const char **)val) < 0) {
            VIR_FREE(val);
            goto save_error;
        }

        VIR_FREE(val);
    }

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
    if (vshCommandOptStringReq(ctl, cmd, "comp-methods", &opt) < 0)
        goto out;
    if (opt) {
        char **val = virStringSplit(opt, ",", 0);

        if (virTypedParamsAddStringList(&params,
                                        &nparams,
                                        &maxparams,
                                        VIR_MIGRATE_PARAM_COMPRESSION,
                                        (const char **)val) < 0) {
            VIR_FREE(val);
            goto save_error;
        }

        VIR_FREE(val);
    }

    if ((rv = vshCommandOptInt(ctl, cmd, "comp-mt-level", &intOpt)) < 0) {
        goto out;
    } else if (rv > 0) {
        if (virTypedParamsAddInt(&params, &nparams, &maxparams,
                                 VIR_MIGRATE_PARAM_COMPRESSION_MT_LEVEL,
                                 intOpt) < 0)
            goto save_error;
    }

    if ((rv = vshCommandOptInt(ctl, cmd, "comp-mt-threads", &intOpt)) < 0) {
        goto out;
    } else if (rv > 0) {
        if (virTypedParamsAddInt(&params, &nparams, &maxparams,
                                 VIR_MIGRATE_PARAM_COMPRESSION_MT_THREADS,
                                 intOpt) < 0)
            goto save_error;
    }

    if ((rv = vshCommandOptInt(ctl, cmd, "comp-mt-dthreads", &intOpt)) < 0) {
        goto out;
    } else if (rv > 0) {
        if (virTypedParamsAddInt(&params, &nparams, &maxparams,
                                 VIR_MIGRATE_PARAM_COMPRESSION_MT_DTHREADS,
                                 intOpt) < 0)
            goto save_error;
    }

    if ((rv = vshCommandOptULongLong(ctl, cmd, "comp-xbzrle-cache", &ullOpt)) < 0) {
        goto out;
    } else if (rv > 0) {
        if (virTypedParamsAddULLong(&params, &nparams, &maxparams,
                                    VIR_MIGRATE_PARAM_COMPRESSION_XBZRLE_CACHE,
                                    ullOpt) < 0)
            goto save_error;
    }

10711 10712 10713 10714 10715
    if (vshCommandOptStringReq(ctl, cmd, "xml", &opt) < 0)
        goto out;
    if (opt) {
        char *xml;

10716
        if (virFileReadAll(opt, VSH_MAX_XML_FILE, &xml) < 0) {
10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728
            vshError(ctl, _("cannot read file '%s'"), opt);
            goto save_error;
        }

        if (virTypedParamsAddString(&params, &nparams, &maxparams,
                                    VIR_MIGRATE_PARAM_DEST_XML, xml) < 0) {
            VIR_FREE(xml);
            goto save_error;
        }
        VIR_FREE(xml);
    }

10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746
    if (vshCommandOptStringReq(ctl, cmd, "persistent-xml", &opt) < 0)
        goto out;
    if (opt) {
        char *xml;

        if (virFileReadAll(opt, VSH_MAX_XML_FILE, &xml) < 0) {
            vshError(ctl, _("cannot read file '%s'"), opt);
            goto save_error;
        }

        if (virTypedParamsAddString(&params, &nparams, &maxparams,
                                    VIR_MIGRATE_PARAM_PERSIST_XML, xml) < 0) {
            VIR_FREE(xml);
            goto save_error;
        }
        VIR_FREE(xml);
    }

10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764
    if ((rv = vshCommandOptInt(ctl, cmd, "auto-converge-initial", &intOpt)) < 0) {
        goto out;
    } else if (rv > 0) {
        if (virTypedParamsAddInt(&params, &nparams, &maxparams,
                                 VIR_MIGRATE_PARAM_AUTO_CONVERGE_INITIAL,
                                 intOpt) < 0)
            goto save_error;
    }

    if ((rv = vshCommandOptInt(ctl, cmd, "auto-converge-increment", &intOpt)) < 0) {
        goto out;
    } else if (rv > 0) {
        if (virTypedParamsAddInt(&params, &nparams, &maxparams,
                                 VIR_MIGRATE_PARAM_AUTO_CONVERGE_INCREMENT,
                                 intOpt) < 0)
            goto save_error;
    }

10765 10766 10767 10768 10769 10770 10771 10772 10773
    if ((rv = vshCommandOptULongLong(ctl, cmd, "postcopy-bandwidth", &ullOpt)) < 0) {
        goto out;
    } else if (rv > 0) {
        if (virTypedParamsAddULLong(&params, &nparams, &maxparams,
                                    VIR_MIGRATE_PARAM_BANDWIDTH_POSTCOPY,
                                    ullOpt) < 0)
            goto save_error;
    }

10774
    if ((rv = vshCommandOptInt(ctl, cmd, "parallel-connections", &intOpt)) < 0) {
10775
        goto out;
10776 10777 10778 10779
    } else if (rv > 0) {
        if (virTypedParamsAddInt(&params, &nparams, &maxparams,
                                 VIR_MIGRATE_PARAM_PARALLEL_CONNECTIONS,
                                 intOpt) < 0)
10780 10781 10782
            goto save_error;
    }

10783
    if ((rv = vshCommandOptULongLong(ctl, cmd, "bandwidth", &ullOpt)) < 0) {
10784 10785 10786 10787 10788
        goto out;
    } else if (rv > 0) {
        if (virTypedParamsAddULLong(&params, &nparams, &maxparams,
                                    VIR_MIGRATE_PARAM_BANDWIDTH,
                                    ullOpt) < 0)
10789 10790
            goto save_error;
    }
10791

10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818
    if (vshCommandOptBool(cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
    if (vshCommandOptBool(cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
    if (vshCommandOptBool(cmd, "tunnelled"))
        flags |= VIR_MIGRATE_TUNNELLED;

    if (vshCommandOptBool(cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool(cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

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

    if (vshCommandOptBool(cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

    if (vshCommandOptBool(cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;

    if (vshCommandOptBool(cmd, "unsafe"))
        flags |= VIR_MIGRATE_UNSAFE;

10819 10820 10821
    if (vshCommandOptBool(cmd, "compressed"))
        flags |= VIR_MIGRATE_COMPRESSED;

10822 10823 10824
    if (vshCommandOptBool(cmd, "auto-converge"))
        flags |= VIR_MIGRATE_AUTO_CONVERGE;

10825 10826 10827
    if (vshCommandOptBool(cmd, "rdma-pin-all"))
        flags |= VIR_MIGRATE_RDMA_PIN_ALL;

10828
    if (vshCommandOptBool(cmd, "offline"))
L
liguang 已提交
10829 10830
        flags |= VIR_MIGRATE_OFFLINE;

10831 10832 10833
    if (vshCommandOptBool(cmd, "abort-on-error"))
        flags |= VIR_MIGRATE_ABORT_ON_ERROR;

10834 10835 10836
    if (vshCommandOptBool(cmd, "postcopy"))
        flags |= VIR_MIGRATE_POSTCOPY;

10837 10838 10839
    if (vshCommandOptBool(cmd, "tls"))
        flags |= VIR_MIGRATE_TLS;

10840 10841 10842
    if (vshCommandOptBool(cmd, "parallel"))
        flags |= VIR_MIGRATE_PARALLEL;

10843
    if (flags & VIR_MIGRATE_PEER2PEER || vshCommandOptBool(cmd, "direct")) {
10844
        if (virDomainMigrateToURI3(dom, desturi, params, nparams, flags) == 0)
10845 10846 10847 10848 10849
            ret = '0';
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virDomainPtr ddom = NULL;

10850
        if ((ddom = virDomainMigrate3(dom, dconn, params, nparams, flags))) {
10851
            virshDomainFree(ddom);
10852 10853 10854 10855
            ret = '0';
        }
    }

10856
 out:
10857
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
10858
 out_sig:
10859
    virTypedParamsFree(params, nparams);
10860
    virshDomainFree(dom);
10861
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
10862 10863
    return;

10864
 save_error:
10865 10866
    vshSaveLibvirtError();
    goto out;
10867 10868
}

10869 10870 10871 10872 10873 10874
typedef enum {
    VIRSH_MIGRATE_TIMEOUT_DEFAULT,
    VIRSH_MIGRATE_TIMEOUT_SUSPEND,
    VIRSH_MIGRATE_TIMEOUT_POSTCOPY,
} virshMigrateTimeoutAction;

10875
static void
10876 10877 10878
virshMigrateTimeout(vshControl *ctl,
                    virDomainPtr dom,
                    void *opaque)
10879
{
10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897
    virshMigrateTimeoutAction action = *(virshMigrateTimeoutAction *) opaque;

    switch (action) {
    case VIRSH_MIGRATE_TIMEOUT_DEFAULT: /* unreachable */
    case VIRSH_MIGRATE_TIMEOUT_SUSPEND:
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "migration timed out; suspending domain\n");
        if (virDomainSuspend(dom) < 0)
            vshDebug(ctl, VSH_ERR_INFO, "suspending domain failed\n");
        break;

    case VIRSH_MIGRATE_TIMEOUT_POSTCOPY:
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "migration timed out; switching to post-copy\n");
        if (virDomainMigrateStartPostCopy(dom, 0) < 0)
            vshDebug(ctl, VSH_ERR_INFO, "switching to post-copy failed\n");
        break;
    }
10898 10899
}

10900
static void
J
Ján Tomko 已提交
10901
virshMigrateIteration(virConnectPtr conn G_GNUC_UNUSED,
10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916
                      virDomainPtr dom,
                      int iteration,
                      void *opaque)
{
    vshControl *ctl = opaque;

    if (iteration == 2) {
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "iteration %d finished; switching to post-copy\n",
                 iteration - 1);
        if (virDomainMigrateStartPostCopy(dom, 0) < 0)
            vshDebug(ctl, VSH_ERR_INFO, "switching to post-copy failed\n");
    }
}

10917 10918 10919 10920 10921 10922 10923 10924 10925
static bool
cmdMigrate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    virThread workerThread;
    bool verbose = false;
    bool functionReturn = false;
    int timeout = 0;
10926
    virshMigrateTimeoutAction timeoutAction = VIRSH_MIGRATE_TIMEOUT_DEFAULT;
10927
    bool live_flag = false;
10928
    virshCtrlData data = { .dconn = NULL };
10929 10930
    virshControlPtr priv = ctl->privData;
    int iterEvent = -1;
10931

10932
    VSH_EXCLUSIVE_OPTIONS("live", "offline");
10933
    VSH_EXCLUSIVE_OPTIONS("timeout-suspend", "timeout-postcopy");
10934
    VSH_REQUIRE_OPTION("postcopy-after-precopy", "postcopy");
10935
    VSH_REQUIRE_OPTION("timeout-postcopy", "postcopy");
10936
    VSH_REQUIRE_OPTION("persistent-xml", "persistent");
10937

10938
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
10939 10940 10941 10942 10943 10944 10945
        return false;

    if (vshCommandOptBool(cmd, "verbose"))
        verbose = true;

    if (vshCommandOptBool(cmd, "live"))
        live_flag = true;
10946 10947 10948 10949 10950
    if (vshCommandOptTimeoutToMs(ctl, cmd, &timeout) < 0) {
        goto cleanup;
    } else if (timeout > 0 && !live_flag) {
        vshError(ctl, "%s",
                 _("migrate: Unexpected timeout for offline migration"));
10951
        goto cleanup;
10952 10953
    }

10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966
    if (vshCommandOptBool(cmd, "timeout-suspend"))
        timeoutAction = VIRSH_MIGRATE_TIMEOUT_SUSPEND;
    if (vshCommandOptBool(cmd, "timeout-postcopy"))
        timeoutAction = VIRSH_MIGRATE_TIMEOUT_POSTCOPY;
    if (timeout > 0) {
        if (timeoutAction == VIRSH_MIGRATE_TIMEOUT_DEFAULT)
            timeoutAction = VIRSH_MIGRATE_TIMEOUT_SUSPEND;
    } else if (timeoutAction) {
        vshError(ctl, "%s",
                 _("migrate: Unexpected --timeout-* option without --timeout"));
        goto cleanup;
    }

10967 10968 10969 10970 10971 10972 10973 10974 10975 10976
    if (vshCommandOptBool(cmd, "postcopy-after-precopy")) {
        iterEvent = virConnectDomainEventRegisterAny(
                            priv->conn, dom,
                            VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION,
                            VIR_DOMAIN_EVENT_CALLBACK(virshMigrateIteration),
                            ctl, NULL);
        if (iterEvent < 0)
            goto cleanup;
    }

10977 10978 10979 10980 10981 10982 10983
    if (pipe(p) < 0)
        goto cleanup;

    data.ctl = ctl;
    data.cmd = cmd;
    data.writefd = p[1];

10984 10985 10986 10987 10988 10989 10990 10991 10992 10993
    if (vshCommandOptBool(cmd, "p2p") || vshCommandOptBool(cmd, "direct")) {
        data.dconn = NULL;
    } else {
        /* For traditional live migration, connect to the destination host. */
        virConnectPtr dconn = NULL;
        const char *desturi = NULL;

        if (vshCommandOptStringReq(ctl, cmd, "desturi", &desturi) < 0)
            goto cleanup;

10994
        dconn = virshConnect(ctl, desturi, false);
10995 10996 10997 10998 10999 11000
        if (!dconn)
            goto cleanup;

        data.dconn = dconn;
    }

11001 11002 11003 11004 11005
    if (virThreadCreate(&workerThread,
                        true,
                        doMigrate,
                        &data) < 0)
        goto cleanup;
11006
    functionReturn = virshWatchJob(ctl, dom, verbose, p[0], timeout,
11007 11008
                                   virshMigrateTimeout,
                                   &timeoutAction, _("Migration"));
11009 11010 11011

    virThreadJoin(&workerThread);

11012
 cleanup:
11013 11014
    if (data.dconn)
        virConnectClose(data.dconn);
11015 11016
    if (iterEvent != -1)
        virConnectDomainEventDeregisterAny(priv->conn, iterEvent);
11017
    virshDomainFree(dom);
11018 11019 11020 11021 11022 11023 11024 11025 11026
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
    return functionReturn;
}

/*
 * "migrate-setmaxdowntime" command
 */
static const vshCmdInfo info_migrate_setmaxdowntime[] = {
11027 11028 11029 11030 11031 11032 11033
    {.name = "help",
     .data = N_("set maximum tolerable downtime")
    },
    {.name = "desc",
     .data = N_("Set maximum tolerable downtime of a domain which is being live-migrated to another host.")
    },
    {.name = NULL}
11034 11035 11036
};

static const vshCmdOptDef opts_migrate_setmaxdowntime[] = {
11037
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
11038 11039 11040 11041 11042 11043
    {.name = "downtime",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ,
     .help = N_("maximum tolerable downtime (in milliseconds) for migration")
    },
    {.name = NULL}
11044 11045 11046 11047 11048 11049
};

static bool
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
11050
    unsigned long long downtime = 0;
11051 11052
    bool ret = false;

11053
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
11054 11055
        return false;

11056
    if (vshCommandOptULongLong(ctl, cmd, "downtime", &downtime) < 0)
11057 11058
        goto done;
    if (downtime < 1) {
11059 11060 11061 11062 11063 11064 11065 11066 11067
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

    ret = true;

11068
 done:
11069
    virshDomainFree(dom);
11070 11071 11072
    return ret;
}

11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087

/*
 * "migrate-getmaxdowntime" command
 */
static const vshCmdInfo info_migrate_getmaxdowntime[] = {
    {.name = "help",
     .data = N_("get maximum tolerable downtime")
    },
    {.name = "desc",
     .data = N_("Get maximum tolerable downtime of a domain which is being live-migrated to another host.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_migrate_getmaxdowntime[] = {
11088
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113
    {.name = NULL}
};

static bool
cmdMigrateGetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    unsigned long long downtime;
    bool ret = false;

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    if (virDomainMigrateGetMaxDowntime(dom, &downtime, 0) < 0)
        goto done;

    vshPrint(ctl, "%llu\n", downtime);
    ret = true;

 done:
    virshDomainFree(dom);
    return ret;
}


11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128
/*
 * "migrate-compcache" command
 */
static const vshCmdInfo info_migrate_compcache[] = {
    {.name = "help",
     .data = N_("get/set compression cache size")
    },
    {.name = "desc",
     .data = N_("Get/set size of the cache (in bytes) used for compressing "
                "repeatedly transferred memory pages during live migration.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_migrate_compcache[] = {
11129
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147
    {.name = "size",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ_OPT,
     .help = N_("requested size of the cache (in bytes) used for compression")
    },
    {.name = NULL}
};

static bool
cmdMigrateCompCache(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    unsigned long long size = 0;
    bool ret = false;
    const char *unit;
    double value;
    int rc;

11148
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
11149 11150
        return false;

11151
    rc = vshCommandOptULongLong(ctl, cmd, "size", &size);
11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165
    if (rc < 0) {
        goto cleanup;
    } else if (rc != 0) {
        if (virDomainMigrateSetCompressionCache(dom, size, 0) < 0)
            goto cleanup;
    }

    if (virDomainMigrateGetCompressionCache(dom, &size, 0) < 0)
        goto cleanup;

    value = vshPrettyCapacity(size, &unit);
    vshPrint(ctl, _("Compression cache: %.3lf %s"), value, unit);

    ret = true;
11166
 cleanup:
11167
    virshDomainFree(dom);
11168 11169 11170
    return ret;
}

11171 11172 11173 11174
/*
 * "migrate-setspeed" command
 */
static const vshCmdInfo info_migrate_setspeed[] = {
11175 11176 11177 11178 11179 11180 11181 11182
    {.name = "help",
     .data = N_("Set the maximum migration bandwidth")
    },
    {.name = "desc",
     .data = N_("Set the maximum migration bandwidth (in MiB/s) for a domain "
                "which is being migrated to another host.")
    },
    {.name = NULL}
11183 11184 11185
};

static const vshCmdOptDef opts_migrate_setspeed[] = {
11186
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
11187 11188 11189 11190 11191
    {.name = "bandwidth",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ,
     .help = N_("migration bandwidth limit in MiB/s")
    },
11192 11193 11194 11195
    {.name = "postcopy",
     .type = VSH_OT_BOOL,
     .help = N_("set post-copy migration bandwidth")
    },
11196
    {.name = NULL}
11197 11198 11199 11200 11201 11202 11203
};

static bool
cmdMigrateSetMaxSpeed(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    unsigned long bandwidth = 0;
11204
    unsigned int flags = 0;
11205 11206
    bool ret = false;

11207
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
11208 11209
        return false;

11210
    if (vshCommandOptULWrap(ctl, cmd, "bandwidth", &bandwidth) < 0)
11211 11212
        goto done;

11213 11214 11215 11216
    if (vshCommandOptBool(cmd, "postcopy"))
        flags |= VIR_DOMAIN_MIGRATE_MAX_SPEED_POSTCOPY;

    if (virDomainMigrateSetMaxSpeed(dom, bandwidth, flags) < 0)
11217 11218 11219 11220
        goto done;

    ret = true;

11221
 done:
11222
    virshDomainFree(dom);
11223 11224 11225 11226 11227 11228 11229
    return ret;
}

/*
 * "migrate-getspeed" command
 */
static const vshCmdInfo info_migrate_getspeed[] = {
11230 11231 11232 11233 11234 11235 11236
    {.name = "help",
     .data = N_("Get the maximum migration bandwidth")
    },
    {.name = "desc",
     .data = N_("Get the maximum migration bandwidth (in MiB/s) for a domain.")
    },
    {.name = NULL}
11237 11238 11239
};

static const vshCmdOptDef opts_migrate_getspeed[] = {
11240
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
11241 11242 11243 11244
    {.name = "postcopy",
     .type = VSH_OT_BOOL,
     .help = N_("get post-copy migration bandwidth")
    },
11245
    {.name = NULL}
11246 11247 11248 11249 11250 11251 11252
};

static bool
cmdMigrateGetMaxSpeed(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    unsigned long bandwidth;
11253
    unsigned int flags = 0;
11254 11255
    bool ret = false;

11256
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
11257 11258
        return false;

11259 11260 11261 11262
    if (vshCommandOptBool(cmd, "postcopy"))
        flags |= VIR_DOMAIN_MIGRATE_MAX_SPEED_POSTCOPY;

    if (virDomainMigrateGetMaxSpeed(dom, &bandwidth, flags) < 0)
11263 11264 11265 11266 11267 11268
        goto done;

    vshPrint(ctl, "%lu\n", bandwidth);

    ret = true;

11269
 done:
11270
    virshDomainFree(dom);
11271 11272 11273
    return ret;
}

11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288
/*
 * "migrate-postcopy" command
 */
static const vshCmdInfo info_migrate_postcopy[] = {
    {.name = "help",
     .data = N_("Switch running migration from pre-copy to post-copy")
    },
    {.name = "desc",
     .data = N_("Switch running migration from pre-copy to post-copy. "
                "The migration must have been started with --postcopy option.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_migrate_postcopy[] = {
11289
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307
    {.name = NULL}
};

static bool
cmdMigratePostCopy(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = false;

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    if (virDomainMigrateStartPostCopy(dom, 0) < 0)
        goto cleanup;

    ret = true;

 cleanup:
11308
    virshDomainFree(dom);
11309 11310 11311
    return ret;
}

11312 11313 11314 11315
/*
 * "domdisplay" command
 */
static const vshCmdInfo info_domdisplay[] = {
11316 11317 11318 11319
    {.name = "help",
     .data = N_("domain display connection URI")
    },
    {.name = "desc",
11320 11321
     .data = N_("Output the IP address and port number "
                "for the graphical display.")
11322 11323
    },
    {.name = NULL}
11324 11325 11326
};

static const vshCmdOptDef opts_domdisplay[] = {
11327
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
11328 11329 11330 11331
    {.name = "include-password",
     .type = VSH_OT_BOOL,
     .help = N_("includes the password into the connection URI if available")
    },
11332
    {.name = "type",
11333
     .type = VSH_OT_STRING,
11334
     .help = N_("select particular graphical display "
11335 11336
                "(e.g. \"vnc\", \"spice\", \"rdp\")")
    },
11337 11338 11339 11340
    {.name = "all",
     .type = VSH_OT_BOOL,
     .help = N_("show all possible graphical displays")
    },
11341
    {.name = NULL}
11342 11343 11344 11345 11346 11347 11348 11349 11350 11351
};

static bool
cmdDomDisplay(vshControl *ctl, const vshCmd *cmd)
{
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool ret = false;
M
Martin Kletzander 已提交
11352 11353
    char *xpath = NULL;
    char *listen_addr = NULL;
11354
    int port, tls_port = 0;
11355
    char *type_conn = NULL;
11356
    char *sockpath = NULL;
11357 11358 11359
    char *passwd = NULL;
    char *output = NULL;
    const char *scheme[] = { "vnc", "spice", "rdp", NULL };
11360
    const char *type = NULL;
11361 11362 11363
    int iter = 0;
    int tmp;
    int flags = 0;
M
Martin Kletzander 已提交
11364
    bool params = false;
11365
    bool all = vshCommandOptBool(cmd, "all");
11366
    const char *xpath_fmt = "string(/domain/devices/graphics[@type='%s']/%s)";
11367
    virSocketAddr addr;
11368

11369
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
11370 11371 11372 11373 11374 11375 11376 11377 11378 11379
        return false;

    if (!virDomainIsActive(dom)) {
        vshError(ctl, _("Domain is not running"));
        goto cleanup;
    }

    if (vshCommandOptBool(cmd, "include-password"))
        flags |= VIR_DOMAIN_XML_SECURE;

11380 11381 11382
    if (vshCommandOptStringReq(ctl, cmd, "type", &type) < 0)
        goto cleanup;

11383
    if (virshDomainGetXMLFromDom(ctl, dom, flags, &xml, &ctxt) < 0)
11384 11385 11386 11387
        goto cleanup;

    /* Attempt to grab our display info */
    for (iter = 0; scheme[iter] != NULL; iter++) {
11388
        /* Particular scheme requested */
11389
        if (!all && type && STRNEQ(type, scheme[iter]))
11390 11391
            continue;

11392
        /* Create our XPATH lookup for the current display's port */
11393
        VIR_FREE(xpath);
11394
        xpath = g_strdup_printf(xpath_fmt, scheme[iter], "@port");
11395 11396 11397 11398 11399 11400

        /* Attempt to get the port number for the current graphics scheme */
        tmp = virXPathInt(xpath, ctxt, &port);
        VIR_FREE(xpath);

        /* If there is no port number for this type, then jump to the next
M
Martin Kletzander 已提交
11401
         * scheme */
11402
        if (tmp)
11403 11404 11405 11406
            port = 0;

        /* Create our XPATH lookup for TLS Port (automatically skipped
         * for unsupported schemes */
11407
        xpath = g_strdup_printf(xpath_fmt, scheme[iter], "@tlsPort");
11408 11409 11410 11411 11412 11413 11414

        /* Attempt to get the TLS port number */
        tmp = virXPathInt(xpath, ctxt, &tls_port);
        VIR_FREE(xpath);
        if (tmp)
            tls_port = 0;

11415
        /* Create our XPATH lookup for the current display's address */
11416
        xpath = g_strdup_printf(xpath_fmt, scheme[iter], "@listen");
11417 11418

        /* Attempt to get the listening addr if set for the current
M
Martin Kletzander 已提交
11419
         * graphics scheme */
11420
        VIR_FREE(listen_addr);
11421 11422 11423
        listen_addr = virXPathString(xpath, ctxt);
        VIR_FREE(xpath);

11424
        /* Create our XPATH lookup for the current spice type. */
11425
        xpath = g_strdup_printf(xpath_fmt, scheme[iter], "listen/@type");
11426 11427 11428 11429 11430 11431 11432

        /* Attempt to get the type of spice connection */
        VIR_FREE(type_conn);
        type_conn = virXPathString(xpath, ctxt);
        VIR_FREE(xpath);

        if (STREQ_NULLABLE(type_conn, "socket")) {
11433
            if (!sockpath) {
11434
                xpath = g_strdup_printf(xpath_fmt, scheme[iter], "listen/@socket");
11435

11436
                sockpath = virXPathString(xpath, ctxt);
11437 11438 11439 11440 11441

                VIR_FREE(xpath);
            }
        }

11442
        if (!port && !tls_port && !sockpath)
11443 11444
            continue;

11445 11446 11447 11448 11449 11450 11451 11452 11453
        if (!listen_addr) {
            /* The subelement address - <listen address='xyz'/> -
             * *should* have been automatically backfilled into its
             * parent <graphics listen='xyz'> (which we just tried to
             * retrieve into listen_addr above) but in some cases it
             * isn't, so we also do an explicit check for the
             * subelement (which, by the way, doesn't exist on libvirt
             * < 0.9.4, so we really do need to check both places)
             */
11454
            xpath = g_strdup_printf(xpath_fmt, scheme[iter], "listen/@address");
11455 11456 11457

            listen_addr = virXPathString(xpath, ctxt);
            VIR_FREE(xpath);
11458 11459 11460
        } else {
            /* If listen_addr is 0.0.0.0 or [::] we should try to parse URI and set
             * listen_addr based on current URI. */
11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476
            if (virSocketAddrParse(&addr, listen_addr, AF_UNSPEC) > 0 &&
                virSocketAddrIsWildcard(&addr)) {

                virConnectPtr conn = ((virshControlPtr)(ctl->privData))->conn;
                char *uriStr = virConnectGetURI(conn);
                virURIPtr uri = NULL;

                if (uriStr) {
                    uri = virURIParse(uriStr);
                    VIR_FREE(uriStr);
                }

                /* It's safe to free the listen_addr even if parsing of URI
                 * fails, if there is no listen_addr we will print "localhost". */
                VIR_FREE(listen_addr);

11477
                if (uri) {
J
Ján Tomko 已提交
11478
                    listen_addr = g_strdup(uri->server);
11479 11480
                    virURIFree(uri);
                }
11481 11482 11483
            }
        }

M
Martin Kletzander 已提交
11484 11485 11486 11487 11488 11489
        /* We can query this info for all the graphics types since we'll
         * get nothing for the unsupported ones (just rdp for now).
         * Also the parameter '--include-password' was already taken
         * care of when getting the XML */

        /* Create our XPATH lookup for the password */
11490
        xpath = g_strdup_printf(xpath_fmt, scheme[iter], "@passwd");
M
Martin Kletzander 已提交
11491 11492

        /* Attempt to get the password */
11493
        VIR_FREE(passwd);
M
Martin Kletzander 已提交
11494 11495 11496
        passwd = virXPathString(xpath, ctxt);
        VIR_FREE(xpath);

11497
        /* Build up the full URI, starting with the scheme */
11498
        if (sockpath)
11499 11500 11501
            virBufferAsprintf(&buf, "%s+unix://", scheme[iter]);
        else
            virBufferAsprintf(&buf, "%s://", scheme[iter]);
11502

M
Martin Kletzander 已提交
11503 11504 11505 11506
        /* There is no user, so just append password if there's any */
        if (STREQ(scheme[iter], "vnc") && passwd)
            virBufferAsprintf(&buf, ":%s@", passwd);

11507
        /* Then host name or IP */
11508
        if (!listen_addr && !sockpath)
11509
            virBufferAddLit(&buf, "localhost");
11510
        else if (!sockpath && strchr(listen_addr, ':'))
11511
            virBufferAsprintf(&buf, "[%s]", listen_addr);
11512 11513
        else if (sockpath)
            virBufferAsprintf(&buf, "%s", sockpath);
11514 11515 11516
        else
            virBufferAsprintf(&buf, "%s", listen_addr);

11517
        /* Free socket to prepare the pointer for the next iteration */
11518
        VIR_FREE(sockpath);
11519

11520
        /* Add the port */
11521 11522 11523 11524 11525 11526 11527
        if (port) {
            if (STREQ(scheme[iter], "vnc")) {
                /* VNC protocol handlers take their port number as
                 * 'port' - 5900 */
                port -= 5900;
            }

11528
            virBufferAsprintf(&buf, ":%d", port);
11529
        }
11530 11531

        /* TLS Port */
M
Martin Kletzander 已提交
11532 11533
        if (tls_port) {
            virBufferAsprintf(&buf,
J
John Ferlan 已提交
11534
                              "?tls-port=%d",
M
Martin Kletzander 已提交
11535 11536 11537
                              tls_port);
            params = true;
        }
11538

M
Martin Kletzander 已提交
11539 11540 11541 11542 11543 11544
        if (STREQ(scheme[iter], "spice") && passwd) {
            virBufferAsprintf(&buf,
                              "%spassword=%s",
                              params ? "&" : "?",
                              passwd);
            params = true;
11545 11546 11547
        }

        /* Print out our full URI */
11548
        VIR_FREE(output);
11549 11550 11551 11552 11553
        output = virBufferContentAndReset(&buf);
        vshPrint(ctl, "%s", output);

        /* We got what we came for so return successfully */
        ret = true;
11554 11555 11556 11557 11558
        if (!all) {
            break;
        } else {
            vshPrint(ctl, "\n");
        }
11559 11560
    }

11561 11562 11563 11564 11565 11566
    if (!ret) {
        if (type)
            vshError(ctl, _("No graphical display with type '%s' found"), type);
        else
            vshError(ctl, _("No graphical display found"));
    }
11567

11568
 cleanup:
M
Martin Kletzander 已提交
11569
    VIR_FREE(xpath);
11570
    VIR_FREE(type_conn);
11571
    VIR_FREE(sockpath);
M
Martin Kletzander 已提交
11572 11573 11574
    VIR_FREE(passwd);
    VIR_FREE(listen_addr);
    VIR_FREE(output);
11575 11576
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
11577
    virshDomainFree(dom);
11578 11579 11580 11581 11582 11583 11584
    return ret;
}

/*
 * "vncdisplay" command
 */
static const vshCmdInfo info_vncdisplay[] = {
11585 11586 11587 11588 11589 11590 11591
    {.name = "help",
     .data = N_("vnc display")
    },
    {.name = "desc",
     .data = N_("Output the IP address and port number for the VNC display.")
    },
    {.name = NULL}
11592 11593 11594
};

static const vshCmdOptDef opts_vncdisplay[] = {
11595
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
11596
    {.name = NULL}
11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608
};

static bool
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
{
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
    bool ret = false;
    int port = 0;
    char *listen_addr = NULL;

11609
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
11610 11611 11612 11613 11614 11615 11616 11617
        return false;

    /* Check if the domain is active and don't rely on -1 for this */
    if (!virDomainIsActive(dom)) {
        vshError(ctl, _("Domain is not running"));
        goto cleanup;
    }

11618
    if (virshDomainGetXMLFromDom(ctl, dom, 0, &xml, &ctxt) < 0)
11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629
        goto cleanup;

    /* Get the VNC port */
    if (virXPathInt("string(/domain/devices/graphics[@type='vnc']/@port)",
                    ctxt, &port)) {
        vshError(ctl, _("Failed to get VNC port. Is this domain using VNC?"));
        goto cleanup;
    }

    listen_addr = virXPathString("string(/domain/devices/graphics"
                                 "[@type='vnc']/@listen)", ctxt);
11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641
    if (!listen_addr) {
        /* The subelement address - <listen address='xyz'/> -
         * *should* have been automatically backfilled into its
         * parent <graphics listen='xyz'> (which we just tried to
         * retrieve into listen_addr above) but in some cases it
         * isn't, so we also do an explicit check for the
         * subelement (which, by the way, doesn't exist on libvirt
         * < 0.9.4, so we really do need to check both places)
         */
        listen_addr = virXPathString("string(/domain/devices/graphics"
                                     "[@type='vnc']/listen/@address)", ctxt);
    }
11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652
    if (listen_addr == NULL || STREQ(listen_addr, "0.0.0.0"))
        vshPrint(ctl, ":%d\n", port-5900);
    else
        vshPrint(ctl, "%s:%d\n", listen_addr, port-5900);

    ret = true;

 cleanup:
    VIR_FREE(listen_addr);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
11653
    virshDomainFree(dom);
11654 11655 11656 11657 11658 11659 11660
    return ret;
}

/*
 * "ttyconsole" command
 */
static const vshCmdInfo info_ttyconsole[] = {
11661 11662 11663 11664 11665 11666 11667
    {.name = "help",
     .data = N_("tty console")
    },
    {.name = "desc",
     .data = N_("Output the device for the TTY console.")
    },
    {.name = NULL}
11668 11669 11670
};

static const vshCmdOptDef opts_ttyconsole[] = {
11671
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
11672
    {.name = NULL}
11673 11674 11675 11676 11677 11678 11679 11680
};

static bool
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
{
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    bool ret = false;
11681
    char *tty = NULL;
11682

11683
    if (virshDomainGetXML(ctl, cmd, 0, &xml, &ctxt) < 0)
11684 11685
        return false;

11686
    if (!(tty = virXPathString("string(/domain/devices/console/@tty)", ctxt)))
11687 11688
        goto cleanup;

11689
    vshPrint(ctl, "%s\n", tty);
11690 11691 11692 11693 11694
    ret = true;

 cleanup:
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
11695
    VIR_FREE(tty);
11696 11697 11698 11699 11700 11701 11702
    return ret;
}

/*
 * "domhostname" command
 */
static const vshCmdInfo info_domhostname[] = {
11703 11704 11705 11706 11707 11708 11709
    {.name = "help",
     .data = N_("print the domain's hostname")
    },
    {.name = "desc",
     .data = ""
    },
    {.name = NULL}
11710 11711 11712
};

static const vshCmdOptDef opts_domhostname[] = {
11713
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
11714
    {.name = NULL}
11715 11716 11717 11718 11719 11720 11721 11722 11723
};

static bool
cmdDomHostname(vshControl *ctl, const vshCmd *cmd)
{
    char *hostname;
    virDomainPtr dom;
    bool ret = false;

11724
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735
        return false;

    hostname = virDomainGetHostname(dom, 0);
    if (hostname == NULL) {
        vshError(ctl, "%s", _("failed to get hostname"));
        goto error;
    }

    vshPrint(ctl, "%s\n", hostname);
    ret = true;

11736
 error:
11737
    VIR_FREE(hostname);
11738
    virshDomainFree(dom);
11739 11740 11741 11742 11743 11744 11745 11746 11747 11748
    return ret;
}

/**
 * Check if n1 is superset of n2, meaning n1 contains all elements and
 * attributes as n2 at least. Including children.
 * @n1 first node
 * @n2 second node
 * returns true in case n1 covers n2, false otherwise.
 */
J
Ján Tomko 已提交
11749
G_GNUC_UNUSED
11750
static bool
11751
virshNodeIsSuperset(xmlNodePtr n1, xmlNodePtr n2)
11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796
{
    xmlNodePtr child1, child2;
    xmlAttrPtr attr;
    char *prop1, *prop2;
    bool found;
    bool visited;
    bool ret = false;
    long n1_child_size, n2_child_size, n1_iter;
    virBitmapPtr bitmap;

    if (!n1 && !n2)
        return true;

    if (!n1 || !n2)
        return false;

    if (!xmlStrEqual(n1->name, n2->name))
        return false;

    /* Iterate over n2 attributes and check if n1 contains them*/
    attr = n2->properties;
    while (attr) {
        if (attr->type == XML_ATTRIBUTE_NODE) {
            prop1 = virXMLPropString(n1, (const char *) attr->name);
            prop2 = virXMLPropString(n2, (const char *) attr->name);
            if (STRNEQ_NULLABLE(prop1, prop2)) {
                xmlFree(prop1);
                xmlFree(prop2);
                return false;
            }
            xmlFree(prop1);
            xmlFree(prop2);
        }
        attr = attr->next;
    }

    n1_child_size = virXMLChildElementCount(n1);
    n2_child_size = virXMLChildElementCount(n2);
    if (n1_child_size < 0 || n2_child_size < 0 ||
        n1_child_size < n2_child_size)
        return false;

    if (n1_child_size == 0 && n2_child_size == 0)
        return true;

11797
    if (!(bitmap = virBitmapNew(n1_child_size)))
11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833
        return false;

    child2 = n2->children;
    while (child2) {
        if (child2->type != XML_ELEMENT_NODE) {
            child2 = child2->next;
            continue;
        }

        child1 = n1->children;
        n1_iter = 0;
        found = false;
        while (child1) {
            if (child1->type != XML_ELEMENT_NODE) {
                child1 = child1->next;
                continue;
            }

            if (virBitmapGetBit(bitmap, n1_iter, &visited) < 0) {
                vshError(NULL, "%s", _("Bad child elements counting."));
                goto cleanup;
            }

            if (visited) {
                child1 = child1->next;
                n1_iter++;
                continue;
            }

            if (xmlStrEqual(child1->name, child2->name)) {
                found = true;
                if (virBitmapSetBit(bitmap, n1_iter) < 0) {
                    vshError(NULL, "%s", _("Bad child elements counting."));
                    goto cleanup;
                }

11834
                if (!virshNodeIsSuperset(child1, child2))
11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851
                    goto cleanup;

                break;
            }

            child1 = child1->next;
            n1_iter++;
        }

        if (!found)
            goto cleanup;

        child2 = child2->next;
    }

    ret = true;

11852
 cleanup:
11853 11854 11855 11856 11857 11858 11859 11860 11861
    virBitmapFree(bitmap);
    return ret;
}


/*
 * "detach-device" command
 */
static const vshCmdInfo info_detach_device[] = {
11862 11863 11864 11865 11866 11867 11868
    {.name = "help",
     .data = N_("detach device from an XML file")
    },
    {.name = "desc",
     .data = N_("Detach device from an XML <file>")
    },
    {.name = NULL}
11869 11870 11871
};

static const vshCmdOptDef opts_detach_device[] = {
11872
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
11873
    VIRSH_COMMON_OPT_FILE(N_("XML file")),
11874
    VIRSH_COMMON_OPT_DOMAIN_PERSISTENT,
11875
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
11876
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
11877
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
11878
    {.name = NULL}
11879 11880 11881 11882 11883 11884 11885 11886 11887 11888
};

static bool
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    const char *from = NULL;
    char *buffer = NULL;
    int ret;
    bool funcRet = false;
11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool persistent = vshCommandOptBool(cmd, "persistent");
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;

    VSH_EXCLUSIVE_OPTIONS_VAR(persistent, current);

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config || persistent)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
11904

11905
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
11906 11907
        return false;

11908 11909 11910 11911
    if (persistent &&
        virDomainIsActive(dom) == 1)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

11912
    if (vshCommandOptStringReq(ctl, cmd, "file", &from) < 0)
11913 11914
        goto cleanup;

E
Eric Blake 已提交
11915 11916
    if (virFileReadAll(from, VSH_MAX_XML_FILE, &buffer) < 0) {
        vshReportError(ctl);
11917 11918 11919
        goto cleanup;
    }

11920
    if (flags != 0 || current)
11921
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
11922
    else
11923 11924 11925 11926 11927 11928 11929
        ret = virDomainDetachDevice(dom, buffer);

    if (ret < 0) {
        vshError(ctl, _("Failed to detach device from %s"), from);
        goto cleanup;
    }

P
Pino Toscano 已提交
11930
    vshPrintExtra(ctl, "%s", _("Device detached successfully\n"));
11931 11932
    funcRet = true;

11933
 cleanup:
11934
    VIR_FREE(buffer);
11935
    virshDomainFree(dom);
11936 11937 11938
    return funcRet;
}

11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957

/*
 * "detach-device-alias" command
 */
static const vshCmdInfo info_detach_device_alias[] = {
    {.name = "help",
     .data = N_("detach device from an alias")
    },
    {.name = "desc",
     .data = N_("Detach device identified by the given alias from a domain")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_detach_device_alias[] = {
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
    {.name = "alias",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
11958
     .completer = virshDomainDeviceAliasCompleter,
11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005
     .help = N_("device alias")
    },
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
    {.name = NULL}
};

static bool
cmdDetachDeviceAlias(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    const char *alias = NULL;
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
    bool ret = false;

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    if (vshCommandOptStringReq(ctl, cmd, "alias", &alias) < 0)
        goto cleanup;

    if (virDomainDetachDeviceAlias(dom, alias, flags) < 0) {
        vshError(ctl, _("Failed to detach device with alias %s"), alias);
        goto cleanup;
    }

    vshPrintExtra(ctl, "%s", _("Device detach request sent successfully\n"));
    ret = true;

 cleanup:
    virshDomainFree(dom);
    return ret;
}


12006 12007 12008 12009
/*
 * "update-device" command
 */
static const vshCmdInfo info_update_device[] = {
12010 12011 12012 12013 12014 12015 12016
    {.name = "help",
     .data = N_("update device from an XML file")
    },
    {.name = "desc",
     .data = N_("Update device from an XML <file>.")
    },
    {.name = NULL}
12017 12018 12019
};

static const vshCmdOptDef opts_update_device[] = {
12020
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
12021
    VIRSH_COMMON_OPT_FILE(N_("XML file")),
12022
    VIRSH_COMMON_OPT_DOMAIN_PERSISTENT,
12023
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
12024
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
12025
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
12026 12027 12028 12029 12030
    {.name = "force",
     .type = VSH_OT_BOOL,
     .help = N_("force device update")
    },
    {.name = NULL}
12031 12032 12033 12034 12035 12036 12037
};

static bool
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *from = NULL;
12038 12039
    char *buffer = NULL;
    bool ret = false;
12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool persistent = vshCommandOptBool(cmd, "persistent");

    VSH_EXCLUSIVE_OPTIONS_VAR(persistent, current);

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config || persistent)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
12055

12056
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
12057 12058
        return false;

12059 12060
    if (vshCommandOptStringReq(ctl, cmd, "file", &from) < 0)
        goto cleanup;
12061

12062 12063 12064 12065
    if (persistent &&
        virDomainIsActive(dom) == 1)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

E
Eric Blake 已提交
12066 12067
    if (virFileReadAll(from, VSH_MAX_XML_FILE, &buffer) < 0) {
        vshReportError(ctl);
12068
        goto cleanup;
12069 12070 12071 12072 12073
    }

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

12074
    if (virDomainUpdateDeviceFlags(dom, buffer, flags) < 0) {
12075
        vshError(ctl, _("Failed to update device from %s"), from);
12076
        goto cleanup;
12077 12078
    }

P
Pino Toscano 已提交
12079
    vshPrintExtra(ctl, "%s", _("Device updated successfully\n"));
12080 12081
    ret = true;

12082
 cleanup:
12083
    VIR_FREE(buffer);
12084
    virshDomainFree(dom);
12085
    return ret;
12086 12087 12088 12089 12090 12091
}

/*
 * "detach-interface" command
 */
static const vshCmdInfo info_detach_interface[] = {
12092 12093 12094 12095 12096 12097 12098
    {.name = "help",
     .data = N_("detach network interface")
    },
    {.name = "desc",
     .data = N_("Detach network interface.")
    },
    {.name = NULL}
12099 12100 12101
};

static const vshCmdOptDef opts_detach_interface[] = {
12102
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
12103 12104 12105 12106 12107 12108 12109
    {.name = "type",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("network interface type")
    },
    {.name = "mac",
     .type = VSH_OT_STRING,
12110 12111
     .completer = virshDomainInterfaceCompleter,
     .completer_flags = VIRSH_DOMAIN_INTERFACE_COMPLETER_MAC,
12112 12113
     .help = N_("MAC address")
    },
12114
    VIRSH_COMMON_OPT_DOMAIN_PERSISTENT,
12115
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
12116
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
12117
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
12118
    {.name = NULL}
12119 12120 12121
};

static bool
12122 12123 12124 12125 12126 12127 12128
virshDomainDetachInterface(char *doc,
                           unsigned int flags,
                           virDomainPtr dom,
                           vshControl *ctl,
                           bool current,
                           const char *type,
                           const char *mac)
12129 12130
{
    xmlDocPtr xml = NULL;
12131
    xmlXPathObjectPtr obj = NULL;
12132
    xmlXPathContextPtr ctxt = NULL;
12133
    xmlNodePtr cur = NULL, matchNode = NULL;
12134 12135
    char *detach_xml = NULL, buf[64];
    int diff_mac, ret = -1;
12136
    size_t i;
12137

12138
    if (!(xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt))) {
12139 12140 12141 12142
        vshError(ctl, "%s", _("Failed to get interface information"));
        goto cleanup;
    }

12143
    g_snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
12144 12145 12146
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if (obj == NULL || obj->type != XPATH_NODESET ||
        obj->nodesetval == NULL || obj->nodesetval->nodeNr == 0) {
12147
        vshError(ctl, _("No interface found whose type is %s"), type);
12148 12149 12150 12151 12152 12153 12154 12155 12156
        goto cleanup;
    }

    if (!mac && obj->nodesetval->nodeNr > 1) {
        vshError(ctl, _("Domain has %d interfaces. Please specify which one "
                        "to detach using --mac"), obj->nodesetval->nodeNr);
        goto cleanup;
    }

12157 12158
    if (!mac) {
        matchNode = obj->nodesetval->nodeTab[0];
12159
        goto hit;
12160
    }
12161

12162
    /* multiple possibilities, so search for matching mac */
12163
    for (i = 0; i < obj->nodesetval->nodeNr; i++) {
12164 12165 12166
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
            if (cur->type == XML_ELEMENT_NODE &&
12167
                virXMLNodeNameEqual(cur, "mac")) {
12168 12169 12170 12171
                char *tmp_mac = virXMLPropString(cur, "address");
                diff_mac = virMacAddrCompare(tmp_mac, mac);
                VIR_FREE(tmp_mac);
                if (!diff_mac) {
12172 12173 12174 12175 12176 12177 12178 12179 12180
                    if (matchNode) {
                        /* this is the 2nd match, so it's ambiguous */
                        vshError(ctl, _("Domain has multiple interfaces matching "
                                        "MAC address %s. You must use detach-device and "
                                        "specify the device pci address to remove it."),
                                 mac);
                        goto cleanup;
                    }
                    matchNode = obj->nodesetval->nodeTab[i];
12181 12182 12183 12184 12185
                }
            }
            cur = cur->next;
        }
    }
12186 12187 12188 12189
    if (!matchNode) {
        vshError(ctl, _("No interface with MAC address %s was found"), mac);
        goto cleanup;
    }
12190

12191
 hit:
12192 12193
    if (!(detach_xml = virXMLNodeToString(xml, matchNode))) {
        vshSaveLibvirtError();
12194 12195 12196
        goto cleanup;
    }

12197
    if (flags != 0 || current)
12198 12199 12200
        ret = virDomainDetachDeviceFlags(dom, detach_xml, flags);
    else
        ret = virDomainDetachDevice(dom, detach_xml);
12201

12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214
 cleanup:
    VIR_FREE(detach_xml);
    xmlFreeDoc(xml);
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    return ret == 0;
}


static bool
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
12215
    char *doc_live = NULL, *doc_config = NULL;
12216
    const char *mac = NULL, *type = NULL;
12217 12218
    int flags = 0;
    bool ret = false, affect_config, affect_live;
12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool persistent = vshCommandOptBool(cmd, "persistent");

    VSH_EXCLUSIVE_OPTIONS_VAR(persistent, current);

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    if (vshCommandOptStringReq(ctl, cmd, "type", &type) < 0)
        goto cleanup;

    if (vshCommandOptStringReq(ctl, cmd, "mac", &mac) < 0)
        goto cleanup;

12238
    affect_config = (config || persistent);
12239

12240 12241 12242 12243 12244 12245 12246 12247
    if (affect_config) {
        if (!(doc_config = virDomainGetXMLDesc(dom, VIR_DOMAIN_XML_INACTIVE)))
            goto cleanup;
        if (!(ret = virshDomainDetachInterface(doc_config,
                                               flags | VIR_DOMAIN_AFFECT_CONFIG,
                                               dom, ctl, current, type, mac)))
            goto cleanup;
    }
12248

12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262
    affect_live = (live || (persistent && virDomainIsActive(dom) == 1));

    if (affect_live || !affect_config) {
        flags = 0;

        if (affect_live)
            flags |= VIR_DOMAIN_AFFECT_LIVE;

        if (!(doc_live = virDomainGetXMLDesc(dom, 0)))
            goto cleanup;

        ret = virshDomainDetachInterface(doc_live, flags,
                                         dom, ctl, current, type, mac);
    }
12263 12264 12265

 cleanup:
    if (!ret) {
12266 12267
        vshError(ctl, "%s", _("Failed to detach interface"));
    } else {
P
Pino Toscano 已提交
12268
        vshPrintExtra(ctl, "%s", _("Interface detached successfully\n"));
12269
    }
12270 12271
    VIR_FREE(doc_live);
    VIR_FREE(doc_config);
12272
    virshDomainFree(dom);
12273
    return ret;
12274 12275
}

12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295

static void
virshDiskDropBackingStore(xmlNodePtr disk_node)
{
    xmlNodePtr tmp;

    for (tmp = disk_node->children; tmp; tmp = tmp->next) {
        if (tmp->type != XML_ELEMENT_NODE)
            continue;

        if (virXMLNodeNameEqual(tmp, "backingStore")) {
            xmlUnlinkNode(tmp);
            xmlFreeNode(tmp);

            return;
        }
    }
}


12296
typedef enum {
12297 12298 12299
    VIRSH_FIND_DISK_NORMAL,
    VIRSH_FIND_DISK_CHANGEABLE,
} virshFindDiskType;
12300 12301 12302 12303

/* Helper function to find disk device in XML doc.  Returns the disk
 * node on success, or NULL on failure. Caller must free the result
 * @path: Fully-qualified path or target of disk device.
12304
 * @type: Either VIRSH_FIND_DISK_NORMAL or VIRSH_FIND_DISK_CHANGEABLE.
12305 12306
 */
static xmlNodePtr
12307 12308 12309
virshFindDisk(const char *doc,
              const char *path,
              int type)
12310 12311
{
    xmlDocPtr xml = NULL;
12312
    xmlXPathObjectPtr obj = NULL;
12313 12314 12315
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlNodePtr ret = NULL;
12316
    size_t i;
12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333

    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
    if (!xml) {
        vshError(NULL, "%s", _("Failed to get disk information"));
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if (obj == NULL ||
        obj->type != XPATH_NODESET ||
        obj->nodesetval == NULL ||
        obj->nodesetval->nodeNr == 0) {
        vshError(NULL, "%s", _("Failed to get disk information"));
        goto cleanup;
    }

    /* search disk using @path */
12334
    for (i = 0; i < obj->nodesetval->nodeNr; i++) {
12335 12336
        bool is_supported = true;

12337
        if (type == VIRSH_FIND_DISK_CHANGEABLE) {
12338 12339 12340 12341
            xmlNodePtr n = obj->nodesetval->nodeTab[i];
            is_supported = false;

            /* Check if the disk is CDROM or floppy disk */
12342
            if (virXMLNodeNameEqual(n, "disk")) {
12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360
                char *device_value = virXMLPropString(n, "device");

                if (STREQ(device_value, "cdrom") ||
                    STREQ(device_value, "floppy"))
                    is_supported = true;

                VIR_FREE(device_value);
            }

            if (!is_supported)
                continue;
        }

        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
            if (cur->type == XML_ELEMENT_NODE) {
                char *tmp = NULL;

12361
                if (virXMLNodeNameEqual(cur, "source")) {
12362 12363 12364 12365 12366
                    if ((tmp = virXMLPropString(cur, "file")) ||
                        (tmp = virXMLPropString(cur, "dev")) ||
                        (tmp = virXMLPropString(cur, "dir")) ||
                        (tmp = virXMLPropString(cur, "name"))) {
                    }
12367
                } else if (virXMLNodeNameEqual(cur, "target")) {
12368 12369 12370 12371 12372
                    tmp = virXMLPropString(cur, "dev");
                }

                if (STREQ_NULLABLE(tmp, path)) {
                    ret = xmlCopyNode(obj->nodesetval->nodeTab[i], 1);
12373 12374
                    /* drop backing store since they are not needed here */
                    virshDiskDropBackingStore(ret);
12375 12376 12377 12378 12379 12380 12381 12382 12383
                    VIR_FREE(tmp);
                    goto cleanup;
                }
                VIR_FREE(tmp);
            }
            cur = cur->next;
        }
    }

12384
    vshError(NULL, _("No disk found whose source path or target is %s"), path);
12385

12386
 cleanup:
12387 12388 12389 12390 12391 12392 12393
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    return ret;
}

typedef enum {
12394 12395 12396 12397
    VIRSH_UPDATE_DISK_XML_EJECT,
    VIRSH_UPDATE_DISK_XML_INSERT,
    VIRSH_UPDATE_DISK_XML_UPDATE,
} virshUpdateDiskXMLType;
12398 12399 12400 12401 12402 12403 12404

/* Helper function to prepare disk XML. Could be used for disk
 * detaching, media changing(ejecting, inserting, updating)
 * for changeable disk. Returns the processed XML as string on
 * success, or NULL on failure. Caller must free the result.
 */
static char *
12405 12406 12407 12408 12409
virshUpdateDiskXML(xmlNodePtr disk_node,
                   const char *new_source,
                   bool source_block,
                   const char *target,
                   virshUpdateDiskXMLType type)
12410
{
12411
    xmlNodePtr tmp = NULL;
12412
    xmlNodePtr source = NULL;
12413 12414
    xmlNodePtr target_node = NULL;
    xmlNodePtr text_node = NULL;
M
Michal Privoznik 已提交
12415
    char *device_type = NULL;
12416
    char *ret = NULL;
12417
    char *startupPolicy = NULL;
12418
    char *source_path = NULL;
12419 12420 12421 12422 12423 12424

    if (!disk_node)
        return NULL;

    device_type = virXMLPropString(disk_node, "device");

12425 12426 12427 12428 12429
    if (!(STREQ_NULLABLE(device_type, "cdrom") ||
          STREQ_NULLABLE(device_type, "floppy"))) {
        vshError(NULL, _("The disk device '%s' is not removable"), target);
        goto cleanup;
    }
12430

12431
    /* find the current source subelement */
12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446
    for (tmp = disk_node->children; tmp; tmp = tmp->next) {
        /*
         * Save the last text node before the <target/>.  The
         * reasoning behind this is that the target node will be
         * present in this case and also has a proper indentation.
         */
        if (!target_node && tmp->type == XML_TEXT_NODE)
            text_node = tmp;

        /*
         * We need only element nodes from now on.
         */
        if (tmp->type != XML_ELEMENT_NODE)
            continue;

12447
        if (virXMLNodeNameEqual(tmp, "source"))
12448 12449
            source = tmp;

12450
        if (virXMLNodeNameEqual(tmp, "target"))
12451 12452 12453 12454 12455
            target_node = tmp;

        /*
         * We've found all we needed.
         */
12456
        if (source && target_node)
12457 12458 12459
            break;
    }

12460
    if (type == VIRSH_UPDATE_DISK_XML_EJECT) {
12461 12462 12463
        if (!source) {
            vshError(NULL, _("The disk device '%s' doesn't have media"), target);
            goto cleanup;
12464 12465
        }

12466 12467 12468 12469 12470 12471 12472
        /* forcibly switch to empty file cdrom */
        source_block = false;
        new_source = NULL;
    } else if (!new_source) {
        vshError(NULL, _("New disk media source was not specified"));
        goto cleanup;
    }
12473

12474
    if (source) {
12475 12476 12477 12478 12479 12480 12481
        if (!(source_path = virXMLPropString(source, "file")) &&
            !(source_path = virXMLPropString(source, "dev")) &&
            !(source_path = virXMLPropString(source, "dir")) &&
            !(source_path = virXMLPropString(source, "pool")))
            source_path = virXMLPropString(source, "name");

        if (source_path && type == VIRSH_UPDATE_DISK_XML_INSERT) {
12482 12483 12484 12485 12486 12487 12488
            vshError(NULL, _("The disk device '%s' already has media"), target);
            goto cleanup;
        }

        startupPolicy = virXMLPropString(source, "startupPolicy");

        /* remove current source */
12489 12490 12491 12492
        xmlUnlinkNode(source);
        xmlFreeNode(source);
        source = NULL;
    }
12493

12494 12495 12496 12497 12498
    /* set the correct disk type */
    if (source_block)
        xmlSetProp(disk_node, BAD_CAST "type", BAD_CAST "block");
    else
        xmlSetProp(disk_node, BAD_CAST "type", BAD_CAST "file");
12499

12500 12501 12502 12503 12504
    if (new_source) {
        /* create new source subelement */
        if (!(source = xmlNewNode(NULL, BAD_CAST "source"))) {
            vshError(NULL, _("Failed to allocate new source node"));
            goto cleanup;
12505
        }
12506 12507 12508 12509 12510 12511

        if (source_block)
            xmlNewProp(source, BAD_CAST "dev", BAD_CAST new_source);
        else
            xmlNewProp(source, BAD_CAST "file", BAD_CAST new_source);

12512 12513
        if (startupPolicy)
            xmlNewProp(source, BAD_CAST "startupPolicy", BAD_CAST startupPolicy);
12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529

        /*
         * So that the output XML looks nice in case anyone calls
         * 'change-media' with '--print-xml', let's attach the source
         * before target...
         */
        xmlAddPrevSibling(target_node, source);

        /*
         * ... and duplicate the text node doing the indentation just
         * so it's more easily readable.  And don't make it fatal.
         */
        if ((tmp = xmlCopyNode(text_node, 0))) {
            if (!xmlAddPrevSibling(target_node, tmp))
                xmlFreeNode(tmp);
        }
12530 12531
    }

12532 12533 12534
    if (!(ret = virXMLNodeToString(NULL, disk_node))) {
        vshSaveLibvirtError();
        goto cleanup;
12535 12536
    }

12537
 cleanup:
12538
    VIR_FREE(device_type);
12539
    VIR_FREE(startupPolicy);
12540
    VIR_FREE(source_path);
12541 12542 12543 12544 12545 12546 12547 12548
    return ret;
}


/*
 * "detach-disk" command
 */
static const vshCmdInfo info_detach_disk[] = {
12549 12550 12551 12552 12553 12554 12555
    {.name = "help",
     .data = N_("detach disk device")
    },
    {.name = "desc",
     .data = N_("Detach disk device.")
    },
    {.name = NULL}
12556 12557 12558
};

static const vshCmdOptDef opts_detach_disk[] = {
12559
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
12560 12561 12562
    {.name = "target",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
12563
     .completer = virshDomainDiskTargetCompleter,
12564 12565
     .help = N_("target of disk device")
    },
12566
    VIRSH_COMMON_OPT_DOMAIN_PERSISTENT,
12567
    VIRSH_COMMON_OPT_DOMAIN_CONFIG,
12568
    VIRSH_COMMON_OPT_DOMAIN_LIVE,
12569
    VIRSH_COMMON_OPT_DOMAIN_CURRENT,
12570 12571
    {.name = "print-xml",
     .type = VSH_OT_BOOL,
12572
     .help = N_("print XML document rather than detach the disk")
12573
    },
12574
    {.name = NULL}
12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586
};

static bool
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
{
    char *disk_xml = NULL;
    virDomainPtr dom = NULL;
    const char *target = NULL;
    char *doc = NULL;
    int ret;
    bool functionReturn = false;
    xmlNodePtr disk_node = NULL;
12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601
    bool current = vshCommandOptBool(cmd, "current");
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool persistent = vshCommandOptBool(cmd, "persistent");
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;

    VSH_EXCLUSIVE_OPTIONS_VAR(persistent, current);

    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);

    if (config || persistent)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
12602

12603
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
12604
        return false;
12605

12606
    if (vshCommandOptStringReq(ctl, cmd, "target", &target) < 0)
12607 12608
        goto cleanup;

12609 12610 12611 12612 12613 12614
    if (flags == VIR_DOMAIN_AFFECT_CONFIG)
        doc = virDomainGetXMLDesc(dom, VIR_DOMAIN_XML_INACTIVE);
    else
        doc = virDomainGetXMLDesc(dom, 0);

    if (!doc)
12615 12616
        goto cleanup;

12617 12618 12619 12620
    if (persistent &&
        virDomainIsActive(dom) == 1)
        flags |= VIR_DOMAIN_AFFECT_LIVE;

12621
    if (!(disk_node = virshFindDisk(doc, target, VIRSH_FIND_DISK_NORMAL)))
12622 12623
        goto cleanup;

12624 12625
    if (!(disk_xml = virXMLNodeToString(NULL, disk_node))) {
        vshSaveLibvirtError();
12626
        goto cleanup;
12627
    }
12628

12629 12630 12631 12632 12633 12634
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s", disk_xml);
        functionReturn = true;
        goto cleanup;
    }

12635
    if (flags != 0 || current)
12636 12637
        ret = virDomainDetachDeviceFlags(dom, disk_xml, flags);
    else
12638 12639 12640 12641
        ret = virDomainDetachDevice(dom, disk_xml);

    if (ret != 0) {
        vshError(ctl, "%s", _("Failed to detach disk"));
12642
        goto cleanup;
12643 12644
    }

P
Pino Toscano 已提交
12645
    vshPrintExtra(ctl, "%s", _("Disk detached successfully\n"));
12646 12647
    functionReturn = true;

12648 12649 12650 12651
 cleanup:
    xmlFreeNode(disk_node);
    VIR_FREE(disk_xml);
    VIR_FREE(doc);
12652
    virshDomainFree(dom);
12653 12654 12655 12656 12657 12658 12659
    return functionReturn;
}

/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
12660 12661 12662 12663 12664 12665 12666
    {.name = "help",
     .data = N_("edit XML configuration for a domain")
    },
    {.name = "desc",
     .data = N_("Edit the XML configuration for a domain.")
    },
    {.name = NULL}
12667 12668 12669
};

static const vshCmdOptDef opts_edit[] = {
12670
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
12671 12672 12673 12674
    {.name = "skip-validate",
     .type = VSH_OT_BOOL,
     .help = N_("skip validation of the XML against the schema")
    },
12675
    {.name = NULL}
12676 12677 12678 12679 12680 12681 12682 12683
};

static bool
cmdEdit(vshControl *ctl, const vshCmd *cmd)
{
    bool ret = false;
    virDomainPtr dom = NULL;
    virDomainPtr dom_edited = NULL;
12684 12685
    unsigned int query_flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
    unsigned int define_flags = VIR_DOMAIN_DEFINE_VALIDATE;
12686
    virshControlPtr priv = ctl->privData;
12687

12688
    dom = virshCommandOptDomain(ctl, cmd, NULL);
12689 12690 12691
    if (dom == NULL)
        goto cleanup;

12692 12693 12694 12695
    if (vshCommandOptBool(cmd, "skip-validate"))
        define_flags &= ~VIR_DOMAIN_DEFINE_VALIDATE;

#define EDIT_GET_XML virDomainGetXMLDesc(dom, query_flags)
12696 12697 12698 12699 12700 12701
#define EDIT_NOT_CHANGED \
    do { \
        vshPrintExtra(ctl, _("Domain %s XML configuration not changed.\n"), \
                      virDomainGetName(dom)); \
        ret = true; \
        goto edit_cleanup; \
12702
    } while (0)
12703
#define EDIT_DEFINE \
12704
    (dom_edited = virshDomainDefine(priv->conn, doc_edited, define_flags))
12705 12706 12707
#define EDIT_RELAX \
    do { \
        define_flags &= ~VIR_DOMAIN_DEFINE_VALIDATE; \
12708 12709
    } while (0);

12710
#include "virsh-edit.c"
12711
#undef EDIT_RELAX
12712

12713 12714
    vshPrintExtra(ctl, _("Domain %s XML configuration edited.\n"),
                  virDomainGetName(dom_edited));
12715 12716 12717 12718

    ret = true;

 cleanup:
12719 12720
    virshDomainFree(dom);
    virshDomainFree(dom_edited);
12721 12722 12723 12724

    return ret;
}

12725 12726 12727 12728

/*
 * "event" command
 */
12729
VIR_ENUM_DECL(virshDomainEvent);
12730
VIR_ENUM_IMPL(virshDomainEvent,
12731 12732 12733 12734 12735 12736 12737 12738 12739
              VIR_DOMAIN_EVENT_LAST,
              N_("Defined"),
              N_("Undefined"),
              N_("Started"),
              N_("Suspended"),
              N_("Resumed"),
              N_("Stopped"),
              N_("Shutdown"),
              N_("PMSuspended"),
12740
              N_("Crashed"));
12741

12742
static const char *
12743
virshDomainEventToString(int event)
12744
{
12745
    const char *str = virshDomainEventTypeToString(event);
12746
    return str ? _(str) : _("unknown");
12747 12748
}

12749
VIR_ENUM_DECL(virshDomainEventDefined);
12750
VIR_ENUM_IMPL(virshDomainEventDefined,
12751 12752
              VIR_DOMAIN_EVENT_DEFINED_LAST,
              N_("Added"),
12753
              N_("Updated"),
12754
              N_("Renamed"),
12755
              N_("Snapshot"));
12756

12757
VIR_ENUM_DECL(virshDomainEventUndefined);
12758
VIR_ENUM_IMPL(virshDomainEventUndefined,
12759
              VIR_DOMAIN_EVENT_UNDEFINED_LAST,
12760
              N_("Removed"),
12761
              N_("Renamed"));
12762

12763
VIR_ENUM_DECL(virshDomainEventStarted);
12764
VIR_ENUM_IMPL(virshDomainEventStarted,
12765 12766 12767 12768 12769
              VIR_DOMAIN_EVENT_STARTED_LAST,
              N_("Booted"),
              N_("Migrated"),
              N_("Restored"),
              N_("Snapshot"),
12770
              N_("Event wakeup"));
12771

12772
VIR_ENUM_DECL(virshDomainEventSuspended);
12773
VIR_ENUM_IMPL(virshDomainEventSuspended,
12774 12775 12776 12777 12778 12779 12780
              VIR_DOMAIN_EVENT_SUSPENDED_LAST,
              N_("Paused"),
              N_("Migrated"),
              N_("I/O Error"),
              N_("Watchdog"),
              N_("Restored"),
              N_("Snapshot"),
12781 12782
              N_("API error"),
              N_("Post-copy"),
12783
              N_("Post-copy Error"));
12784

12785
VIR_ENUM_DECL(virshDomainEventResumed);
12786
VIR_ENUM_IMPL(virshDomainEventResumed,
12787 12788 12789
              VIR_DOMAIN_EVENT_RESUMED_LAST,
              N_("Unpaused"),
              N_("Migrated"),
12790
              N_("Snapshot"),
12791
              N_("Post-copy"));
12792

12793
VIR_ENUM_DECL(virshDomainEventStopped);
12794
VIR_ENUM_IMPL(virshDomainEventStopped,
12795 12796 12797 12798 12799 12800 12801
              VIR_DOMAIN_EVENT_STOPPED_LAST,
              N_("Shutdown"),
              N_("Destroyed"),
              N_("Crashed"),
              N_("Migrated"),
              N_("Saved"),
              N_("Failed"),
12802
              N_("Snapshot"));
12803

12804
VIR_ENUM_DECL(virshDomainEventShutdown);
12805
VIR_ENUM_IMPL(virshDomainEventShutdown,
12806
              VIR_DOMAIN_EVENT_SHUTDOWN_LAST,
12807 12808
              N_("Finished"),
              N_("Finished after guest request"),
12809
              N_("Finished after host request"));
12810

12811
VIR_ENUM_DECL(virshDomainEventPMSuspended);
12812
VIR_ENUM_IMPL(virshDomainEventPMSuspended,
12813 12814
              VIR_DOMAIN_EVENT_PMSUSPENDED_LAST,
              N_("Memory"),
12815
              N_("Disk"));
12816

12817
VIR_ENUM_DECL(virshDomainEventCrashed);
12818
VIR_ENUM_IMPL(virshDomainEventCrashed,
12819
              VIR_DOMAIN_EVENT_CRASHED_LAST,
12820
              N_("Panicked"));
12821

12822
static const char *
12823
virshDomainEventDetailToString(int event, int detail)
12824
{
12825
    const char *str = NULL;
12826 12827
    switch ((virDomainEventType) event) {
    case VIR_DOMAIN_EVENT_DEFINED:
12828
        str = virshDomainEventDefinedTypeToString(detail);
12829 12830
        break;
    case VIR_DOMAIN_EVENT_UNDEFINED:
12831
        str = virshDomainEventUndefinedTypeToString(detail);
12832 12833
        break;
    case VIR_DOMAIN_EVENT_STARTED:
12834
        str = virshDomainEventStartedTypeToString(detail);
12835 12836
        break;
    case VIR_DOMAIN_EVENT_SUSPENDED:
12837
        str = virshDomainEventSuspendedTypeToString(detail);
12838 12839
        break;
    case VIR_DOMAIN_EVENT_RESUMED:
12840
        str = virshDomainEventResumedTypeToString(detail);
12841 12842
        break;
    case VIR_DOMAIN_EVENT_STOPPED:
12843
        str = virshDomainEventStoppedTypeToString(detail);
12844 12845
        break;
    case VIR_DOMAIN_EVENT_SHUTDOWN:
12846
        str = virshDomainEventShutdownTypeToString(detail);
12847 12848
        break;
    case VIR_DOMAIN_EVENT_PMSUSPENDED:
12849
        str = virshDomainEventPMSuspendedTypeToString(detail);
12850 12851
        break;
    case VIR_DOMAIN_EVENT_CRASHED:
12852
        str = virshDomainEventCrashedTypeToString(detail);
12853 12854 12855 12856
        break;
    case VIR_DOMAIN_EVENT_LAST:
        break;
    }
12857
    return str ? _(str) : _("unknown");
12858 12859
}

12860
VIR_ENUM_DECL(virshDomainEventWatchdog);
12861
VIR_ENUM_IMPL(virshDomainEventWatchdog,
12862 12863 12864 12865 12866 12867
              VIR_DOMAIN_EVENT_WATCHDOG_LAST,
              N_("none"),
              N_("pause"),
              N_("reset"),
              N_("poweroff"),
              N_("shutdown"),
12868
              N_("debug"),
12869
              N_("inject-nmi"));
12870 12871

static const char *
12872
virshDomainEventWatchdogToString(int action)
12873
{
12874
    const char *str = virshDomainEventWatchdogTypeToString(action);
12875 12876 12877
    return str ? _(str) : _("unknown");
}

12878
VIR_ENUM_DECL(virshDomainEventIOError);
12879
VIR_ENUM_IMPL(virshDomainEventIOError,
12880 12881 12882
              VIR_DOMAIN_EVENT_IO_ERROR_LAST,
              N_("none"),
              N_("pause"),
12883
              N_("report"));
12884 12885

static const char *
12886
virshDomainEventIOErrorToString(int action)
12887
{
12888
    const char *str = virshDomainEventIOErrorTypeToString(action);
12889 12890 12891
    return str ? _(str) : _("unknown");
}

12892
VIR_ENUM_DECL(virshGraphicsPhase);
12893
VIR_ENUM_IMPL(virshGraphicsPhase,
12894 12895 12896
              VIR_DOMAIN_EVENT_GRAPHICS_LAST,
              N_("connect"),
              N_("initialize"),
12897
              N_("disconnect"));
12898 12899

static const char *
12900
virshGraphicsPhaseToString(int phase)
12901
{
12902
    const char *str = virshGraphicsPhaseTypeToString(phase);
12903 12904 12905
    return str ? _(str) : _("unknown");
}

12906
VIR_ENUM_DECL(virshGraphicsAddress);
12907
VIR_ENUM_IMPL(virshGraphicsAddress,
12908 12909 12910
              VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_LAST,
              N_("IPv4"),
              N_("IPv6"),
12911
              N_("unix"));
12912 12913

static const char *
12914
virshGraphicsAddressToString(int family)
12915
{
12916
    const char *str = virshGraphicsAddressTypeToString(family);
12917 12918 12919
    return str ? _(str) : _("unknown");
}

12920
VIR_ENUM_DECL(virshDomainBlockJobStatus);
12921
VIR_ENUM_IMPL(virshDomainBlockJobStatus,
12922 12923 12924 12925
              VIR_DOMAIN_BLOCK_JOB_LAST,
              N_("completed"),
              N_("failed"),
              N_("canceled"),
12926
              N_("ready"));
12927 12928

static const char *
12929
virshDomainBlockJobStatusToString(int status)
12930
{
12931
    const char *str = virshDomainBlockJobStatusTypeToString(status);
12932 12933 12934
    return str ? _(str) : _("unknown");
}

12935
VIR_ENUM_DECL(virshDomainEventDiskChange);
12936
VIR_ENUM_IMPL(virshDomainEventDiskChange,
12937 12938
              VIR_DOMAIN_EVENT_DISK_CHANGE_LAST,
              N_("changed"),
12939
              N_("dropped"));
12940 12941

static const char *
12942
virshDomainEventDiskChangeToString(int reason)
12943
{
12944
    const char *str = virshDomainEventDiskChangeTypeToString(reason);
12945 12946 12947
    return str ? _(str) : _("unknown");
}

12948
VIR_ENUM_DECL(virshDomainEventTrayChange);
12949
VIR_ENUM_IMPL(virshDomainEventTrayChange,
12950 12951
              VIR_DOMAIN_EVENT_TRAY_CHANGE_LAST,
              N_("opened"),
12952
              N_("closed"));
12953 12954

static const char *
12955
virshDomainEventTrayChangeToString(int reason)
12956
{
12957
    const char *str = virshDomainEventTrayChangeTypeToString(reason);
12958 12959 12960
    return str ? _(str) : _("unknown");
}

12961
struct virshDomEventData {
12962 12963
    vshControl *ctl;
    bool loop;
12964
    int *count;
J
Jiri Denemark 已提交
12965
    bool timestamp;
12966
    virshDomainEventCallback *cb;
12967
    int id;
12968
};
12969
typedef struct virshDomEventData virshDomEventData;
12970

J
Jiri Denemark 已提交
12971 12972 12973 12974 12975 12976 12977 12978 12979 12980
/**
 * virshEventPrint:
 *
 * @data: opaque data passed to all event callbacks
 * @buf: string buffer describing the event
 *
 * Print the event description found in @buf and update virshDomEventData.
 *
 * This function resets @buf and frees all memory consumed by its content.
 */
12981
static void
J
Jiri Denemark 已提交
12982 12983
virshEventPrint(virshDomEventData *data,
                virBufferPtr buf)
12984
{
J
Jiri Denemark 已提交
12985
    char *msg;
12986

J
Jiri Denemark 已提交
12987
    if (!(msg = virBufferContentAndReset(buf)))
12988
        return;
J
Jiri Denemark 已提交
12989 12990 12991 12992

    if (!data->loop && *data->count)
        goto cleanup;

J
Jiri Denemark 已提交
12993 12994 12995 12996 12997 12998 12999 13000 13001 13002
    if (data->timestamp) {
        char timestamp[VIR_TIME_STRING_BUFLEN];

        if (virTimeStringNowRaw(timestamp) < 0)
            timestamp[0] = '\0';

        vshPrint(data->ctl, "%s: %s", timestamp, msg);
    } else {
        vshPrint(data->ctl, "%s", msg);
    }
J
Jiri Denemark 已提交
13003

13004
    (*data->count)++;
13005 13006
    if (!data->loop)
        vshEventDone(data->ctl);
J
Jiri Denemark 已提交
13007 13008 13009 13010 13011 13012

 cleanup:
    VIR_FREE(msg);
}

static void
J
Ján Tomko 已提交
13013
virshEventGenericPrint(virConnectPtr conn G_GNUC_UNUSED,
J
Jiri Denemark 已提交
13014 13015 13016 13017 13018 13019 13020 13021 13022
                       virDomainPtr dom,
                       void *opaque)
{
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    virBufferAsprintf(&buf, _("event '%s' for domain %s\n"),
                      ((virshDomEventData *) opaque)->cb->name,
                      virDomainGetName(dom));
    virshEventPrint(opaque, &buf);
13023
}
13024 13025

static void
J
Ján Tomko 已提交
13026
virshEventLifecyclePrint(virConnectPtr conn G_GNUC_UNUSED,
13027 13028 13029 13030
                         virDomainPtr dom,
                         int event,
                         int detail,
                         void *opaque)
13031
{
J
Jiri Denemark 已提交
13032
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13033

J
Jiri Denemark 已提交
13034 13035 13036 13037 13038
    virBufferAsprintf(&buf, _("event 'lifecycle' for domain %s: %s %s\n"),
                      virDomainGetName(dom),
                      virshDomainEventToString(event),
                      virshDomainEventDetailToString(event, detail));
    virshEventPrint(opaque, &buf);
13039 13040
}

13041
static void
J
Ján Tomko 已提交
13042
virshEventRTCChangePrint(virConnectPtr conn G_GNUC_UNUSED,
13043 13044 13045
                         virDomainPtr dom,
                         long long utcoffset,
                         void *opaque)
13046
{
J
Jiri Denemark 已提交
13047
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13048

J
Jiri Denemark 已提交
13049 13050 13051 13052
    virBufferAsprintf(&buf, _("event 'rtc-change' for domain %s: %lld\n"),
                      virDomainGetName(dom),
                      utcoffset);
    virshEventPrint(opaque, &buf);
13053 13054 13055
}

static void
J
Ján Tomko 已提交
13056
virshEventWatchdogPrint(virConnectPtr conn G_GNUC_UNUSED,
13057 13058 13059
                        virDomainPtr dom,
                        int action,
                        void *opaque)
13060
{
J
Jiri Denemark 已提交
13061
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13062

J
Jiri Denemark 已提交
13063 13064 13065 13066
    virBufferAsprintf(&buf, _("event 'watchdog' for domain %s: %s\n"),
                      virDomainGetName(dom),
                      virshDomainEventWatchdogToString(action));
    virshEventPrint(opaque, &buf);
13067 13068 13069
}

static void
J
Ján Tomko 已提交
13070
virshEventIOErrorPrint(virConnectPtr conn G_GNUC_UNUSED,
13071 13072 13073 13074 13075
                       virDomainPtr dom,
                       const char *srcPath,
                       const char *devAlias,
                       int action,
                       void *opaque)
13076
{
J
Jiri Denemark 已提交
13077
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13078

J
Jiri Denemark 已提交
13079 13080 13081 13082 13083 13084
    virBufferAsprintf(&buf, _("event 'io-error' for domain %s: %s (%s) %s\n"),
                      virDomainGetName(dom),
                      srcPath,
                      devAlias,
                      virshDomainEventIOErrorToString(action));
    virshEventPrint(opaque, &buf);
13085 13086 13087
}

static void
J
Ján Tomko 已提交
13088
virshEventGraphicsPrint(virConnectPtr conn G_GNUC_UNUSED,
13089 13090 13091 13092 13093 13094 13095 13096
                        virDomainPtr dom,
                        int phase,
                        const virDomainEventGraphicsAddress *local,
                        const virDomainEventGraphicsAddress *remote,
                        const char *authScheme,
                        const virDomainEventGraphicsSubject *subject,
                        void *opaque)
{
J
Jiri Denemark 已提交
13097
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13098 13099
    size_t i;

J
Jiri Denemark 已提交
13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116
    virBufferAsprintf(&buf, _("event 'graphics' for domain %s: "
                              "%s local[%s %s %s] remote[%s %s %s] %s\n"),
                      virDomainGetName(dom),
                      virshGraphicsPhaseToString(phase),
                      virshGraphicsAddressToString(local->family),
                      local->node,
                      local->service,
                      virshGraphicsAddressToString(remote->family),
                      remote->node,
                      remote->service,
                      authScheme);
    for (i = 0; i < subject->nidentity; i++) {
        virBufferAsprintf(&buf, "\t%s=%s\n",
                          subject->identities[i].type,
                          subject->identities[i].name);
    }
    virshEventPrint(opaque, &buf);
13117 13118 13119
}

static void
J
Ján Tomko 已提交
13120
virshEventIOErrorReasonPrint(virConnectPtr conn G_GNUC_UNUSED,
13121 13122 13123 13124 13125 13126
                             virDomainPtr dom,
                             const char *srcPath,
                             const char *devAlias,
                             int action,
                             const char *reason,
                             void *opaque)
13127
{
J
Jiri Denemark 已提交
13128
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13129

J
Jiri Denemark 已提交
13130 13131 13132 13133 13134 13135 13136 13137
    virBufferAsprintf(&buf, _("event 'io-error-reason' for domain %s: "
                              "%s (%s) %s due to %s\n"),
                      virDomainGetName(dom),
                      srcPath,
                      devAlias,
                      virshDomainEventIOErrorToString(action),
                      reason);
    virshEventPrint(opaque, &buf);
13138 13139 13140
}

static void
J
Ján Tomko 已提交
13141
virshEventBlockJobPrint(virConnectPtr conn G_GNUC_UNUSED,
13142 13143 13144 13145 13146
                        virDomainPtr dom,
                        const char *disk,
                        int type,
                        int status,
                        void *opaque)
13147
{
J
Jiri Denemark 已提交
13148
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13149

J
Jiri Denemark 已提交
13150 13151 13152 13153 13154 13155 13156
    virBufferAsprintf(&buf, _("event '%s' for domain %s: %s for %s %s\n"),
                      ((virshDomEventData *) opaque)->cb->name,
                      virDomainGetName(dom),
                      virshDomainBlockJobToString(type),
                      disk,
                      virshDomainBlockJobStatusToString(status));
    virshEventPrint(opaque, &buf);
13157 13158 13159
}

static void
J
Ján Tomko 已提交
13160
virshEventDiskChangePrint(virConnectPtr conn G_GNUC_UNUSED,
13161 13162 13163 13164 13165 13166
                          virDomainPtr dom,
                          const char *oldSrc,
                          const char *newSrc,
                          const char *alias,
                          int reason,
                          void *opaque)
13167
{
J
Jiri Denemark 已提交
13168
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13169

J
Jiri Denemark 已提交
13170 13171 13172 13173 13174 13175 13176 13177
    virBufferAsprintf(&buf, _("event 'disk-change' for domain %s disk %s: "
                              "%s -> %s: %s\n"),
                      virDomainGetName(dom),
                      alias,
                      NULLSTR(oldSrc),
                      NULLSTR(newSrc),
                      virshDomainEventDiskChangeToString(reason));
    virshEventPrint(opaque, &buf);
13178 13179 13180
}

static void
J
Ján Tomko 已提交
13181
virshEventTrayChangePrint(virConnectPtr conn G_GNUC_UNUSED,
13182 13183 13184 13185
                          virDomainPtr dom,
                          const char *alias,
                          int reason,
                          void *opaque)
13186
{
J
Jiri Denemark 已提交
13187
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13188

J
Jiri Denemark 已提交
13189 13190 13191 13192 13193
    virBufferAsprintf(&buf, _("event 'tray-change' for domain %s disk %s: %s\n"),
                      virDomainGetName(dom),
                      alias,
                      virshDomainEventTrayChangeToString(reason));
    virshEventPrint(opaque, &buf);
13194 13195 13196
}

static void
J
Ján Tomko 已提交
13197
virshEventPMChangePrint(virConnectPtr conn G_GNUC_UNUSED,
13198
                        virDomainPtr dom,
J
Ján Tomko 已提交
13199
                        int reason G_GNUC_UNUSED,
13200
                        void *opaque)
13201 13202 13203
{
    /* As long as libvirt.h doesn't define any reasons, we might as
     * well treat all PM state changes as generic events.  */
13204
    virshEventGenericPrint(conn, dom, opaque);
13205 13206 13207
}

static void
J
Ján Tomko 已提交
13208
virshEventBalloonChangePrint(virConnectPtr conn G_GNUC_UNUSED,
13209 13210 13211
                             virDomainPtr dom,
                             unsigned long long actual,
                             void *opaque)
13212
{
J
Jiri Denemark 已提交
13213
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13214

J
Jiri Denemark 已提交
13215 13216 13217 13218
    virBufferAsprintf(&buf, _("event 'balloon-change' for domain %s: %lluKiB\n"),
                      virDomainGetName(dom),
                      actual);
    virshEventPrint(opaque, &buf);
13219 13220 13221
}

static void
J
Ján Tomko 已提交
13222
virshEventDeviceRemovedPrint(virConnectPtr conn G_GNUC_UNUSED,
13223 13224 13225
                             virDomainPtr dom,
                             const char *alias,
                             void *opaque)
13226
{
J
Jiri Denemark 已提交
13227
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13228

J
Jiri Denemark 已提交
13229 13230 13231 13232
    virBufferAsprintf(&buf, _("event 'device-removed' for domain %s: %s\n"),
                      virDomainGetName(dom),
                      alias);
    virshEventPrint(opaque, &buf);
13233 13234
}

13235
static void
J
Ján Tomko 已提交
13236
virshEventDeviceAddedPrint(virConnectPtr conn G_GNUC_UNUSED,
13237 13238 13239 13240
                           virDomainPtr dom,
                           const char *alias,
                           void *opaque)
{
J
Jiri Denemark 已提交
13241
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13242

J
Jiri Denemark 已提交
13243 13244 13245 13246
    virBufferAsprintf(&buf, _("event 'device-added' for domain %s: %s\n"),
                      virDomainGetName(dom),
                      alias);
    virshEventPrint(opaque, &buf);
13247 13248
}

13249
static void
J
Ján Tomko 已提交
13250
virshEventTunablePrint(virConnectPtr conn G_GNUC_UNUSED,
13251 13252 13253 13254
                       virDomainPtr dom,
                       virTypedParameterPtr params,
                       int nparams,
                       void *opaque)
13255
{
J
Jiri Denemark 已提交
13256
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13257
    size_t i;
J
Jiri Denemark 已提交
13258
    char *value;
13259

J
Jiri Denemark 已提交
13260 13261
    virBufferAsprintf(&buf, _("event 'tunable' for domain %s:\n"),
                      virDomainGetName(dom));
13262 13263 13264
    for (i = 0; i < nparams; i++) {
        value = virTypedParameterToString(&params[i]);
        if (value) {
J
Jiri Denemark 已提交
13265
            virBufferAsprintf(&buf, "\t%s: %s\n", params[i].field, value);
13266 13267 13268
            VIR_FREE(value);
        }
    }
J
Jiri Denemark 已提交
13269
    virshEventPrint(opaque, &buf);
13270 13271
}

13272
VIR_ENUM_DECL(virshEventAgentLifecycleState);
13273
VIR_ENUM_IMPL(virshEventAgentLifecycleState,
13274 13275 13276
              VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_LAST,
              N_("unknown"),
              N_("connected"),
13277
              N_("disconnected"));
13278

13279
VIR_ENUM_DECL(virshEventAgentLifecycleReason);
13280
VIR_ENUM_IMPL(virshEventAgentLifecycleReason,
13281 13282 13283
              VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_LAST,
              N_("unknown"),
              N_("domain started"),
13284
              N_("channel event"));
13285 13286 13287

#define UNKNOWNSTR(str) (str ? str : N_("unsupported value"))
static void
J
Ján Tomko 已提交
13288
virshEventAgentLifecyclePrint(virConnectPtr conn G_GNUC_UNUSED,
13289 13290 13291 13292
                              virDomainPtr dom,
                              int state,
                              int reason,
                              void *opaque)
13293
{
J
Jiri Denemark 已提交
13294
    virBuffer buf = VIR_BUFFER_INITIALIZER;
13295

J
Jiri Denemark 已提交
13296 13297 13298 13299 13300 13301
    virBufferAsprintf(&buf, _("event 'agent-lifecycle' for domain %s: state: "
                              "'%s' reason: '%s'\n"),
                      virDomainGetName(dom),
                      UNKNOWNSTR(virshEventAgentLifecycleStateTypeToString(state)),
                      UNKNOWNSTR(virshEventAgentLifecycleReasonTypeToString(reason)));
    virshEventPrint(opaque, &buf);
13302 13303
}

13304
static void
J
Ján Tomko 已提交
13305
virshEventMigrationIterationPrint(virConnectPtr conn G_GNUC_UNUSED,
13306 13307 13308 13309 13310 13311 13312 13313 13314 13315 13316 13317 13318 13319
                                  virDomainPtr dom,
                                  int iteration,
                                  void *opaque)
{
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    virBufferAsprintf(&buf, _("event 'migration-iteration' for domain %s: "
                              "iteration: '%d'\n"),
                      virDomainGetName(dom),
                      iteration);

    virshEventPrint(opaque, &buf);
}

J
Jiri Denemark 已提交
13320
static void
J
Ján Tomko 已提交
13321
virshEventJobCompletedPrint(virConnectPtr conn G_GNUC_UNUSED,
J
Jiri Denemark 已提交
13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342
                            virDomainPtr dom,
                            virTypedParameterPtr params,
                            int nparams,
                            void *opaque)
{
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    size_t i;
    char *value;

    virBufferAsprintf(&buf, _("event 'job-completed' for domain %s:\n"),
                      virDomainGetName(dom));
    for (i = 0; i < nparams; i++) {
        value = virTypedParameterToString(&params[i]);
        if (value) {
            virBufferAsprintf(&buf, "\t%s: %s\n", params[i].field, value);
            VIR_FREE(value);
        }
    }
    virshEventPrint(opaque, &buf);
}

13343 13344

static void
J
Ján Tomko 已提交
13345
virshEventDeviceRemovalFailedPrint(virConnectPtr conn G_GNUC_UNUSED,
13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357
                                   virDomainPtr dom,
                                   const char *alias,
                                   void *opaque)
{
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    virBufferAsprintf(&buf, _("event 'device-removal-failed' for domain %s: %s\n"),
                      virDomainGetName(dom),
                      alias);
    virshEventPrint(opaque, &buf);
}

13358
VIR_ENUM_DECL(virshEventMetadataChangeType);
13359 13360 13361 13362
VIR_ENUM_IMPL(virshEventMetadataChangeType,
              VIR_DOMAIN_METADATA_LAST,
              N_("description"),
              N_("title"),
13363
              N_("element"));
13364 13365

static void
J
Ján Tomko 已提交
13366
virshEventMetadataChangePrint(virConnectPtr conn G_GNUC_UNUSED,
13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380
                              virDomainPtr dom,
                              int type,
                              const char *nsuri,
                              void *opaque)
{
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    virBufferAsprintf(&buf, _("event 'metdata-change' for domain %s: %s %s\n"),
                      virDomainGetName(dom),
                      UNKNOWNSTR(virshEventMetadataChangeTypeTypeToString(type)),
                      NULLSTR(nsuri));
    virshEventPrint(opaque, &buf);
}

13381

13382
static void
J
Ján Tomko 已提交
13383
virshEventBlockThresholdPrint(virConnectPtr conn G_GNUC_UNUSED,
13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400
                              virDomainPtr dom,
                              const char *dev,
                              const char *path,
                              unsigned long long threshold,
                              unsigned long long excess,
                              void *opaque)
{
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    virBufferAsprintf(&buf, _("event 'block-threshold' for domain %s: "
                              "dev: %s(%s) %llu %llu\n"),
                      virDomainGetName(dom),
                      dev, NULLSTR(path), threshold, excess);
    virshEventPrint(opaque, &buf);
}


13401
virshDomainEventCallback virshDomainEventCallbacks[] = {
13402
    { "lifecycle",
13403 13404
      VIR_DOMAIN_EVENT_CALLBACK(virshEventLifecyclePrint), },
    { "reboot", virshEventGenericPrint, },
13405
    { "rtc-change",
13406
      VIR_DOMAIN_EVENT_CALLBACK(virshEventRTCChangePrint), },
13407
    { "watchdog",
13408
      VIR_DOMAIN_EVENT_CALLBACK(virshEventWatchdogPrint), },
13409
    { "io-error",
13410
      VIR_DOMAIN_EVENT_CALLBACK(virshEventIOErrorPrint), },
13411
    { "graphics",
13412
      VIR_DOMAIN_EVENT_CALLBACK(virshEventGraphicsPrint), },
13413
    { "io-error-reason",
13414 13415
      VIR_DOMAIN_EVENT_CALLBACK(virshEventIOErrorReasonPrint), },
    { "control-error", virshEventGenericPrint, },
13416
    { "block-job",
13417
      VIR_DOMAIN_EVENT_CALLBACK(virshEventBlockJobPrint), },
13418
    { "disk-change",
13419
      VIR_DOMAIN_EVENT_CALLBACK(virshEventDiskChangePrint), },
13420
    { "tray-change",
13421
      VIR_DOMAIN_EVENT_CALLBACK(virshEventTrayChangePrint), },
13422
    { "pm-wakeup",
13423
      VIR_DOMAIN_EVENT_CALLBACK(virshEventPMChangePrint), },
13424
    { "pm-suspend",
13425
      VIR_DOMAIN_EVENT_CALLBACK(virshEventPMChangePrint), },
13426
    { "balloon-change",
13427
      VIR_DOMAIN_EVENT_CALLBACK(virshEventBalloonChangePrint), },
13428
    { "pm-suspend-disk",
13429
      VIR_DOMAIN_EVENT_CALLBACK(virshEventPMChangePrint), },
13430
    { "device-removed",
13431
      VIR_DOMAIN_EVENT_CALLBACK(virshEventDeviceRemovedPrint), },
13432
    { "block-job-2",
13433
      VIR_DOMAIN_EVENT_CALLBACK(virshEventBlockJobPrint), },
13434
    { "tunable",
13435
      VIR_DOMAIN_EVENT_CALLBACK(virshEventTunablePrint), },
13436
    { "agent-lifecycle",
13437
      VIR_DOMAIN_EVENT_CALLBACK(virshEventAgentLifecyclePrint), },
13438
    { "device-added",
13439
      VIR_DOMAIN_EVENT_CALLBACK(virshEventDeviceAddedPrint), },
13440 13441
    { "migration-iteration",
      VIR_DOMAIN_EVENT_CALLBACK(virshEventMigrationIterationPrint), },
J
Jiri Denemark 已提交
13442 13443
    { "job-completed",
      VIR_DOMAIN_EVENT_CALLBACK(virshEventJobCompletedPrint), },
13444 13445
    { "device-removal-failed",
      VIR_DOMAIN_EVENT_CALLBACK(virshEventDeviceRemovalFailedPrint), },
13446 13447
    { "metadata-change",
      VIR_DOMAIN_EVENT_CALLBACK(virshEventMetadataChangePrint), },
13448 13449
    { "block-threshold",
      VIR_DOMAIN_EVENT_CALLBACK(virshEventBlockThresholdPrint), },
13450
};
13451
verify(VIR_DOMAIN_EVENT_ID_LAST == G_N_ELEMENTS(virshDomainEventCallbacks));
13452

13453
static const vshCmdInfo info_event[] = {
E
Eric Blake 已提交
13454
    {.name = "help",
13455 13456 13457 13458 13459 13460 13461 13462 13463
     .data = N_("Domain Events")
    },
    {.name = "desc",
     .data = N_("List event types, or wait for domain events to occur")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_event[] = {
13464
    VIRSH_COMMON_OPT_DOMAIN_OT_STRING(N_("filter by domain name, id or uuid"),
13465
                                      0, 0),
13466
    {.name = "event",
13467
     .type = VSH_OT_STRING,
13468
     .completer = virshDomainEventNameCompleter,
13469 13470
     .help = N_("which event type to wait for")
    },
13471 13472 13473 13474
    {.name = "all",
     .type = VSH_OT_BOOL,
     .help = N_("wait for all events instead of just one type")
    },
13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486
    {.name = "loop",
     .type = VSH_OT_BOOL,
     .help = N_("loop until timeout or interrupt, rather than one-shot")
    },
    {.name = "timeout",
     .type = VSH_OT_INT,
     .help = N_("timeout seconds")
    },
    {.name = "list",
     .type = VSH_OT_BOOL,
     .help = N_("list valid event types")
    },
J
Jiri Denemark 已提交
13487 13488 13489 13490
    {.name = "timestamp",
     .type = VSH_OT_BOOL,
     .help = N_("show timestamp for each printed event")
    },
13491 13492 13493 13494 13495 13496 13497 13498 13499
    {.name = NULL}
};

static bool
cmdEvent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    int timeout = 0;
13500
    virshDomEventData *data = NULL;
13501
    size_t i;
13502
    const char *eventName = NULL;
13503 13504 13505
    int event = -1;
    bool all = vshCommandOptBool(cmd, "all");
    bool loop = vshCommandOptBool(cmd, "loop");
J
Jiri Denemark 已提交
13506
    bool timestamp = vshCommandOptBool(cmd, "timestamp");
13507
    int count = 0;
13508
    virshControlPtr priv = ctl->privData;
13509 13510

    if (vshCommandOptBool(cmd, "list")) {
13511
        for (event = 0; event < VIR_DOMAIN_EVENT_ID_LAST; event++)
13512
            vshPrint(ctl, "%s\n", virshDomainEventCallbacks[event].name);
13513 13514 13515
        return true;
    }

13516
    if (vshCommandOptStringReq(ctl, cmd, "event", &eventName) < 0)
13517
        return false;
13518 13519
    if (eventName) {
        for (event = 0; event < VIR_DOMAIN_EVENT_ID_LAST; event++)
13520
            if (STREQ(eventName, virshDomainEventCallbacks[event].name))
13521 13522 13523 13524 13525 13526 13527
                break;
        if (event == VIR_DOMAIN_EVENT_ID_LAST) {
            vshError(ctl, _("unknown event type %s"), eventName);
            return false;
        }
    } else if (!all) {
        vshError(ctl, "%s",
13528
                 _("one of --list, --all, or --event <type> is required"));
13529 13530 13531
        return false;
    }

13532 13533 13534 13535 13536 13537 13538
    if (all) {
        if (VIR_ALLOC_N(data, VIR_DOMAIN_EVENT_ID_LAST) < 0)
            goto cleanup;
        for (i = 0; i < VIR_DOMAIN_EVENT_ID_LAST; i++) {
            data[i].ctl = ctl;
            data[i].loop = loop;
            data[i].count = &count;
J
Jiri Denemark 已提交
13539
            data[i].timestamp = timestamp;
13540
            data[i].cb = &virshDomainEventCallbacks[i];
13541 13542 13543 13544 13545 13546 13547 13548
            data[i].id = -1;
        }
    } else {
        if (VIR_ALLOC_N(data, 1) < 0)
            goto cleanup;
        data[0].ctl = ctl;
        data[0].loop = vshCommandOptBool(cmd, "loop");
        data[0].count = &count;
J
Jiri Denemark 已提交
13549
        data[0].timestamp = timestamp;
13550
        data[0].cb = &virshDomainEventCallbacks[event];
13551 13552
        data[0].id = -1;
    }
13553
    if (vshCommandOptTimeoutToMs(ctl, cmd, &timeout) < 0)
13554
        goto cleanup;
13555 13556

    if (vshCommandOptBool(cmd, "domain"))
13557 13558 13559
        if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
            goto cleanup;

13560 13561 13562
    if (vshEventStart(ctl, timeout) < 0)
        goto cleanup;

13563
    for (i = 0; i < (all ? VIR_DOMAIN_EVENT_ID_LAST : 1); i++) {
13564
        if ((data[i].id = virConnectDomainEventRegisterAny(priv->conn, dom,
13565 13566 13567 13568 13569 13570 13571 13572 13573 13574 13575 13576 13577 13578
                                                           all ? i : event,
                                                           data[i].cb->cb,
                                                           &data[i],
                                                           NULL)) < 0) {
            /* When registering for all events: if the first
             * registration succeeds, silently ignore failures on all
             * later registrations on the assumption that the server
             * is older and didn't know quite as many events.  */
            if (i)
                vshResetLibvirtError();
            else
                goto cleanup;
        }
    }
13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590
    switch (vshEventWait(ctl)) {
    case VSH_EVENT_INTERRUPT:
        vshPrint(ctl, "%s", _("event loop interrupted\n"));
        break;
    case VSH_EVENT_TIMEOUT:
        vshPrint(ctl, "%s", _("event loop timed out\n"));
        break;
    case VSH_EVENT_DONE:
        break;
    default:
        goto cleanup;
    }
13591 13592
    vshPrint(ctl, _("events received: %d\n"), count);
    if (count)
13593 13594
        ret = true;

13595
 cleanup:
13596
    vshEventCleanup(ctl);
13597 13598 13599
    if (data) {
        for (i = 0; i < (all ? VIR_DOMAIN_EVENT_ID_LAST : 1); i++) {
            if (data[i].id >= 0 &&
13600
                virConnectDomainEventDeregisterAny(priv->conn, data[i].id) < 0)
13601 13602 13603 13604
                ret = false;
        }
        VIR_FREE(data);
    }
13605
    virshDomainFree(dom);
13606 13607 13608 13609
    return ret;
}


13610 13611 13612 13613
/*
 * "change-media" command
 */
static const vshCmdInfo info_change_media[] = {
13614 13615 13616 13617 13618 13619 13620
    {.name = "help",
     .data = N_("Change media of CD or floppy drive")
    },
    {.name = "desc",
     .data = N_("Change media of CD or floppy drive.")
    },
    {.name = NULL}
13621 13622 13623
};

static const vshCmdOptDef opts_change_media[] = {
13624
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
13625 13626 13627
    {.name = "path",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
13628
     .completer = virshDomainDiskTargetCompleter,
13629 13630 13631
     .help = N_("Fully-qualified path or target of disk device")
    },
    {.name = "source",
13632
     .type = VSH_OT_STRING,
13633 13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645 13646
     .help = N_("source of the media")
    },
    {.name = "eject",
     .type = VSH_OT_BOOL,
     .help = N_("Eject the media")
    },
    {.name = "insert",
     .type = VSH_OT_BOOL,
     .help = N_("Insert the media")
    },
    {.name = "update",
     .type = VSH_OT_BOOL,
     .help = N_("Update the media")
    },
13647 13648 13649
    VIRSH_COMMON_OPT_CURRENT(N_("can be either or both of --live and "
                                "--config, depends on implementation "
                                "hypervisor driver")),
13650
    VIRSH_COMMON_OPT_LIVE(N_("alter live configuration of running domain")),
13651 13652
    VIRSH_COMMON_OPT_CONFIG(N_("alter persistent configuration, effect "
                               "observed on next boot")),
13653 13654 13655 13656
    {.name = "force",
     .type = VSH_OT_BOOL,
     .help = N_("force media changing")
    },
13657 13658 13659 13660
    {.name = "print-xml",
     .type = VSH_OT_BOOL,
     .help = N_("print XML document rather than change media")
    },
13661 13662 13663 13664
    {.name = "block",
     .type = VSH_OT_BOOL,
     .help = N_("source media is a block device")
    },
13665
    {.name = NULL}
13666 13667 13668 13669 13670 13671 13672 13673
};

static bool
cmdChangeMedia(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    const char *source = NULL;
    const char *path = NULL;
13674
    char *doc = NULL;
13675
    xmlNodePtr disk_node = NULL;
13676
    char *disk_xml = NULL;
13677
    bool ret = false;
13678
    virshUpdateDiskXMLType update_type;
13679
    const char *action = NULL;
13680
    const char *success_msg = NULL;
13681 13682 13683 13684 13685 13686 13687
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
    bool current = vshCommandOptBool(cmd, "current");
    bool force = vshCommandOptBool(cmd, "force");
    bool eject = vshCommandOptBool(cmd, "eject");
    bool insert = vshCommandOptBool(cmd, "insert");
    bool update = vshCommandOptBool(cmd, "update");
13688
    bool block = vshCommandOptBool(cmd, "block");
13689
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;
13690

13691 13692 13693
    VSH_EXCLUSIVE_OPTIONS_VAR(eject, insert);
    VSH_EXCLUSIVE_OPTIONS_VAR(eject, update);
    VSH_EXCLUSIVE_OPTIONS_VAR(insert, update);
13694

13695 13696
    VSH_EXCLUSIVE_OPTIONS_VAR(eject, block);

13697 13698 13699 13700 13701 13702 13703 13704 13705
    if (vshCommandOptStringReq(ctl, cmd, "source", &source) < 0)
        return false;

    /* Docs state that update without source is eject */
    if (update && !source) {
        update = false;
        eject = true;
    }

13706
    if (eject) {
13707
        update_type = VIRSH_UPDATE_DISK_XML_EJECT;
13708
        action = "eject";
13709
        success_msg = _("Successfully ejected media.");
13710 13711 13712
    }

    if (insert) {
13713
        update_type = VIRSH_UPDATE_DISK_XML_INSERT;
13714
        action = "insert";
13715
        success_msg = _("Successfully inserted media.");
13716 13717 13718
    }

    if (update || (!eject && !insert)) {
13719
        update_type = VIRSH_UPDATE_DISK_XML_UPDATE;
13720
        action = "update";
13721
        success_msg = _("Successfully updated media.");
13722 13723
    }

13724 13725
    VSH_EXCLUSIVE_OPTIONS_VAR(current, live);
    VSH_EXCLUSIVE_OPTIONS_VAR(current, config);
13726

13727 13728 13729 13730
    if (config)
        flags |= VIR_DOMAIN_AFFECT_CONFIG;
    if (live)
        flags |= VIR_DOMAIN_AFFECT_LIVE;
13731 13732 13733
    if (force)
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

13734
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
13735
        return false;
13736

13737
    if (vshCommandOptStringReq(ctl, cmd, "path", &path) < 0)
13738 13739 13740 13741 13742 13743 13744 13745 13746
        goto cleanup;

    if (flags & VIR_DOMAIN_AFFECT_CONFIG)
        doc = virDomainGetXMLDesc(dom, VIR_DOMAIN_XML_INACTIVE);
    else
        doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

13747
    if (!(disk_node = virshFindDisk(doc, path, VIRSH_FIND_DISK_CHANGEABLE)))
13748 13749
        goto cleanup;

13750 13751
    if (!(disk_xml = virshUpdateDiskXML(disk_node, source, block, path,
                                        update_type)))
13752 13753
        goto cleanup;

13754 13755 13756 13757 13758 13759 13760 13761
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s", disk_xml);
    } else {
        if (virDomainUpdateDeviceFlags(dom, disk_xml, flags) != 0) {
            vshError(ctl, _("Failed to complete action %s on media"), action);
            goto cleanup;
        }

13762
        vshPrint(ctl, "%s", success_msg);
13763 13764 13765 13766
    }

    ret = true;

13767
 cleanup:
13768 13769 13770
    VIR_FREE(doc);
    xmlFreeNode(disk_node);
    VIR_FREE(disk_xml);
13771
    virshDomainFree(dom);
13772 13773
    return ret;
}
13774

13775
static const vshCmdInfo info_domfstrim[] = {
13776 13777 13778 13779 13780 13781 13782
    {.name = "help",
     .data = N_("Invoke fstrim on domain's mounted filesystems.")
    },
    {.name = "desc",
     .data = N_("Invoke fstrim on domain's mounted filesystems.")
    },
    {.name = NULL}
13783 13784 13785
};

static const vshCmdOptDef opts_domfstrim[] = {
13786
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
13787 13788 13789 13790 13791 13792
    {.name = "minimum",
     .type = VSH_OT_INT,
     .help = N_("Just a hint to ignore contiguous "
                "free ranges smaller than this (Bytes)")
    },
    {.name = "mountpoint",
13793
     .type = VSH_OT_STRING,
13794 13795
     .help = N_("which mount point to trim")
    },
13796
    {.name = NULL}
13797 13798 13799 13800 13801 13802 13803 13804 13805 13806
};
static bool
cmdDomFSTrim(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    unsigned long long minimum = 0;
    const char *mountPoint = NULL;
    unsigned int flags = 0;

13807
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
13808
        return ret;
13809

13810
    if (vshCommandOptULongLong(ctl, cmd, "minimum", &minimum) < 0)
13811 13812
        goto cleanup;

13813
    if (vshCommandOptStringReq(ctl, cmd, "mountpoint", &mountPoint) < 0)
13814 13815 13816 13817 13818 13819 13820 13821 13822
        goto cleanup;

    if (virDomainFSTrim(dom, mountPoint, minimum, flags) < 0) {
        vshError(ctl, _("Unable to invoke fstrim"));
        goto cleanup;
    }

    ret = true;

13823
 cleanup:
13824
    virshDomainFree(dom);
13825 13826 13827
    return ret;
}

13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838
static const vshCmdInfo info_domfsfreeze[] = {
    {.name = "help",
     .data = N_("Freeze domain's mounted filesystems.")
    },
    {.name = "desc",
     .data = N_("Freeze domain's mounted filesystems.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_domfsfreeze[] = {
13839
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850 13851 13852 13853 13854
    {.name = "mountpoint",
     .type = VSH_OT_ARGV,
     .help = N_("mountpoint path to be frozen")
    },
    {.name = NULL}
};
static bool
cmdDomFSFreeze(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = -1;
    const vshCmdOpt *opt = NULL;
    const char **mountpoints = NULL;
    size_t nmountpoints = 0;

13855
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
13856 13857
        return false;

13858
    while ((opt = vshCommandOptArgv(ctl, cmd, opt))) {
13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872
        if (VIR_EXPAND_N(mountpoints, nmountpoints, 1) < 0) {
            vshError(ctl, _("%s: %d: failed to allocate mountpoints"),
                     __FILE__, __LINE__);
            goto cleanup;
        }
        mountpoints[nmountpoints-1] = opt->data;
    }

    ret = virDomainFSFreeze(dom, mountpoints, nmountpoints, 0);
    if (ret < 0) {
        vshError(ctl, _("Unable to freeze filesystems"));
        goto cleanup;
    }

13873
    vshPrintExtra(ctl, _("Froze %d filesystem(s)\n"), ret);
13874 13875 13876

 cleanup:
    VIR_FREE(mountpoints);
13877
    virshDomainFree(dom);
13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891
    return ret >= 0;
}

static const vshCmdInfo info_domfsthaw[] = {
    {.name = "help",
     .data = N_("Thaw domain's mounted filesystems.")
    },
    {.name = "desc",
     .data = N_("Thaw domain's mounted filesystems.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_domfsthaw[] = {
13892
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
13893 13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907
    {.name = "mountpoint",
     .type = VSH_OT_ARGV,
     .help = N_("mountpoint path to be thawed")
    },
    {.name = NULL}
};
static bool
cmdDomFSThaw(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int ret = -1;
    const vshCmdOpt *opt = NULL;
    const char **mountpoints = NULL;
    size_t nmountpoints = 0;

13908
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
13909 13910
        return false;

13911
    while ((opt = vshCommandOptArgv(ctl, cmd, opt))) {
13912 13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925
        if (VIR_EXPAND_N(mountpoints, nmountpoints, 1) < 0) {
            vshError(ctl, _("%s: %d: failed to allocate mountpoints"),
                     __FILE__, __LINE__);
            goto cleanup;
        }
        mountpoints[nmountpoints-1] = opt->data;
    }

    ret = virDomainFSThaw(dom, mountpoints, nmountpoints, 0);
    if (ret < 0) {
        vshError(ctl, _("Unable to thaw filesystems"));
        goto cleanup;
    }

13926
    vshPrintExtra(ctl, _("Thawed %d filesystem(s)\n"), ret);
13927 13928 13929

 cleanup:
    VIR_FREE(mountpoints);
13930
    virshDomainFree(dom);
13931 13932 13933
    return ret >= 0;
}

T
Tomoki Sekiyama 已提交
13934 13935 13936 13937 13938 13939 13940 13941 13942 13943 13944
static const vshCmdInfo info_domfsinfo[] = {
    {.name = "help",
     .data = N_("Get information of domain's mounted filesystems.")
    },
    {.name = "desc",
     .data = N_("Get information of domain's mounted filesystems.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_domfsinfo[] = {
13945
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
T
Tomoki Sekiyama 已提交
13946 13947 13948 13949 13950 13951 13952
    {.name = NULL}
};

static bool
cmdDomFSInfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
13953
    int rc = -1;
T
Tomoki Sekiyama 已提交
13954
    size_t i, j;
13955
    virDomainFSInfoPtr *info = NULL;
13956
    vshTablePtr table = NULL;
13957
    size_t ninfos = 0;
13958
    bool ret = false;
T
Tomoki Sekiyama 已提交
13959

13960
    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
T
Tomoki Sekiyama 已提交
13961 13962
        return false;

13963 13964
    rc = virDomainGetFSInfo(dom, &info, 0);
    if (rc < 0) {
T
Tomoki Sekiyama 已提交
13965 13966 13967
        vshError(ctl, _("Unable to get filesystem information"));
        goto cleanup;
    }
13968
    ninfos = rc;
13969 13970

    if (ninfos == 0) {
13971
        ret = true;
13972
        vshPrintExtra(ctl, _("No filesystems are mounted in the domain"));
T
Tomoki Sekiyama 已提交
13973 13974 13975 13976
        goto cleanup;
    }

    if (info) {
13977 13978 13979 13980
        table = vshTableNew(_("Mountpoint"), _("Name"), _("Type"), _("Target"), NULL);
        if (!table)
            goto cleanup;

13981
        for (i = 0; i < ninfos; i++) {
13982
            virBuffer targetsBuff = VIR_BUFFER_INITIALIZER;
13983
            g_autofree char *targets = NULL;
13984

13985 13986 13987
            for (j = 0; j < info[i]->ndevAlias; j++)
                virBufferAsprintf(&targetsBuff, "%s,", info[i]->devAlias[j]);
            virBufferTrim(&targetsBuff, ",", -1);
T
Tomoki Sekiyama 已提交
13988

13989 13990 13991 13992 13993 13994
            targets = virBufferContentAndReset(&targetsBuff);

            if (vshTableRowAppend(table,
                                  info[i]->mountpoint,
                                  info[i]->name,
                                  info[i]->fstype,
13995
                                  targets ? targets : "",
13996 13997
                                  NULL) < 0)
                goto cleanup;
T
Tomoki Sekiyama 已提交
13998
        }
13999 14000

        vshTablePrintToStdout(table, ctl);
T
Tomoki Sekiyama 已提交
14001 14002
    }

14003 14004
    ret = true;

T
Tomoki Sekiyama 已提交
14005
 cleanup:
14006
    if (info) {
14007
        for (i = 0; i < ninfos; i++)
14008 14009 14010 14011
            virDomainFSInfoFree(info[i]);
        VIR_FREE(info);
    }
    vshTableFree(table);
14012
    virshDomainFree(dom);
14013
    return ret;
T
Tomoki Sekiyama 已提交
14014 14015
}

14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061
/*
 * "guest-agent-timeout" command
 */
static const vshCmdInfo info_guest_agent_timeout[] = {
    {.name = "help",
     .data = N_("Set the guest agent timeout")
    },
    {.name = "desc",
     .data = N_("Set the number of seconds to wait for a response from the guest agent.")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_guest_agent_timeout[] = {
    VIRSH_COMMON_OPT_DOMAIN_FULL(0),
    {.name = "timeout",
     .type = VSH_OT_INT,
     .flags = VSH_OFLAG_REQ_OPT,
     .help = N_("timeout seconds.")
    },
    {.name = NULL}
};

static bool
cmdGuestAgentTimeout(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int timeout;
    const unsigned int flags = 0;
    bool ret = false;

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    if (vshCommandOptInt(ctl, cmd, "timeout", &timeout) < 0)
        goto cleanup;

    if (virDomainAgentSetResponseTimeout(dom, timeout, flags) < 0)
        goto cleanup;

    ret = true;
 cleanup:
    virshDomainFree(dom);
    return ret;
}

14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080 14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141
/*
 * "guestinfo" command
 */
static const vshCmdInfo info_guestinfo[] = {
    {.name = "help",
     .data = N_("query information about the guest (via agent)")
    },
    {.name = "desc",
     .data = N_("Use the guest agent to query various information from guest's "
                "point of view")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_guestinfo[] = {
    VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE),
    {.name = "user",
     .type = VSH_OT_BOOL,
     .help = N_("report active users"),
    },
    {.name = "os",
     .type = VSH_OT_BOOL,
     .help = N_("report operating system information"),
    },
    {.name = "timezone",
     .type = VSH_OT_BOOL,
     .help = N_("report timezone information"),
    },
    {.name = "hostname",
     .type = VSH_OT_BOOL,
     .help = N_("report hostname"),
    },
    {.name = "filesystem",
     .type = VSH_OT_BOOL,
     .help = N_("report filesystem information"),
    },
    {.name = NULL}
};

static bool
cmdGuestInfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = false;
    virTypedParameterPtr params = NULL;
    int nparams = 0;
    size_t i;
    unsigned int types = 0;

    if (vshCommandOptBool(cmd, "user"))
        types |= VIR_DOMAIN_GUEST_INFO_USERS;
    if (vshCommandOptBool(cmd, "os"))
        types |= VIR_DOMAIN_GUEST_INFO_OS;
    if (vshCommandOptBool(cmd, "timezone"))
        types |= VIR_DOMAIN_GUEST_INFO_TIMEZONE;
    if (vshCommandOptBool(cmd, "hostname"))
        types |= VIR_DOMAIN_GUEST_INFO_HOSTNAME;
    if (vshCommandOptBool(cmd, "filesystem"))
        types |= VIR_DOMAIN_GUEST_INFO_FILESYSTEM;

    if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    if (virDomainGetGuestInfo(dom, types, &params, &nparams, 0) < 0)
        goto cleanup;

    for (i = 0; i < nparams; i++) {
        char *str = vshGetTypedParamValue(ctl, &params[i]);
        vshPrint(ctl, "%-20s: %s\n", params[i].field, str);
        VIR_FREE(str);
    }

    ret = true;

 cleanup:
    virTypedParamsFree(params, nparams);
    virshDomainFree(dom);
    return ret;
}

E
Eric Blake 已提交
14142
const vshCmdDef domManagementCmds[] = {
14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179
    {.name = "attach-device",
     .handler = cmdAttachDevice,
     .opts = opts_attach_device,
     .info = info_attach_device,
     .flags = 0
    },
    {.name = "attach-disk",
     .handler = cmdAttachDisk,
     .opts = opts_attach_disk,
     .info = info_attach_disk,
     .flags = 0
    },
    {.name = "attach-interface",
     .handler = cmdAttachInterface,
     .opts = opts_attach_interface,
     .info = info_attach_interface,
     .flags = 0
    },
    {.name = "autostart",
     .handler = cmdAutostart,
     .opts = opts_autostart,
     .info = info_autostart,
     .flags = 0
    },
    {.name = "blkdeviotune",
     .handler = cmdBlkdeviotune,
     .opts = opts_blkdeviotune,
     .info = info_blkdeviotune,
     .flags = 0
    },
    {.name = "blkiotune",
     .handler = cmdBlkiotune,
     .opts = opts_blkiotune,
     .info = info_blkiotune,
     .flags = 0
    },
    {.name = "blockcommit",
14180 14181 14182
     .handler = cmdBlockcommit,
     .opts = opts_blockcommit,
     .info = info_blockcommit,
14183 14184 14185
     .flags = 0
    },
    {.name = "blockcopy",
14186 14187 14188
     .handler = cmdBlockcopy,
     .opts = opts_blockcopy,
     .info = info_blockcopy,
14189 14190 14191
     .flags = 0
    },
    {.name = "blockjob",
14192 14193 14194
     .handler = cmdBlockjob,
     .opts = opts_blockjob,
     .info = info_blockjob,
14195 14196 14197
     .flags = 0
    },
    {.name = "blockpull",
14198 14199 14200
     .handler = cmdBlockpull,
     .opts = opts_blockpull,
     .info = info_blockpull,
14201 14202 14203
     .flags = 0
    },
    {.name = "blockresize",
14204 14205 14206
     .handler = cmdBlockresize,
     .opts = opts_blockresize,
     .info = info_blockresize,
14207 14208 14209 14210 14211 14212 14213 14214
     .flags = 0
    },
    {.name = "change-media",
     .handler = cmdChangeMedia,
     .opts = opts_change_media,
     .info = info_change_media,
     .flags = 0
    },
14215
#ifndef WIN32
14216 14217 14218 14219 14220 14221
    {.name = "console",
     .handler = cmdConsole,
     .opts = opts_console,
     .info = info_console,
     .flags = 0
    },
14222
#endif
14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250 14251 14252 14253 14254 14255 14256 14257 14258
    {.name = "cpu-stats",
     .handler = cmdCPUStats,
     .opts = opts_cpu_stats,
     .info = info_cpu_stats,
     .flags = 0
    },
    {.name = "create",
     .handler = cmdCreate,
     .opts = opts_create,
     .info = info_create,
     .flags = 0
    },
    {.name = "define",
     .handler = cmdDefine,
     .opts = opts_define,
     .info = info_define,
     .flags = 0
    },
    {.name = "desc",
     .handler = cmdDesc,
     .opts = opts_desc,
     .info = info_desc,
     .flags = 0
    },
    {.name = "destroy",
     .handler = cmdDestroy,
     .opts = opts_destroy,
     .info = info_destroy,
     .flags = 0
    },
    {.name = "detach-device",
     .handler = cmdDetachDevice,
     .opts = opts_detach_device,
     .info = info_detach_device,
     .flags = 0
    },
14259 14260 14261 14262 14263 14264
    {.name = "detach-device-alias",
     .handler = cmdDetachDeviceAlias,
     .opts = opts_detach_device_alias,
     .info = info_detach_device_alias,
     .flags = 0
    },
14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278 14279 14280 14281 14282
    {.name = "detach-disk",
     .handler = cmdDetachDisk,
     .opts = opts_detach_disk,
     .info = info_detach_disk,
     .flags = 0
    },
    {.name = "detach-interface",
     .handler = cmdDetachInterface,
     .opts = opts_detach_interface,
     .info = info_detach_interface,
     .flags = 0
    },
    {.name = "domdisplay",
     .handler = cmdDomDisplay,
     .opts = opts_domdisplay,
     .info = info_domdisplay,
     .flags = 0
    },
14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294
    {.name = "domfsfreeze",
     .handler = cmdDomFSFreeze,
     .opts = opts_domfsfreeze,
     .info = info_domfsfreeze,
     .flags = 0
    },
    {.name = "domfsthaw",
     .handler = cmdDomFSThaw,
     .opts = opts_domfsthaw,
     .info = info_domfsthaw,
     .flags = 0
    },
T
Tomoki Sekiyama 已提交
14295 14296 14297 14298 14299 14300
    {.name = "domfsinfo",
     .handler = cmdDomFSInfo,
     .opts = opts_domfsinfo,
     .info = info_domfsinfo,
     .flags = 0
    },
14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348
    {.name = "domfstrim",
     .handler = cmdDomFSTrim,
     .opts = opts_domfstrim,
     .info = info_domfstrim,
     .flags = 0
    },
    {.name = "domhostname",
     .handler = cmdDomHostname,
     .opts = opts_domhostname,
     .info = info_domhostname,
     .flags = 0
    },
    {.name = "domid",
     .handler = cmdDomid,
     .opts = opts_domid,
     .info = info_domid,
     .flags = 0
    },
    {.name = "domif-setlink",
     .handler = cmdDomIfSetLink,
     .opts = opts_domif_setlink,
     .info = info_domif_setlink,
     .flags = 0
    },
    {.name = "domiftune",
     .handler = cmdDomIftune,
     .opts = opts_domiftune,
     .info = info_domiftune,
     .flags = 0
    },
    {.name = "domjobabort",
     .handler = cmdDomjobabort,
     .opts = opts_domjobabort,
     .info = info_domjobabort,
     .flags = 0
    },
    {.name = "domjobinfo",
     .handler = cmdDomjobinfo,
     .opts = opts_domjobinfo,
     .info = info_domjobinfo,
     .flags = 0
    },
    {.name = "domname",
     .handler = cmdDomname,
     .opts = opts_domname,
     .info = info_domname,
     .flags = 0
    },
14349 14350 14351 14352 14353 14354
    {.name = "domrename",
     .handler = cmdDomrename,
     .opts = opts_domrename,
     .info = info_domrename,
     .flags = 0
    },
14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402
    {.name = "dompmsuspend",
     .handler = cmdDomPMSuspend,
     .opts = opts_dom_pm_suspend,
     .info = info_dom_pm_suspend,
     .flags = 0
    },
    {.name = "dompmwakeup",
     .handler = cmdDomPMWakeup,
     .opts = opts_dom_pm_wakeup,
     .info = info_dom_pm_wakeup,
     .flags = 0
    },
    {.name = "domuuid",
     .handler = cmdDomuuid,
     .opts = opts_domuuid,
     .info = info_domuuid,
     .flags = 0
    },
    {.name = "domxml-from-native",
     .handler = cmdDomXMLFromNative,
     .opts = opts_domxmlfromnative,
     .info = info_domxmlfromnative,
     .flags = 0
    },
    {.name = "domxml-to-native",
     .handler = cmdDomXMLToNative,
     .opts = opts_domxmltonative,
     .info = info_domxmltonative,
     .flags = 0
    },
    {.name = "dump",
     .handler = cmdDump,
     .opts = opts_dump,
     .info = info_dump,
     .flags = 0
    },
    {.name = "dumpxml",
     .handler = cmdDumpXML,
     .opts = opts_dumpxml,
     .info = info_dumpxml,
     .flags = 0
    },
    {.name = "edit",
     .handler = cmdEdit,
     .opts = opts_edit,
     .info = info_edit,
     .flags = 0
    },
14403 14404 14405 14406 14407 14408
    {.name = "event",
     .handler = cmdEvent,
     .opts = opts_event,
     .info = info_event,
     .flags = 0
    },
14409 14410 14411 14412 14413 14414
    {.name = "inject-nmi",
     .handler = cmdInjectNMI,
     .opts = opts_inject_nmi,
     .info = info_inject_nmi,
     .flags = 0
    },
14415 14416 14417 14418
    {.name = "iothreadinfo",
     .handler = cmdIOThreadInfo,
     .opts = opts_iothreadinfo,
     .info = info_iothreadinfo,
J
John Ferlan 已提交
14419 14420
     .flags = 0
    },
J
John Ferlan 已提交
14421 14422 14423 14424 14425 14426
    {.name = "iothreadpin",
     .handler = cmdIOThreadPin,
     .opts = opts_iothreadpin,
     .info = info_iothreadpin,
     .flags = 0
    },
14427 14428 14429 14430 14431 14432
    {.name = "iothreadadd",
     .handler = cmdIOThreadAdd,
     .opts = opts_iothreadadd,
     .info = info_iothreadadd,
     .flags = 0
    },
J
John Ferlan 已提交
14433 14434 14435 14436 14437 14438
    {.name = "iothreadset",
     .handler = cmdIOThreadSet,
     .opts = opts_iothreadset,
     .info = info_iothreadset,
     .flags = 0
    },
14439 14440 14441 14442 14443 14444
    {.name = "iothreaddel",
     .handler = cmdIOThreadDel,
     .opts = opts_iothreaddel,
     .info = info_iothreaddel,
     .flags = 0
    },
14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474
    {.name = "send-key",
     .handler = cmdSendKey,
     .opts = opts_send_key,
     .info = info_send_key,
     .flags = 0
    },
    {.name = "send-process-signal",
     .handler = cmdSendProcessSignal,
     .opts = opts_send_process_signal,
     .info = info_send_process_signal,
     .flags = 0
    },
    {.name = "lxc-enter-namespace",
     .handler = cmdLxcEnterNamespace,
     .opts = opts_lxc_enter_namespace,
     .info = info_lxc_enter_namespace,
     .flags = 0
    },
    {.name = "managedsave",
     .handler = cmdManagedSave,
     .opts = opts_managedsave,
     .info = info_managedsave,
     .flags = 0
    },
    {.name = "managedsave-remove",
     .handler = cmdManagedSaveRemove,
     .opts = opts_managedsaveremove,
     .info = info_managedsaveremove,
     .flags = 0
    },
14475 14476 14477 14478 14479 14480
    {.name = "managedsave-edit",
     .handler = cmdManagedSaveEdit,
     .opts = opts_managed_save_edit,
     .info = info_managed_save_edit,
     .flags = 0
    },
14481 14482 14483 14484 14485 14486
    {.name = "managedsave-dumpxml",
     .handler = cmdManagedSaveDumpxml,
     .opts = opts_managed_save_dumpxml,
     .info = info_managed_save_dumpxml,
     .flags = 0
    },
14487 14488 14489 14490 14491 14492
    {.name = "managedsave-define",
     .handler = cmdManagedSaveDefine,
     .opts = opts_managed_save_define,
     .info = info_managed_save_define,
     .flags = 0
    },
14493 14494 14495 14496 14497 14498
    {.name = "memtune",
     .handler = cmdMemtune,
     .opts = opts_memtune,
     .info = info_memtune,
     .flags = 0
    },
14499 14500 14501 14502 14503 14504
    {.name = "perf",
     .handler = cmdPerf,
     .opts = opts_perf,
     .info = info_perf,
     .flags = 0
    },
14505 14506 14507 14508 14509 14510
    {.name = "metadata",
     .handler = cmdMetadata,
     .opts = opts_metadata,
     .info = info_metadata,
     .flags = 0
    },
14511 14512 14513 14514 14515 14516 14517 14518 14519 14520 14521 14522
    {.name = "migrate",
     .handler = cmdMigrate,
     .opts = opts_migrate,
     .info = info_migrate,
     .flags = 0
    },
    {.name = "migrate-setmaxdowntime",
     .handler = cmdMigrateSetMaxDowntime,
     .opts = opts_migrate_setmaxdowntime,
     .info = info_migrate_setmaxdowntime,
     .flags = 0
    },
14523 14524 14525 14526 14527 14528
    {.name = "migrate-getmaxdowntime",
     .handler = cmdMigrateGetMaxDowntime,
     .opts = opts_migrate_getmaxdowntime,
     .info = info_migrate_getmaxdowntime,
     .flags = 0
    },
14529 14530 14531 14532 14533 14534
    {.name = "migrate-compcache",
     .handler = cmdMigrateCompCache,
     .opts = opts_migrate_compcache,
     .info = info_migrate_compcache,
     .flags = 0
    },
14535 14536 14537 14538 14539 14540 14541 14542 14543 14544 14545 14546
    {.name = "migrate-setspeed",
     .handler = cmdMigrateSetMaxSpeed,
     .opts = opts_migrate_setspeed,
     .info = info_migrate_setspeed,
     .flags = 0
    },
    {.name = "migrate-getspeed",
     .handler = cmdMigrateGetMaxSpeed,
     .opts = opts_migrate_getspeed,
     .info = info_migrate_getspeed,
     .flags = 0
    },
14547 14548 14549 14550 14551 14552
    {.name = "migrate-postcopy",
     .handler = cmdMigratePostCopy,
     .opts = opts_migrate_postcopy,
     .info = info_migrate_postcopy,
     .flags = 0
    },
14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570
    {.name = "numatune",
     .handler = cmdNumatune,
     .opts = opts_numatune,
     .info = info_numatune,
     .flags = 0
    },
    {.name = "qemu-attach",
     .handler = cmdQemuAttach,
     .opts = opts_qemu_attach,
     .info = info_qemu_attach,
     .flags = 0
    },
    {.name = "qemu-monitor-command",
     .handler = cmdQemuMonitorCommand,
     .opts = opts_qemu_monitor_command,
     .info = info_qemu_monitor_command,
     .flags = 0
    },
E
Eric Blake 已提交
14571 14572 14573 14574 14575 14576
    {.name = "qemu-monitor-event",
     .handler = cmdQemuMonitorEvent,
     .opts = opts_qemu_monitor_event,
     .info = info_qemu_monitor_event,
     .flags = 0
    },
14577 14578 14579 14580 14581 14582
    {.name = "qemu-agent-command",
     .handler = cmdQemuAgentCommand,
     .opts = opts_qemu_agent_command,
     .info = info_qemu_agent_command,
     .flags = 0
    },
14583 14584 14585 14586 14587 14588
    {.name = "guest-agent-timeout",
     .handler = cmdGuestAgentTimeout,
     .opts = opts_guest_agent_timeout,
     .info = info_guest_agent_timeout,
     .flags = 0
    },
14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600 14601 14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648
    {.name = "reboot",
     .handler = cmdReboot,
     .opts = opts_reboot,
     .info = info_reboot,
     .flags = 0
    },
    {.name = "reset",
     .handler = cmdReset,
     .opts = opts_reset,
     .info = info_reset,
     .flags = 0
    },
    {.name = "restore",
     .handler = cmdRestore,
     .opts = opts_restore,
     .info = info_restore,
     .flags = 0
    },
    {.name = "resume",
     .handler = cmdResume,
     .opts = opts_resume,
     .info = info_resume,
     .flags = 0
    },
    {.name = "save",
     .handler = cmdSave,
     .opts = opts_save,
     .info = info_save,
     .flags = 0
    },
    {.name = "save-image-define",
     .handler = cmdSaveImageDefine,
     .opts = opts_save_image_define,
     .info = info_save_image_define,
     .flags = 0
    },
    {.name = "save-image-dumpxml",
     .handler = cmdSaveImageDumpxml,
     .opts = opts_save_image_dumpxml,
     .info = info_save_image_dumpxml,
     .flags = 0
    },
    {.name = "save-image-edit",
     .handler = cmdSaveImageEdit,
     .opts = opts_save_image_edit,
     .info = info_save_image_edit,
     .flags = 0
    },
    {.name = "schedinfo",
     .handler = cmdSchedinfo,
     .opts = opts_schedinfo,
     .info = info_schedinfo,
     .flags = 0
    },
    {.name = "screenshot",
     .handler = cmdScreenshot,
     .opts = opts_screenshot,
     .info = info_screenshot,
     .flags = 0
    },
14649 14650 14651 14652 14653 14654
    {.name = "set-lifecycle-action",
     .handler = cmdSetLifecycleAction,
     .opts = opts_setLifecycleAction,
     .info = info_setLifecycleAction,
     .flags = 0
    },
14655 14656 14657 14658 14659 14660
    {.name = "set-user-password",
     .handler = cmdSetUserPassword,
     .opts = opts_set_user_password,
     .info = info_set_user_password,
     .flags = 0
    },
14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740 14741 14742 14743 14744
    {.name = "setmaxmem",
     .handler = cmdSetmaxmem,
     .opts = opts_setmaxmem,
     .info = info_setmaxmem,
     .flags = 0
    },
    {.name = "setmem",
     .handler = cmdSetmem,
     .opts = opts_setmem,
     .info = info_setmem,
     .flags = 0
    },
    {.name = "setvcpus",
     .handler = cmdSetvcpus,
     .opts = opts_setvcpus,
     .info = info_setvcpus,
     .flags = 0
    },
    {.name = "shutdown",
     .handler = cmdShutdown,
     .opts = opts_shutdown,
     .info = info_shutdown,
     .flags = 0
    },
    {.name = "start",
     .handler = cmdStart,
     .opts = opts_start,
     .info = info_start,
     .flags = 0
    },
    {.name = "suspend",
     .handler = cmdSuspend,
     .opts = opts_suspend,
     .info = info_suspend,
     .flags = 0
    },
    {.name = "ttyconsole",
     .handler = cmdTTYConsole,
     .opts = opts_ttyconsole,
     .info = info_ttyconsole,
     .flags = 0
    },
    {.name = "undefine",
     .handler = cmdUndefine,
     .opts = opts_undefine,
     .info = info_undefine,
     .flags = 0
    },
    {.name = "update-device",
     .handler = cmdUpdateDevice,
     .opts = opts_update_device,
     .info = info_update_device,
     .flags = 0
    },
    {.name = "vcpucount",
     .handler = cmdVcpucount,
     .opts = opts_vcpucount,
     .info = info_vcpucount,
     .flags = 0
    },
    {.name = "vcpuinfo",
     .handler = cmdVcpuinfo,
     .opts = opts_vcpuinfo,
     .info = info_vcpuinfo,
     .flags = 0
    },
    {.name = "vcpupin",
     .handler = cmdVcpuPin,
     .opts = opts_vcpupin,
     .info = info_vcpupin,
     .flags = 0
    },
    {.name = "emulatorpin",
     .handler = cmdEmulatorPin,
     .opts = opts_emulatorpin,
     .info = info_emulatorpin,
     .flags = 0
    },
    {.name = "vncdisplay",
     .handler = cmdVNCDisplay,
     .opts = opts_vncdisplay,
     .info = info_vncdisplay,
     .flags = 0
    },
14745 14746 14747 14748 14749 14750
    {.name = "guestvcpus",
     .handler = cmdGuestvcpus,
     .opts = opts_guestvcpus,
     .info = info_guestvcpus,
     .flags = 0
    },
14751 14752 14753 14754 14755 14756
    {.name = "setvcpu",
     .handler = cmdSetvcpu,
     .opts = opts_setvcpu,
     .info = info_setvcpu,
     .flags = 0
    },
14757 14758 14759 14760 14761 14762
    {.name = "domblkthreshold",
     .handler = cmdDomblkthreshold,
     .opts = opts_domblkthreshold,
     .info = info_domblkthreshold,
     .flags = 0
    },
14763 14764 14765 14766 14767 14768
    {.name = "guestinfo",
     .handler = cmdGuestInfo,
     .opts = opts_guestinfo,
     .info = info_guestinfo,
     .flags = 0
    },
14769
    {.name = NULL}
14770
};