virsh-pool.c 69.8 KB
Newer Older
1 2 3
/*
 * virsh-pool.c: Commands to manage storage pool
 *
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 21 22 23 24 25
 * <http://www.gnu.org/licenses/>.
 *
 *  Daniel Veillard <veillard@redhat.com>
 *  Karel Zak <kzak@redhat.com>
 *  Daniel P. Berrange <berrange@redhat.com>
 *
 */

E
Eric Blake 已提交
26 27
#include <config.h>
#include "virsh-pool.h"
28

E
Eric Blake 已提交
29
#include "internal.h"
30
#include "virbuffer.h"
31
#include "viralloc.h"
32
#include "virfile.h"
33
#include "conf/storage_conf.h"
34
#include "virstring.h"
35
#include "virtime.h"
E
Eric Blake 已提交
36

37 38
#define VIRSH_COMMON_OPT_POOL_FULL                            \
    VIRSH_COMMON_OPT_POOL(N_("pool name or uuid"))            \
39

40
#define VIRSH_COMMON_OPT_POOL_BUILD                           \
41 42 43 44 45 46
    {.name = "build",                                         \
     .type = VSH_OT_BOOL,                                     \
     .flags = 0,                                              \
     .help = N_("build the pool as normal")                   \
    }                                                         \

47
#define VIRSH_COMMON_OPT_POOL_NO_OVERWRITE                        \
48 49 50
    {.name = "no-overwrite",                                      \
     .type = VSH_OT_BOOL,                                         \
     .flags = 0,                                                  \
51
     .help = N_("do not overwrite any existing data")             \
52 53
    }                                                             \

54
#define VIRSH_COMMON_OPT_POOL_OVERWRITE                           \
55 56 57 58 59 60
    {.name = "overwrite",                                         \
     .type = VSH_OT_BOOL,                                         \
     .flags = 0,                                                  \
     .help = N_("overwrite any existing data")                    \
    }                                                             \

61
#define VIRSH_COMMON_OPT_POOL_X_AS                                     \
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
    {.name = "name",                                                   \
     .type = VSH_OT_DATA,                                              \
     .flags = VSH_OFLAG_REQ,                                           \
     .help = N_("name of the pool")                                    \
    },                                                                 \
    {.name = "type",                                                   \
     .type = VSH_OT_DATA,                                              \
     .flags = VSH_OFLAG_REQ,                                           \
     .help = N_("type of the pool")                                    \
    },                                                                 \
    {.name = "print-xml",                                              \
     .type = VSH_OT_BOOL,                                              \
     .help = N_("print XML document, but don't define/create")         \
    },                                                                 \
    {.name = "source-host",                                            \
     .type = VSH_OT_STRING,                                            \
     .help = N_("source-host for underlying storage")                  \
    },                                                                 \
    {.name = "source-path",                                            \
     .type = VSH_OT_STRING,                                            \
     .help = N_("source path for underlying storage")                  \
    },                                                                 \
    {.name = "source-dev",                                             \
     .type = VSH_OT_STRING,                                            \
     .help = N_("source device for underlying storage")                \
    },                                                                 \
    {.name = "source-name",                                            \
     .type = VSH_OT_STRING,                                            \
     .help = N_("source name for underlying storage")                  \
    },                                                                 \
    {.name = "target",                                                 \
     .type = VSH_OT_STRING,                                            \
     .help = N_("target for underlying storage")                       \
    },                                                                 \
    {.name = "source-format",                                          \
     .type = VSH_OT_STRING,                                            \
     .help = N_("format for underlying storage")                       \
    },                                                                 \
    {.name = "auth-type",                                              \
     .type = VSH_OT_STRING,                                            \
     .help = N_("auth type to be used for underlying storage")         \
    },                                                                 \
    {.name = "auth-username",                                          \
     .type = VSH_OT_STRING,                                            \
     .help = N_("auth username to be used for underlying storage")     \
    },                                                                 \
    {.name = "secret-usage",                                           \
     .type = VSH_OT_STRING,                                            \
     .help = N_("auth secret usage to be used for underlying storage") \
    },                                                                 \
    {.name = "adapter-name",                                           \
     .type = VSH_OT_STRING,                                            \
     .help = N_("adapter name to be used for underlying storage")      \
    },                                                                 \
    {.name = "adapter-wwnn",                                           \
     .type = VSH_OT_STRING,                                            \
     .help = N_("adapter wwnn to be used for underlying storage")      \
    },                                                                 \
    {.name = "adapter-wwpn",                                           \
     .type = VSH_OT_STRING,                                            \
     .help = N_("adapter wwpn to be used for underlying storage")      \
    },                                                                 \
    {.name = "adapter-parent",                                         \
     .type = VSH_OT_STRING,                                            \
     .help = N_("adapter parent to be used for underlying storage")    \
    }                                                                  \

E
Eric Blake 已提交
129
virStoragePoolPtr
130 131
virshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
                      const char **name, unsigned int flags)
132 133 134
{
    virStoragePoolPtr pool = NULL;
    const char *n = NULL;
135 136 137
    virshControlPtr priv = ctl->privData;

    virCheckFlags(VIRSH_BYUUID | VIRSH_BYNAME, NULL);
138

139
    if (vshCommandOptStringReq(ctl, cmd, optname, &n) < 0)
140 141 142 143 144 145 146 147 148
        return NULL;

    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
149
    if ((flags & VIRSH_BYUUID) && strlen(n) == VIR_UUID_STRING_BUFLEN-1) {
150 151
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
                 cmd->def->name, optname);
152
        pool = virStoragePoolLookupByUUIDString(priv->conn, n);
153 154
    }
    /* try it by NAME */
155
    if (!pool && (flags & VIRSH_BYNAME)) {
156 157
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
158
        pool = virStoragePoolLookupByName(priv->conn, n);
159 160 161 162 163 164 165 166 167 168 169 170
    }

    if (!pool)
        vshError(ctl, _("failed to get pool '%s'"), n);

    return pool;
}

/*
 * "pool-autostart" command
 */
static const vshCmdInfo info_pool_autostart[] = {
171 172 173 174 175 176 177
    {.name = "help",
     .data = N_("autostart a pool")
    },
    {.name = "desc",
     .data = N_("Configure a pool to be automatically started at boot.")
    },
    {.name = NULL}
178 179 180
};

static const vshCmdOptDef opts_pool_autostart[] = {
181
    VIRSH_COMMON_OPT_POOL_FULL,
182

183 184 185 186 187
    {.name = "disable",
     .type = VSH_OT_BOOL,
     .help = N_("disable autostarting")
    },
    {.name = NULL}
188 189 190 191 192 193 194 195 196
};

static bool
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    const char *name;
    int autostart;

197
    if (!(pool = virshCommandOptPool(ctl, cmd, "pool", &name)))
198 199 200 201 202 203 204 205 206 207 208 209 210 211
        return false;

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

    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
        else
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
        virStoragePoolFree(pool);
        return false;
    }

    if (autostart)
P
Pino Toscano 已提交
212
        vshPrintExtra(ctl, _("Pool %s marked as autostarted\n"), name);
213
    else
P
Pino Toscano 已提交
214
        vshPrintExtra(ctl, _("Pool %s unmarked as autostarted\n"), name);
215 216 217 218 219 220 221 222 223

    virStoragePoolFree(pool);
    return true;
}

/*
 * "pool-create" command
 */
static const vshCmdInfo info_pool_create[] = {
224 225 226 227 228 229 230
    {.name = "help",
     .data = N_("create a pool from an XML file")
    },
    {.name = "desc",
     .data = N_("Create a pool.")
    },
    {.name = NULL}
231 232 233
};

static const vshCmdOptDef opts_pool_create[] = {
234
    VIRSH_COMMON_OPT_FILE(N_("file containing an XML pool description")),
235 236 237
    VIRSH_COMMON_OPT_POOL_BUILD,
    VIRSH_COMMON_OPT_POOL_NO_OVERWRITE,
    VIRSH_COMMON_OPT_POOL_OVERWRITE,
238

239
    {.name = NULL}
240 241 242 243 244 245 246 247 248
};

static bool
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    const char *from = NULL;
    bool ret = true;
    char *buffer;
249 250 251 252
    bool build;
    bool overwrite;
    bool no_overwrite;
    unsigned int flags = 0;
253
    virshControlPtr priv = ctl->privData;
254

255
    if (vshCommandOptStringReq(ctl, cmd, "file", &from) < 0)
256 257
        return false;

258 259 260 261 262 263 264 265 266 267 268 269 270 271
    build = vshCommandOptBool(cmd, "build");
    overwrite = vshCommandOptBool(cmd, "overwrite");
    no_overwrite = vshCommandOptBool(cmd, "no-overwrite");

    VSH_EXCLUSIVE_OPTIONS_EXPR("overwrite", overwrite,
                               "no-overwrite", no_overwrite);

    if (build)
        flags |= VIR_STORAGE_POOL_CREATE_WITH_BUILD;
    if (overwrite)
        flags |= VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE;
    if (no_overwrite)
        flags |= VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE;

E
Eric Blake 已提交
272
    if (virFileReadAll(from, VSH_MAX_XML_FILE, &buffer) < 0)
273 274
        return false;

275
    pool = virStoragePoolCreateXML(priv->conn, buffer, flags);
276 277 278
    VIR_FREE(buffer);

    if (pool != NULL) {
P
Pino Toscano 已提交
279 280
        vshPrintExtra(ctl, _("Pool %s created from %s\n"),
                      virStoragePoolGetName(pool), from);
281 282 283 284 285 286 287 288
        virStoragePoolFree(pool);
    } else {
        vshError(ctl, _("Failed to create pool from %s"), from);
        ret = false;
    }
    return ret;
}

