storage_backend.c 49.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

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

83 84
#define VIR_FROM_THIS VIR_FROM_STORAGE

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

114 115 116 117 118 119 120 121
static int track_allocation_progress = 0;

enum {
    TOOL_QEMU_IMG,
    TOOL_KVM_IMG,
    TOOL_QCOW_CREATE,
};

122 123 124
#define READ_BLOCK_SIZE_DEFAULT  (1024 * 1024)
#define WRITE_BLOCK_SIZE_DEFAULT (4 * 1024)

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

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

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
#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;
    }
165

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

    while (amtread != 0) {
        int amtleft;

175 176
        if (*total < rbytes)
            rbytes = *total;
177

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

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

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

            }
210
        } while ((amtleft -= interval) > 0);
211 212
    }

213 214 215 216 217 218 219 220
    if (fdatasync(fd) < 0) {
        ret = -errno;
        virReportSystemError(errno, _("cannot sync data to file '%s'"),
                             vol->target.path);
        goto cleanup;
    }


221
    if (VIR_CLOSE(inputfd) < 0) {
222
        ret = -errno;
223
        virReportSystemError(errno,
224 225 226 227 228 229 230
                             _("cannot close file '%s'"),
                             inputvol->target.path);
        goto cleanup;
    }
    inputfd = -1;

cleanup:
231
    VIR_FORCE_CLOSE(inputfd);
232

233
    VIR_FREE(zerobuf);
234 235
    VIR_FREE(buf);

236 237 238
    return ret;
}

239
static int
240
virStorageBackendCreateBlockFrom(virConnectPtr conn ATTRIBUTE_UNUSED,
241
                                 virStoragePoolObjPtr pool ATTRIBUTE_UNUSED,
242 243
                                 virStorageVolDefPtr vol,
                                 virStorageVolDefPtr inputvol,
E
Eric Blake 已提交
244
                                 unsigned int flags)
245 246 247 248
{
    int fd = -1;
    int ret = -1;
    unsigned long long remain;
249 250 251
    struct stat st;
    gid_t gid;
    uid_t uid;
252

E
Eric Blake 已提交
253 254
    virCheckFlags(0, -1);

255
    if ((fd = open(vol->target.path, O_RDWR)) < 0) {
256
        virReportSystemError(errno,
257 258 259 260 261 262 263 264
                             _("cannot create path '%s'"),
                             vol->target.path);
        goto cleanup;
    }

    remain = vol->allocation;

    if (inputvol) {
265
        int res = virStorageBackendCopyToFD(vol, inputvol,
266
                                            fd, &remain, 0);
267 268 269 270
        if (res < 0)
            goto cleanup;
    }

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

    ret = 0;
cleanup:
301
    VIR_FORCE_CLOSE(fd);
302 303 304 305

    return ret;
}

E
Eric Blake 已提交
306 307 308 309
static int
createRawFile(int fd, virStorageVolDefPtr vol,
              virStorageVolDefPtr inputvol)
{
310 311
    int ret = 0;
    unsigned long long remain;
312

313 314
    /* Seek to the final size, so the capacity is available upfront
     * for progress reporting */
E
Eric Blake 已提交
315
    if (ftruncate(fd, vol->capacity) < 0) {
316
        ret = -errno;
317
        virReportSystemError(errno,
318
                             _("cannot extend file '%s'"),
E
Eric Blake 已提交
319
                             vol->target.path);
320 321 322
        goto cleanup;
    }

E
Eric Blake 已提交
323
    remain = vol->allocation;
324

E
Eric Blake 已提交
325 326
    if (inputvol) {
        ret = virStorageBackendCopyToFD(vol, inputvol, fd, &remain, 1);
327
        if (ret < 0) {
328
            goto cleanup;
329
        }
330 331 332 333 334 335 336 337 338 339 340 341 342 343
    }

    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 已提交
344
                if (safezero(fd, vol->allocation - remain, bytes) < 0) {
345
                    ret = -errno;
J
Jiri Denemark 已提交
346
                    virReportSystemError(errno, _("cannot fill file '%s'"),
E
Eric Blake 已提交
347
                                         vol->target.path);
348 349 350 351 352
                    goto cleanup;
                }
                remain -= bytes;
            }
        } else { /* No progress bars to be shown */
E
Eric Blake 已提交
353
            if (safezero(fd, 0, remain) < 0) {
354
                ret = -errno;
J
Jiri Denemark 已提交
355
                virReportSystemError(errno, _("cannot fill file '%s'"),
E
Eric Blake 已提交
356
                                     vol->target.path);
357 358 359
                goto cleanup;
            }
        }
360

361 362 363
    }

    if (fsync(fd) < 0) {
364
        ret = -errno;
365
        virReportSystemError(errno, _("cannot sync data to file '%s'"),
E
Eric Blake 已提交
366
                             vol->target.path);
367
        goto cleanup;
368 369
    }

