storage_backend.c 50.4 KB
Newer Older
1
/*
2
 * storage_backend.c: internal storage driver backend contract
3
 *
4
 * Copyright (C) 2007-2011 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 * Copyright (C) 2007-2008 Daniel P. Berrange
 *
 * 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
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 * Author: Daniel P. Berrange <berrange@redhat.com>
 */

#include <config.h>

#include <string.h>
27
#include <stdio.h>
D
Daniel P. Berrange 已提交
28
#if HAVE_REGEX_H
29
# include <regex.h>
D
Daniel P. Berrange 已提交
30
#endif
31
#include <sys/types.h>
E
Eric Blake 已提交
32
#include <sys/wait.h>
33
#include <unistd.h>
34 35 36
#include <fcntl.h>
#include <stdint.h>
#include <sys/stat.h>
37
#include <sys/param.h>
38
#include <dirent.h>
39 40 41 42
#ifdef __linux__
# include <sys/ioctl.h>
# include <linux/fs.h>
#endif
43 44

#if HAVE_SELINUX
45
# include <selinux/selinux.h>
46
#endif
47

48
#include "datatypes.h"
49
#include "virterror_internal.h"
D
Daniel P. Berrange 已提交
50 51
#include "util.h"
#include "memory.h"
52
#include "internal.h"
53
#include "secret_conf.h"
54
#include "uuid.h"
55
#include "storage_file.h"
D
Daniel P. Berrange 已提交
56
#include "storage_backend.h"
57
#include "logging.h"
58
#include "files.h"
59

60
#if WITH_STORAGE_LVM
61
# include "storage_backend_logical.h"
62 63
#endif
#if WITH_STORAGE_ISCSI
64
# include "storage_backend_iscsi.h"
65
#endif
66
#if WITH_STORAGE_SCSI
67
# include "storage_backend_scsi.h"
68
#endif
D
Dave Allan 已提交
69
#if WITH_STORAGE_MPATH
70
# include "storage_backend_mpath.h"
D
Dave Allan 已提交
71
#endif
72
#if WITH_STORAGE_DISK
73
# include "storage_backend_disk.h"
74 75
#endif
#if WITH_STORAGE_DIR
76
# include "storage_backend_fs.h"
77 78
#endif

79 80
#define VIR_FROM_THIS VIR_FROM_STORAGE

81 82 83 84 85 86 87 88 89 90 91 92 93 94
static virStorageBackendPtr backends[] = {
#if WITH_STORAGE_DIR
    &virStorageBackendDirectory,
#endif
#if WITH_STORAGE_FS
    &virStorageBackendFileSystem,
    &virStorageBackendNetFileSystem,
#endif
#if WITH_STORAGE_LVM
    &virStorageBackendLogical,
#endif
#if WITH_STORAGE_ISCSI
    &virStorageBackendISCSI,
#endif
95 96 97
#if WITH_STORAGE_SCSI
    &virStorageBackendSCSI,
#endif
D
Dave Allan 已提交
98 99 100
#if WITH_STORAGE_MPATH
    &virStorageBackendMpath,
#endif
101 102 103 104 105
#if WITH_STORAGE_DISK
    &virStorageBackendDisk,
#endif
    NULL
};
106

107 108 109 110 111 112 113 114
static int track_allocation_progress = 0;

enum {
    TOOL_QEMU_IMG,
    TOOL_KVM_IMG,
    TOOL_QCOW_CREATE,
};

115 116 117
#define READ_BLOCK_SIZE_DEFAULT  (1024 * 1024)
#define WRITE_BLOCK_SIZE_DEFAULT (4 * 1024)

118 119
static int ATTRIBUTE_NONNULL (2)
virStorageBackendCopyToFD(virStorageVolDefPtr vol,
120 121
                          virStorageVolDefPtr inputvol,
                          int fd,
122 123
                          unsigned long long *total,
                          int is_dest_file)
124 125 126
{
    int inputfd = -1;
    int amtread = -1;
127
    int ret = 0;
128
    unsigned long long remain;
129 130 131 132
    size_t rbytes = READ_BLOCK_SIZE_DEFAULT;
    size_t wbytes = 0;
    int interval;
    char *zerobuf;
133
    char *buf = NULL;
134
    struct stat st;
135

136
    if ((inputfd = open(inputvol->target.path, O_RDONLY)) < 0) {
137
        ret = -errno;
138
        virReportSystemError(errno,
139 140 141
                             _("could not open input path '%s'"),
                             inputvol->target.path);
        goto cleanup;
142 143
    }

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
#ifdef __linux__
    if (ioctl(fd, BLKBSZGET, &wbytes) < 0) {
        wbytes = 0;
    }
#endif
    if ((wbytes == 0) && fstat(fd, &st) == 0)
        wbytes = st.st_blksize;
    if (wbytes < WRITE_BLOCK_SIZE_DEFAULT)
        wbytes = WRITE_BLOCK_SIZE_DEFAULT;

    if (VIR_ALLOC_N(zerobuf, wbytes) < 0) {
        ret = -errno;
        virReportOOMError();
        goto cleanup;
    }
159

160
    if (VIR_ALLOC_N(buf, rbytes) < 0) {
161
        ret = -errno;
162
        virReportOOMError();
163 164 165 166 167 168 169 170
        goto cleanup;
    }

    remain = *total;

    while (amtread != 0) {
        int amtleft;

171 172
        if (remain < rbytes)
            rbytes = remain;
173

174
        if ((amtread = saferead(inputfd, buf, rbytes)) < 0) {
175
            ret = -errno;
176
            virReportSystemError(errno,
177 178 179 180 181 182 183 184 185 186
                                 _("failed reading from file '%s'"),
                                 inputvol->target.path);
            goto cleanup;
        }
        remain -= amtread;

        /* Loop over amt read in 512 byte increments, looking for sparse
         * blocks */
        amtleft = amtread;
        do {
187
            interval = ((wbytes > amtleft) ? amtleft : wbytes);
188 189
            int offset = amtread - amtleft;

190
            if (is_dest_file && memcmp(buf+offset, zerobuf, interval) == 0) {
191
                if (lseek(fd, interval, SEEK_CUR) < 0) {
192
                    ret = -errno;
193
                    virReportSystemError(errno,
194 195 196 197 198
                                         _("cannot extend file '%s'"),
                                         vol->target.path);
                    goto cleanup;
                }
            } else if (safewrite(fd, buf+offset, interval) < 0) {
199
                ret = -errno;
200
                virReportSystemError(errno,
201 202 203 204 205
                                     _("failed writing to file '%s'"),
                                     vol->target.path);
                goto cleanup;

            }
206
        } while ((amtleft -= interval) > 0);
207 208
    }

209
    if (VIR_CLOSE(inputfd) < 0) {
210
        ret = -errno;
211
        virReportSystemError(errno,
212 213 214 215 216 217 218 219 220
                             _("cannot close file '%s'"),
                             inputvol->target.path);
        goto cleanup;
    }
    inputfd = -1;

    *total -= remain;

cleanup:
221
    VIR_FORCE_CLOSE(inputfd);
222

223
    VIR_FREE(zerobuf);
224 225
    VIR_FREE(buf);

226 227 228
    return ret;
}

