storage_backend.c 48.3 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
#include "dirname.h"
40 41 42 43
#ifdef __linux__
# include <sys/ioctl.h>
# include <linux/fs.h>
#endif
44 45

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

49
#include "datatypes.h"
50
#include "virterror_internal.h"
D
Daniel P. Berrange 已提交
51 52
#include "util.h"
#include "memory.h"
53
#include "internal.h"
54
#include "secret_conf.h"
55
#include "uuid.h"
56
#include "storage_file.h"
D
Daniel P. Berrange 已提交
57
#include "storage_backend.h"
58
#include "logging.h"
E
Eric Blake 已提交
59
#include "virfile.h"
60
#include "command.h"
61

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

81 82
#define VIR_FROM_THIS VIR_FROM_STORAGE

83 84 85 86 87 88 89 90 91 92 93 94 95 96
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
97 98 99
#if WITH_STORAGE_SCSI
    &virStorageBackendSCSI,
#endif
D
Dave Allan 已提交
100 101 102
#if WITH_STORAGE_MPATH
    &virStorageBackendMpath,
#endif
103 104 105 106 107
#if WITH_STORAGE_DISK
    &virStorageBackendDisk,
#endif
    NULL
};
108

109 110 111 112 113 114 115 116
static int track_allocation_progress = 0;

enum {
    TOOL_QEMU_IMG,
    TOOL_KVM_IMG,
    TOOL_QCOW_CREATE,
};

117 118 119
#define READ_BLOCK_SIZE_DEFAULT  (1024 * 1024)
#define WRITE_BLOCK_SIZE_DEFAULT (4 * 1024)

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

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

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
#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;
    }
161

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

    remain = *total;

    while (amtread != 0) {
        int amtleft;

173 174
        if (remain < rbytes)
            rbytes = remain;
175

176
        if ((amtread = saferead(inputfd, buf, rbytes)) < 0) {
177
            ret = -errno;
178
            virReportSystemError(errno,
179 180 181 182 183 184 185 186 187 188
                                 _("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 {
189
            interval = ((wbytes > amtleft) ? amtleft : wbytes);
190 191
            int offset = amtread - amtleft;

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

            }
208
        } while ((amtleft -= interval) > 0);
209 210
    }

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

    *total -= remain;

cleanup:
223
    VIR_FORCE_CLOSE(inputfd);
224

225
    VIR_FREE(zerobuf);
226 227
    VIR_FREE(buf);

228 229 230
    return ret;
}

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

E
Eric Blake 已提交
245 246
    virCheckFlags(0, -1);

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

    remain = vol->allocation;

    if (inputvol) {
257
        int res = virStorageBackendCopyToFD(vol, inputvol,
258
                                            fd, &remain, 0);
259 260 261 262
        if (res < 0)
            goto cleanup;
    }

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

    ret = 0;
cleanup:
293
    VIR_FORCE_CLOSE(fd);
294 295 296 297

    return ret;
}

E
Eric Blake 已提交
298 299 300 301
static int
createRawFile(int fd, virStorageVolDefPtr vol,
              virStorageVolDefPtr inputvol)
{
302 303
    int ret = 0;
    unsigned long long remain;
304

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

E
Eric Blake 已提交
315
    remain = vol->allocation;
316

E
Eric Blake 已提交
317 318
    if (inputvol) {
        ret = virStorageBackendCopyToFD(vol, inputvol, fd, &remain, 1);
319
        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;
E
Eric Blake 已提交
336
                if (safezero(fd, vol->allocation - remain, bytes) < 0) {
337
                    ret = -errno;
J
Jiri Denemark 已提交
338
                    virReportSystemError(errno, _("cannot fill file '%s'"),
E
Eric Blake 已提交
339
                                         vol->target.path);
340 341 342 343 344
                    goto cleanup;
                }
                remain -= bytes;
            }
        } else { /* No progress bars to be shown */
E
Eric Blake 已提交
345
            if (safezero(fd, 0, remain) < 0) {
346
                ret = -errno;
J
Jiri Denemark 已提交
347
                virReportSystemError(errno, _("cannot fill file '%s'"),
E
Eric Blake 已提交
348
                                     vol->target.path);
349 350 351
                goto cleanup;
            }
        }
352

353 354 355
    }

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

362 363 364 365 366 367 368 369 370
cleanup:
    return ret;
}

int
virStorageBackendCreateRaw(virConnectPtr conn ATTRIBUTE_UNUSED,
                           virStoragePoolObjPtr pool,
                           virStorageVolDefPtr vol,
                           virStorageVolDefPtr inputvol,
E
Eric Blake 已提交
371
                           unsigned int flags)