370 371 372 373 374 375 376 377 378
cleanup:
    return ret;
}

int
virStorageBackendCreateRaw(virConnectPtr conn ATTRIBUTE_UNUSED,
                           virStoragePoolObjPtr pool,
                           virStorageVolDefPtr vol,
                           virStorageVolDefPtr inputvol,
E
Eric Blake 已提交
379
                           unsigned int flags)
380 381
{
    int ret = -1;
E
Eric Blake 已提交
382 383 384 385
    int fd = -1;
    int operation_flags;

    virCheckFlags(0, -1);
386 387

    if (vol->target.encryption != NULL) {
O
Osier Yang 已提交
388
        virStorageReportError(VIR_ERR_CONFIG_UNSUPPORTED,
389 390
                              "%s", _("storage pool does not support encrypted "
                                      "volumes"));
391 392
        goto cleanup;
    }
393

L
Laine Stump 已提交
394
    operation_flags = VIR_FILE_OPEN_FORCE_MODE | VIR_FILE_OPEN_FORCE_OWNER;
E
Eric Blake 已提交
395
    if (pool->def->type == VIR_STORAGE_POOL_NETFS)
L
Laine Stump 已提交
396
        operation_flags |= VIR_FILE_OPEN_FORK;
E
Eric Blake 已提交
397

398 399
    if ((fd = virFileOpenAs(vol->target.path,
                            O_RDWR | O_CREAT | O_EXCL,
L
Laine Stump 已提交
400 401 402
                            vol->target.perms.mode,
                            vol->target.perms.uid,
                            vol->target.perms.gid,
403
                            operation_flags)) < 0) {
E
Eric Blake 已提交
404 405 406 407 408 409
        virReportSystemError(-fd,
                             _("cannot create path '%s'"),
                             vol->target.path);
        goto cleanup;
    }

410 411
    if ((ret = createRawFile(fd, vol, inputvol)) < 0)
        /* createRawFile already reported the exact error. */
E
Eric Blake 已提交
412
        ret = -1;
413 414

cleanup:
E
Eric Blake 已提交
415
    VIR_FORCE_CLOSE(fd);
416 417 418
    return ret;
}

419 420 421 422 423 424 425 426 427
static int
virStorageGenerateSecretUUID(virConnectPtr conn,
                             unsigned char *uuid)
{
    unsigned attempt;

    for (attempt = 0; attempt < 65536; attempt++) {
        virSecretPtr tmp;
        if (virUUIDGenerate(uuid) < 0) {
428 429
            virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                                  _("unable to generate uuid"));
430 431 432 433 434 435 436 437 438
            return -1;
        }
        tmp = conn->secretDriver->lookupByUUID(conn, uuid);
        if (tmp == NULL)
            return 0;

        virSecretFree(tmp);
    }

439 440
    virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                          _("too many conflicts when generating an uuid"));
441 442 443 444

    return -1;
}

445 446 447 448 449 450 451 452 453
static int
virStorageGenerateQcowEncryption(virConnectPtr conn,
                                 virStorageVolDefPtr vol)
{
    virSecretDefPtr def = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    virStorageEncryptionPtr enc;
    virStorageEncryptionSecretPtr enc_secret = NULL;
    virSecretPtr secret = NULL;
454
    char *xml;
455 456 457
    unsigned char value[VIR_STORAGE_QCOW_PASSPHRASE_SIZE];
    int ret = -1;

458 459 460
    if (conn->secretDriver == NULL ||
        conn->secretDriver->lookupByUUID == NULL ||
        conn->secretDriver->defineXML == NULL ||
461
        conn->secretDriver->setValue == NULL) {
O
Osier Yang 已提交
462
        virStorageReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s",
463 464 465 466 467 468
                              _("secret storage not supported"));
        goto cleanup;
    }

    enc = vol->target.encryption;
    if (enc->nsecrets != 0) {
469
        virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
470 471 472 473 474 475
                              _("secrets already defined"));
        goto cleanup;
    }

    if (VIR_ALLOC(enc_secret) < 0 || VIR_REALLOC_N(enc->secrets, 1) < 0 ||
        VIR_ALLOC(def) < 0) {
476
        virReportOOMError();
477 478 479 480 481
        goto cleanup;
    }

    def->ephemeral = 0;
    def->private = 0;
482
    if (virStorageGenerateSecretUUID(conn, def->uuid) < 0)
483
        goto cleanup;
484

485 486 487
    def->usage_type = VIR_SECRET_USAGE_TYPE_VOLUME;
    def->usage.volume = strdup(vol->target.path);
    if (def->usage.volume == NULL) {
488
        virReportOOMError();
489 490
        goto cleanup;
    }
491
    xml = virSecretDefFormat(def);
492 493 494 495 496 497 498 499 500 501 502 503
    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);

504
    if (virStorageGenerateQcowPassphrase(value) < 0)