229
static int
230
virStorageBackendCreateBlockFrom(virConnectPtr conn ATTRIBUTE_UNUSED,
231
                                 virStoragePoolObjPtr pool ATTRIBUTE_UNUSED,
232 233 234 235 236 237 238
                                 virStorageVolDefPtr vol,
                                 virStorageVolDefPtr inputvol,
                                 unsigned int flags ATTRIBUTE_UNUSED)
{
    int fd = -1;
    int ret = -1;
    unsigned long long remain;
239 240 241
    struct stat st;
    gid_t gid;
    uid_t uid;
242 243

    if ((fd = open(vol->target.path, O_RDWR)) < 0) {
244
        virReportSystemError(errno,
245 246 247 248 249 250 251 252
                             _("cannot create path '%s'"),
                             vol->target.path);
        goto cleanup;
    }

    remain = vol->allocation;

    if (inputvol) {
253
        int res = virStorageBackendCopyToFD(vol, inputvol,
254
                                            fd, &remain, 0);
255 256 257 258
        if (res < 0)
            goto cleanup;
    }

259
    if (fstat(fd, &st) == -1) {
260
        virReportSystemError(errno, _("stat of '%s' failed"),
261 262 263 264 265 266
                             vol->target.path);
        goto cleanup;
    }
    uid = (vol->target.perms.uid != st.st_uid) ? vol->target.perms.uid : -1;
    gid = (vol->target.perms.gid != st.st_gid) ? vol->target.perms.gid : -1;
    if (((uid != -1) || (gid != -1))
267
        && (fchown(fd, uid, gid) < 0)) {
268
        virReportSystemError(errno,
269
                             _("cannot chown '%s' to (%u, %u)"),
270
                             vol->target.path, uid, gid);
271 272 273
        goto cleanup;
    }
    if (fchmod(fd, vol->target.perms.mode) < 0) {
274
        virReportSystemError(errno,
275 276 277 278
                             _("cannot set mode of '%s' to %04o"),
                             vol->target.path, vol->target.perms.mode);
        goto cleanup;
    }
279
    if (VIR_CLOSE(fd) < 0) {
280
        virReportSystemError(errno,
281 282 283 284 285 286 287 288
                             _("cannot close file '%s'"),
                             vol->target.path);
        goto cleanup;
    }
    fd = -1;

    ret = 0;
cleanup:
289
    VIR_FORCE_CLOSE(fd);
290 291 292 293

    return ret;
}

294 295 296 297
struct createRawFileOpHookData {
    virStorageVolDefPtr vol;
    virStorageVolDefPtr inputvol;
};
298

299 300 301 302
static int createRawFileOpHook(int fd, void *data) {
    struct createRawFileOpHookData *hdata = data;
    int ret = 0;
    unsigned long long remain;
303

304 305
    /* Seek to the final size, so the capacity is available upfront
     * for progress reporting */
306
    if (ftruncate(fd, hdata->vol->capacity) < 0) {
307
        ret = -errno;
308
        virReportSystemError(errno,
309
                             _("cannot extend file '%s'"),
310
                             hdata->vol->target.path);
311 312 313
        goto cleanup;
    }

314
    remain = hdata->vol->allocation;
315

316
    if (hdata->inputvol) {
317 318 319
        ret = virStorageBackendCopyToFD(hdata->vol, hdata->inputvol,
                                        fd, &remain, 1);
        if (ret < 0) {
320
            goto cleanup;
321
        }
322 323 324 325 326 327 328 329 330 331 332 333 334 335
    }

    if (remain) {
        if (track_allocation_progress) {

            while (remain) {
                /* Allocate in chunks of 512MiB: big-enough chunk
                 * size and takes approx. 9s on ext3. A progress
                 * update every 9s is a fair-enough trade-off
                 */
                unsigned long long bytes = 512 * 1024 * 1024;

                if (bytes > remain)
                    bytes = remain;
336 337
                if (safezero(fd, 0, hdata->vol->allocation - remain,
                             bytes) != 0) {
338
                    ret = -errno;
J
Jiri Denemark 已提交
339
                    virReportSystemError(errno, _("cannot fill file '%s'"),
340
                                         hdata->vol->target.path);
341 342 343 344 345
                    goto cleanup;
                }
                remain -= bytes;
            }
        } else { /* No progress bars to be shown */
346
            if (safezero(fd, 0, 0, remain) != 0) {
347
                ret = -errno;
J
Jiri Denemark 已提交
348
                virReportSystemError(errno, _("cannot fill file '%s'"),
349
                                     hdata->vol->target.path);
350 351 352
                goto cleanup;
            }
        }
353

354 355 356
    }

    if (fsync(fd) < 0) {
357
        ret = -errno;
358 359 360
        virReportSystemError(errno, _("cannot sync data to file '%s'"),
                             hdata->vol->target.path);
        goto cleanup;
361 362
    }

363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
cleanup:
    return ret;
}

int
virStorageBackendCreateRaw(virConnectPtr conn ATTRIBUTE_UNUSED,
                           virStoragePoolObjPtr pool,
                           virStorageVolDefPtr vol,
                           virStorageVolDefPtr inputvol,
                           unsigned int flags ATTRIBUTE_UNUSED)
{
    int ret = -1;
    int createstat;
    struct createRawFileOpHookData hdata = { vol, inputvol };

    if (vol->target.encryption != NULL) {
        virStorageReportError(VIR_ERR_NO_SUPPORT,
                              "%s", _("storage pool does not support encrypted "
                                      "volumes"));
382 383
        goto cleanup;
    }
384

385 386 387
    uid_t uid = (vol->target.perms.uid == -1) ? getuid() : vol->target.perms.uid;
    gid_t gid = (vol->target.perms.gid == -1) ? getgid() : vol->target.perms.gid;

388
    if ((createstat = virFileOperation(vol->target.path,
389
                                       O_RDWR | O_CREAT | O_EXCL,
390
                                       vol->target.perms.mode, uid, gid,
391 392 393 394
                                       createRawFileOpHook, &hdata,
                                       VIR_FILE_OP_FORCE_PERMS |
                                       (pool->def->type == VIR_STORAGE_POOL_NETFS
                                        ? VIR_FILE_OP_AS_UID : 0))) < 0) {
395
    virReportSystemError(-createstat,
396 397 398 399
                         _("cannot create path '%s'"),
                         vol->target.path);
    goto cleanup;
    }
400 401 402 403 404 405

    ret = 0;
cleanup:
    return ret;
}

406 407 408 409 410 411 412 413 414
static int
virStorageGenerateSecretUUID(virConnectPtr conn,
                             unsigned char *uuid)
{
    unsigned attempt;

    for (attempt = 0; attempt < 65536; attempt++) {
        virSecretPtr tmp;
        if (virUUIDGenerate(uuid) < 0) {
415 416
            virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                                  _("unable to generate uuid"));
417 418 419 420 421 422 423 424 425
            return -1;
        }
        tmp = conn->secretDriver->lookupByUUID(conn, uuid);
        if (tmp == NULL)
            return 0;

        virSecretFree(tmp);
    }

426 427
    virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                          _("too many conflicts when generating an uuid"));
428 429 430 431

    return -1;
}