372 373
{
    int ret = -1;
E
Eric Blake 已提交
374 375 376 377 378 379
    int fd = -1;
    uid_t uid;
    gid_t gid;
    int operation_flags;

    virCheckFlags(0, -1);
380 381 382 383 384

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

E
Eric Blake 已提交
388 389
    uid = (vol->target.perms.uid == -1) ? getuid() : vol->target.perms.uid;
    gid = (vol->target.perms.gid == -1) ? getgid() : vol->target.perms.gid;
390
    operation_flags = VIR_FILE_OPEN_FORCE_PERMS;
E
Eric Blake 已提交
391
    if (pool->def->type == VIR_STORAGE_POOL_NETFS)
392
        operation_flags |= VIR_FILE_OPEN_AS_UID;
E
Eric Blake 已提交
393

394 395 396 397
    if ((fd = virFileOpenAs(vol->target.path,
                            O_RDWR | O_CREAT | O_EXCL,
                            vol->target.perms.mode, uid, gid,
                            operation_flags)) < 0) {
E
Eric Blake 已提交
398 399 400 401 402 403
        virReportSystemError(-fd,
                             _("cannot create path '%s'"),
                             vol->target.path);
        goto cleanup;
    }

404 405
    if ((ret = createRawFile(fd, vol, inputvol)) < 0)
        /* createRawFile already reported the exact error. */
E
Eric Blake 已提交
406
        ret = -1;
407 408

cleanup:
E
Eric Blake 已提交
409
    VIR_FORCE_CLOSE(fd);
410 411 412
    return ret;
}

413 414 415 416 417 418 419 420 421
static int
virStorageGenerateSecretUUID(virConnectPtr conn,
                             unsigned char *uuid)
{
    unsigned attempt;

    for (attempt = 0; attempt < 65536; attempt++) {
        virSecretPtr tmp;
        if (virUUIDGenerate(uuid) < 0) {
422 423
            virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                                  _("unable to generate uuid"));
424 425 426 427 428 429 430 431 432
            return -1;
        }
        tmp = conn->secretDriver->lookupByUUID(conn, uuid);
        if (tmp == NULL)
            return 0;

        virSecretFree(tmp);
    }

433 434
    virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                          _("too many conflicts when generating an uuid"));
435 436 437 438

    return -1;
}

439 440 441 442 443 444 445 446 447
static int
virStorageGenerateQcowEncryption(virConnectPtr conn,
                                 virStorageVolDefPtr vol)
{
    virSecretDefPtr def = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    virStorageEncryptionPtr enc;
    virStorageEncryptionSecretPtr enc_secret = NULL;
    virSecretPtr secret = NULL;
448
    char *xml;
449 450 451
    unsigned char value[VIR_STORAGE_QCOW_PASSPHRASE_SIZE];
    int ret = -1;

452 453 454
    if (conn->secretDriver == NULL ||
        conn->secretDriver->lookupByUUID == NULL ||
        conn->secretDriver->defineXML == NULL ||
455
        conn->secretDriver->setValue == NULL) {
456
        virStorageReportError(VIR_ERR_NO_SUPPORT, "%s",
457 458 459 460 461 462
                              _("secret storage not supported"));
        goto cleanup;
    }

    enc = vol->target.encryption;
    if (enc->nsecrets != 0) {
463
        virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
464 465 466 467 468 469
                              _("secrets already defined"));
        goto cleanup;
    }

    if (VIR_ALLOC(enc_secret) < 0 || VIR_REALLOC_N(enc->secrets, 1) < 0 ||
        VIR_ALLOC(def) < 0) {
470
        virReportOOMError();
471 472 473 474 475
        goto cleanup;
    }

    def->ephemeral = 0;
    def->private = 0;
476
    if (virStorageGenerateSecretUUID(conn, def->uuid) < 0)
477
        goto cleanup;
478

479 480 481
    def->usage_type = VIR_SECRET_USAGE_TYPE_VOLUME;
    def->usage.volume = strdup(vol->target.path);
    if (def->usage.volume == NULL) {
482
        virReportOOMError();
483 484
        goto cleanup;
    }
485
    xml = virSecretDefFormat(def);
486 487 488 489 490 491 492 493 494 495 496 497
    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);

498
    if (virStorageGenerateQcowPassphrase(value) < 0)
499 500 501 502 503 504
        goto cleanup;

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

    enc_secret->type = VIR_STORAGE_ENCRYPTION_SECRET_TYPE_PASSPHRASE;
505
    memcpy(enc_secret->uuid, secret->uuid, VIR_UUID_BUFLEN);
506 507 508 509 510 511 512 513 514
    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) {
515 516
        if (ret != 0 &&
            conn->secretDriver->undefine != NULL)
517 518 519
            conn->secretDriver->undefine(secret);
        virSecretFree(secret);
    }
520
    virBufferFreeAndReset(&buf);
521 522 523 524 525
    virSecretDefFree(def);
    VIR_FREE(enc_secret);
    return ret;
}

526 527 528 529 530
struct hookdata {
    virStorageVolDefPtr vol;
    bool skip;
};

531
static int virStorageBuildSetUIDHook(void *data) {
532 533 534 535 536
    struct hookdata *tmp = data;
    virStorageVolDefPtr vol = tmp->vol;

    if (tmp->skip)
        return 0;
537

538
    if (virSetUIDGID(vol->target.perms.uid, vol->target.perms.gid) < 0)
539
        return -1;
540

541 542 543
    return 0;
}