505 506 507 508 509 510
        goto cleanup;

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

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

532 533 534 535 536
struct hookdata {
    virStorageVolDefPtr vol;
    bool skip;
};

537
static int virStorageBuildSetUIDHook(void *data) {
538 539 540 541 542
    struct hookdata *tmp = data;
    virStorageVolDefPtr vol = tmp->vol;

    if (tmp->skip)
        return 0;
543

544
    if (virSetUIDGID(vol->target.perms.uid, vol->target.perms.gid) < 0)
545
        return -1;
546

547 548 549
    return 0;
}

550
static int virStorageBackendCreateExecCommand(virStoragePoolObjPtr pool,
551
                                              virStorageVolDefPtr vol,
552
                                              virCommandPtr cmd) {
553 554 555 556
    struct stat st;
    gid_t gid;
    uid_t uid;
    int filecreated = 0;
557
    struct hookdata data = {vol, false};
558 559

    if ((pool->def->type == VIR_STORAGE_POOL_NETFS)
560 561 562 563 564
        && (((getuid() == 0)
             && (vol->target.perms.uid != -1)
             && (vol->target.perms.uid != 0))
            || ((vol->target.perms.gid != -1)
                && (vol->target.perms.gid != getgid())))) {
565 566 567 568

        virCommandSetPreExecHook(cmd, virStorageBuildSetUIDHook, &data);

        if (virCommandRun(cmd, NULL) == 0) {
569 570 571 572 573
            /* command was successfully run, check if the file was created */
            if (stat(vol->target.path, &st) >=0)
                filecreated = 1;
        }
    }
574 575 576

    data.skip = true;

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

606 607 608 609 610 611 612 613 614 615 616 617 618
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;
619
    int exitstatus;
620
    virCommandPtr cmd = virCommandNewArgList(qemuimg, "-h", NULL);
621

622 623 624
    virCommandAddEnvString(cmd, "LC_ALL=C");
    virCommandSetOutputBuffer(cmd, &help);
    virCommandClearCaps(cmd);
625

626 627 628
    /* 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 */
629
    if (virCommandRun(cmd, &exitstatus) < 0)
630 631
        goto cleanup;

632 633 634 635 636 637 638
    if ((start = strstr(help, " create ")) == NULL ||
        (end = strstr(start, "\n")) == NULL) {
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
                              _("unable to parse qemu-img output '%s'"),
                              help);
        goto cleanup;
    }
639 640
    if (((tmp = strstr(start, "-F fmt")) && tmp < end) ||
        ((tmp = strstr(start, "-F backing_fmt")) && tmp < end))
641 642 643 644 645 646 647
        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:
648
    virCommandFree(cmd);
649 650 651 652 653
    VIR_FREE(help);
    return ret;
}


654 655
static int
virStorageBackendCreateQemuImg(virConnectPtr conn,
656
                               virStoragePoolObjPtr pool,
657
                               virStorageVolDefPtr vol,
658
                               virStorageVolDefPtr inputvol,
E
Eric Blake 已提交
659
                               unsigned int flags)