432 433 434 435 436 437 438 439 440
static int
virStorageGenerateQcowEncryption(virConnectPtr conn,
                                 virStorageVolDefPtr vol)
{
    virSecretDefPtr def = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    virStorageEncryptionPtr enc;
    virStorageEncryptionSecretPtr enc_secret = NULL;
    virSecretPtr secret = NULL;
441
    char *xml;
442 443 444
    unsigned char value[VIR_STORAGE_QCOW_PASSPHRASE_SIZE];
    int ret = -1;

445 446 447
    if (conn->secretDriver == NULL ||
        conn->secretDriver->lookupByUUID == NULL ||
        conn->secretDriver->defineXML == NULL ||
448
        conn->secretDriver->setValue == NULL) {
449
        virStorageReportError(VIR_ERR_NO_SUPPORT, "%s",
450 451 452 453 454 455
                              _("secret storage not supported"));
        goto cleanup;
    }

    enc = vol->target.encryption;
    if (enc->nsecrets != 0) {
456
        virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
457 458 459 460 461 462
                              _("secrets already defined"));
        goto cleanup;
    }

    if (VIR_ALLOC(enc_secret) < 0 || VIR_REALLOC_N(enc->secrets, 1) < 0 ||
        VIR_ALLOC(def) < 0) {
463
        virReportOOMError();
464 465 466 467 468
        goto cleanup;
    }

    def->ephemeral = 0;
    def->private = 0;
469
    if (virStorageGenerateSecretUUID(conn, def->uuid) < 0)
470
        goto cleanup;
471

472 473 474
    def->usage_type = VIR_SECRET_USAGE_TYPE_VOLUME;
    def->usage.volume = strdup(vol->target.path);
    if (def->usage.volume == NULL) {
475
        virReportOOMError();
476 477
        goto cleanup;
    }
478
    xml = virSecretDefFormat(def);
479 480 481 482 483 484 485 486 487 488 489 490
    virSecretDefFree(def);
    def = NULL;
    if (xml == NULL)
        goto cleanup;

    secret = conn->secretDriver->defineXML(conn, xml, 0);
    if (secret == NULL) {
        VIR_FREE(xml);
        goto cleanup;
    }
    VIR_FREE(xml);

491
    if (virStorageGenerateQcowPassphrase(value) < 0)
492 493 494 495 496 497
        goto cleanup;

    if (conn->secretDriver->setValue(secret, value, sizeof(value), 0) < 0)
        goto cleanup;

    enc_secret->type = VIR_STORAGE_ENCRYPTION_SECRET_TYPE_PASSPHRASE;
498
    memcpy(enc_secret->uuid, secret->uuid, VIR_UUID_BUFLEN);
499 500 501 502 503 504 505 506 507
    enc->format = VIR_STORAGE_ENCRYPTION_FORMAT_QCOW;
    enc->secrets[0] = enc_secret; /* Space for secrets[0] allocated above */
    enc_secret = NULL;
    enc->nsecrets = 1;

    ret = 0;

cleanup:
    if (secret != NULL) {
508 509
        if (ret != 0 &&
            conn->secretDriver->undefine != NULL)
510 511 512
            conn->secretDriver->undefine(secret);
        virSecretFree(secret);
    }
513
    virBufferFreeAndReset(&buf);
514 515 516 517 518
    virSecretDefFree(def);
    VIR_FREE(enc_secret);
    return ret;
}

519 520 521
static int virStorageBuildSetUIDHook(void *data) {
    virStorageVolDefPtr vol = data;

522
    if ((vol->target.perms.gid != -1)
523
        && (setgid(vol->target.perms.gid) != 0)) {
524
        virReportSystemError(errno,
525 526 527 528
                             _("Cannot set gid to %u before creating %s"),
                             vol->target.perms.gid, vol->target.path);
        return -1;
    }
529
    if ((vol->target.perms.uid != -1)
530
        && (setuid(vol->target.perms.uid) != 0)) {
531
        virReportSystemError(errno,
532 533 534 535 536 537 538
                             _("Cannot set uid to %u before creating %s"),
                             vol->target.perms.uid, vol->target.path);
        return -1;
    }
    return 0;
}

539
static int virStorageBackendCreateExecCommand(virStoragePoolObjPtr pool,
540 541 542 543 544 545 546 547
                                              virStorageVolDefPtr vol,
                                              const char **cmdargv) {
    struct stat st;
    gid_t gid;
    uid_t uid;
    int filecreated = 0;

    if ((pool->def->type == VIR_STORAGE_POOL_NETFS)
548 549 550 551 552
        && (((getuid() == 0)
             && (vol->target.perms.uid != -1)
             && (vol->target.perms.uid != 0))
            || ((vol->target.perms.gid != -1)
                && (vol->target.perms.gid != getgid())))) {
553
        if (virRunWithHook(cmdargv,
554 555 556 557 558 559 560
                           virStorageBuildSetUIDHook, vol, NULL) == 0) {
            /* command was successfully run, check if the file was created */
            if (stat(vol->target.path, &st) >=0)
                filecreated = 1;
        }
    }
    if (!filecreated) {
561
        if (virRun(cmdargv, NULL) < 0) {
562 563 564
            return -1;
        }
        if (stat(vol->target.path, &st) < 0) {
565
            virReportSystemError(errno,
566 567 568 569 570 571 572 573 574 575
                                 _("%s failed to create %s"),
                                 cmdargv[0], vol->target.path);
            return -1;
        }
    }

    uid = (vol->target.perms.uid != st.st_uid) ? vol->target.perms.uid : -1;
    gid = (vol->target.perms.gid != st.st_gid) ? vol->target.perms.gid : -1;
    if (((uid != -1) || (gid != -1))
        && (chown(vol->target.path, uid, gid) < 0)) {
576
        virReportSystemError(errno,
577
                             _("cannot chown %s to (%u, %u)"),
578
                             vol->target.path, uid, gid);
579 580 581
        return -1;
    }
    if (chmod(vol->target.path, vol->target.perms.mode) < 0) {
582
        virReportSystemError(errno,
583 584 585 586 587 588 589
                             _("cannot set mode of '%s' to %04o"),
                             vol->target.path, vol->target.perms.mode);
        return -1;
    }
    return 0;
}

590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
enum {
    QEMU_IMG_BACKING_FORMAT_NONE = 0,
    QEMU_IMG_BACKING_FORMAT_FLAG,
    QEMU_IMG_BACKING_FORMAT_OPTIONS,
};

static int virStorageBackendQEMUImgBackingFormat(const char *qemuimg)
{
    const char *const qemuarg[] = { qemuimg, "-h", NULL };
    const char *const qemuenv[] = { "LC_ALL=C", NULL };
    pid_t child = 0;
    int status;
    int newstdout = -1;
    char *help = NULL;
    enum { MAX_HELP_OUTPUT_SIZE = 1024*8 };
    char *start;
    char *end;
    char *tmp;
    int ret = -1;

    if (virExec(qemuarg, qemuenv, NULL,
                &child, -1, &newstdout, NULL, VIR_EXEC_CLEAR_CAPS) < 0)
        goto cleanup;

E
Eric Blake 已提交
614
    if (virFileReadLimFD(newstdout, MAX_HELP_OUTPUT_SIZE, &help) < 0) {
615 616 617 618 619 620 621 622
        virReportSystemError(errno,
                             _("Unable to read '%s -h' output"),
                             qemuimg);
        goto cleanup;
    }

    start = strstr(help, " create ");
    end = strstr(start, "\n");
623 624
    if (((tmp = strstr(start, "-F fmt")) && tmp < end) ||
        ((tmp = strstr(start, "-F backing_fmt")) && tmp < end))
625 626 627 628 629 630 631 632
        ret = QEMU_IMG_BACKING_FORMAT_FLAG;
    else if ((tmp = strstr(start, "[-o options]")) && tmp < end)
        ret = QEMU_IMG_BACKING_FORMAT_OPTIONS;
    else
        ret = QEMU_IMG_BACKING_FORMAT_NONE;

cleanup:
    VIR_FREE(help);
633
    VIR_FORCE_CLOSE(newstdout);
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
rewait:
    if (child) {
        if (waitpid(child, &status, 0) != child) {
            if (errno == EINTR)
                goto rewait;

            VIR_ERROR(_("Unexpected exit status from qemu %d pid %lu"),
                      WEXITSTATUS(status), (unsigned long)child);
        }
        if (WEXITSTATUS(status) != 0) {
            VIR_WARN("Unexpected exit status '%d', qemu probably failed",
                     WEXITSTATUS(status));
        }
    }

    return ret;
}