544
static int virStorageBackendCreateExecCommand(virStoragePoolObjPtr pool,
545
                                              virStorageVolDefPtr vol,
546
                                              virCommandPtr cmd) {
547 548 549 550
    struct stat st;
    gid_t gid;
    uid_t uid;
    int filecreated = 0;
551
    struct hookdata data = {vol, false};
552 553

    if ((pool->def->type == VIR_STORAGE_POOL_NETFS)
554 555 556 557 558
        && (((getuid() == 0)
             && (vol->target.perms.uid != -1)
             && (vol->target.perms.uid != 0))
            || ((vol->target.perms.gid != -1)
                && (vol->target.perms.gid != getgid())))) {
559 560 561 562

        virCommandSetPreExecHook(cmd, virStorageBuildSetUIDHook, &data);

        if (virCommandRun(cmd, NULL) == 0) {
563 564 565 566 567
            /* command was successfully run, check if the file was created */
            if (stat(vol->target.path, &st) >=0)
                filecreated = 1;
        }
    }
568 569 570

    data.skip = true;

571
    if (!filecreated) {
572
        if (virCommandRun(cmd, NULL) < 0) {
573 574 575
            return -1;
        }
        if (stat(vol->target.path, &st) < 0) {
576
            virReportSystemError(errno,
577
                                 _("failed to create %s"), vol->target.path);
578 579 580 581 582 583 584 585
            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)) {
586
        virReportSystemError(errno,
587
                             _("cannot chown %s to (%u, %u)"),
588
                             vol->target.path, uid, gid);
589 590 591
        return -1;
    }
    if (chmod(vol->target.path, vol->target.perms.mode) < 0) {
592
        virReportSystemError(errno,
593 594 595 596 597 598 599
                             _("cannot set mode of '%s' to %04o"),
                             vol->target.path, vol->target.perms.mode);
        return -1;
    }
    return 0;
}

600 601 602 603 604 605 606 607 608 609 610 611 612
enum {
    QEMU_IMG_BACKING_FORMAT_NONE = 0,
    QEMU_IMG_BACKING_FORMAT_FLAG,
    QEMU_IMG_BACKING_FORMAT_OPTIONS,
};

static int virStorageBackendQEMUImgBackingFormat(const char *qemuimg)
{
    char *help = NULL;
    char *start;
    char *end;
    char *tmp;
    int ret = -1;
613
    int exitstatus;
614
    virCommandPtr cmd = virCommandNewArgList(qemuimg, "-h", NULL);
615

616 617 618
    virCommandAddEnvString(cmd, "LC_ALL=C");
    virCommandSetOutputBuffer(cmd, &help);
    virCommandClearCaps(cmd);
619

620 621 622
    /* qemuimg doesn't return zero exit status on -h,
     * therefore we need to provide pointer for storing
     * exit status, although we don't parse it any later */
623
    if (virCommandRun(cmd, &exitstatus) < 0)
624 625 626 627
        goto cleanup;

    start = strstr(help, " create ");
    end = strstr(start, "\n");
628 629
    if (((tmp = strstr(start, "-F fmt")) && tmp < end) ||
        ((tmp = strstr(start, "-F backing_fmt")) && tmp < end))
630 631 632 633 634 635 636
        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:
637
    virCommandFree(cmd);
638 639 640 641 642
    VIR_FREE(help);
    return ret;
}


643 644
static int
virStorageBackendCreateQemuImg(virConnectPtr conn,
645
                               virStoragePoolObjPtr pool,
646
                               virStorageVolDefPtr vol,
647
                               virStorageVolDefPtr inputvol,
E
Eric Blake 已提交
648
                               unsigned int flags)
649
{
650
    int ret = -1;
651
    char *create_tool;
652
    int imgformat = -1;
653 654
    virCommandPtr cmd = NULL;
    bool do_encryption = (vol->target.encryption != NULL);
655
    unsigned long long int size_arg;
656

E
Eric Blake 已提交
657 658
    virCheckFlags(0, -1);

659
    const char *type = virStorageFileFormatTypeToString(vol->target.format);
660
    const char *backingType = vol->backingStore.path ?
661
        virStorageFileFormatTypeToString(vol->backingStore.format) : NULL;
662 663 664 665 666 667

    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 ?
668 669 670 671
        virStorageFileFormatTypeToString(inputvol->type == VIR_STORAGE_VOL_BLOCK ?
                                         VIR_STORAGE_FILE_RAW :
                                         inputvol->target.format) :
        NULL;
672 673

    if (type == NULL) {
674
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
675 676 677 678 679
                              _("unknown storage vol type %d"),
                              vol->target.format);
        return -1;
    }
    if (inputvol && inputType == NULL) {
680
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
681 682 683 684 685 686
                              _("unknown storage vol type %d"),
                              inputvol->target.format);
        return -1;
    }

    if (vol->backingStore.path) {
687 688
        int accessRetCode = -1;
        char *absolutePath = NULL;
689 690 691 692 693 694 695 696

        /* 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))) {
697
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
E
Eric Blake 已提交
698
                                  "%s", _("a different backing store cannot "
699 700 701 702 703
                                          "be specified."));
            return -1;
        }

        if (backingType == NULL) {
704
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
705 706 707 708
                                  _("unknown storage vol backing store type %d"),
                                  vol->backingStore.format);
            return -1;
        }
709 710 711 712 713 714 715 716 717 718 719 720 721 722

        /* Convert relative backing store paths to absolute paths for access
         * validation.
         */
        if ('/' != *(vol->backingStore.path) &&
            virAsprintf(&absolutePath, "%s/%s", pool->def->target.path,
                        vol->backingStore.path) < 0) {
            virReportOOMError();
            return -1;
        }
        accessRetCode = access(absolutePath ? absolutePath
                               : vol->backingStore.path, R_OK);
        VIR_FREE(absolutePath);
        if (accessRetCode != 0) {
723
            virReportSystemError(errno,
724 725 726 727 728 729
                                 _("inaccessible backing store volume %s"),
                                 vol->backingStore.path);
            return -1;
        }
    }