660
{
661
    int ret = -1;
662
    char *create_tool;
663
    int imgformat = -1;
664 665
    virCommandPtr cmd = NULL;
    bool do_encryption = (vol->target.encryption != NULL);
666
    unsigned long long int size_arg;
667

E
Eric Blake 已提交
668 669
    virCheckFlags(0, -1);

670
    const char *type = virStorageFileFormatTypeToString(vol->target.format);
671
    const char *backingType = vol->backingStore.path ?
672
        virStorageFileFormatTypeToString(vol->backingStore.format) : NULL;
673 674 675 676 677 678

    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 ?
679 680 681 682
        virStorageFileFormatTypeToString(inputvol->type == VIR_STORAGE_VOL_BLOCK ?
                                         VIR_STORAGE_FILE_RAW :
                                         inputvol->target.format) :
        NULL;
683 684

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

    if (vol->backingStore.path) {
698 699
        int accessRetCode = -1;
        char *absolutePath = NULL;
700 701 702 703 704 705 706 707

        /* 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))) {
708
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
E
Eric Blake 已提交
709
                                  "%s", _("a different backing store cannot "
710 711 712 713 714
                                          "be specified."));
            return -1;
        }

        if (backingType == NULL) {
715
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
716 717 718 719
                                  _("unknown storage vol backing store type %d"),
                                  vol->backingStore.format);
            return -1;
        }
720 721 722 723 724 725 726 727 728 729 730 731 732 733

        /* 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) {
734
            virReportSystemError(errno,
735 736 737 738 739 740
                                 _("inaccessible backing store volume %s"),
                                 vol->backingStore.path);
            return -1;
        }
    }

741
    if (do_encryption) {
742 743
        virStorageEncryptionPtr enc;

744 745
        if (vol->target.format != VIR_STORAGE_FILE_QCOW &&
            vol->target.format != VIR_STORAGE_FILE_QCOW2) {
O
Osier Yang 已提交
746
            virStorageReportError(VIR_ERR_CONFIG_UNSUPPORTED,
747 748 749 750
                                  _("qcow volume encryption unsupported with "
                                    "volume format %s"), type);
            return -1;
        }
751 752 753
        enc = vol->target.encryption;
        if (enc->format != VIR_STORAGE_ENCRYPTION_FORMAT_QCOW &&
            enc->format != VIR_STORAGE_ENCRYPTION_FORMAT_DEFAULT) {
O
Osier Yang 已提交
754
            virStorageReportError(VIR_ERR_CONFIG_UNSUPPORTED,
755 756 757 758
                                  _("unsupported volume encryption format %d"),
                                  vol->target.encryption->format);
            return -1;
        }
759
        if (enc->nsecrets > 1) {
760
            virStorageReportError(VIR_ERR_XML_ERROR, "%s",
761 762 763
                                  _("too many secrets for qcow encryption"));
            return -1;
        }
764 765 766 767 768
        if (enc->format == VIR_STORAGE_ENCRYPTION_FORMAT_DEFAULT ||
            enc->nsecrets == 0) {
            if (virStorageGenerateQcowEncryption(conn, vol) < 0)
                return -1;
        }
769 770
    }

771
    /* Size in KB */
772
    size_arg = VIR_DIV_UP(vol->capacity, 1024);
773 774 775 776 777 778 779

    /* 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) {
780
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
781
                              "%s", _("unable to find kvm-img or qemu-img"));
782 783 784
        return -1;
    }

785 786 787 788
    imgformat = virStorageBackendQEMUImgBackingFormat(create_tool);
    if (imgformat < 0)
        goto cleanup;

789 790
    cmd = virCommandNew(create_tool);

791
    if (inputvol) {
792 793 794 795
        virCommandAddArgList(cmd, "convert", "-f", inputType, "-O", type,
                             inputPath, vol->target.path, NULL);

        if (do_encryption) {
796
            if (imgformat == QEMU_IMG_BACKING_FORMAT_OPTIONS) {
797
                virCommandAddArgList(cmd, "-o", "encryption=on", NULL);
798
            } else {
799
                virCommandAddArg(cmd, "-e");
800 801 802
            }
        }

803
    } else if (vol->backingStore.path) {
804 805 806
        virCommandAddArgList(cmd, "create", "-f", type,
                             "-b", vol->backingStore.path, NULL);

807 808
        switch (imgformat) {
        case QEMU_IMG_BACKING_FORMAT_FLAG:
809
            virCommandAddArgList(cmd, "-F", backingType, vol->target.path,
810 811
                                 NULL);
            virCommandAddArgFormat(cmd, "%lluK", size_arg);
812 813 814

            if (do_encryption)
                virCommandAddArg(cmd, "-e");
815 816 817
            break;

        case QEMU_IMG_BACKING_FORMAT_OPTIONS:
818 819 820
            virCommandAddArg(cmd, "-o");
            virCommandAddArgFormat(cmd, "backing_fmt=%s%s", backingType,
                                   do_encryption ? ",encryption=on" : "");
821 822
            virCommandAddArg(cmd, vol->target.path);
            virCommandAddArgFormat(cmd, "%lluK", size_arg);
823
            break;
824 825 826 827 828

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

829 830
            virCommandAddArg(cmd, vol->target.path);
            virCommandAddArgFormat(cmd, "%lluK", size_arg);
831 832 833
            if (do_encryption)
                virCommandAddArg(cmd, "-e");
        }
834
    } else {
835
        virCommandAddArgList(cmd, "create", "-f", type,
836 837
                             vol->target.path, NULL);
        virCommandAddArgFormat(cmd, "%lluK", size_arg);
838 839

        if (do_encryption) {
840
            if (imgformat == QEMU_IMG_BACKING_FORMAT_OPTIONS) {
841
                virCommandAddArgList(cmd, "-o", "encryption=on", NULL);
842
            } else {
843
                virCommandAddArg(cmd, "-e");
844 845
            }
        }
846
    }
847

848 849
    ret = virStorageBackendCreateExecCommand(pool, vol, cmd);
cleanup:
850
    VIR_FREE(create_tool);
851
    virCommandFree(cmd);
852

853
    return ret;
854 855 856 857 858 859 860
}

/*
 * Xen removed the fully-functional qemu-img, and replaced it
 * with a partially functional qcow-create. Go figure ??!?
 */
static int
861
virStorageBackendCreateQcowCreate(virConnectPtr conn ATTRIBUTE_UNUSED,
862
                                  virStoragePoolObjPtr pool,
863
                                  virStorageVolDefPtr vol,
864
                                  virStorageVolDefPtr inputvol,
E
Eric Blake 已提交
865
                                  unsigned int flags)
866
{
867
    int ret;
E
Eric Blake 已提交
868
    char *size;
869
    virCommandPtr cmd;
870

E
Eric Blake 已提交
871 872
    virCheckFlags(0, -1);

873
    if (inputvol) {
874
        virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
875 876 877 878
                              _("cannot copy from volume with qcow-create"));
        return -1;
    }

879
    if (vol->target.format != VIR_STORAGE_FILE_QCOW2) {
880
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
881 882 883 884 885
                              _("unsupported storage vol type %d"),
                              vol->target.format);
        return -1;
    }
    if (vol->backingStore.path != NULL) {
O
Osier Yang 已提交
886
        virStorageReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s",
887
                              _("copy-on-write image not supported with "
888
                                      "qcow-create"));
889 890
        return -1;
    }