289
static const vshCmdOptDef opts_pool_define_as[] = {
290
    VIRSH_COMMON_OPT_POOL_X_AS,
291

292
    {.name = NULL}
293 294
};

295
static int
296 297 298 299
virshBuildPoolXML(vshControl *ctl,
                  const vshCmd *cmd,
                  const char **retname,
                  char **xml)
300
{
301
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
302
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL,
303
               *target = NULL, *authType = NULL, *authUsername = NULL,
304 305
               *secretUsage = NULL, *adapterName = NULL, *adapterParent = NULL,
               *adapterWwnn = NULL, *adapterWwpn = NULL;
306 307
    virBuffer buf = VIR_BUFFER_INITIALIZER;

308
    if (vshCommandOptStringReq(ctl, cmd, "name", &name) < 0)
309
        goto cleanup;
310
    if (vshCommandOptStringReq(ctl, cmd, "type", &type) < 0)
311 312
        goto cleanup;

313 314 315 316 317
    if (vshCommandOptStringReq(ctl, cmd, "source-host", &srcHost) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "source-path", &srcPath) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "source-dev", &srcDev) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "source-name", &srcName) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "source-format", &srcFormat) < 0 ||
318 319 320
        vshCommandOptStringReq(ctl, cmd, "target", &target) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "auth-type", &authType) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "auth-username", &authUsername) < 0 ||
321 322 323 324 325
        vshCommandOptStringReq(ctl, cmd, "secret-usage", &secretUsage) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "adapter-name", &adapterName) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "adapter-wwnn", &adapterWwnn) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "adapter-wwpn", &adapterWwpn) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "adapter-parent", &adapterParent) < 0)
326 327 328
        goto cleanup;

    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
329 330
    virBufferAdjustIndent(&buf, 2);
    virBufferAsprintf(&buf, "<name>%s</name>\n", name);
331 332
    if (srcHost || srcPath || srcDev || srcFormat || srcName ||
        (adapterWwnn && adapterWwpn) || adapterName) {
333 334
        virBufferAddLit(&buf, "<source>\n");
        virBufferAdjustIndent(&buf, 2);
335 336

        if (srcHost)
337
            virBufferAsprintf(&buf, "<host name='%s'/>\n", srcHost);
338
        if (srcPath)
339
            virBufferAsprintf(&buf, "<dir path='%s'/>\n", srcPath);
340
        if (srcDev)
341
            virBufferAsprintf(&buf, "<device path='%s'/>\n", srcDev);
342 343 344 345 346 347 348 349 350 351
        if (adapterWwnn && adapterWwpn) {
            virBufferAddLit(&buf, "<adapter type='fc_host'");
            if (adapterParent)
                virBufferAsprintf(&buf, " parent='%s'", adapterParent);
            virBufferAsprintf(&buf, " wwnn='%s' wwpn='%s'/>\n",
                              adapterWwnn, adapterWwpn);
        } else if (adapterName) {
            virBufferAsprintf(&buf, "<adapter type='scsi_host' name='%s'/>\n",
                              adapterName);
        }
352 353 354 355 356 357 358 359
        if (authType && authUsername && secretUsage) {
            virBufferAsprintf(&buf, "<auth type='%s' username='%s'>\n",
                              authType, authUsername);
            virBufferAdjustIndent(&buf, 2);
            virBufferAsprintf(&buf, "<secret usage='%s'/>\n", secretUsage);
            virBufferAdjustIndent(&buf, -2);
            virBufferAddLit(&buf, "</auth>\n");
        }
360
        if (srcFormat)
361
            virBufferAsprintf(&buf, "<format type='%s'/>\n", srcFormat);
362
        if (srcName)
363
            virBufferAsprintf(&buf, "<name>%s</name>\n", srcName);
364

365 366
        virBufferAdjustIndent(&buf, -2);
        virBufferAddLit(&buf, "</source>\n");
367 368
    }
    if (target) {
369 370 371 372 373
        virBufferAddLit(&buf, "<target>\n");
        virBufferAdjustIndent(&buf, 2);
        virBufferAsprintf(&buf, "<path>%s</path>\n", target);
        virBufferAdjustIndent(&buf, -2);
        virBufferAddLit(&buf, "</target>\n");
374
    }
375
    virBufferAdjustIndent(&buf, -2);
376 377 378
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
379
        vshError(ctl, "%s", _("Failed to allocate XML buffer"));
380 381 382 383 384 385 386
        return false;
    }

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

387
 cleanup:
388 389 390 391 392 393 394 395
    virBufferFreeAndReset(&buf);
    return false;
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
396 397 398 399 400 401 402
    {.name = "help",
     .data = N_("create a pool from a set of args")
    },
    {.name = "desc",
     .data = N_("Create a pool.")
    },
    {.name = NULL}
403 404
};

405
static const vshCmdOptDef opts_pool_create_as[] = {
406 407 408 409
    VIRSH_COMMON_OPT_POOL_X_AS,
    VIRSH_COMMON_OPT_POOL_BUILD,
    VIRSH_COMMON_OPT_POOL_NO_OVERWRITE,
    VIRSH_COMMON_OPT_POOL_OVERWRITE,
410 411 412 413

    {.name = NULL}
};

414 415 416 417 418 419 420
static bool
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    const char *name;
    char *xml;
    bool printXML = vshCommandOptBool(cmd, "print-xml");
421 422 423 424
    bool build;
    bool overwrite;
    bool no_overwrite;
    unsigned int flags = 0;
425
    virshControlPtr priv = ctl->privData;
426

427 428 429 430 431 432 433 434 435 436 437 438 439 440
    build = vshCommandOptBool(cmd, "build");
    overwrite = vshCommandOptBool(cmd, "overwrite");
    no_overwrite = vshCommandOptBool(cmd, "no-overwrite");

    VSH_EXCLUSIVE_OPTIONS_EXPR("overwrite", overwrite,
                               "no-overwrite", no_overwrite);

    if (build)
        flags |= VIR_STORAGE_POOL_CREATE_WITH_BUILD;
    if (overwrite)
        flags |= VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE;
    if (no_overwrite)
        flags |= VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE;

441
    if (!virshBuildPoolXML(ctl, cmd, &name, &xml))
442 443 444 445 446 447
        return false;

    if (printXML) {
        vshPrint(ctl, "%s", xml);
        VIR_FREE(xml);
    } else {
448
        pool = virStoragePoolCreateXML(priv->conn, xml, flags);
449 450 451
        VIR_FREE(xml);

        if (pool != NULL) {
P
Pino Toscano 已提交
452
            vshPrintExtra(ctl, _("Pool %s created\n"), name);
453 454 455 456 457 458 459 460 461 462 463 464 465
            virStoragePoolFree(pool);
        } else {
            vshError(ctl, _("Failed to create pool %s"), name);
            return false;
        }
    }
    return true;
}

/*
 * "pool-define" command
 */
static const vshCmdInfo info_pool_define[] = {
466
    {.name = "help",
467 468
     .data = N_("define an inactive persistent storage pool or modify "
                "an existing persistent one from an XML file")
469 470
    },
    {.name = "desc",
471
     .data = N_("Define or modify a persistent storage pool.")
472 473
    },
    {.name = NULL}
474 475 476
};

static const vshCmdOptDef opts_pool_define[] = {
477
    VIRSH_COMMON_OPT_FILE(N_("file containing an XML pool description")),
478

479
    {.name = NULL}
480 481 482 483 484 485 486 487 488
};

static bool
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    const char *from = NULL;
    bool ret = true;
    char *buffer;
489
    virshControlPtr priv = ctl->privData;
490

491
    if (vshCommandOptStringReq(ctl, cmd, "file", &from) < 0)
492 493
        return false;

E
Eric Blake 已提交
494
    if (virFileReadAll(from, VSH_MAX_XML_FILE, &buffer) < 0)
495 496
        return false;

497
    pool = virStoragePoolDefineXML(priv->conn, buffer, 0);
498 499 500
    VIR_FREE(buffer);

    if (pool != NULL) {
P
Pino Toscano 已提交
501 502
        vshPrintExtra(ctl, _("Pool %s defined from %s\n"),
                      virStoragePoolGetName(pool), from);
503 504 505 506 507 508 509 510 511 512 513 514
        virStoragePoolFree(pool);
    } else {
        vshError(ctl, _("Failed to define pool from %s"), from);
        ret = false;
    }
    return ret;
}

/*
 * "pool-define-as" command
 */
static const vshCmdInfo info_pool_define_as[] = {
515 516 517 518 519 520 521
    {.name = "help",
     .data = N_("define a pool from a set of args")
    },
    {.name = "desc",
     .data = N_("Define a pool.")
    },
    {.name = NULL}
522 523 524 525 526 527 528 529 530
};

static bool
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    const char *name;
    char *xml;
    bool printXML = vshCommandOptBool(cmd, "print-xml");
531
    virshControlPtr priv = ctl->privData;
532

533
    if (!virshBuildPoolXML(ctl, cmd, &name, &xml))
534 535 536 537 538 539
        return false;

    if (printXML) {
        vshPrint(ctl, "%s", xml);
        VIR_FREE(xml);
    } else {
540
        pool = virStoragePoolDefineXML(priv->conn, xml, 0);
541 542 543
        VIR_FREE(xml);

        if (pool != NULL) {
P
Pino Toscano 已提交
544
            vshPrintExtra(ctl, _("Pool %s defined\n"), name);
545 546 547 548 549 550 551 552 553 554 555 556 557
            virStoragePoolFree(pool);
        } else {
            vshError(ctl, _("Failed to define pool %s"), name);
            return false;
        }
    }
    return true;
}