730
    if (do_encryption) {
731 732
        virStorageEncryptionPtr enc;

733 734
        if (vol->target.format != VIR_STORAGE_FILE_QCOW &&
            vol->target.format != VIR_STORAGE_FILE_QCOW2) {
735
            virStorageReportError(VIR_ERR_NO_SUPPORT,
736 737 738 739
                                  _("qcow volume encryption unsupported with "
                                    "volume format %s"), type);
            return -1;
        }
740 741 742
        enc = vol->target.encryption;
        if (enc->format != VIR_STORAGE_ENCRYPTION_FORMAT_QCOW &&
            enc->format != VIR_STORAGE_ENCRYPTION_FORMAT_DEFAULT) {
743
            virStorageReportError(VIR_ERR_NO_SUPPORT,
744 745 746 747
                                  _("unsupported volume encryption format %d"),
                                  vol->target.encryption->format);
            return -1;
        }
748
        if (enc->nsecrets > 1) {
749
            virStorageReportError(VIR_ERR_XML_ERROR, "%s",
750 751 752
                                  _("too many secrets for qcow encryption"));
            return -1;
        }
753 754 755 756 757
        if (enc->format == VIR_STORAGE_ENCRYPTION_FORMAT_DEFAULT ||
            enc->nsecrets == 0) {
            if (virStorageGenerateQcowEncryption(conn, vol) < 0)
                return -1;
        }
758 759
    }

760
    /* Size in KB */
761
    size_arg = VIR_DIV_UP(vol->capacity, 1024);
762 763 764 765 766 767 768

    /* 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) {
769
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
770
                              "%s", _("unable to find kvm-img or qemu-img"));
771 772 773
        return -1;
    }

774 775 776 777
    imgformat = virStorageBackendQEMUImgBackingFormat(create_tool);
    if (imgformat < 0)
        goto cleanup;

778 779
    cmd = virCommandNew(create_tool);

780
    if (inputvol) {
781 782 783 784
        virCommandAddArgList(cmd, "convert", "-f", inputType, "-O", type,
                             inputPath, vol->target.path, NULL);

        if (do_encryption) {
785
            if (imgformat == QEMU_IMG_BACKING_FORMAT_OPTIONS) {
786
                virCommandAddArgList(cmd, "-o", "encryption=on", NULL);
787
            } else {
788
                virCommandAddArg(cmd, "-e");
789 790 791
            }
        }

792
    } else if (vol->backingStore.path) {
793 794 795
        virCommandAddArgList(cmd, "create", "-f", type,
                             "-b", vol->backingStore.path, NULL);

796 797
        switch (imgformat) {
        case QEMU_IMG_BACKING_FORMAT_FLAG:
798
            virCommandAddArgList(cmd, "-F", backingType, vol->target.path,
799 800
                                 NULL);
            virCommandAddArgFormat(cmd, "%lluK", size_arg);
801 802 803

            if (do_encryption)
                virCommandAddArg(cmd, "-e");
804 805 806
            break;

        case QEMU_IMG_BACKING_FORMAT_OPTIONS:
807 808 809
            virCommandAddArg(cmd, "-o");
            virCommandAddArgFormat(cmd, "backing_fmt=%s%s", backingType,
                                   do_encryption ? ",encryption=on" : "");
810 811
            virCommandAddArg(cmd, vol->target.path);
            virCommandAddArgFormat(cmd, "%lluK", size_arg);
812
            break;
813 814 815 816 817

        default:
            VIR_INFO("Unable to set backing store format for %s with %s",
                     vol->target.path, create_tool);

818 819
            virCommandAddArg(cmd, vol->target.path);
            virCommandAddArgFormat(cmd, "%lluK", size_arg);
820 821 822
            if (do_encryption)
                virCommandAddArg(cmd, "-e");
        }
823
    } else {
824
        virCommandAddArgList(cmd, "create", "-f", type,
825 826
                             vol->target.path, NULL);
        virCommandAddArgFormat(cmd, "%lluK", size_arg);
827 828

        if (do_encryption) {
829
            if (imgformat == QEMU_IMG_BACKING_FORMAT_OPTIONS) {
830
                virCommandAddArgList(cmd, "-o", "encryption=on", NULL);
831
            } else {
832
                virCommandAddArg(cmd, "-e");
833 834
            }
        }
835
    }
836

837 838
    ret = virStorageBackendCreateExecCommand(pool, vol, cmd);
cleanup:
839
    VIR_FREE(create_tool);
840
    virCommandFree(cmd);
841

842
    return ret;
843 844 845 846 847 848 849
}

/*
 * Xen removed the fully-functional qemu-img, and replaced it
 * with a partially functional qcow-create. Go figure ??!?
 */