891
    if (vol->target.encryption != NULL) {
O
Osier Yang 已提交
892
        virStorageReportError(VIR_ERR_CONFIG_UNSUPPORTED,
893 894 895 896
                              "%s", _("encrypted volumes not supported with "
                                      "qcow-create"));
        return -1;
    }
897 898

    /* Size in MB - yes different units to qemu-img :-( */
899 900
    if (virAsprintf(&size, "%llu",
                    VIR_DIV_UP(vol->capacity, (1024 * 1024))) < 0) {
E
Eric Blake 已提交
901 902 903
        virReportOOMError();
        return -1;
    }
904

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

907 908
    ret = virStorageBackendCreateExecCommand(pool, vol, cmd);
    virCommandFree(cmd);
E
Eric Blake 已提交
909
    VIR_FREE(size);
910

911
    return ret;
912 913
}

914
virStorageBackendBuildVolFrom
915
virStorageBackendFSImageToolTypeToFunc(int tool_type)
916 917 918 919 920 921 922 923
{
    switch (tool_type) {
    case TOOL_KVM_IMG:
    case TOOL_QEMU_IMG:
        return virStorageBackendCreateQemuImg;
    case TOOL_QCOW_CREATE:
        return virStorageBackendCreateQcowCreate;
    default:
924
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
                              _("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;
}

954
virStorageBackendBuildVolFrom
955
virStorageBackendGetBuildVolFromFunction(virStorageVolDefPtr vol,
956 957 958 959 960 961 962 963 964 965 966
                                         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 &&
967
         vol->target.format != VIR_STORAGE_FILE_RAW) ||
968
        (inputvol->type == VIR_STORAGE_VOL_FILE &&
969
         inputvol->target.format != VIR_STORAGE_FILE_RAW)) {
970

D
Daniel P. Berrange 已提交
971
        if ((tool_type = virStorageBackendFindFSImageTool(NULL)) < 0) {
972
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
973 974 975 976 977
                                  "%s", _("creation of non-raw file images is "
                                          "not supported without qemu-img."));
            return NULL;
        }

978
        return virStorageBackendFSImageToolTypeToFunc(tool_type);
979 980
    }

981 982 983 984
    if (vol->type == VIR_STORAGE_VOL_BLOCK)
        return virStorageBackendCreateBlockFrom;
    else
        return virStorageBackendCreateRaw;
985
}
986

987

988 989
virStorageBackendPtr
virStorageBackendForType(int type) {
990
    unsigned int i;
991
    for (i = 0; backends[i]; i++)
992 993 994
        if (backends[i]->type == type)
            return backends[i];

995
    virStorageReportError(VIR_ERR_INTERNAL_ERROR,
996 997 998 999 1000
                          _("missing backend for pool type %d"), type);
    return NULL;
}


1001 1002 1003
/*
 * Allows caller to silently ignore files with improper mode
 *
1004 1005
 * Returns -1 on error, -2 if file mode is unexpected or the
 * volume is a dangling symbolic link.
1006
 */
1007
int
1008
virStorageBackendVolOpenCheckMode(const char *path, unsigned int flags)
1009
{
1010 1011
    int fd, mode = 0;
    struct stat sb;
1012
    char *base = last_component(path);
1013

1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
    if (lstat(path, &sb) < 0) {
        virReportSystemError(errno,
                             _("cannot stat file '%s'"),
                             path);
        return -1;
    }

    if (S_ISFIFO(sb.st_mode)) {
        VIR_WARN("ignoring FIFO '%s'", path);
        return -2;
    } else if (S_ISSOCK(sb.st_mode)) {
        VIR_WARN("ignoring socket '%s'", path);
        return -2;
    }

1029
    if ((fd = open(path, O_RDONLY|O_NONBLOCK|O_NOCTTY)) < 0) {
1030
        if ((errno == ENOENT || errno == ELOOP) &&
1031
            S_ISLNK(sb.st_mode)) {
1032 1033 1034 1035
            VIR_WARN("ignoring dangling symlink '%s'", path);
            return -2;
        }

1036
        virReportSystemError(errno,
1037
                             _("cannot open volume '%s'"),
1038
                             path);
1039 1040 1041
        return -1;
    }

1042 1043 1044 1045 1046 1047 1048 1049
    if (fstat(fd, &sb) < 0) {
        virReportSystemError(errno,
                             _("cannot stat file '%s'"),
                             path);
        VIR_FORCE_CLOSE(fd);
        return -1;
    }

1050 1051 1052 1053 1054 1055
    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;
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
    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;
        }
    }