/*
 * "pool-build" command
 */
static const vshCmdInfo info_pool_build[] = {
558 559 560 561 562 563 564
    {.name = "help",
     .data = N_("build a pool")
    },
    {.name = "desc",
     .data = N_("Build a given pool.")
    },
    {.name = NULL}
565 566 567
};

static const vshCmdOptDef opts_pool_build[] = {
568
    VIRSH_COMMON_OPT_POOL_FULL,
569 570
    VIRSH_COMMON_OPT_POOL_NO_OVERWRITE,
    VIRSH_COMMON_OPT_POOL_OVERWRITE,
571

572
    {.name = NULL}
573 574 575 576 577 578 579 580 581 582
};

static bool
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    bool ret = true;
    const char *name;
    unsigned int flags = 0;

583
    if (!(pool = virshCommandOptPool(ctl, cmd, "pool", &name)))
584 585
        return false;

586
    if (vshCommandOptBool(cmd, "no-overwrite"))
587 588
        flags |= VIR_STORAGE_POOL_BUILD_NO_OVERWRITE;

589
    if (vshCommandOptBool(cmd, "overwrite"))
590 591 592
        flags |= VIR_STORAGE_POOL_BUILD_OVERWRITE;

    if (virStoragePoolBuild(pool, flags) == 0) {
P
Pino Toscano 已提交
593
        vshPrintExtra(ctl, _("Pool %s built\n"), name);
594 595 596 597 598 599 600 601 602 603 604 605 606 607
    } else {
        vshError(ctl, _("Failed to build pool %s"), name);
        ret = false;
    }

    virStoragePoolFree(pool);

    return ret;
}

/*
 * "pool-destroy" command
 */
static const vshCmdInfo info_pool_destroy[] = {
608 609 610 611 612 613 614
    {.name = "help",
     .data = N_("destroy (stop) a pool")
    },
    {.name = "desc",
     .data = N_("Forcefully stop a given pool. Raw data in the pool is untouched")
    },
    {.name = NULL}
615 616 617
};

static const vshCmdOptDef opts_pool_destroy[] = {
618
    VIRSH_COMMON_OPT_POOL_FULL,
619

620
    {.name = NULL}
621 622 623 624 625 626 627 628 629
};

static bool
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    bool ret = true;
    const char *name;

630
    if (!(pool = virshCommandOptPool(ctl, cmd, "pool", &name)))
631 632 633
        return false;

    if (virStoragePoolDestroy(pool) == 0) {
P
Pino Toscano 已提交
634
        vshPrintExtra(ctl, _("Pool %s destroyed\n"), name);
635 636 637 638 639 640 641 642 643 644 645 646 647
    } else {
        vshError(ctl, _("Failed to destroy pool %s"), name);
        ret = false;
    }

    virStoragePoolFree(pool);
    return ret;
}

/*
 * "pool-delete" command
 */
static const vshCmdInfo info_pool_delete[] = {
648 649 650 651 652 653 654
    {.name = "help",
     .data = N_("delete a pool")
    },
    {.name = "desc",
     .data = N_("Delete a given pool.")
    },
    {.name = NULL}
655 656 657
};

static const vshCmdOptDef opts_pool_delete[] = {
658
    VIRSH_COMMON_OPT_POOL_FULL,
659

660
    {.name = NULL}
661 662 663 664 665 666 667 668 669
};

static bool
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    bool ret = true;
    const char *name;

670
    if (!(pool = virshCommandOptPool(ctl, cmd, "pool", &name)))
671 672 673
        return false;

    if (virStoragePoolDelete(pool, 0) == 0) {
P
Pino Toscano 已提交
674
        vshPrintExtra(ctl, _("Pool %s deleted\n"), name);
675 676 677 678 679 680 681 682 683 684 685 686 687
    } else {
        vshError(ctl, _("Failed to delete pool %s"), name);
        ret = false;
    }

    virStoragePoolFree(pool);
    return ret;
}

/*
 * "pool-refresh" command
 */
static const vshCmdInfo info_pool_refresh[] = {
688 689 690 691 692 693 694
    {.name = "help",
     .data = N_("refresh a pool")
    },
    {.name = "desc",
     .data = N_("Refresh a given pool.")
    },
    {.name = NULL}
695 696 697
};

static const vshCmdOptDef opts_pool_refresh[] = {
698
    VIRSH_COMMON_OPT_POOL_FULL,
699

700
    {.name = NULL}
701 702 703 704 705 706 707 708 709
};

static bool
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    bool ret = true;
    const char *name;

710
    if (!(pool = virshCommandOptPool(ctl, cmd, "pool", &name)))
711 712 713
        return false;

    if (virStoragePoolRefresh(pool, 0) == 0) {
P
Pino Toscano 已提交
714
        vshPrintExtra(ctl, _("Pool %s refreshed\n"), name);
715 716 717 718 719 720 721 722 723 724 725 726 727
    } else {
        vshError(ctl, _("Failed to refresh pool %s"), name);
        ret = false;
    }
    virStoragePoolFree(pool);

    return ret;
}

/*
 * "pool-dumpxml" command
 */
static const vshCmdInfo info_pool_dumpxml[] = {
728 729 730 731 732 733 734
    {.name = "help",
     .data = N_("pool information in XML")
    },
    {.name = "desc",
     .data = N_("Output the pool information as an XML dump to stdout.")
    },
    {.name = NULL}
735 736 737
};

static const vshCmdOptDef opts_pool_dumpxml[] = {
738
    VIRSH_COMMON_OPT_POOL_FULL,
739

740 741 742 743 744
    {.name = "inactive",
     .type = VSH_OT_BOOL,
     .help = N_("show inactive defined XML")
    },
    {.name = NULL}
745 746 747 748 749 750 751 752 753 754 755 756 757 758
};

static bool
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    bool ret = true;
    bool inactive = vshCommandOptBool(cmd, "inactive");
    unsigned int flags = 0;
    char *dump;

    if (inactive)
        flags |= VIR_STORAGE_XML_INACTIVE;

759
    if (!(pool = virshCommandOptPool(ctl, cmd, "pool", NULL)))
760 761 762 763 764 765 766 767 768 769 770 771 772 773
        return false;

    dump = virStoragePoolGetXMLDesc(pool, flags);
    if (dump != NULL) {
        vshPrint(ctl, "%s", dump);
        VIR_FREE(dump);
    } else {
        ret = false;
    }

    virStoragePoolFree(pool);
    return ret;
}

774
static int
775
virshStoragePoolSorter(const void *a, const void *b)
776 777 778 779 780 781 782 783 784 785 786 787 788 789
{
    virStoragePoolPtr *pa = (virStoragePoolPtr *) a;
    virStoragePoolPtr *pb = (virStoragePoolPtr *) b;

    if (*pa && !*pb)
        return -1;

    if (!*pa)
        return *pb != NULL;

    return vshStrcasecmp(virStoragePoolGetName(*pa),
                         virStoragePoolGetName(*pb));
}

790
struct virshStoragePoolList {
791 792 793
    virStoragePoolPtr *pools;
    size_t npools;
};
794
typedef struct virshStoragePoolList *virshStoragePoolListPtr;
795 796

static void
797
virshStoragePoolListFree(virshStoragePoolListPtr list)
798
{
799
    size_t i;
800 801 802 803 804 805 806 807 808 809 810

    if (list && list->pools) {
        for (i = 0; i < list->npools; i++) {
            if (list->pools[i])
                virStoragePoolFree(list->pools[i]);
        }
        VIR_FREE(list->pools);
    }
    VIR_FREE(list);
}

811 812 813
static virshStoragePoolListPtr
virshStoragePoolListCollect(vshControl *ctl,
                            unsigned int flags)
814
{
815
    virshStoragePoolListPtr list = vshMalloc(ctl, sizeof(*list));
816
    size_t i;
817 818 819 820 821 822 823 824 825 826
    int ret;
    char **names = NULL;
    virStoragePoolPtr pool;
    bool success = false;
    size_t deleted = 0;
    int persistent;
    int autostart;
    int nActivePools = 0;
    int nInactivePools = 0;
    int nAllPools = 0;
827
    virshControlPtr priv = ctl->privData;
828

829
    /* try the list with flags support (0.10.2 and later) */
830
    if ((ret = virConnectListAllStoragePools(priv->conn,
831 832 833 834 835 836 837
                                             &list->pools,
                                             flags)) >= 0) {
        list->npools = ret;
        goto finished;
    }

    /* check if the command is actually supported */
838
    if (last_error && last_error->code == VIR_ERR_NO_SUPPORT)
839 840 841 842 843 844 845
        goto fallback;

    if (last_error && last_error->code ==  VIR_ERR_INVALID_ARG) {
        /* try the new API again but mask non-guaranteed flags */
        unsigned int newflags = flags & (VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE |
                                         VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE);
        vshResetLibvirtError();
846
        if ((ret = virConnectListAllStoragePools(priv->conn, &list->pools,
847 848 849 850 851 852 853 854 855 856 857
                                                 newflags)) >= 0) {
            list->npools = ret;
            goto filter;
        }
    }

    /* there was an error during the first or second call */
    vshError(ctl, "%s", _("Failed to list pools"));
    goto cleanup;


858
 fallback:
859
    /* fall back to old method (0.10.1 and older) */
860 861 862
    vshResetLibvirtError();

    /* There is no way to get the pool type */
E
Eric Blake 已提交
863
    if (VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_FILTERS_POOL_TYPE)) {
864 865 866 867 868 869
        vshError(ctl, "%s", _("Filtering using --type is not supported "
                              "by this libvirt"));
        goto cleanup;
    }

    /* Get the number of active pools */