static int
850
virStorageBackendCreateQcowCreate(virConnectPtr conn ATTRIBUTE_UNUSED,
851
                                  virStoragePoolObjPtr pool,
852
                                  virStorageVolDefPtr vol,
853
                                  virStorageVolDefPtr inputvol,
E
Eric Blake 已提交
854
                                  unsigned int flags)
855
{
856
    int ret;
E
Eric Blake 已提交
857
    char *size;
858
    virCommandPtr cmd;
859

E
Eric Blake 已提交
860 861
    virCheckFlags(0, -1);

862
    if (inputvol) {
863
        virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
864 865 866 867
                              _("cannot copy from volume with qcow-create"));
        return -1;
    }

868
    if (vol->target.format != VIR_STORAGE_FILE_QCOW2) {
869
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
870 871 872 873 874
                              _("unsupported storage vol type %d"),
                              vol->target.format);
        return -1;
    }
    if (vol->backingStore.path != NULL) {
875
        virStorageReportError(VIR_ERR_NO_SUPPORT, "%s",
876
                              _("copy-on-write image not supported with "
877
                                      "qcow-create"));
878 879
        return -1;
    }
880
    if (vol->target.encryption != NULL) {
881
        virStorageReportError(VIR_ERR_NO_SUPPORT,
882 883 884 885
                              "%s", _("encrypted volumes not supported with "
                                      "qcow-create"));
        return -1;
    }
886 887

    /* Size in MB - yes different units to qemu-img :-( */
888 889
    if (virAsprintf(&size, "%llu",
                    VIR_DIV_UP(vol->capacity, (1024 * 1024))) < 0) {
E
Eric Blake 已提交
890 891 892
        virReportOOMError();
        return -1;
    }
893

894
    cmd = virCommandNewArgList("qcow-create", size, vol->target.path, NULL);
895

896 897
    ret = virStorageBackendCreateExecCommand(pool, vol, cmd);
    virCommandFree(cmd);
E
Eric Blake 已提交
898
    VIR_FREE(size);
899

900
    return ret;
901 902
}

903
virStorageBackendBuildVolFrom
904
virStorageBackendFSImageToolTypeToFunc(int tool_type)
905 906 907 908 909 910 911 912
{
    switch (tool_type) {
    case TOOL_KVM_IMG:
    case TOOL_QEMU_IMG:
        return virStorageBackendCreateQemuImg;
    case TOOL_QCOW_CREATE:
        return virStorageBackendCreateQcowCreate;
    default:
913
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
                              _("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;
}

943
virStorageBackendBuildVolFrom
944
virStorageBackendGetBuildVolFromFunction(virStorageVolDefPtr vol,
945 946 947 948 949 950 951 952 953 954 955
                                         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 &&
956
         vol->target.format != VIR_STORAGE_FILE_RAW) ||
957
        (inputvol->type == VIR_STORAGE_VOL_FILE &&
958
         inputvol->target.format != VIR_STORAGE_FILE_RAW)) {
959

D
Daniel P. Berrange 已提交
960
        if ((tool_type = virStorageBackendFindFSImageTool(NULL)) < 0) {
961
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
962 963 964 965 966
                                  "%s", _("creation of non-raw file images is "
                                          "not supported without qemu-img."));
            return NULL;
        }

967
        return virStorageBackendFSImageToolTypeToFunc(tool_type);
968 969
    }

970 971 972 973
    if (vol->type == VIR_STORAGE_VOL_BLOCK)
        return virStorageBackendCreateBlockFrom;
    else
        return virStorageBackendCreateRaw;
974
}
975

976

977 978
virStorageBackendPtr
virStorageBackendForType(int type) {
979
    unsigned int i;
980
    for (i = 0; backends[i]; i++)
981 982 983
        if (backends[i]->type == type)
            return backends[i];

984
    virStorageReportError(VIR_ERR_INTERNAL_ERROR,
985 986 987 988 989
                          _("missing backend for pool type %d"), type);
    return NULL;
}


990 991 992
/*
 * Allows caller to silently ignore files with improper mode
 *
993 994
 * Returns -1 on error, -2 if file mode is unexpected or the
 * volume is a dangling symbolic link.
995
 */