1066 1067

    if (!(mode & flags)) {
1068
        VIR_FORCE_CLOSE(fd);
1069
        VIR_INFO("Skipping volume '%s'", path);
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091

        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,
1092 1093
                                     unsigned long long *capacity,
                                     unsigned int openflags)
1094 1095 1096
{
    int ret, fd;

1097 1098
    if ((ret = virStorageBackendVolOpenCheckMode(target->path,
                                                 openflags)) < 0)
1099 1100 1101
        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 1114 1115
virStorageBackendUpdateVolInfoFlags(virStorageVolDefPtr vol,
                                    int withCapacity,
                                    unsigned int openflags)
1116 1117 1118
{
    int ret;

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

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

    return 0;
}

1134 1135 1136 1137 1138 1139 1140
int virStorageBackendUpdateVolInfo(virStorageVolDefPtr vol,
                                   int withCapacity)
{
    return virStorageBackendUpdateVolInfoFlags(vol, withCapacity,
                                               VIR_STORAGE_VOL_OPEN_DEFAULT);
}

1141 1142 1143 1144
/*
 * virStorageBackendUpdateVolTargetInfoFD:
 * @conn: connection to report errors on
 * @target: target definition ptr of volume to update
1145
 * @fd: fd of storage volume to update, via virStorageBackendOpenVol*
1146 1147 1148
 * @allocation: If not NULL, updated allocation information will be stored
 * @capacity: If not NULL, updated capacity info will be stored
 *
1149
 * Returns 0 for success, -1 on a legitimate error condition.
1150
 */
1151
int
1152
virStorageBackendUpdateVolTargetInfoFD(virStorageVolTargetPtr target,
1153 1154 1155
                                       int fd,
                                       unsigned long long *allocation,
                                       unsigned long long *capacity)
1156 1157 1158 1159 1160 1161 1162
{
    struct stat sb;
#if HAVE_SELINUX
    security_context_t filecon = NULL;
#endif

    if (fstat(fd, &sb) < 0) {
1163
        virReportSystemError(errno,
1164
                             _("cannot stat file '%s'"),
1165
                             target->path);
1166 1167 1168
        return -1;
    }

1169 1170
    if (allocation) {
        if (S_ISREG(sb.st_mode)) {
1171
#ifndef WIN32
1172
            *allocation = (unsigned long long)sb.st_blocks *
1173
                          (unsigned long long)DEV_BSIZE;
D
Daniel P. Berrange 已提交
1174
#else
1175
            *allocation = sb.st_size;
D
Daniel P. Berrange 已提交
1176
#endif
1177 1178 1179 1180 1181
            /* Regular files may be sparse, so logical size (capacity) is not same
             * as actual allocation above
             */
            if (capacity)
                *capacity = sb.st_size;
1182 1183 1184 1185 1186
        } else if (S_ISDIR(sb.st_mode)) {
            *allocation = 0;
            if (capacity)
                *capacity = 0;

1187 1188
        } else {
            off_t end;
E
Eric Blake 已提交
1189
            /* XXX this is POSIX compliant, but doesn't work for CHAR files,
1190 1191 1192 1193 1194 1195
             * 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) {
1196
                virReportSystemError(errno,
1197 1198 1199 1200 1201 1202 1203
                                     _("cannot seek to end of file '%s'"),
                                     target->path);
                return -1;
            }
            *allocation = end;
            if (capacity)
                *capacity = end;
1204 1205 1206
        }
    }

1207 1208 1209
    target->perms.mode = sb.st_mode & S_IRWXUGO;
    target->perms.uid = sb.st_uid;
    target->perms.gid = sb.st_gid;
1210

1211
    VIR_FREE(target->perms.label);
1212 1213

#if HAVE_SELINUX
1214
    /* XXX: make this a security driver call */
1215
    if (fgetfilecon(fd, &filecon) == -1) {
1216
        if (errno != ENODATA && errno != ENOTSUP) {
1217
            virReportSystemError(errno,
1218
                                 _("cannot get file context of '%s'"),
1219
                                 target->path);
1220 1221
            return -1;
        } else {
1222
            target->perms.label = NULL;
1223 1224
        }
    } else {
1225
        target->perms.label = strdup(filecon);
1226
        freecon(filecon);
1227
        if (target->perms.label == NULL) {
1228
            virReportOOMError();
1229 1230
            return -1;
        }
1231 1232
    }
#else
1233
    target->perms.label = NULL;
1234 1235 1236 1237 1238
#endif

    return 0;
}

D
Dave Allan 已提交
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273

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
1274 1275
virStorageBackendDetectBlockVolFormatFD(virStorageVolTargetPtr target,
                                        int fd)
D
Dave Allan 已提交
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
{
    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) {
1287
        virReportSystemError(errno,
D
Dave Allan 已提交
1288 1289 1290 1291 1292 1293
                             _("cannot seek to beginning of file '%s'"),
                             target->path);
        return -1;
    }
    bytes = saferead(fd, buffer, sizeof(buffer));
    if (bytes < 0) {
1294
        virReportSystemError(errno,
D
Dave Allan 已提交
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
                             _("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;
}


1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
/*
 * 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 *
1328
virStorageBackendStablePath(virStoragePoolObjPtr pool,
1329
                            const char *devpath)
1330 1331 1332
{
    DIR *dh;
    struct dirent *dent;
1333
    char *stablepath;
1334
    int opentries = 0;
1335 1336 1337 1338 1339

    /* 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/"))
1340
        goto ret_strdup;
1341

1342 1343 1344 1345 1346 1347
    /* 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;

1348 1349 1350 1351
    /* Logical pools are under /dev but already have stable paths */
    if (pool->def->type == VIR_STORAGE_POOL_LOGICAL)
        goto ret_strdup;

1352 1353 1354
    /* 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.
1355
     */
1356
 reopen:
1357
    if ((dh = opendir(pool->def->target.path)) == NULL) {
1358 1359 1360 1361 1362
        opentries++;
        if (errno == ENOENT && opentries < 50) {
            usleep(100 * 1000);
            goto reopen;
        }
1363
        virReportSystemError(errno,
1364 1365
                             _("cannot read dir '%s'"),
                             pool->def->target.path);
1366 1367 1368
        return NULL;
    }

1369 1370 1371 1372 1373
    /* 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
     */
1374 1375 1376 1377
    while ((dent = readdir(dh)) != NULL) {
        if (dent->d_name[0] == '.')
            continue;

1378 1379 1380
        if (virAsprintf(&stablepath, "%s/%s",
                        pool->def->target.path,
                        dent->d_name) == -1) {
1381
            virReportOOMError();
1382 1383 1384 1385 1386 1387 1388 1389 1390
            closedir(dh);
            return NULL;
        }

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

1391
        VIR_FREE(stablepath);
1392 1393 1394 1395
    }

    closedir(dh);

1396
 ret_strdup:
1397 1398 1399
    /* Couldn't find any matching stable link so give back
     * the original non-stable dev path
     */
1400 1401 1402 1403

    stablepath = strdup(devpath);

    if (stablepath == NULL)
1404
        virReportOOMError();
1405 1406

    return stablepath;
1407 1408
}

D
Daniel P. Berrange 已提交
1409

1410
#ifndef WIN32
1411 1412 1413 1414
/*
 * Run an external program.
 *
 * Read its output and apply a series of regexes to each line
R
Richard W.M. Jones 已提交
1415
 * When the entire set of regexes has matched consecutively
1416 1417 1418
 * then run a callback passing in all the matches
 */
int
1419
virStorageBackendRunProgRegex(virStoragePoolObjPtr pool,
1420
                              virCommandPtr cmd,
1421 1422 1423 1424
                              int nregex,
                              const char **regex,
                              int *nvars,
                              virStorageBackendListVolRegexFunc func,
1425
                              void *data, const char *prefix)
1426
{
1427
    int fd = -1, err, ret = -1;
1428 1429 1430 1431 1432 1433 1434 1435 1436
    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 */
1437
    if (VIR_ALLOC_N(reg, nregex) < 0) {
1438
        virReportOOMError();
1439 1440 1441 1442 1443 1444 1445 1446
        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));
1447
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
1448 1449 1450
                                  _("Failed to compile regex %s"), error);
            for (j = 0 ; j <= i ; j++)
                regfree(&reg[j]);
1451
            VIR_FREE(reg);
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461
            return -1;
        }

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

    }

    /* Storage for matched variables */
1462
    if (VIR_ALLOC_N(groups, totgroups) < 0) {
1463
        virReportOOMError();
1464 1465
        goto cleanup;
    }
1466
    if (VIR_ALLOC_N(vars, maxvars+1) < 0) {
1467
        virReportOOMError();
1468 1469 1470
        goto cleanup;
    }

1471 1472
    virCommandSetOutputFD(cmd, &fd);
    if (virCommandRunAsync(cmd, NULL) < 0) {
1473 1474 1475
        goto cleanup;
    }

1476
    if ((list = VIR_FDOPEN(fd, "r")) == NULL) {
1477
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
J
Jim Meyering 已提交
1478
                              "%s", _("cannot read fd"));
1479 1480 1481 1482
        goto cleanup;
    }

    while (fgets(line, sizeof(line), list) != NULL) {
1483
        char *p = NULL;
1484 1485 1486 1487 1488
        /* Strip trailing newline */
        int len = strlen(line);
        if (len && line[len-1] == '\n')
            line[len-1] = '\0';

1489 1490 1491 1492 1493 1494
        /* ignore any command prefix */
        if (prefix)
            p = STRSKIP(line, prefix);
        if (!p)
            p = line;

1495
        for (i = 0 ; i <= maxReg && i < nregex ; i++) {
1496
            if (regexec(&reg[i], p, nvars[i]+1, vars, 0) == 0) {
1497 1498 1499 1500 1501 1502 1503 1504
                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 */
1505
                    p[vars[j+1].rm_eo] = '\0';
1506
                    if ((groups[ngroup++] =
1507
                         strdup(p + vars[j+1].rm_so)) == NULL) {
1508
                        virReportOOMError();
1509 1510 1511 1512 1513 1514
                        goto cleanup;
                    }
                }

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

                    /* Release matches & restart to matching the first regex */
1519
                    for (j = 0 ; j < totgroups ; j++)
1520
                        VIR_FREE(groups[j]);
1521 1522 1523 1524 1525 1526 1527
                    maxReg = 0;
                    ngroup = 0;
                }
            }
        }
    }