653 654
static int
virStorageBackendCreateQemuImg(virConnectPtr conn,
655
                               virStoragePoolObjPtr pool,
656
                               virStorageVolDefPtr vol,
657 658
                               virStorageVolDefPtr inputvol,
                               unsigned int flags ATTRIBUTE_UNUSED)
659
{
660
    int ret = -1;
E
Eric Blake 已提交
661
    char *size = NULL;
662
    char *create_tool;
663
    int imgformat = -1;
664

665
    const char *type = virStorageFileFormatTypeToString(vol->target.format);
666
    const char *backingType = vol->backingStore.path ?
667
        virStorageFileFormatTypeToString(vol->backingStore.format) : NULL;
668 669 670 671 672 673

    const char *inputBackingPath = (inputvol ? inputvol->backingStore.path
                                             : NULL);
    const char *inputPath = inputvol ? inputvol->target.path : NULL;
    /* Treat input block devices as 'raw' format */
    const char *inputType = inputPath ?
674 675 676 677
        virStorageFileFormatTypeToString(inputvol->type == VIR_STORAGE_VOL_BLOCK ?
                                         VIR_STORAGE_FILE_RAW :
                                         inputvol->target.format) :
        NULL;
678 679

    if (type == NULL) {
680
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
681 682 683 684 685
                              _("unknown storage vol type %d"),
                              vol->target.format);
        return -1;
    }
    if (inputvol && inputType == NULL) {
686
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
687 688 689 690 691 692 693 694 695 696 697 698 699 700
                              _("unknown storage vol type %d"),
                              inputvol->target.format);
        return -1;
    }

    if (vol->backingStore.path) {

        /* XXX: Not strictly required: qemu-img has an option a different
         * backing store, not really sure what use it serves though, and it
         * may cause issues with lvm. Untested essentially.
         */
        if (inputvol &&
            (!inputBackingPath ||
             STRNEQ(inputBackingPath, vol->backingStore.path))) {
701
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
702 703 704 705 706 707
                                  "%s", _("a different backing store can not "
                                          "be specified."));
            return -1;
        }

        if (backingType == NULL) {
708
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
709 710 711 712 713
                                  _("unknown storage vol backing store type %d"),
                                  vol->backingStore.format);
            return -1;
        }
        if (access(vol->backingStore.path, R_OK) != 0) {
714
            virReportSystemError(errno,
715 716 717 718 719 720
                                 _("inaccessible backing store volume %s"),
                                 vol->backingStore.path);
            return -1;
        }
    }

721
    if (vol->target.encryption != NULL) {
722 723
        virStorageEncryptionPtr enc;

724 725
        if (vol->target.format != VIR_STORAGE_FILE_QCOW &&
            vol->target.format != VIR_STORAGE_FILE_QCOW2) {
726
            virStorageReportError(VIR_ERR_NO_SUPPORT,
727 728 729 730
                                  _("qcow volume encryption unsupported with "
                                    "volume format %s"), type);
            return -1;
        }
731 732 733
        enc = vol->target.encryption;
        if (enc->format != VIR_STORAGE_ENCRYPTION_FORMAT_QCOW &&
            enc->format != VIR_STORAGE_ENCRYPTION_FORMAT_DEFAULT) {
734
            virStorageReportError(VIR_ERR_NO_SUPPORT,
735 736 737 738
                                  _("unsupported volume encryption format %d"),
                                  vol->target.encryption->format);
            return -1;
        }
739
        if (enc->nsecrets > 1) {
740
            virStorageReportError(VIR_ERR_XML_ERROR, "%s",
741 742 743
                                  _("too many secrets for qcow encryption"));
            return -1;
        }
744 745 746 747 748
        if (enc->format == VIR_STORAGE_ENCRYPTION_FORMAT_DEFAULT ||
            enc->nsecrets == 0) {
            if (virStorageGenerateQcowEncryption(conn, vol) < 0)
                return -1;
        }
749 750
    }

751
    /* Size in KB */
752
    if (virAsprintf(&size, "%lluK", VIR_DIV_UP(vol->capacity, 1024)) < 0) {
E
Eric Blake 已提交
753 754 755
        virReportOOMError();
        goto cleanup;
    }
756 757 758 759 760 761 762

    /* KVM is usually ahead of qemu on features, so try that first */
    create_tool = virFindFileInPath("kvm-img");
    if (!create_tool)
        create_tool = virFindFileInPath("qemu-img");

    if (!create_tool) {
763
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
764
                              "%s", _("unable to find kvm-img or qemu-img"));
765 766 767
        return -1;
    }

768 769 770 771
    imgformat = virStorageBackendQEMUImgBackingFormat(create_tool);
    if (imgformat < 0)
        goto cleanup;

772
    if (inputvol) {
773 774 775 776 777 778 779 780
        const char *imgargv[] = {
            create_tool,
            "convert",
            "-f", inputType,
            "-O", type,
            inputPath,
            vol->target.path,
            NULL,
781 782
            NULL,
            NULL
783 784
        };

785
        if (vol->target.encryption != NULL) {
786
            if (imgformat == QEMU_IMG_BACKING_FORMAT_OPTIONS) {
787 788 789 790 791 792 793
                imgargv[8] = "-o";
                imgargv[9] = "encryption=on";
            } else {
                imgargv[8] = "-e";
            }
        }

794
        ret = virStorageBackendCreateExecCommand(pool, vol, imgargv);
795
    } else if (vol->backingStore.path) {
796 797 798 799 800 801 802 803 804 805 806 807 808
        const char *imgargv[] = {
            create_tool,
            "create",
            "-f", type,
            "-b", vol->backingStore.path,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL
        };

809
        char *optflag = NULL;
810 811 812 813 814 815
        switch (imgformat) {
        case QEMU_IMG_BACKING_FORMAT_FLAG:
            imgargv[6] = "-F";
            imgargv[7] = backingType;
            imgargv[8] = vol->target.path;
            imgargv[9] = size;
816
            if (vol->target.encryption != NULL)
817 818 819 820 821 822 823 824
                imgargv[10] = "-e";
            break;

        case QEMU_IMG_BACKING_FORMAT_OPTIONS:
            if (virAsprintf(&optflag, "backing_fmt=%s", backingType) < 0) {
                virReportOOMError();
                goto cleanup;
            }
825 826 827 828 829 830 831 832 833 834 835

            if (vol->target.encryption != NULL) {
                char *tmp = NULL;
                if (virAsprintf(&tmp, "%s,%s", optflag, "encryption=on") < 0) {
                    virReportOOMError();
                    goto cleanup;
                }
                VIR_FREE(optflag);
                optflag = tmp;
            }

836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
            imgargv[6] = "-o";
            imgargv[7] = optflag;
            imgargv[8] = vol->target.path;
            imgargv[9] = size;

        default:
            VIR_INFO("Unable to set backing store format for %s with %s",
                     vol->target.path, create_tool);
            imgargv[6] = vol->target.path;
            imgargv[7] = size;
            if (vol->target.encryption != NULL)
                imgargv[8] = "-e";
        }

        ret = virStorageBackendCreateExecCommand(pool, vol, imgargv);
        VIR_FREE(optflag);
852
    } else {
853 854 855 856 857 858 859 860
        /* The extra NULL field is for indicating encryption (-e). */
        const char *imgargv[] = {
            create_tool,
            "create",
            "-f", type,
            vol->target.path,
            size,
            NULL,
861
            NULL,
862 863
            NULL
        };
864 865

        if (vol->target.encryption != NULL) {
866
            if (imgformat == QEMU_IMG_BACKING_FORMAT_OPTIONS) {
867 868 869 870 871 872
                imgargv[6] = "-o";
                imgargv[7] = "encryption=on";
            } else {
                imgargv[6] = "-e";
            }
        }
873

874 875
        ret = virStorageBackendCreateExecCommand(pool, vol, imgargv);
    }