996
int
997
virStorageBackendVolOpenCheckMode(const char *path, unsigned int flags)
998
{
999 1000
    int fd, mode = 0;
    struct stat sb;
1001
    char *base = last_component(path);
1002

1003
    if ((fd = open(path, O_RDONLY|O_NONBLOCK|O_NOCTTY)) < 0) {
1004 1005 1006 1007 1008 1009
        if ((errno == ENOENT || errno == ELOOP) &&
            lstat(path, &sb) == 0) {
            VIR_WARN("ignoring dangling symlink '%s'", path);
            return -2;
        }

1010
        virReportSystemError(errno,
1011
                             _("cannot open volume '%s'"),
1012
                             path);
1013 1014 1015
        return -1;
    }

1016 1017 1018 1019
    if (fstat(fd, &sb) < 0) {
        virReportSystemError(errno,
                             _("cannot stat file '%s'"),
                             path);
1020
        VIR_FORCE_CLOSE(fd);
1021 1022 1023 1024 1025 1026 1027 1028 1029
        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;
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
    else if (S_ISDIR(sb.st_mode)) {
        mode = VIR_STORAGE_VOL_OPEN_DIR;

        if (STREQ(base, ".") ||
            STREQ(base, "..")) {
            VIR_FORCE_CLOSE(fd);
            VIR_INFO("Skipping special dir '%s'", base);
            return -2;
        }
    }
1040 1041

    if (!(mode & flags)) {
1042
        VIR_FORCE_CLOSE(fd);
1043
        VIR_INFO("Skipping volume '%s'", path);
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065

        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,
1066 1067
                                     unsigned long long *capacity,
                                     unsigned int openflags)
1068 1069 1070
{
    int ret, fd;

1071 1072
    if ((ret = virStorageBackendVolOpenCheckMode(target->path,
                                                 openflags)) < 0)
1073 1074 1075
        return ret;

    fd = ret;
1076
    ret = virStorageBackendUpdateVolTargetInfoFD(target,
1077 1078 1079
                                                 fd,
                                                 allocation,
                                                 capacity);
1080

1081
    VIR_FORCE_CLOSE(fd);
1082 1083 1084 1085

    return ret;
}

1086
int
1087 1088 1089
virStorageBackendUpdateVolInfoFlags(virStorageVolDefPtr vol,
                                    int withCapacity,
                                    unsigned int openflags)
1090 1091 1092
{
    int ret;

1093
    if ((ret = virStorageBackendUpdateVolTargetInfo(&vol->target,
1094 1095 1096
                                    &vol->allocation,
                                    withCapacity ? &vol->capacity : NULL,
                                    openflags)) < 0)
1097 1098 1099
        return ret;

    if (vol->backingStore.path &&
1100
        (ret = virStorageBackendUpdateVolTargetInfo(&vol->backingStore,
1101 1102
                                            NULL, NULL,
                                            VIR_STORAGE_VOL_OPEN_DEFAULT)) < 0)
1103 1104 1105 1106 1107
        return ret;

    return 0;
}

1108 1109 1110 1111 1112 1113 1114
int virStorageBackendUpdateVolInfo(virStorageVolDefPtr vol,
                                   int withCapacity)
{
    return virStorageBackendUpdateVolInfoFlags(vol, withCapacity,
                                               VIR_STORAGE_VOL_OPEN_DEFAULT);
}

1115 1116 1117 1118
/*
 * virStorageBackendUpdateVolTargetInfoFD:
 * @conn: connection to report errors on
 * @target: target definition ptr of volume to update
1119
 * @fd: fd of storage volume to update, via virStorageBackendOpenVol*
1120 1121 1122
 * @allocation: If not NULL, updated allocation information will be stored
 * @capacity: If not NULL, updated capacity info will be stored
 *
1123
 * Returns 0 for success, -1 on a legitimate error condition.
1124
 */
1125
int
1126
virStorageBackendUpdateVolTargetInfoFD(virStorageVolTargetPtr target,
1127 1128 1129
                                       int fd,
                                       unsigned long long *allocation,
                                       unsigned long long *capacity)
1130 1131 1132 1133 1134 1135 1136
{
    struct stat sb;
#if HAVE_SELINUX
    security_context_t filecon = NULL;
#endif

    if (fstat(fd, &sb) < 0) {
1137
        virReportSystemError(errno,
1138
                             _("cannot stat file '%s'"),
1139
                             target->path);
1140 1141 1142
        return -1;
    }

1143 1144
    if (allocation) {
        if (S_ISREG(sb.st_mode)) {
1145
#ifndef WIN32
1146
            *allocation = (unsigned long long)sb.st_blocks *
1147
                          (unsigned long long)DEV_BSIZE;
D
Daniel P. Berrange 已提交
1148
#else
1149
            *allocation = sb.st_size;
D
Daniel P. Berrange 已提交
1150
#endif
1151 1152 1153 1154 1155
            /* Regular files may be sparse, so logical size (capacity) is not same
             * as actual allocation above
             */
            if (capacity)
                *capacity = sb.st_size;
1156 1157 1158 1159 1160
        } else if (S_ISDIR(sb.st_mode)) {
            *allocation = 0;
            if (capacity)
                *capacity = 0;

1161 1162
        } else {
            off_t end;
E
Eric Blake 已提交
1163
            /* XXX this is POSIX compliant, but doesn't work for CHAR files,
1164 1165 1166 1167 1168 1169
             * 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) {
1170
                virReportSystemError(errno,
1171 1172 1173 1174 1175 1176 1177
                                     _("cannot seek to end of file '%s'"),
                                     target->path);
                return -1;
            }
            *allocation = end;
            if (capacity)
                *capacity = end;
1178 1179 1180
        }
    }

1181 1182 1183
    target->perms.mode = sb.st_mode & S_IRWXUGO;
    target->perms.uid = sb.st_uid;
    target->perms.gid = sb.st_gid;
1184

1185
    VIR_FREE(target->perms.label);
1186 1187

#if HAVE_SELINUX
1188
    /* XXX: make this a security driver call */
1189
    if (fgetfilecon(fd, &filecon) == -1) {
1190
        if (errno != ENODATA && errno != ENOTSUP) {
1191
            virReportSystemError(errno,
1192
                                 _("cannot get file context of '%s'"),
1193
                                 target->path);
1194 1195
            return -1;
        } else {
1196
            target->perms.label = NULL;
1197 1198
        }
    } else {
1199
        target->perms.label = strdup(filecon);
1200
        freecon(filecon);
1201
        if (target->perms.label == NULL) {
1202
            virReportOOMError();
1203 1204
            return -1;
        }
1205 1206
    }
#else
1207
    target->perms.label = NULL;
1208 1209 1210 1211 1212
#endif

    return 0;
}

D
Dave Allan 已提交
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247

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
1248 1249
virStorageBackendDetectBlockVolFormatFD(virStorageVolTargetPtr target,
                                        int fd)
D
Dave Allan 已提交
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
{
    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) {
1261
        virReportSystemError(errno,
D
Dave Allan 已提交
1262 1263 1264 1265 1266 1267
                             _("cannot seek to beginning of file '%s'"),
                             target->path);
        return -1;
    }
    bytes = saferead(fd, buffer, sizeof(buffer));
    if (bytes < 0) {
1268
        virReportSystemError(errno,
D
Dave Allan 已提交
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
                             _("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;
}


1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
/*
 * 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 *
1302
virStorageBackendStablePath(virStoragePoolObjPtr pool,
1303
                            const char *devpath)
1304 1305 1306
{
    DIR *dh;
    struct dirent *dent;
1307
    char *stablepath;
1308
    int opentries = 0;
1309 1310 1311 1312 1313

    /* 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/"))
1314
        goto ret_strdup;
1315

1316 1317 1318 1319 1320 1321
    /* 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;

1322 1323 1324
    /* 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.
1325
     */
1326
 reopen:
1327
    if ((dh = opendir(pool->def->target.path)) == NULL) {
1328 1329 1330 1331 1332
        opentries++;
        if (errno == ENOENT && opentries < 50) {
            usleep(100 * 1000);
            goto reopen;
        }
1333
        virReportSystemError(errno,
1334 1335
                             _("cannot read dir '%s'"),
                             pool->def->target.path);
1336 1337 1338
        return NULL;
    }

1339 1340 1341 1342 1343
    /* 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
     */
1344 1345 1346 1347
    while ((dent = readdir(dh)) != NULL) {
        if (dent->d_name[0] == '.')
            continue;

1348 1349 1350
        if (virAsprintf(&stablepath, "%s/%s",
                        pool->def->target.path,
                        dent->d_name) == -1) {
1351
            virReportOOMError();
1352 1353 1354 1355 1356 1357 1358 1359 1360
            closedir(dh);
            return NULL;
        }

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

1361
        VIR_FREE(stablepath);
1362 1363 1364 1365
    }

    closedir(dh);

1366
 ret_strdup:
1367 1368 1369
    /* Couldn't find any matching stable link so give back
     * the original non-stable dev path
     */
1370 1371 1372 1373

    stablepath = strdup(devpath);

    if (stablepath == NULL)
1374
        virReportOOMError();
1375 1376

    return stablepath;
1377 1378
}

D
Daniel P. Berrange 已提交
1379

1380
#ifndef WIN32
1381 1382 1383 1384
/*
 * Run an external program.
 *
 * Read its output and apply a series of regexes to each line
R
Richard W.M. Jones 已提交
1385
 * When the entire set of regexes has matched consecutively
1386 1387 1388
 * then run a callback passing in all the matches
 */
int
1389
virStorageBackendRunProgRegex(virStoragePoolObjPtr pool,
1390
                              const char *const*prog,
1391 1392 1393 1394
                              int nregex,
                              const char **regex,
                              int *nvars,
                              virStorageBackendListVolRegexFunc func,
1395
                              void *data)
1396
{
1397
    int fd = -1, err, ret = -1;
1398 1399 1400 1401 1402 1403 1404
    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;
1405
    virCommandPtr cmd = NULL;
1406 1407

    /* Compile all regular expressions */
1408
    if (VIR_ALLOC_N(reg, nregex) < 0) {
1409
        virReportOOMError();
1410 1411 1412 1413 1414 1415 1416 1417
        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));
1418
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
1419 1420 1421
                                  _("Failed to compile regex %s"), error);
            for (j = 0 ; j <= i ; j++)
                regfree(&reg[j]);
1422
            VIR_FREE(reg);
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
            return -1;
        }

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

    }

    /* Storage for matched variables */
1433
    if (VIR_ALLOC_N(groups, totgroups) < 0) {
1434
        virReportOOMError();
1435 1436
        goto cleanup;
    }
1437
    if (VIR_ALLOC_N(vars, maxvars+1) < 0) {
1438
        virReportOOMError();
1439 1440 1441
        goto cleanup;
    }

1442 1443 1444
    cmd = virCommandNewArgs(prog);
    virCommandSetOutputFD(cmd, &fd);
    if (virCommandRunAsync(cmd, NULL) < 0) {
1445 1446 1447
        goto cleanup;
    }

1448
    if ((list = VIR_FDOPEN(fd, "r")) == NULL) {
1449
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
J
Jim Meyering 已提交
1450
                              "%s", _("cannot read fd"));
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
        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) {
1473
                        virReportOOMError();
1474 1475 1476 1477 1478 1479
                        goto cleanup;
                    }
                }

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

                    /* Release matches & restart to matching the first regex */