E
Eric Blake 已提交
870 871
    if (!VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_FILTERS_ACTIVE) ||
        VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE)) {
872
        if ((nActivePools = virConnectNumOfStoragePools(priv->conn)) < 0) {
873 874 875 876 877 878
            vshError(ctl, "%s", _("Failed to get the number of active pools "));
            goto cleanup;
        }
    }

    /* Get the number of inactive pools */
E
Eric Blake 已提交
879 880
    if (!VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_FILTERS_ACTIVE) ||
        VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE)) {
881
        if ((nInactivePools = virConnectNumOfDefinedStoragePools(priv->conn)) < 0) {
882 883 884 885 886 887 888 889 890 891 892 893 894
            vshError(ctl, "%s", _("Failed to get the number of inactive pools"));
            goto cleanup;
        }
    }

    nAllPools = nActivePools + nInactivePools;

    if (nAllPools == 0)
        return list;

    names = vshMalloc(ctl, sizeof(char *) * nAllPools);

    /* Retrieve a list of active storage pool names */
E
Eric Blake 已提交
895 896
    if (!VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_FILTERS_ACTIVE) ||
        VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE)) {
897
        if (virConnectListStoragePools(priv->conn,
898 899 900 901 902 903 904
                                       names, nActivePools) < 0) {
            vshError(ctl, "%s", _("Failed to list active pools"));
            goto cleanup;
        }
    }

    /* Add the inactive storage pools to the end of the name list */
E
Eric Blake 已提交
905 906
    if (!VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_FILTERS_ACTIVE) ||
        VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE)) {
907
        if (virConnectListDefinedStoragePools(priv->conn,
908 909 910 911 912 913 914 915 916 917 918 919
                                              &names[nActivePools],
                                              nInactivePools) < 0) {
            vshError(ctl, "%s", _("Failed to list inactive pools"));
            goto cleanup;
        }
    }

    list->pools = vshMalloc(ctl, sizeof(virStoragePoolPtr) * (nAllPools));
    list->npools = 0;

    /* get active pools */
    for (i = 0; i < nActivePools; i++) {
920
        if (!(pool = virStoragePoolLookupByName(priv->conn, names[i])))
921 922 923 924 925 926
            continue;
        list->pools[list->npools++] = pool;
    }

    /* get inactive pools */
    for (i = 0; i < nInactivePools; i++) {
927
        if (!(pool = virStoragePoolLookupByName(priv->conn, names[i])))
928 929 930 931 932 933 934
            continue;
        list->pools[list->npools++] = pool;
    }

    /* truncate pools that weren't found */
    deleted = nAllPools - list->npools;

935
 filter:
936 937 938 939 940
    /* filter list the list if the list was acquired by fallback means */
    for (i = 0; i < list->npools; i++) {
        pool = list->pools[i];

        /* persistence filter */
E
Eric Blake 已提交
941
        if (VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_FILTERS_PERSISTENT)) {
942 943 944 945 946
            if ((persistent = virStoragePoolIsPersistent(pool)) < 0) {
                vshError(ctl, "%s", _("Failed to get pool persistence info"));
                goto cleanup;
            }

E
Eric Blake 已提交
947 948
            if (!((VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT) && persistent) ||
                  (VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT) && !persistent)))
949 950 951 952
                goto remove_entry;
        }

        /* autostart filter */
E
Eric Blake 已提交
953
        if (VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_FILTERS_AUTOSTART)) {
954 955 956 957 958
            if (virStoragePoolGetAutostart(pool, &autostart) < 0) {
                vshError(ctl, "%s", _("Failed to get pool autostart state"));
                goto cleanup;
            }

E
Eric Blake 已提交
959 960
            if (!((VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART) && autostart) ||
                  (VSH_MATCH(VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART) && !autostart)))
961 962 963 964 965 966
                goto remove_entry;
        }

        /* the pool matched all filters, it may stay */
        continue;

967
 remove_entry:
968 969 970 971 972 973
        /* the pool has to be removed as it failed one of the filters */
        virStoragePoolFree(list->pools[i]);
        list->pools[i] = NULL;
        deleted++;
    }

974
 finished:
975 976 977
    /* sort the list */
    if (list->pools && list->npools)
        qsort(list->pools, list->npools,
978
              sizeof(*list->pools), virshStoragePoolSorter);
979 980 981 982 983 984 985

    /* truncate the list if filter simulation deleted entries */
    if (deleted)
        VIR_SHRINK_N(list->pools, list->npools, deleted);

    success = true;

986
 cleanup:
987 988 989 990
    for (i = 0; i < nAllPools; i++)
        VIR_FREE(names[i]);

    if (!success) {
991
        virshStoragePoolListFree(list);
992 993 994 995 996 997 998
        list = NULL;
    }

    VIR_FREE(names);
    return list;
}

999

1000 1001
VIR_ENUM_DECL(virshStoragePoolState)
VIR_ENUM_IMPL(virshStoragePoolState,
1002 1003 1004 1005 1006 1007 1008 1009
              VIR_STORAGE_POOL_STATE_LAST,
              N_("inactive"),
              N_("building"),
              N_("running"),
              N_("degraded"),
              N_("inaccessible"))

static const char *
1010
virshStoragePoolStateToString(int state)
1011
{
1012
    const char *str = virshStoragePoolStateTypeToString(state);
1013 1014 1015 1016
    return str ? _(str) : _("unknown");
}


1017 1018 1019 1020
/*
 * "pool-list" command
 */
static const vshCmdInfo info_pool_list[] = {
1021 1022 1023 1024 1025 1026 1027
    {.name = "help",
     .data = N_("list pools")
    },
    {.name = "desc",
     .data = N_("Returns list of pools.")
    },
    {.name = NULL}
1028 1029 1030
};

static const vshCmdOptDef opts_pool_list[] = {
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
    {.name = "inactive",
     .type = VSH_OT_BOOL,
     .help = N_("list inactive pools")
    },
    {.name = "all",
     .type = VSH_OT_BOOL,
     .help = N_("list inactive & active pools")
    },
    {.name = "transient",
     .type = VSH_OT_BOOL,
     .help = N_("list transient pools")
    },
    {.name = "persistent",
     .type = VSH_OT_BOOL,
     .help = N_("list persistent pools")
    },
    {.name = "autostart",
     .type = VSH_OT_BOOL,
     .help = N_("list pools with autostart enabled")
    },
    {.name = "no-autostart",
     .type = VSH_OT_BOOL,
     .help = N_("list pools with autostart disabled")
    },
    {.name = "type",
     .type = VSH_OT_STRING,
     .help = N_("only list pool of specified type(s) (if supported)")
    },
    {.name = "details",
     .type = VSH_OT_BOOL,
     .help = N_("display extended details for pools")
    },
1063 1064 1065 1066
    {.name = "uuid",
     .type = VSH_OT_BOOL,
     .help = N_("list UUID of active pools only")
    },
1067 1068 1069 1070
    {.name = "name",
     .type = VSH_OT_BOOL,
     .help = N_("list name of active pools only")
    },
1071
    {.name = NULL}
1072 1073 1074 1075 1076 1077
};

static bool
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    virStoragePoolInfo info;
1078
    size_t i;
1079
    bool ret = false;
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
    size_t stringLength = 0, nameStrLength = 0;
    size_t autostartStrLength = 0, persistStrLength = 0;
    size_t stateStrLength = 0, capStrLength = 0;
    size_t allocStrLength = 0, availStrLength = 0;
    struct poolInfoText {
        char *state;
        char *autostart;
        char *persistent;
        char *capacity;
        char *allocation;
        char *available;
    };
    struct poolInfoText *poolInfoTexts = NULL;
1093
    unsigned int flags = VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE;
1094
    virshStoragePoolListPtr list = NULL;
1095
    const char *type = NULL;
1096
    bool details = vshCommandOptBool(cmd, "details");
1097
    bool inactive, all;
1098
    bool uuid = false;
1099
    bool name = false;
1100
    char *outputStr = NULL;
1101

1102 1103
    inactive = vshCommandOptBool(cmd, "inactive");
    all = vshCommandOptBool(cmd, "all");
1104

1105 1106
    if (inactive)
        flags = VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE;
1107

1108 1109 1110
    if (all)
        flags = VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE |
                VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE;
1111

1112 1113
    if (vshCommandOptBool(cmd, "autostart"))
        flags |= VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART;
1114

1115 1116 1117 1118 1119 1120 1121 1122 1123
    if (vshCommandOptBool(cmd, "no-autostart"))
        flags |= VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART;

    if (vshCommandOptBool(cmd, "persistent"))
        flags |= VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT;

    if (vshCommandOptBool(cmd, "transient"))
        flags |= VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT;

1124 1125 1126
    if (vshCommandOptBool(cmd, "uuid"))
        uuid = true;

1127 1128 1129
    if (vshCommandOptBool(cmd, "name"))
        name = true;

1130
    if (vshCommandOptStringReq(ctl, cmd, "type", &type) < 0)
1131
        return false;
1132

1133
    VSH_EXCLUSIVE_OPTIONS("details", "uuid");