876

877
    cleanup:
E
Eric Blake 已提交
878
    VIR_FREE(size);
879
    VIR_FREE(create_tool);
880

881
    return ret;
882 883 884 885 886 887 888
}

/*
 * Xen removed the fully-functional qemu-img, and replaced it
 * with a partially functional qcow-create. Go figure ??!?
 */
static int
889
virStorageBackendCreateQcowCreate(virConnectPtr conn ATTRIBUTE_UNUSED,
890
                                  virStoragePoolObjPtr pool,
891
                                  virStorageVolDefPtr vol,
892 893
                                  virStorageVolDefPtr inputvol,
                                  unsigned int flags ATTRIBUTE_UNUSED)
894
{
895
    int ret;
E
Eric Blake 已提交
896
    char *size;
897 898 899
    const char *imgargv[4];

    if (inputvol) {
900
        virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
901 902 903 904
                              _("cannot copy from volume with qcow-create"));
        return -1;
    }

905
    if (vol->target.format != VIR_STORAGE_FILE_QCOW2) {
906
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
907 908 909 910 911
                              _("unsupported storage vol type %d"),
                              vol->target.format);
        return -1;
    }
    if (vol->backingStore.path != NULL) {
912
        virStorageReportError(VIR_ERR_NO_SUPPORT, "%s",
913
                              _("copy-on-write image not supported with "
914
                                      "qcow-create"));
915 916
        return -1;
    }
917
    if (vol->target.encryption != NULL) {
918
        virStorageReportError(VIR_ERR_NO_SUPPORT,
919 920 921 922
                              "%s", _("encrypted volumes not supported with "
                                      "qcow-create"));
        return -1;
    }
923 924

    /* Size in MB - yes different units to qemu-img :-( */
925 926
    if (virAsprintf(&size, "%llu",
                    VIR_DIV_UP(vol->capacity, (1024 * 1024))) < 0) {
E
Eric Blake 已提交
927 928 929
        virReportOOMError();
        return -1;
    }
930 931 932 933 934 935

    imgargv[0] = virFindFileInPath("qcow-create");
    imgargv[1] = size;
    imgargv[2] = vol->target.path;
    imgargv[3] = NULL;

936
    ret = virStorageBackendCreateExecCommand(pool, vol, imgargv);
937
    VIR_FREE(imgargv[0]);
E
Eric Blake 已提交
938
    VIR_FREE(size);
939

940
    return ret;
941 942
}

943
virStorageBackendBuildVolFrom
944
virStorageBackendFSImageToolTypeToFunc(int tool_type)
945 946 947 948 949 950 951 952
{
    switch (tool_type) {
    case TOOL_KVM_IMG:
    case TOOL_QEMU_IMG:
        return virStorageBackendCreateQemuImg;
    case TOOL_QCOW_CREATE:
        return virStorageBackendCreateQcowCreate;
    default:
953
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
                              _("Unknown file create tool type '%d'."),
                              tool_type);
    }

    return NULL;
}

int
virStorageBackendFindFSImageTool(char **tool)
{
    int tool_type = -1;
    char *tmp = NULL;

    if ((tmp = virFindFileInPath("kvm-img")) != NULL) {
        tool_type = TOOL_KVM_IMG;
    } else if ((tmp = virFindFileInPath("qemu-img")) != NULL) {
        tool_type = TOOL_QEMU_IMG;
    } else if ((tmp = virFindFileInPath("qcow-create")) != NULL) {
        tool_type = TOOL_QCOW_CREATE;
    }

    if (tool)
        *tool = tmp;
    else
        VIR_FREE(tmp);

    return tool_type;
}

983
virStorageBackendBuildVolFrom
984
virStorageBackendGetBuildVolFromFunction(virStorageVolDefPtr vol,
985 986 987 988 989 990 991 992 993 994 995
                                         virStorageVolDefPtr inputvol)
{
    int tool_type;

    if (!inputvol)
        return NULL;

    /* If either volume is a non-raw file vol, we need to use an external
     * tool for converting
     */
    if ((vol->type == VIR_STORAGE_VOL_FILE &&
996
         vol->target.format != VIR_STORAGE_FILE_RAW) ||
997
        (inputvol->type == VIR_STORAGE_VOL_FILE &&
998
         inputvol->target.format != VIR_STORAGE_FILE_RAW)) {
999

D
Daniel P. Berrange 已提交
1000
        if ((tool_type = virStorageBackendFindFSImageTool(NULL)) < 0) {
1001
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
1002 1003 1004 1005 1006
                                  "%s", _("creation of non-raw file images is "
                                          "not supported without qemu-img."));
            return NULL;
        }

1007
        return virStorageBackendFSImageToolTypeToFunc(tool_type);
1008 1009
    }

1010 1011 1012 1013
    if (vol->type == VIR_STORAGE_VOL_BLOCK)
        return virStorageBackendCreateBlockFrom;
    else
        return virStorageBackendCreateRaw;
1014
}
1015

1016

1017 1018
virStorageBackendPtr
virStorageBackendForType(int type) {
1019
    unsigned int i;
1020
    for (i = 0; backends[i]; i++)
1021 1022 1023
        if (backends[i]->type == type)
            return backends[i];

1024
    virStorageReportError(VIR_ERR_INTERNAL_ERROR,
1025 1026 1027 1028 1029
                          _("missing backend for pool type %d"), type);
    return NULL;
}


1030 1031 1032
/*
 * Allows caller to silently ignore files with improper mode
 *
1033 1034
 * Returns -1 on error, -2 if file mode is unexpected or the
 * volume is a dangling symbolic link.
1035
 */
1036
int
1037
virStorageBackendVolOpenCheckMode(const char *path, unsigned int flags)
1038
{
1039 1040
    int fd, mode = 0;
    struct stat sb;
1041

1042
    if ((fd = open(path, O_RDONLY|O_NONBLOCK|O_NOCTTY)) < 0) {
1043 1044 1045 1046 1047 1048
        if ((errno == ENOENT || errno == ELOOP) &&
            lstat(path, &sb) == 0) {
            VIR_WARN("ignoring dangling symlink '%s'", path);
            return -2;
        }

1049
        virReportSystemError(errno,
1050
                             _("cannot open volume '%s'"),
1051
                             path);
1052 1053 1054
        return -1;
    }

1055 1056 1057 1058
    if (fstat(fd, &sb) < 0) {
        virReportSystemError(errno,
                             _("cannot stat file '%s'"),
                             path);
1059
        VIR_FORCE_CLOSE(fd);
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
        return -1;
    }

    if (S_ISREG(sb.st_mode))
        mode = VIR_STORAGE_VOL_OPEN_REG;
    else if (S_ISCHR(sb.st_mode))
        mode = VIR_STORAGE_VOL_OPEN_CHAR;
    else if (S_ISBLK(sb.st_mode))
        mode = VIR_STORAGE_VOL_OPEN_BLOCK;

    if (!(mode & flags)) {
1071
        VIR_FORCE_CLOSE(fd);
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101

        if (mode & VIR_STORAGE_VOL_OPEN_ERROR) {
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
                                  _("unexpected storage mode for '%s'"), path);
            return -1;
        }

        return -2;
    }

    return fd;
}