1528
    ret = virCommandWait(cmd, NULL);
1529
cleanup:
1530 1531
    if (groups) {
        for (j = 0 ; j < totgroups ; j++)
1532 1533
            VIR_FREE(groups[j]);
        VIR_FREE(groups);
1534
    }
1535
    VIR_FREE(vars);
1536 1537 1538 1539

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

1540
    VIR_FREE(reg);
1541

1542 1543
    VIR_FORCE_FCLOSE(list);
    VIR_FORCE_CLOSE(fd);
1544

1545
    return ret;
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
}

/*
 * 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
1560
virStorageBackendRunProgNul(virStoragePoolObjPtr pool,
1561
                            virCommandPtr cmd,
1562 1563 1564 1565 1566
                            size_t n_columns,
                            virStorageBackendListVolNulFunc func,
                            void *data)
{
    size_t n_tok = 0;
1567
    int fd = -1;
1568 1569
    FILE *fp = NULL;
    char **v;
1570
    int ret = -1;
1571 1572 1573 1574 1575
    int i;

    if (n_columns == 0)
        return -1;

1576
    if (VIR_ALLOC_N(v, n_columns) < 0) {
1577
        virReportOOMError();
1578 1579 1580 1581 1582
        return -1;
    }
    for (i = 0; i < n_columns; i++)
        v[i] = NULL;

1583 1584
    virCommandSetOutputFD(cmd, &fd);
    if (virCommandRunAsync(cmd, NULL) < 0) {
1585 1586 1587
        goto cleanup;
    }

1588
    if ((fp = VIR_FDOPEN(fd, "r")) == NULL) {
1589
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
1590
                              "%s", _("cannot open file using fd"));
1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
        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.  */