1134
    VSH_EXCLUSIVE_OPTIONS("details", "name");
1135

1136 1137 1138 1139 1140
    if (type) {
        int poolType = -1;
        char **poolTypes = NULL;
        int npoolTypes = 0;

1141 1142
        if ((npoolTypes = vshStringToArray(type, &poolTypes)) < 0)
            return false;
1143 1144 1145

        for (i = 0; i < npoolTypes; i++) {
            if ((poolType = virStoragePoolTypeFromString(poolTypes[i])) < 0) {
1146
                vshError(ctl, _("Invalid pool type '%s'"), poolTypes[i]);
1147
                virStringListFree(poolTypes);
1148 1149 1150
                return false;
            }

1151
            switch ((virStoragePoolType) poolType) {
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
            case VIR_STORAGE_POOL_DIR:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_DIR;
                break;
            case VIR_STORAGE_POOL_FS:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_FS;
                break;
            case VIR_STORAGE_POOL_NETFS:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_NETFS;
                break;
            case VIR_STORAGE_POOL_LOGICAL:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL;
                break;
            case VIR_STORAGE_POOL_DISK:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_DISK;
                break;
            case VIR_STORAGE_POOL_ISCSI:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI;
                break;
            case VIR_STORAGE_POOL_SCSI:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_SCSI;
                break;
            case VIR_STORAGE_POOL_MPATH:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_MPATH;
                break;
            case VIR_STORAGE_POOL_RBD:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_RBD;
                break;
1179 1180 1181 1182 1183 1184
            case VIR_STORAGE_POOL_SHEEPDOG:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG;
                break;
            case VIR_STORAGE_POOL_GLUSTER:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER;
                break;
R
Roman Bogorodskiy 已提交
1185 1186 1187
            case VIR_STORAGE_POOL_ZFS:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_ZFS;
                break;
1188 1189 1190
            case VIR_STORAGE_POOL_VSTORAGE:
                flags |= VIR_CONNECT_LIST_STORAGE_POOLS_VSTORAGE;
                break;
1191
            case VIR_STORAGE_POOL_LAST:
1192 1193
                break;
            }
1194
        }
1195
        virStringListFree(poolTypes);
1196 1197
    }

1198
    if (!(list = virshStoragePoolListCollect(ctl, flags)))
1199 1200 1201
        goto cleanup;

    poolInfoTexts = vshCalloc(ctl, list->npools, sizeof(*poolInfoTexts));
1202 1203

    /* Collect the storage pool information for display */
1204
    for (i = 0; i < list->npools; i++) {
1205 1206 1207
        int autostart = 0, persistent = 0;

        /* Retrieve the autostart status of the pool */
1208
        if (virStoragePoolGetAutostart(list->pools[i], &autostart) < 0)
1209 1210 1211 1212 1213 1214 1215
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
        else
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
1216
            persistent = virStoragePoolIsPersistent(list->pools[i]);
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
            if (persistent < 0)
                poolInfoTexts[i].persistent = vshStrdup(ctl, _("unknown"));
            else
                poolInfoTexts[i].persistent = vshStrdup(ctl, persistent ?
                                                         _("yes") : _("no"));

            /* Keep the length of persistent string if longest so far */
            stringLength = strlen(poolInfoTexts[i].persistent);
            if (stringLength > persistStrLength)
                persistStrLength = stringLength;
        }

        /* Collect further extended information about the pool */
1232
        if (virStoragePoolGetInfo(list->pools[i], &info) != 0) {
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
            /* Something went wrong retrieving pool info, cope with it */
            vshError(ctl, "%s", _("Could not retrieve pool information"));
            poolInfoTexts[i].state = vshStrdup(ctl, _("unknown"));
            if (details) {
                poolInfoTexts[i].capacity = vshStrdup(ctl, _("unknown"));
                poolInfoTexts[i].allocation = vshStrdup(ctl, _("unknown"));
                poolInfoTexts[i].available = vshStrdup(ctl, _("unknown"));
            }
        } else {
            /* Decide which state string to display */
            if (details) {
1244
                const char *state = virshStoragePoolStateToString(info.state);
1245 1246

                poolInfoTexts[i].state = vshStrdup(ctl, state);
1247 1248 1249 1250 1251 1252 1253

                /* Create the pool size related strings */
                if (info.state == VIR_STORAGE_POOL_RUNNING ||
                    info.state == VIR_STORAGE_POOL_DEGRADED) {
                    double val;
                    const char *unit;

E
Eric Blake 已提交
1254
                    val = vshPrettyCapacity(info.capacity, &unit);
1255 1256 1257
                    if (virAsprintf(&poolInfoTexts[i].capacity,
                                    "%.2lf %s", val, unit) < 0)
                        goto cleanup;
1258

E
Eric Blake 已提交
1259
                    val = vshPrettyCapacity(info.allocation, &unit);
1260 1261 1262
                    if (virAsprintf(&poolInfoTexts[i].allocation,
                                    "%.2lf %s", val, unit) < 0)
                        goto cleanup;
1263

E
Eric Blake 已提交
1264
                    val = vshPrettyCapacity(info.available, &unit);
1265 1266 1267
                    if (virAsprintf(&poolInfoTexts[i].available,
                                    "%.2lf %s", val, unit) < 0)
                        goto cleanup;
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
                } else {
                    /* Capacity related information isn't available */
                    poolInfoTexts[i].capacity = vshStrdup(ctl, _("-"));
                    poolInfoTexts[i].allocation = vshStrdup(ctl, _("-"));
                    poolInfoTexts[i].available = vshStrdup(ctl, _("-"));
                }

                /* Keep the length of capacity string if longest so far */
                stringLength = strlen(poolInfoTexts[i].capacity);
                if (stringLength > capStrLength)
                    capStrLength = stringLength;

                /* Keep the length of allocation string if longest so far */
                stringLength = strlen(poolInfoTexts[i].allocation);
                if (stringLength > allocStrLength)
                    allocStrLength = stringLength;

                /* Keep the length of available string if longest so far */
                stringLength = strlen(poolInfoTexts[i].available);
                if (stringLength > availStrLength)
                    availStrLength = stringLength;
            } else {
                /* --details option was not specified, only active/inactive
1291 1292
                 * state strings are used */
                if (virStoragePoolIsActive(list->pools[i]))
1293
                    poolInfoTexts[i].state = vshStrdup(ctl, _("active"));
1294 1295 1296
                else
                    poolInfoTexts[i].state = vshStrdup(ctl, _("inactive"));
           }
1297 1298 1299
        }

        /* Keep the length of name string if longest so far */
1300
        stringLength = strlen(virStoragePoolGetName(list->pools[i]));
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321
        if (stringLength > nameStrLength)
            nameStrLength = stringLength;

        /* Keep the length of state string if longest so far */
        stringLength = strlen(poolInfoTexts[i].state);
        if (stringLength > stateStrLength)
            stateStrLength = stringLength;

        /* Keep the length of autostart string if longest so far */
        stringLength = strlen(poolInfoTexts[i].autostart);
        if (stringLength > autostartStrLength)
            autostartStrLength = stringLength;
    }

    /* If the --details option wasn't selected, we output the pool
     * info using the fixed string format from previous versions to
     * maintain backward compatibility.
     */

    /* Output basic info then return if --details option not selected */
    if (!details) {
1322
        if (uuid || name) {
1323
            for (i = 0; i < list->npools; i++) {
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
                if (uuid) {
                    char uuid_str[VIR_UUID_STRING_BUFLEN];
                    virStoragePoolGetUUIDString(list->pools[i], uuid_str);
                    vshPrint(ctl, "%-36s%c", uuid_str, name ? ' ': '\n');
                }
                if (name) {
                    const char *name_str =
                        virStoragePoolGetName(list->pools[i]);
                    vshPrint(ctl, "%-20s\n", name_str);
                }
1334 1335 1336 1337 1338
            }
            ret = true;
            goto cleanup;
        }

1339
        /* Output old style header */
1340
        vshPrintExtra(ctl, " %-20s %-10s %-10s\n", _("Name"), _("State"),
1341
                      _("Autostart"));
1342
        vshPrintExtra(ctl, "-------------------------------------------\n");
1343 1344

        /* Output old style pool info */
1345
        for (i = 0; i < list->npools; i++) {
1346
            const char *name_str = virStoragePoolGetName(list->pools[i]);
1347
            vshPrint(ctl, " %-20s %-10s %-10s\n",
1348
                 name_str,
1349 1350 1351 1352 1353
                 poolInfoTexts[i].state,
                 poolInfoTexts[i].autostart);
        }

        /* Cleanup and return */
1354
        ret = true;
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413
        goto cleanup;
    }

    /* We only get here if the --details option was selected. */

    /* Use the length of name header string if it's longest */
    stringLength = strlen(_("Name"));
    if (stringLength > nameStrLength)
        nameStrLength = stringLength;

    /* Use the length of state header string if it's longest */
    stringLength = strlen(_("State"));
    if (stringLength > stateStrLength)
        stateStrLength = stringLength;

    /* Use the length of autostart header string if it's longest */
    stringLength = strlen(_("Autostart"));
    if (stringLength > autostartStrLength)
        autostartStrLength = stringLength;

    /* Use the length of persistent header string if it's longest */
    stringLength = strlen(_("Persistent"));
    if (stringLength > persistStrLength)
        persistStrLength = stringLength;

    /* Use the length of capacity header string if it's longest */
    stringLength = strlen(_("Capacity"));
    if (stringLength > capStrLength)
        capStrLength = stringLength;

    /* Use the length of allocation header string if it's longest */
    stringLength = strlen(_("Allocation"));
    if (stringLength > allocStrLength)
        allocStrLength = stringLength;

    /* Use the length of available header string if it's longest */
    stringLength = strlen(_("Available"));
    if (stringLength > availStrLength)
        availStrLength = stringLength;

    /* Display the string lengths for debugging. */
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
             (unsigned long) nameStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
             (unsigned long) stateStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
             (unsigned long) autostartStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
             (unsigned long) persistStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
             (unsigned long) capStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
             (unsigned long) allocStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
             (unsigned long) availStrLength);

    /* Create the output template.  Each column is sized according to
     * the longest string.
     */
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
    if (virAsprintf(&outputStr,
                    " %%-%lus  %%-%lus  %%-%lus  %%-%lus  %%%lus  %%%lus  %%%lus\n",
                    (unsigned long) nameStrLength,
                    (unsigned long) stateStrLength,
                    (unsigned long) autostartStrLength,
                    (unsigned long) persistStrLength,
                    (unsigned long) capStrLength,
                    (unsigned long) allocStrLength,
                    (unsigned long) availStrLength) < 0)
        goto cleanup;