int virStorageBackendVolOpen(const char *path)
{
    return virStorageBackendVolOpenCheckMode(path,
                                             VIR_STORAGE_VOL_OPEN_DEFAULT);
}

int
virStorageBackendUpdateVolTargetInfo(virStorageVolTargetPtr target,
                                     unsigned long long *allocation,
                                     unsigned long long *capacity)
{
    int ret, fd;

    if ((ret = virStorageBackendVolOpen(target->path)) < 0)
        return ret;

    fd = ret;
1102
    ret = virStorageBackendUpdateVolTargetInfoFD(target,
1103 1104 1105
                                                 fd,
                                                 allocation,
                                                 capacity);
1106

1107
    VIR_FORCE_CLOSE(fd);
1108 1109 1110 1111

    return ret;
}

1112
int
1113
virStorageBackendUpdateVolInfo(virStorageVolDefPtr vol,
1114 1115 1116 1117
                               int withCapacity)
{
    int ret;

1118
    if ((ret = virStorageBackendUpdateVolTargetInfo(&vol->target,
1119 1120 1121 1122 1123
                                                    &vol->allocation,
                                                    withCapacity ? &vol->capacity : NULL)) < 0)
        return ret;

    if (vol->backingStore.path &&
1124
        (ret = virStorageBackendUpdateVolTargetInfo(&vol->backingStore,
1125 1126 1127 1128 1129 1130
                                                    NULL, NULL)) < 0)
        return ret;

    return 0;
}

1131 1132 1133 1134
/*
 * virStorageBackendUpdateVolTargetInfoFD:
 * @conn: connection to report errors on
 * @target: target definition ptr of volume to update
1135
 * @fd: fd of storage volume to update, via virStorageBackendOpenVol*
1136 1137 1138
 * @allocation: If not NULL, updated allocation information will be stored
 * @capacity: If not NULL, updated capacity info will be stored
 *
1139
 * Returns 0 for success, -1 on a legitimate error condition.
1140
 */
1141
int
1142
virStorageBackendUpdateVolTargetInfoFD(virStorageVolTargetPtr target,
1143 1144 1145
                                       int fd,
                                       unsigned long long *allocation,
                                       unsigned long long *capacity)
1146 1147 1148 1149 1150 1151 1152
{
    struct stat sb;
#if HAVE_SELINUX
    security_context_t filecon = NULL;
#endif

    if (fstat(fd, &sb) < 0) {
1153
        virReportSystemError(errno,
1154
                             _("cannot stat file '%s'"),
1155
                             target->path);
1156 1157 1158
        return -1;
    }

1159 1160
    if (allocation) {
        if (S_ISREG(sb.st_mode)) {
1161
#ifndef WIN32
1162
            *allocation = (unsigned long long)sb.st_blocks *
1163
                          (unsigned long long)DEV_BSIZE;
D
Daniel P. Berrange 已提交
1164
#else
1165
            *allocation = sb.st_size;
D
Daniel P. Berrange 已提交
1166
#endif
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
            /* Regular files may be sparse, so logical size (capacity) is not same
             * as actual allocation above
             */
            if (capacity)
                *capacity = sb.st_size;
        } else {
            off_t end;
            /* XXX this is POSIX compliant, but doesn't work for for CHAR files,
             * only BLOCK. There is a Linux specific ioctl() for getting
             * size of both CHAR / BLOCK devices we should check for in
             * configure
             */
            end = lseek(fd, 0, SEEK_END);
            if (end == (off_t)-1) {
1181
                virReportSystemError(errno,
1182 1183 1184 1185 1186 1187 1188
                                     _("cannot seek to end of file '%s'"),
                                     target->path);
                return -1;
            }
            *allocation = end;
            if (capacity)
                *capacity = end;
1189 1190 1191
        }
    }

1192 1193 1194
    target->perms.mode = sb.st_mode & S_IRWXUGO;
    target->perms.uid = sb.st_uid;
    target->perms.gid = sb.st_gid;
1195

1196
    VIR_FREE(target->perms.label);
1197 1198

#if HAVE_SELINUX
1199
    /* XXX: make this a security driver call */
1200
    if (fgetfilecon(fd, &filecon) == -1) {
1201
        if (errno != ENODATA && errno != ENOTSUP) {
1202
            virReportSystemError(errno,
1203
                                 _("cannot get file context of '%s'"),
1204
                                 target->path);
1205 1206
            return -1;
        } else {
1207
            target->perms.label = NULL;
1208 1209
        }
    } else {
1210
        target->perms.label = strdup(filecon);
1211
        freecon(filecon);
1212
        if (target->perms.label == NULL) {
1213
            virReportOOMError();
1214 1215
            return -1;
        }
1216 1217
    }
#else
1218
    target->perms.label = NULL;
1219 1220 1221 1222 1223
#endif

    return 0;
}

D
Dave Allan 已提交
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258

struct diskType {
    int part_table_type;
    unsigned short offset;
    unsigned short length;
    unsigned long long magic;
};


static struct diskType const disk_types[] = {
    { VIR_STORAGE_POOL_DISK_LVM2, 0x218, 8, 0x31303020324D564CULL },
    { VIR_STORAGE_POOL_DISK_GPT,  0x200, 8, 0x5452415020494645ULL },
    { VIR_STORAGE_POOL_DISK_DVH,  0x0,   4, 0x41A9E50BULL },
    { VIR_STORAGE_POOL_DISK_MAC,  0x0,   2, 0x5245ULL },
    { VIR_STORAGE_POOL_DISK_BSD,  0x40,  4, 0x82564557ULL },
    { VIR_STORAGE_POOL_DISK_SUN,  0x1fc, 2, 0xBEDAULL },
    /*
     * NOTE: pc98 is funky; the actual signature is 0x55AA (just like dos), so
     * we can't use that.  At the moment I'm relying on the "dummy" IPL
     * bootloader data that comes from parted.  Luckily, the chances of running
     * into a pc98 machine running libvirt are approximately nil.
     */
    /*{ 0x1fe, 2, 0xAA55UL },*/
    { VIR_STORAGE_POOL_DISK_PC98, 0x0,   8, 0x314C5049000000CBULL },
    /*
     * NOTE: the order is important here; some other disk types (like GPT and
     * and PC98) also have 0x55AA at this offset.  For that reason, the DOS
     * one must be the last one.
     */
    { VIR_STORAGE_POOL_DISK_DOS,  0x1fe, 2, 0xAA55ULL },
    { -1,                         0x0,   0, 0x0ULL },
};


int
1259 1260
virStorageBackendDetectBlockVolFormatFD(virStorageVolTargetPtr target,
                                        int fd)