1604
            if (n_tok && func (pool, n_tok, v, data) < 0)
1605 1606 1607 1608 1609
                goto cleanup;
            break;
        }
        ++n_tok;
        if (n_tok == n_columns) {
1610
            if (func (pool, n_tok, v, data) < 0)
1611 1612 1613
                goto cleanup;
            n_tok = 0;
            for (i = 0; i < n_columns; i++) {
1614
                VIR_FREE(v[i]);
1615 1616 1617 1618
            }
        }
    }

1619 1620 1621
    if (feof(fp) < 0) {
        virReportSystemError(errno, "%s",
                             _("read error on pipe"));
1622 1623
        goto cleanup;
    }
1624

1625
    ret = virCommandWait(cmd, NULL);
1626 1627
 cleanup:
    for (i = 0; i < n_columns; i++)
1628 1629
        VIR_FREE(v[i]);
    VIR_FREE(v);
1630

1631 1632
    VIR_FORCE_FCLOSE(fp);
    VIR_FORCE_CLOSE(fd);
1633

1634
    return ret;
1635
}
D
Daniel P. Berrange 已提交
1636

1637
#else /* WIN32 */
D
Daniel P. Berrange 已提交
1638 1639 1640 1641 1642 1643 1644 1645 1646

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,
1647
                              void *data ATTRIBUTE_UNUSED)
D
Daniel P. Berrange 已提交
1648
{
1649 1650
    virStorageReportError(VIR_ERR_INTERNAL_ERROR,
                          _("%s not implemented on Win32"), __FUNCTION__);
D
Daniel P. Berrange 已提交
1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661
    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)
{
1662
    virStorageReportError(VIR_ERR_INTERNAL_ERROR, _("%s not implemented on Win32"), __FUNCTION__);
D
Daniel P. Berrange 已提交
1663 1664
    return -1;
}
1665
#endif /* WIN32 */