1424 1425

    /* Display the header */
1426 1427 1428
    vshPrintExtra(ctl, outputStr, _("Name"), _("State"), _("Autostart"),
                  _("Persistent"), _("Capacity"), _("Allocation"),
                  _("Available"));
1429 1430 1431
    for (i = nameStrLength + stateStrLength + autostartStrLength
                           + persistStrLength + capStrLength
                           + allocStrLength + availStrLength
1432
                           + 14; i > 0; i--)
1433 1434 1435 1436
        vshPrintExtra(ctl, "-");
    vshPrintExtra(ctl, "\n");

    /* Display the pool info rows */
1437
    for (i = 0; i < list->npools; i++) {
1438
        vshPrint(ctl, outputStr,
1439
                 virStoragePoolGetName(list->pools[i]),
1440 1441 1442 1443 1444 1445 1446 1447 1448
                 poolInfoTexts[i].state,
                 poolInfoTexts[i].autostart,
                 poolInfoTexts[i].persistent,
                 poolInfoTexts[i].capacity,
                 poolInfoTexts[i].allocation,
                 poolInfoTexts[i].available);
    }

    /* Cleanup and return */
1449
    ret = true;
1450

1451
 cleanup:
1452
    VIR_FREE(outputStr);
1453 1454 1455 1456 1457 1458 1459 1460 1461
    if (list && list->npools) {
        for (i = 0; i < list->npools; i++) {
            VIR_FREE(poolInfoTexts[i].state);
            VIR_FREE(poolInfoTexts[i].autostart);
            VIR_FREE(poolInfoTexts[i].persistent);
            VIR_FREE(poolInfoTexts[i].capacity);
            VIR_FREE(poolInfoTexts[i].allocation);
            VIR_FREE(poolInfoTexts[i].available);
        }
1462 1463 1464
    }
    VIR_FREE(poolInfoTexts);

1465
    virshStoragePoolListFree(list);
1466
    return ret;
1467 1468 1469 1470 1471 1472
}

/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
1473 1474 1475 1476 1477 1478 1479
    {.name = "help",
     .data = N_("find potential storage pool sources")
    },
    {.name = "desc",
     .data = N_("Returns XML <sources> document.")
    },
    {.name = NULL}
1480 1481 1482
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
1483 1484 1485 1486 1487 1488
    {.name = "type",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("type of storage pool sources to find")
    },
    {.name = "host",
1489
     .type = VSH_OT_STRING,
1490 1491 1492
     .help = N_("optional host to query")
    },
    {.name = "port",
1493
     .type = VSH_OT_STRING,
1494 1495 1496
     .help = N_("optional port to query")
    },
    {.name = "initiator",
1497
     .type = VSH_OT_STRING,
1498 1499 1500
     .help = N_("optional initiator IQN to use for query")
    },
    {.name = NULL}
1501 1502 1503 1504 1505 1506 1507 1508 1509
};

static bool
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
    const char *type = NULL, *host = NULL;
    char *srcSpec = NULL;
    char *srcList;
    const char *initiator = NULL;
1510
    virshControlPtr priv = ctl->privData;
1511

1512 1513 1514
    if (vshCommandOptStringReq(ctl, cmd, "type", &type) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "host", &host) < 0 ||
        vshCommandOptStringReq(ctl, cmd, "initiator", &initiator) < 0)
1515 1516 1517 1518 1519 1520
        return false;

    if (host) {
        const char *port = NULL;
        virBuffer buf = VIR_BUFFER_INITIALIZER;

1521
        if (vshCommandOptStringReq(ctl, cmd, "port", &port) < 0) {
1522 1523 1524 1525 1526
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
            return false;
        }
        virBufferAddLit(&buf, "<source>\n");
1527 1528
        virBufferAdjustIndent(&buf, 2);
        virBufferAsprintf(&buf, "<host name='%s'", host);
1529 1530 1531 1532
        if (port)
            virBufferAsprintf(&buf, " port='%s'", port);
        virBufferAddLit(&buf, "/>\n");
        if (initiator) {
1533 1534 1535 1536 1537
            virBufferAddLit(&buf, "<initiator>\n");
            virBufferAdjustIndent(&buf, 2);
            virBufferAsprintf(&buf, "<iqn name='%s'/>\n", initiator);
            virBufferAdjustIndent(&buf, -2);
            virBufferAddLit(&buf, "</initiator>\n");
1538
        }
1539
        virBufferAdjustIndent(&buf, -2);
1540 1541 1542 1543 1544 1545 1546 1547
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
            return false;
        }
        srcSpec = virBufferContentAndReset(&buf);
    }

1548
    srcList = virConnectFindStoragePoolSources(priv->conn, type, srcSpec, 0);
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
    VIR_FREE(srcSpec);
    if (srcList == NULL) {
        vshError(ctl, _("Failed to find any %s pool sources"), type);
        return false;
    }
    vshPrint(ctl, "%s", srcList);
    VIR_FREE(srcList);

    return true;
}

/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
1564 1565 1566 1567 1568 1569 1570
    {.name = "help",
     .data = N_("discover potential storage pool sources")
    },
    {.name = "desc",
     .data = N_("Returns XML <sources> document.")
    },
    {.name = NULL}
1571 1572 1573
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
1574 1575 1576 1577 1578 1579
    {.name = "type",
     .type = VSH_OT_DATA,
     .flags = VSH_OFLAG_REQ,
     .help = N_("type of storage pool sources to discover")
    },
    {.name = "srcSpec",
1580
     .type = VSH_OT_STRING,
1581 1582 1583
     .help = N_("optional file of source xml to query for pools")
    },
    {.name = NULL}
1584 1585 1586 1587 1588 1589 1590
};

static bool
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
    const char *type = NULL, *srcSpecFile = NULL;
    char *srcSpec = NULL, *srcList;
1591
    virshControlPtr priv = ctl->privData;
1592

1593
    if (vshCommandOptStringReq(ctl, cmd, "type", &type) < 0)
1594 1595
        return false;

1596
    if (vshCommandOptStringReq(ctl, cmd, "srcSpec", &srcSpecFile) < 0)
1597 1598
        return false;

E
Eric Blake 已提交
1599 1600
    if (srcSpecFile && virFileReadAll(srcSpecFile, VSH_MAX_XML_FILE,
                                      &srcSpec) < 0)
1601 1602
        return false;

1603
    srcList = virConnectFindStoragePoolSources(priv->conn, type, srcSpec, 0);
1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
    VIR_FREE(srcSpec);
    if (srcList == NULL) {
        vshError(ctl, _("Failed to find any %s pool sources"), type);
        return false;
    }
    vshPrint(ctl, "%s", srcList);
    VIR_FREE(srcList);

    return true;
}

/*
 * "pool-info" command
 */
static const vshCmdInfo info_pool_info[] = {
1619 1620 1621 1622 1623 1624 1625
    {.name = "help",
     .data = N_("storage pool information")
    },
    {.name = "desc",
     .data = N_("Returns basic information about the storage pool.")
    },
    {.name = NULL}
1626 1627 1628
};

static const vshCmdOptDef opts_pool_info[] = {
1629
    VIRSH_COMMON_OPT_POOL_FULL,
1630

1631 1632 1633 1634
    {.name = "bytes",
     .type = VSH_OT_BOOL,
     .help = N_("Reture pool info in bytes"),
    },
1635
    {.name = NULL}
1636 1637 1638 1639 1640 1641 1642 1643 1644 1645
};

static bool
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
    int autostart = 0;
    int persistent = 0;
    bool ret = true;
1646
    bool bytes = false;
1647 1648
    char uuid[VIR_UUID_STRING_BUFLEN];

1649
    if (!(pool = virshCommandOptPool(ctl, cmd, "pool", NULL)))
1650 1651
        return false;

1652 1653
    bytes = vshCommandOptBool(cmd, "bytes");

1654 1655
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virStoragePoolGetName(pool));

1656
    if (virStoragePoolGetUUIDString(pool, &uuid[0]) == 0)