D
Dave Allan 已提交
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
{
    int i;
    off_t start;
    unsigned char buffer[1024];
    ssize_t bytes;

    /* make sure to set the target format "unknown" to begin with */
    target->format = VIR_STORAGE_POOL_DISK_UNKNOWN;

    start = lseek(fd, 0, SEEK_SET);
    if (start < 0) {
1272
        virReportSystemError(errno,
D
Dave Allan 已提交
1273 1274 1275 1276 1277 1278
                             _("cannot seek to beginning of file '%s'"),
                             target->path);
        return -1;
    }
    bytes = saferead(fd, buffer, sizeof(buffer));
    if (bytes < 0) {
1279
        virReportSystemError(errno,
D
Dave Allan 已提交
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
                             _("cannot read beginning of file '%s'"),
                             target->path);
        return -1;
    }

    for (i = 0; disk_types[i].part_table_type != -1; i++) {
        if (disk_types[i].offset + disk_types[i].length > bytes)
            continue;
        if (memcmp(buffer+disk_types[i].offset, &disk_types[i].magic,
            disk_types[i].length) == 0) {
            target->format = disk_types[i].part_table_type;
            break;
        }
    }

    return 0;
}


1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
/*
 * Given a volume path directly in /dev/XXX, iterate over the
 * entries in the directory pool->def->target.path and find the
 * first symlink pointing to the volume path.
 *
 * If, the target.path is /dev/, then return the original volume
 * path.
 *
 * If no symlink is found, then return the original volume path
 *
 * Typically target.path is one of the /dev/disk/by-XXX dirs
 * with stable paths.
 */
char *
1313
virStorageBackendStablePath(virStoragePoolObjPtr pool,
1314
                            const char *devpath)
1315 1316 1317
{
    DIR *dh;
    struct dirent *dent;
1318
    char *stablepath;
1319
    int opentries = 0;
1320 1321 1322 1323 1324

    /* Short circuit if pool has no target, or if its /dev */
    if (pool->def->target.path == NULL ||
        STREQ(pool->def->target.path, "/dev") ||
        STREQ(pool->def->target.path, "/dev/"))
1325
        goto ret_strdup;
1326

1327 1328 1329 1330 1331 1332
    /* Skip whole thing for a pool which isn't in /dev
     * so we don't mess will filesystem/dir based pools
     */
    if (!STRPREFIX(pool->def->target.path, "/dev"))
        goto ret_strdup;

1333 1334 1335
    /* We loop here because /dev/disk/by-{id,path} may not have existed
     * before we started this operation, so we have to give it some time to
     * get created.
1336
     */
1337
 reopen:
1338
    if ((dh = opendir(pool->def->target.path)) == NULL) {
1339 1340 1341 1342 1343
        opentries++;
        if (errno == ENOENT && opentries < 50) {
            usleep(100 * 1000);
            goto reopen;
        }
1344
        virReportSystemError(errno,
1345 1346
                             _("cannot read dir '%s'"),
                             pool->def->target.path);
1347 1348 1349
        return NULL;
    }

1350 1351 1352 1353 1354
    /* The pool is pointing somewhere like /dev/disk/by-path
     * or /dev/disk/by-id, so we need to check all symlinks in
     * the target directory and figure out which one points
     * to this device node
     */
1355 1356 1357 1358
    while ((dent = readdir(dh)) != NULL) {
        if (dent->d_name[0] == '.')
            continue;

1359 1360 1361
        if (virAsprintf(&stablepath, "%s/%s",
                        pool->def->target.path,
                        dent->d_name) == -1) {
1362
            virReportOOMError();
1363 1364 1365 1366 1367 1368 1369 1370 1371
            closedir(dh);
            return NULL;
        }

        if (virFileLinkPointsTo(stablepath, devpath)) {
            closedir(dh);
            return stablepath;
        }

1372
        VIR_FREE(stablepath);
1373 1374 1375 1376
    }

    closedir(dh);

1377
 ret_strdup:
1378 1379 1380
    /* Couldn't find any matching stable link so give back
     * the original non-stable dev path
     */
1381 1382 1383 1384

    stablepath = strdup(devpath);

    if (stablepath == NULL)
1385
        virReportOOMError();
1386 1387

    return stablepath;
1388 1389
}

D
Daniel P. Berrange 已提交
1390

1391
#ifndef WIN32
1392 1393 1394 1395
/*
 * Run an external program.
 *
 * Read its output and apply a series of regexes to each line
R
Richard W.M. Jones 已提交
1396
 * When the entire set of regexes has matched consecutively
1397 1398 1399
 * then run a callback passing in all the matches
 */
int
1400
virStorageBackendRunProgRegex(virStoragePoolObjPtr pool,
1401
                              const char *const*prog,
1402 1403 1404 1405
                              int nregex,
                              const char **regex,
                              int *nvars,
                              virStorageBackendListVolRegexFunc func,
1406 1407
                              void *data,
                              int *outexit)
1408
{
1409 1410
    int fd = -1, exitstatus, err, failed = 1;
    pid_t child = 0;
1411 1412 1413 1414 1415 1416 1417 1418 1419
    FILE *list = NULL;
    regex_t *reg;
    regmatch_t *vars = NULL;
    char line[1024];
    int maxReg = 0, i, j;
    int totgroups = 0, ngroup = 0, maxvars = 0;
    char **groups;

    /* Compile all regular expressions */
1420
    if (VIR_ALLOC_N(reg, nregex) < 0) {
1421
        virReportOOMError();
1422 1423 1424 1425 1426 1427 1428 1429
        return -1;
    }

    for (i = 0 ; i < nregex ; i++) {
        err = regcomp(&reg[i], regex[i], REG_EXTENDED);
        if (err != 0) {
            char error[100];
            regerror(err, &reg[i], error, sizeof(error));
1430
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
1431 1432 1433
                                  _("Failed to compile regex %s"), error);
            for (j = 0 ; j <= i ; j++)
                regfree(&reg[j]);
1434
            VIR_FREE(reg);
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
            return -1;
        }

        totgroups += nvars[i];
        if (nvars[i] > maxvars)
            maxvars = nvars[i];

    }

    /* Storage for matched variables */
1445
    if (VIR_ALLOC_N(groups, totgroups) < 0) {
1446
        virReportOOMError();
1447 1448
        goto cleanup;
    }
1449
    if (VIR_ALLOC_N(vars, maxvars+1) < 0) {
1450
        virReportOOMError();
1451 1452 1453 1454 1455
        goto cleanup;
    }


    /* Run the program and capture its output */
1456
    if (virExec(prog, NULL, NULL,
1457
                &child, -1, &fd, NULL, VIR_EXEC_NONE) < 0) {
1458 1459 1460
        goto cleanup;
    }

1461
    if ((list = VIR_FDOPEN(fd, "r")) == NULL) {
1462
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
J
Jim Meyering 已提交
1463
                              "%s", _("cannot read fd"));
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
        goto cleanup;
    }

    while (fgets(line, sizeof(line), list) != NULL) {
        /* Strip trailing newline */
        int len = strlen(line);
        if (len && line[len-1] == '\n')
            line[len-1] = '\0';

        for (i = 0 ; i <= maxReg && i < nregex ; i++) {
            if (regexec(&reg[i], line, nvars[i]+1, vars, 0) == 0) {
                maxReg++;

                if (i == 0)
                    ngroup = 0;

                /* NULL terminate each captured group in the line */
                for (j = 0 ; j < nvars[i] ; j++) {
                    /* NB vars[0] is the full pattern, so we offset j by 1 */
                    line[vars[j+1].rm_eo] = '\0';
                    if ((groups[ngroup++] =
                         strdup(line + vars[j+1].rm_so)) == NULL) {
1486
                        virReportOOMError();
1487 1488 1489 1490 1491 1492
                        goto cleanup;
                    }
                }

                /* We're matching on the last regex, so callback time */
                if (i == (nregex-1)) {
1493
                    if (((*func)(pool, groups, data)) < 0)
1494 1495 1496
                        goto cleanup;

                    /* Release matches & restart to matching the first regex */
1497
                    for (j = 0 ; j < totgroups ; j++)
1498
                        VIR_FREE(groups[j]);
1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
                    maxReg = 0;
                    ngroup = 0;
                }
            }
        }
    }

    failed = 0;

 cleanup:
    if (groups) {
        for (j = 0 ; j < totgroups ; j++)
1511 1512
            VIR_FREE(groups[j]);
        VIR_FREE(groups);
1513
    }