1484
                    for (j = 0 ; j < totgroups ; j++)
1485
                        VIR_FREE(groups[j]);
1486 1487 1488 1489 1490 1491 1492
                    maxReg = 0;
                    ngroup = 0;
                }
            }
        }
    }

1493
    ret = virCommandWait(cmd, NULL);
1494
cleanup:
1495 1496
    if (groups) {
        for (j = 0 ; j < totgroups ; j++)
1497 1498
            VIR_FREE(groups[j]);
        VIR_FREE(groups);
1499
    }
1500
    VIR_FREE(vars);
1501 1502 1503 1504

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

1505
    VIR_FREE(reg);
1506
    virCommandFree(cmd);
1507

1508 1509
    VIR_FORCE_FCLOSE(list);
    VIR_FORCE_CLOSE(fd);
1510

1511
    return ret;
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
}

/*
 * 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
1526
virStorageBackendRunProgNul(virStoragePoolObjPtr pool,
1527 1528 1529 1530 1531 1532
                            const char **prog,
                            size_t n_columns,
                            virStorageBackendListVolNulFunc func,
                            void *data)
{
    size_t n_tok = 0;
1533
    int fd = -1;
1534 1535
    FILE *fp = NULL;
    char **v;
1536
    int ret = -1;
1537
    int i;
1538
    virCommandPtr cmd = NULL;
1539 1540 1541 1542

    if (n_columns == 0)
        return -1;

1543
    if (VIR_ALLOC_N(v, n_columns) < 0) {
1544
        virReportOOMError();
1545 1546 1547 1548 1549
        return -1;
    }
    for (i = 0; i < n_columns; i++)
        v[i] = NULL;

1550 1551 1552
    cmd = virCommandNewArgs(prog);
    virCommandSetOutputFD(cmd, &fd);
    if (virCommandRunAsync(cmd, NULL) < 0) {
1553 1554 1555
        goto cleanup;
    }

1556
    if ((fp = VIR_FDOPEN(fd, "r")) == NULL) {
1557
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
1558
                              "%s", _("cannot open file using fd"));
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
        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.  */