1657 1658 1659 1660 1661
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);

    if (virStoragePoolGetInfo(pool, &info) == 0) {
        double val;
        const char *unit;
1662
        vshPrint(ctl, "%-15s %s\n", _("State:"),
1663
                 virshStoragePoolStateToString(info.state));
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674

        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
        if (persistent < 0)
            vshPrint(ctl, "%-15s %s\n", _("Persistent:"),  _("unknown"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Persistent:"), persistent ? _("yes") : _("no"));

        /* Check and display whether the pool is autostarted or not */
1675
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
1676 1677 1678 1679 1680 1681
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

        if (info.state == VIR_STORAGE_POOL_RUNNING ||
            info.state == VIR_STORAGE_POOL_DEGRADED) {
1682 1683 1684 1685 1686 1687 1688
            if (bytes) {
                vshPrint(ctl, "%-15s %llu\n", _("Capacity:"), info.capacity);
                vshPrint(ctl, "%-15s %llu\n", _("Allocation:"), info.allocation);
                vshPrint(ctl, "%-15s %llu\n", _("Available:"), info.available);
            } else {
                val = vshPrettyCapacity(info.capacity, &unit);
                vshPrint(ctl, "%-15s %2.2lf %s\n", _("Capacity:"), val, unit);
1689

1690 1691
                val = vshPrettyCapacity(info.allocation, &unit);
                vshPrint(ctl, "%-15s %2.2lf %s\n", _("Allocation:"), val, unit);
1692

1693 1694 1695
                val = vshPrettyCapacity(info.available, &unit);
                vshPrint(ctl, "%-15s %2.2lf %s\n", _("Available:"), val, unit);
            }
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708
        }
    } else {
        ret = false;
    }

    virStoragePoolFree(pool);
    return ret;
}

/*
 * "pool-name" command
 */
static const vshCmdInfo info_pool_name[] = {
1709 1710 1711 1712 1713 1714 1715
    {.name = "help",
     .data = N_("convert a pool UUID to pool name")
    },
    {.name = "desc",
     .data = ""
    },
    {.name = NULL}
1716 1717 1718
};

static const vshCmdOptDef opts_pool_name[] = {
1719
    VIRSH_COMMON_OPT_POOL_FULL,
1720

1721
    {.name = NULL}
1722 1723 1724 1725 1726 1727 1728
};

static bool
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;

1729
    if (!(pool = virshCommandOptPoolBy(ctl, cmd, "pool", NULL, VIRSH_BYUUID)))
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
        return false;

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

/*
 * "pool-start" command
 */
static const vshCmdInfo info_pool_start[] = {
1741 1742 1743 1744 1745 1746 1747
    {.name = "help",
     .data = N_("start a (previously defined) inactive pool")
    },
    {.name = "desc",
     .data = N_("Start a pool.")
    },
    {.name = NULL}
1748 1749 1750
};

static const vshCmdOptDef opts_pool_start[] = {
1751
    VIRSH_COMMON_OPT_POOL_FULL,
1752 1753 1754
    VIRSH_COMMON_OPT_POOL_BUILD,
    VIRSH_COMMON_OPT_POOL_NO_OVERWRITE,
    VIRSH_COMMON_OPT_POOL_OVERWRITE,
1755

1756
    {.name = NULL}
1757 1758 1759 1760 1761 1762 1763 1764
};

static bool
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    bool ret = true;
    const char *name = NULL;
1765 1766 1767 1768
    bool build;
    bool overwrite;
    bool no_overwrite;
    unsigned int flags = 0;
1769

1770
    if (!(pool = virshCommandOptPool(ctl, cmd, "pool", &name)))
1771 1772
         return false;

1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787
    build = vshCommandOptBool(cmd, "build");
    overwrite = vshCommandOptBool(cmd, "overwrite");
    no_overwrite = vshCommandOptBool(cmd, "no-overwrite");

    VSH_EXCLUSIVE_OPTIONS_EXPR("overwrite", overwrite,
                               "no-overwrite", no_overwrite);

    if (build)
        flags |= VIR_STORAGE_POOL_CREATE_WITH_BUILD;
    if (overwrite)
        flags |= VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE;
    if (no_overwrite)
        flags |= VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE;

    if (virStoragePoolCreate(pool, flags) == 0) {
P
Pino Toscano 已提交
1788
        vshPrintExtra(ctl, _("Pool %s started\n"), name);
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801
    } else {
        vshError(ctl, _("Failed to start pool %s"), name);
        ret = false;
    }

    virStoragePoolFree(pool);
    return ret;
}

/*
 * "pool-undefine" command
 */
static const vshCmdInfo info_pool_undefine[] = {
1802 1803 1804 1805 1806 1807 1808
    {.name = "help",
     .data = N_("undefine an inactive pool")
    },
    {.name = "desc",
     .data = N_("Undefine the configuration for an inactive pool.")
    },
    {.name = NULL}
1809 1810 1811
};

static const vshCmdOptDef opts_pool_undefine[] = {
1812
    VIRSH_COMMON_OPT_POOL_FULL,
1813

1814
    {.name = NULL}
1815 1816 1817 1818 1819 1820 1821 1822 1823
};

static bool
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    bool ret = true;
    const char *name;

1824
    if (!(pool = virshCommandOptPool(ctl, cmd, "pool", &name)))
1825 1826 1827
        return false;

    if (virStoragePoolUndefine(pool) == 0) {
P
Pino Toscano 已提交
1828
        vshPrintExtra(ctl, _("Pool %s has been undefined\n"), name);
1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841
    } else {
        vshError(ctl, _("Failed to undefine pool %s"), name);
        ret = false;
    }

    virStoragePoolFree(pool);
    return ret;
}

/*
 * "pool-uuid" command
 */
static const vshCmdInfo info_pool_uuid[] = {
1842 1843 1844 1845 1846 1847 1848
    {.name = "help",
     .data = N_("convert a pool name to pool UUID")
    },
    {.name = "desc",
     .data = ""
    },
    {.name = NULL}
1849 1850 1851
};

static const vshCmdOptDef opts_pool_uuid[] = {
1852
    VIRSH_COMMON_OPT_POOL_FULL,
1853

1854
    {.name = NULL}
1855 1856 1857 1858 1859 1860 1861 1862
};

static bool
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

1863
    if (!(pool = virshCommandOptPoolBy(ctl, cmd, "pool", NULL, VIRSH_BYNAME)))
1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878
        return false;

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

    virStoragePoolFree(pool);
    return true;
}

/*
 * "pool-edit" command
 */
static const vshCmdInfo info_pool_edit[] = {
1879 1880 1881 1882 1883 1884 1885
    {.name = "help",
     .data = N_("edit XML configuration for a storage pool")
    },
    {.name = "desc",
     .data = N_("Edit the XML configuration for a storage pool.")
    },
    {.name = NULL}
1886 1887 1888
};

static const vshCmdOptDef opts_pool_edit[] = {
1889
    VIRSH_COMMON_OPT_POOL_FULL,
1890

1891
    {.name = NULL}
1892 1893 1894 1895 1896 1897 1898 1899 1900 1901
};

static bool
cmdPoolEdit(vshControl *ctl, const vshCmd *cmd)
{
    bool ret = false;
    virStoragePoolPtr pool = NULL;
    virStoragePoolPtr pool_edited = NULL;
    unsigned int flags = VIR_STORAGE_XML_INACTIVE;
    char *tmp_desc = NULL;
1902
    virshControlPtr priv = ctl->privData;
1903

1904
    pool = virshCommandOptPool(ctl, cmd, "pool", NULL);
1905 1906 1907 1908 1909 1910 1911
    if (pool == NULL)
        goto cleanup;

    /* Some old daemons don't support _INACTIVE flag */
    if (!(tmp_desc = virStoragePoolGetXMLDesc(pool, flags))) {
        if (last_error->code == VIR_ERR_INVALID_ARG) {
            flags &= ~VIR_STORAGE_XML_INACTIVE;
1912
            vshResetLibvirtError();
1913 1914 1915 1916 1917 1918 1919 1920
        } else {
            goto cleanup;
        }
    } else {
        VIR_FREE(tmp_desc);
    }

#define EDIT_GET_XML virStoragePoolGetXMLDesc(pool, flags)
1921 1922 1923 1924 1925 1926
#define EDIT_NOT_CHANGED                                                     \
    do {                                                                     \
        vshPrintExtra(ctl, _("Pool %s XML configuration not changed.\n"),    \
                 virStoragePoolGetName(pool));                               \
        ret = true;                                                          \
        goto edit_cleanup;                                                   \
1927
    } while (0)
1928
#define EDIT_DEFINE \
1929
    (pool_edited = virStoragePoolDefineXML(priv->conn, doc_edited, 0))
1930 1931
#include "virsh-edit.c"

1932 1933
    vshPrintExtra(ctl, _("Pool %s XML configuration edited.\n"),
                  virStoragePoolGetName(pool_edited));
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944

    ret = true;

 cleanup:
    if (pool)
        virStoragePoolFree(pool);
    if (pool_edited)
        virStoragePoolFree(pool_edited);

    return ret;
}
1945

1946 1947 1948 1949 1950 1951 1952 1953 1954
/*
 * "pool-event" command
 */
VIR_ENUM_DECL(virshPoolEvent)
VIR_ENUM_IMPL(virshPoolEvent,
              VIR_STORAGE_POOL_EVENT_LAST,
              N_("Defined"),
              N_("Undefined"),
              N_("Started"),
1955 1956 1957
              N_("Stopped"),
              N_("Created"),
              N_("Deleted"))
1958 1959 1960 1961 1962 1963 1964 1965

static const char *
virshPoolEventToString(int event)
{
    const char *str = virshPoolEventTypeToString(event);
    return str ? _(str) : _("unknown");
}

1966 1967 1968 1969 1970 1971
struct vshEventCallback {
    const char *name;
    virConnectStoragePoolEventGenericCallback cb;
};
typedef struct vshEventCallback vshEventCallback;