1514
    VIR_FREE(vars);
1515 1516 1517 1518

    for (i = 0 ; i < nregex ; i++)
        regfree(&reg[i]);

1519
    VIR_FREE(reg);
1520

1521 1522
    VIR_FORCE_FCLOSE(list);
    VIR_FORCE_CLOSE(fd);
1523 1524 1525 1526 1527 1528 1529 1530

    while ((err = waitpid(child, &exitstatus, 0) == -1) && errno == EINTR);

    /* Don't bother checking exit status if we already failed */
    if (failed)
        return -1;

    if (err == -1) {
1531
        virReportSystemError(errno,
1532 1533
                             _("failed to wait for command '%s'"),
                             prog[0]);
1534 1535 1536
        return -1;
    } else {
        if (WIFEXITED(exitstatus)) {
1537 1538
            if (outexit != NULL)
                *outexit = WEXITSTATUS(exitstatus);
1539
        } else {
1540
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
J
Jim Meyering 已提交
1541
                                  "%s", _("command did not exit cleanly"));
1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
            return -1;
        }
    }

    return 0;
}

/*
 * Run an external program and read from its standard output
 * a stream of tokens from IN_STREAM, applying FUNC to
 * each successive sequence of N_COLUMNS tokens.
 * If FUNC returns < 0, stop processing input and return -1.
 * Return -1 if N_COLUMNS == 0.
 * Return -1 upon memory allocation error.
 * If the number of input tokens is not a multiple of N_COLUMNS,
 * then the final FUNC call will specify a number smaller than N_COLUMNS.
 * If there are no input tokens (empty input), call FUNC with N_COLUMNS == 0.
 */
int
1561
virStorageBackendRunProgNul(virStoragePoolObjPtr pool,
1562 1563 1564 1565 1566 1567
                            const char **prog,
                            size_t n_columns,
                            virStorageBackendListVolNulFunc func,
                            void *data)
{
    size_t n_tok = 0;
1568 1569
    int fd = -1, exitstatus;
    pid_t child = 0;
1570 1571 1572 1573 1574 1575 1576 1577 1578
    FILE *fp = NULL;
    char **v;
    int err = -1;
    int w_err;
    int i;

    if (n_columns == 0)
        return -1;

1579
    if (VIR_ALLOC_N(v, n_columns) < 0) {
1580
        virReportOOMError();
1581 1582 1583 1584 1585 1586
        return -1;
    }
    for (i = 0; i < n_columns; i++)
        v[i] = NULL;

    /* Run the program and capture its output */
1587
    if (virExec(prog, NULL, NULL,
1588
                &child, -1, &fd, NULL, VIR_EXEC_NONE) < 0) {
1589 1590 1591
        goto cleanup;
    }

1592
    if ((fp = VIR_FDOPEN(fd, "r")) == NULL) {
1593
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
1594
                              "%s", _("cannot open file using fd"));
1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
        goto cleanup;
    }

    while (1) {
        char *buf = NULL;
        size_t buf_len = 0;
        /* Be careful: even when it returns -1,
           this use of getdelim allocates memory.  */
        ssize_t tok_len = getdelim (&buf, &buf_len, 0, fp);
        v[n_tok] = buf;
        if (tok_len < 0) {
            /* Maybe EOF, maybe an error.
               If n_tok > 0, then we know it's an error.  */
1608
            if (n_tok && func (pool, n_tok, v, data) < 0)
1609 1610 1611 1612 1613
                goto cleanup;
            break;
        }
        ++n_tok;
        if (n_tok == n_columns) {
1614
            if (func (pool, n_tok, v, data) < 0)
1615 1616 1617
                goto cleanup;
            n_tok = 0;
            for (i = 0; i < n_columns; i++) {
1618
                VIR_FREE(v[i]);
1619 1620 1621 1622 1623 1624 1625
            }
        }
    }

    if (feof (fp))
        err = 0;
    else
1626
        virReportSystemError(errno,
1627
                             _("read error on pipe to '%s'"), prog[0]);
1628 1629 1630

 cleanup:
    for (i = 0; i < n_columns; i++)
1631 1632
        VIR_FREE(v[i]);
    VIR_FREE(v);
1633

1634 1635
    VIR_FORCE_FCLOSE(fp);
    VIR_FORCE_CLOSE(fd);
1636 1637 1638 1639 1640 1641 1642 1643 1644

    while ((w_err = waitpid (child, &exitstatus, 0) == -1) && errno == EINTR)
        /* empty */ ;

    /* Don't bother checking exit status if we already failed */
    if (err < 0)
        return -1;

    if (w_err == -1) {
1645
        virReportSystemError(errno,
1646 1647
                             _("failed to wait for command '%s'"),
                             prog[0]);
1648 1649 1650 1651
        return -1;
    } else {
        if (WIFEXITED(exitstatus)) {
            if (WEXITSTATUS(exitstatus) != 0) {
1652
                virStorageReportError(VIR_ERR_INTERNAL_ERROR,
1653 1654 1655 1656 1657
                                      _("non-zero exit status from command %d"),
                                      WEXITSTATUS(exitstatus));
                return -1;
            }
        } else {
1658
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
J
Jim Meyering 已提交
1659
                                  "%s", _("command did not exit cleanly"));
1660 1661 1662 1663 1664 1665
            return -1;
        }
    }

    return 0;
}
D
Daniel P. Berrange 已提交
1666

1667
#else /* WIN32 */
D
Daniel P. Berrange 已提交
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679

int
virStorageBackendRunProgRegex(virConnectPtr conn,
                              virStoragePoolObjPtr pool ATTRIBUTE_UNUSED,
                              const char *const*prog ATTRIBUTE_UNUSED,
                              int nregex ATTRIBUTE_UNUSED,
                              const char **regex ATTRIBUTE_UNUSED,
                              int *nvars ATTRIBUTE_UNUSED,
                              virStorageBackendListVolRegexFunc func ATTRIBUTE_UNUSED,
                              void *data ATTRIBUTE_UNUSED,
                              int *outexit ATTRIBUTE_UNUSED)
{
1680
    virStorageReportError(VIR_ERR_INTERNAL_ERROR, _("%s not implemented on Win32"), __FUNCTION__);
D
Daniel P. Berrange 已提交
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
    return -1;
}

int
virStorageBackendRunProgNul(virConnectPtr conn,
                            virStoragePoolObjPtr pool ATTRIBUTE_UNUSED,
                            const char **prog ATTRIBUTE_UNUSED,
                            size_t n_columns ATTRIBUTE_UNUSED,
                            virStorageBackendListVolNulFunc func ATTRIBUTE_UNUSED,
                            void *data ATTRIBUTE_UNUSED)
{
1692
    virStorageReportError(VIR_ERR_INTERNAL_ERROR, _("%s not implemented on Win32"), __FUNCTION__);
D
Daniel P. Berrange 已提交
1693 1694
    return -1;
}
1695
#endif /* WIN32 */