1572
            if (n_tok && func (pool, n_tok, v, data) < 0)
1573 1574 1575 1576 1577
                goto cleanup;
            break;
        }
        ++n_tok;
        if (n_tok == n_columns) {
1578
            if (func (pool, n_tok, v, data) < 0)
1579 1580 1581
                goto cleanup;
            n_tok = 0;
            for (i = 0; i < n_columns; i++) {
1582
                VIR_FREE(v[i]);
1583 1584 1585 1586
            }
        }
    }

1587
    if (feof (fp) < 0) {
1588
        virReportSystemError(errno,
1589
                             _("read error on pipe to '%s'"), prog[0]);
1590 1591
        goto cleanup;
    }
1592

1593
    ret = virCommandWait(cmd, NULL);
1594 1595
 cleanup:
    for (i = 0; i < n_columns; i++)
1596 1597
        VIR_FREE(v[i]);
    VIR_FREE(v);
1598
    virCommandFree(cmd);
1599

1600 1601
    VIR_FORCE_FCLOSE(fp);
    VIR_FORCE_CLOSE(fd);
1602

1603
    return ret;
1604
}
D
Daniel P. Berrange 已提交
1605

1606
#else /* WIN32 */
D
Daniel P. Berrange 已提交
1607 1608 1609 1610 1611 1612 1613 1614 1615

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,
1616
                              void *data ATTRIBUTE_UNUSED)
D
Daniel P. Berrange 已提交
1617
{
1618 1619
    virStorageReportError(VIR_ERR_INTERNAL_ERROR,
                          _("%s not implemented on Win32"), __FUNCTION__);
D
Daniel P. Berrange 已提交
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
    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)
{
1631
    virStorageReportError(VIR_ERR_INTERNAL_ERROR, _("%s not implemented on Win32"), __FUNCTION__);
D
Daniel P. Berrange 已提交
1632 1633
    return -1;
}
1634
#endif /* WIN32 */