1972 1973 1974 1975 1976
struct virshPoolEventData {
    vshControl *ctl;
    bool loop;
    bool timestamp;
    int count;
1977
    vshEventCallback *cb;
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014
};
typedef struct virshPoolEventData virshPoolEventData;


static void
vshEventLifecyclePrint(virConnectPtr conn ATTRIBUTE_UNUSED,
                       virStoragePoolPtr pool,
                       int event,
                       int detail ATTRIBUTE_UNUSED,
                       void *opaque)
{
    virshPoolEventData *data = opaque;

    if (!data->loop && data->count)
        return;

    if (data->timestamp) {
        char timestamp[VIR_TIME_STRING_BUFLEN];

        if (virTimeStringNowRaw(timestamp) < 0)
            timestamp[0] = '\0';

        vshPrint(data->ctl, _("%s: event 'lifecycle' for storage pool %s: %s\n"),
                 timestamp,
                 virStoragePoolGetName(pool),
                 virshPoolEventToString(event));
    } else {
        vshPrint(data->ctl, _("event 'lifecycle' for storage pool %s: %s\n"),
                 virStoragePoolGetName(pool),
                 virshPoolEventToString(event));
    }

    data->count++;
    if (!data->loop)
        vshEventDone(data->ctl);
}

2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030
static void
vshEventGenericPrint(virConnectPtr conn ATTRIBUTE_UNUSED,
                     virStoragePoolPtr pool,
                     void *opaque)
{
    virshPoolEventData *data = opaque;

    if (!data->loop && data->count)
        return;

    if (data->timestamp) {
        char timestamp[VIR_TIME_STRING_BUFLEN];

        if (virTimeStringNowRaw(timestamp) < 0)
            timestamp[0] = '\0';

Y
Yuri Chornoivan 已提交
2031
        vshPrint(data->ctl, _("%s: event '%s' for storage pool %s\n"),
2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053
                 timestamp,
                 data->cb->name,
                 virStoragePoolGetName(pool));
    } else {
        vshPrint(data->ctl, _("event '%s' for storage pool %s\n"),
                 data->cb->name,
                 virStoragePoolGetName(pool));
    }

    data->count++;
    if (!data->loop)
        vshEventDone(data->ctl);
}

static vshEventCallback vshEventCallbacks[] = {
    { "lifecycle",
      VIR_STORAGE_POOL_EVENT_CALLBACK(vshEventLifecyclePrint), },
    { "refresh", vshEventGenericPrint, }
};
verify(VIR_STORAGE_POOL_EVENT_ID_LAST == ARRAY_CARDINALITY(vshEventCallbacks));


2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107
static const vshCmdInfo info_pool_event[] = {
    {.name = "help",
     .data = N_("Storage Pool Events")
    },
    {.name = "desc",
     .data = N_("List event types, or wait for storage pool events to occur")
    },
    {.name = NULL}
};

static const vshCmdOptDef opts_pool_event[] = {
    {.name = "pool",
     .type = VSH_OT_STRING,
     .help = N_("filter by storage pool name or uuid")
    },
    {.name = "event",
     .type = VSH_OT_STRING,
     .help = N_("which event type to wait for")
    },
    {.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")
    },
    {.name = "timestamp",
     .type = VSH_OT_BOOL,
     .help = N_("show timestamp for each printed event")
    },
    {.name = NULL}
};

static bool
cmdPoolEvent(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    bool ret = false;
    int eventId = -1;
    int timeout = 0;
    virshPoolEventData data;
    const char *eventName = NULL;
    int event;
    virshControlPtr priv = ctl->privData;

    if (vshCommandOptBool(cmd, "list")) {
        size_t i;

        for (i = 0; i < VIR_STORAGE_POOL_EVENT_ID_LAST; i++)
2108
            vshPrint(ctl, "%s\n", vshEventCallbacks[i].name);
2109 2110 2111 2112 2113 2114
        return true;
    }

    if (vshCommandOptStringReq(ctl, cmd, "event", &eventName) < 0)
        return false;
    if (!eventName) {
2115
        vshError(ctl, "%s", _("either --list or --event <type> is required"));
2116 2117
        return false;
    }
2118 2119 2120 2121 2122

    for (event = 0; event < VIR_STORAGE_POOL_EVENT_ID_LAST; event++)
        if (STREQ(eventName, vshEventCallbacks[event].name))
            break;
    if (event == VIR_STORAGE_POOL_EVENT_ID_LAST) {
2123 2124 2125 2126 2127 2128 2129 2130
        vshError(ctl, _("unknown event type %s"), eventName);
        return false;
    }

    data.ctl = ctl;
    data.loop = vshCommandOptBool(cmd, "loop");
    data.timestamp = vshCommandOptBool(cmd, "timestamp");
    data.count = 0;
2131
    data.cb = &vshEventCallbacks[event];
2132 2133 2134 2135 2136 2137 2138 2139 2140
    if (vshCommandOptTimeoutToMs(ctl, cmd, &timeout) < 0)
        return false;

    if (vshCommandOptBool(cmd, "pool"))
        pool = virshCommandOptPool(ctl, cmd, "pool", NULL);
    if (vshEventStart(ctl, timeout) < 0)
        goto cleanup;

    if ((eventId = virConnectStoragePoolEventRegisterAny(priv->conn, pool, event,
2141
                                                         data.cb->cb,
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170
                                                         &data, NULL)) < 0)
        goto cleanup;
    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;
    }
    vshPrint(ctl, _("events received: %d\n"), data.count);
    if (data.count)
        ret = true;

 cleanup:
    vshEventCleanup(ctl);
    if (eventId >= 0 &&
        virConnectStoragePoolEventDeregisterAny(priv->conn, eventId) < 0)
        ret = false;
    if (pool)
        virStoragePoolFree(pool);
    return ret;
}


E
Eric Blake 已提交
2171
const vshCmdDef storagePoolCmds[] = {
2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197
    {.name = "find-storage-pool-sources-as",
     .handler = cmdPoolDiscoverSourcesAs,
     .opts = opts_find_storage_pool_sources_as,
     .info = info_find_storage_pool_sources_as,
     .flags = 0
    },
    {.name = "find-storage-pool-sources",
     .handler = cmdPoolDiscoverSources,
     .opts = opts_find_storage_pool_sources,
     .info = info_find_storage_pool_sources,
     .flags = 0
    },
    {.name = "pool-autostart",
     .handler = cmdPoolAutostart,
     .opts = opts_pool_autostart,
     .info = info_pool_autostart,
     .flags = 0
    },
    {.name = "pool-build",
     .handler = cmdPoolBuild,
     .opts = opts_pool_build,
     .info = info_pool_build,
     .flags = 0
    },
    {.name = "pool-create-as",
     .handler = cmdPoolCreateAs,
2198
     .opts = opts_pool_create_as,
2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209
     .info = info_pool_create_as,
     .flags = 0
    },
    {.name = "pool-create",
     .handler = cmdPoolCreate,
     .opts = opts_pool_create,
     .info = info_pool_create,
     .flags = 0
    },
    {.name = "pool-define-as",
     .handler = cmdPoolDefineAs,
2210
     .opts = opts_pool_define_as,
2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285
     .info = info_pool_define_as,
     .flags = 0
    },
    {.name = "pool-define",
     .handler = cmdPoolDefine,
     .opts = opts_pool_define,
     .info = info_pool_define,
     .flags = 0
    },
    {.name = "pool-delete",
     .handler = cmdPoolDelete,
     .opts = opts_pool_delete,
     .info = info_pool_delete,
     .flags = 0
    },
    {.name = "pool-destroy",
     .handler = cmdPoolDestroy,
     .opts = opts_pool_destroy,
     .info = info_pool_destroy,
     .flags = 0
    },
    {.name = "pool-dumpxml",
     .handler = cmdPoolDumpXML,
     .opts = opts_pool_dumpxml,
     .info = info_pool_dumpxml,
     .flags = 0
    },
    {.name = "pool-edit",
     .handler = cmdPoolEdit,
     .opts = opts_pool_edit,
     .info = info_pool_edit,
     .flags = 0
    },
    {.name = "pool-info",
     .handler = cmdPoolInfo,
     .opts = opts_pool_info,
     .info = info_pool_info,
     .flags = 0
    },
    {.name = "pool-list",
     .handler = cmdPoolList,
     .opts = opts_pool_list,
     .info = info_pool_list,
     .flags = 0
    },
    {.name = "pool-name",
     .handler = cmdPoolName,
     .opts = opts_pool_name,
     .info = info_pool_name,
     .flags = 0
    },
    {.name = "pool-refresh",
     .handler = cmdPoolRefresh,
     .opts = opts_pool_refresh,
     .info = info_pool_refresh,
     .flags = 0
    },
    {.name = "pool-start",
     .handler = cmdPoolStart,
     .opts = opts_pool_start,
     .info = info_pool_start,
     .flags = 0
    },
    {.name = "pool-undefine",
     .handler = cmdPoolUndefine,
     .opts = opts_pool_undefine,
     .info = info_pool_undefine,
     .flags = 0
    },
    {.name = "pool-uuid",
     .handler = cmdPoolUuid,
     .opts = opts_pool_uuid,
     .info = info_pool_uuid,
     .flags = 0
    },
2286 2287 2288 2289 2290 2291
    {.name = "pool-event",
     .handler = cmdPoolEvent,
     .opts = opts_pool_event,
     .info = info_pool_event,
     .flags = 0
    },
2292
    {.name = NULL}
2293
};