virstoragefile.c 45.1 KB
Newer Older
1
/*
2
 * virstoragefile.c: file utility functions for FS storage backend
3
 *
4
 * Copyright (C) 2007-2013 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17
 * 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
18
 * License along with this library.  If not, see
O
Osier Yang 已提交
19
 * <http://www.gnu.org/licenses/>.
20 21 22 23 24
 *
 * Author: Daniel P. Berrange <berrange@redhat.com>
 */

#include <config.h>
25
#include "virstoragefile.h"
26

27
#include <sys/stat.h>
28
#include <unistd.h>
29
#include <fcntl.h>
30
#include <stdlib.h>
31
#ifdef __linux__
32 33 34
# if HAVE_LINUX_MAGIC_H
#  include <linux/magic.h>
# endif
35 36
# include <sys/statfs.h>
#endif
37
#include "dirname.h"
38
#include "viralloc.h"
39
#include "virerror.h"
40
#include "virlog.h"
E
Eric Blake 已提交
41
#include "virfile.h"
42
#include "c-ctype.h"
43
#include "vircommand.h"
44
#include "virhash.h"
E
Eric Blake 已提交
45
#include "virendian.h"
46 47
#include "virstring.h"
#include "virutil.h"
48 49 50
#if HAVE_SYS_SYSCALL_H
# include <sys/syscall.h>
#endif
51 52 53

#define VIR_FROM_THIS VIR_FROM_STORAGE

54 55
VIR_ENUM_IMPL(virStorageFileFormat,
              VIR_STORAGE_FILE_LAST,
E
Eric Blake 已提交
56
              "none",
57
              "raw", "dir", "bochs",
58
              "cloop", "cow", "dmg", "iso",
E
Eric Blake 已提交
59
              "qcow", "qcow2", "qed", "vmdk", "vpc",
60
              "fat", "vhd", "vdi")
61

62 63 64 65 66
VIR_ENUM_IMPL(virStorageFileFeature,
              VIR_STORAGE_FILE_FEATURE_LAST,
              "lazy_refcounts",
              )

67 68 69 70 71 72 73 74 75 76 77
enum lv_endian {
    LV_LITTLE_ENDIAN = 1, /* 1234 */
    LV_BIG_ENDIAN         /* 4321 */
};

enum {
    BACKING_STORE_OK,
    BACKING_STORE_INVALID,
    BACKING_STORE_ERROR,
};

78 79
#define FILE_TYPE_VERSIONS_LAST 2

80 81
/* Either 'magic' or 'extension' *must* be provided */
struct FileTypeInfo {
82
    int magicOffset;    /* Byte offset of the magic */
83 84 85 86 87 88
    const char *magic;  /* Optional string of file magic
                         * to check at head of file */
    const char *extension; /* Optional file extension to check */
    enum lv_endian endian; /* Endianness of file format */
    int versionOffset;    /* Byte offset from start of file
                           * where we find version number,
89 90
                           * -1 to always fail the version test,
                           * -2 to always pass the version test */
91 92
    int versionNumbers[FILE_TYPE_VERSIONS_LAST];
                          /* Version numbers to validate. Zeroes are ignored. */
93 94 95 96 97 98 99 100 101 102 103
    int sizeOffset;       /* Byte offset from start of file
                           * where we find capacity info,
                           * -1 to use st_size as capacity */
    int sizeBytes;        /* Number of bytes for size field */
    int sizeMultiplier;   /* A scaling factor if size is not in bytes */
                          /* Store a COW base image path (possibly relative),
                           * or NULL if there is no COW base image, to RES;
                           * return BACKING_STORE_* */
    int qcowCryptOffset;  /* Byte offset from start of file
                           * where to find encryption mode,
                           * -1 if encryption is not used */
104 105
    int (*getBackingStore)(char **res, int *format,
                           const unsigned char *buf, size_t buf_size);
106 107
    int (*getFeatures)(virBitmapPtr *features, int format,
                       unsigned char *buf, ssize_t len);
108 109
};

110 111 112 113 114 115
static int cowGetBackingStore(char **, int *,
                              const unsigned char *, size_t);
static int qcow1GetBackingStore(char **, int *,
                                const unsigned char *, size_t);
static int qcow2GetBackingStore(char **, int *,
                                const unsigned char *, size_t);
116 117
static int qcow2GetFeatures(virBitmapPtr *features, int format,
                            unsigned char *buf, ssize_t len);
118 119
static int vmdk4GetBackingStore(char **, int *,
                                const unsigned char *, size_t);
120 121
static int
qedGetBackingStore(char **, int *, const unsigned char *, size_t);
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136

#define QCOWX_HDR_VERSION (4)
#define QCOWX_HDR_BACKING_FILE_OFFSET (QCOWX_HDR_VERSION+4)
#define QCOWX_HDR_BACKING_FILE_SIZE (QCOWX_HDR_BACKING_FILE_OFFSET+8)
#define QCOWX_HDR_IMAGE_SIZE (QCOWX_HDR_BACKING_FILE_SIZE+4+4)

#define QCOW1_HDR_CRYPT (QCOWX_HDR_IMAGE_SIZE+8+1+1)
#define QCOW2_HDR_CRYPT (QCOWX_HDR_IMAGE_SIZE+8)

#define QCOW1_HDR_TOTAL_SIZE (QCOW1_HDR_CRYPT+4+8)
#define QCOW2_HDR_TOTAL_SIZE (QCOW2_HDR_CRYPT+4+4+8+8+4+4+8)

#define QCOW2_HDR_EXTENSION_END 0
#define QCOW2_HDR_EXTENSION_BACKING_FORMAT 0xE2792ACA

137 138 139 140 141 142 143
#define QCOW2v3_HDR_FEATURES_INCOMPATIBLE (QCOW2_HDR_TOTAL_SIZE)
#define QCOW2v3_HDR_FEATURES_COMPATIBLE (QCOW2v3_HDR_FEATURES_INCOMPATIBLE+8)
#define QCOW2v3_HDR_FEATURES_AUTOCLEAR (QCOW2v3_HDR_FEATURES_COMPATIBLE+8)

/* The location of the header size [4 bytes] */
#define QCOW2v3_HDR_SIZE       (QCOW2_HDR_TOTAL_SIZE+8+8+8+4)

144
#define QED_HDR_FEATURES_OFFSET (4+4+4+4)
145 146
#define QED_HDR_IMAGE_SIZE (QED_HDR_FEATURES_OFFSET+8+8+8+8)
#define QED_HDR_BACKING_FILE_OFFSET (QED_HDR_IMAGE_SIZE+8)
147 148 149
#define QED_HDR_BACKING_FILE_SIZE (QED_HDR_BACKING_FILE_OFFSET+4)
#define QED_F_BACKING_FILE 0x01
#define QED_F_BACKING_FORMAT_NO_PROBE 0x04
A
Adam Litke 已提交
150

151 152
/* VMDK needs at least 20*512 B to find backing store,
 * ISO has 5 Byte magic on offset 32769,
153
 * other formats need less */
154
#define STORAGE_MAX_HEAD 32769+5
155 156 157


static struct FileTypeInfo const fileTypeInfo[] = {
158
    [VIR_STORAGE_FILE_NONE] = { 0, NULL, NULL, LV_LITTLE_ENDIAN,
159
                                -1, {0}, 0, 0, 0, 0, NULL, NULL },
160
    [VIR_STORAGE_FILE_RAW] = { 0, NULL, NULL, LV_LITTLE_ENDIAN,
161
                               -1, {0}, 0, 0, 0, 0, NULL, NULL },
162
    [VIR_STORAGE_FILE_DIR] = { 0, NULL, NULL, LV_LITTLE_ENDIAN,
163
                               -1, {0}, 0, 0, 0, 0, NULL, NULL },
164
    [VIR_STORAGE_FILE_BOCHS] = {
165 166
        /*"Bochs Virtual HD Image", */ /* Untested */
        0, NULL, NULL,
167 168
        LV_LITTLE_ENDIAN, 64, {0x20000},
        32+16+16+4+4+4+4+4, 8, 1, -1, NULL, NULL
169 170
    },
    [VIR_STORAGE_FILE_CLOOP] = {
171 172 173 174 175
        /* #!/bin/sh
           #V2.0 Format
           modprobe cloop file=$0 && mount -r -t iso9660 /dev/cloop $1
        */ /* Untested */
        0, NULL, NULL,
176 177
        LV_LITTLE_ENDIAN, -1, {0},
        -1, 0, 0, -1, NULL, NULL
178 179
    },
    [VIR_STORAGE_FILE_COW] = {
180
        0, "OOOM", NULL,
181 182
        LV_BIG_ENDIAN, 4, {2},
        4+4+1024+4, 8, 1, -1, cowGetBackingStore, NULL
183 184
    },
    [VIR_STORAGE_FILE_DMG] = {
185 186 187 188
        /* XXX QEMU says there's no magic for dmg,
         * /usr/share/misc/magic lists double magic (both offsets
         * would have to match) but then disables that check. */
        0, NULL, ".dmg",
189 190
        0, -1, {0},
        -1, 0, 0, -1, NULL, NULL
191 192
    },
    [VIR_STORAGE_FILE_ISO] = {
193
        32769, "CD001", ".iso",
194 195
        LV_LITTLE_ENDIAN, -2, {0},
        -1, 0, 0, -1, NULL, NULL
196 197
    },
    [VIR_STORAGE_FILE_QCOW] = {
198
        0, "QFI", NULL,
199 200
        LV_BIG_ENDIAN, 4, {1},
        QCOWX_HDR_IMAGE_SIZE, 8, 1, QCOW1_HDR_CRYPT, qcow1GetBackingStore, NULL
201 202
    },
    [VIR_STORAGE_FILE_QCOW2] = {
203
        0, "QFI", NULL,
204
        LV_BIG_ENDIAN, 4, {2, 3},
205
        QCOWX_HDR_IMAGE_SIZE, 8, 1, QCOW2_HDR_CRYPT, qcow2GetBackingStore,
206
        qcow2GetFeatures
207
    },
A
Adam Litke 已提交
208 209
    [VIR_STORAGE_FILE_QED] = {
        /* http://wiki.qemu.org/Features/QED */
210
        0, "QED", NULL,
211 212
        LV_LITTLE_ENDIAN, -2, {0},
        QED_HDR_IMAGE_SIZE, 8, 1, -1, qedGetBackingStore, NULL
A
Adam Litke 已提交
213
    },
214
    [VIR_STORAGE_FILE_VMDK] = {
215
        0, "KDMV", NULL,
216
        LV_LITTLE_ENDIAN, 4, {1, 2},
217
        4+4+4, 8, 512, -1, vmdk4GetBackingStore, NULL
218 219
    },
    [VIR_STORAGE_FILE_VPC] = {
220
        0, "conectix", NULL,
221 222
        LV_BIG_ENDIAN, 12, {0x10000},
        8 + 4 + 4 + 8 + 4 + 4 + 2 + 2 + 4, 8, 1, -1, NULL, NULL
223
    },
224 225 226
    /* TODO: add getBackingStore function */
    [VIR_STORAGE_FILE_VDI] = {
        64, "\x7f\x10\xda\xbe", ".vdi",
227 228
        LV_LITTLE_ENDIAN, 68, {0x00010001},
        64 + 5 * 4 + 256 + 7 * 4, 8, 1, -1, NULL, NULL},
229

E
Eric Blake 已提交
230
    /* Not direct file formats, but used for various drivers */
231
    [VIR_STORAGE_FILE_FAT] = { 0, NULL, NULL, LV_LITTLE_ENDIAN,
232
                               -1, {0}, 0, 0, 0, 0, NULL, NULL },
233
    [VIR_STORAGE_FILE_VHD] = { 0, NULL, NULL, LV_LITTLE_ENDIAN,
234
                               -1, {0}, 0, 0, 0, 0, NULL, NULL },
235
};
236
verify(ARRAY_CARDINALITY(fileTypeInfo) == VIR_STORAGE_FILE_LAST);
237

238 239 240 241 242 243 244 245 246 247 248 249 250 251
/* qcow2 compatible features in the order they appear on-disk */
enum qcow2CompatibleFeature {
    QCOW2_COMPATIBLE_FEATURE_LAZY_REFCOUNTS = 0,

    QCOW2_COMPATIBLE_FEATURE_LAST
};

/* conversion to virStorageFileFeature */
static const int qcow2CompatibleFeatureArray[] = {
    VIR_STORAGE_FILE_FEATURE_LAZY_REFCOUNTS,
};
verify(ARRAY_CARDINALITY(qcow2CompatibleFeatureArray) ==
       QCOW2_COMPATIBLE_FEATURE_LAST);

252
static int
253
cowGetBackingStore(char **res,
254
                   int *format,
255 256 257 258 259
                   const unsigned char *buf,
                   size_t buf_size)
{
#define COW_FILENAME_MAXLEN 1024
    *res = NULL;
260 261
    *format = VIR_STORAGE_FILE_AUTO;

262 263
    if (buf_size < 4+4+ COW_FILENAME_MAXLEN)
        return BACKING_STORE_INVALID;
E
Eric Blake 已提交
264 265
    if (buf[4+4] == '\0') { /* cow_header_v2.backing_file[0] */
        *format = VIR_STORAGE_FILE_NONE;
266
        return BACKING_STORE_OK;
E
Eric Blake 已提交
267
    }
268

269
    if (VIR_STRNDUP(*res, (const char*)buf + 4 + 4, COW_FILENAME_MAXLEN) < 0)
270 271 272 273
        return BACKING_STORE_ERROR;
    return BACKING_STORE_OK;
}

274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295

static int
qcow2GetBackingStoreFormat(int *format,
                           const unsigned char *buf,
                           size_t buf_size,
                           size_t extension_start,
                           size_t extension_end)
{
    size_t offset = extension_start;

    /*
     * The extensions take format of
     *
     * int32: magic
     * int32: length
     * byte[length]: payload
     *
     * Unknown extensions can be ignored by skipping
     * over "length" bytes in the data stream.
     */
    while (offset < (buf_size-8) &&
           offset < (extension_end-8)) {
E
Eric Blake 已提交
296 297
        unsigned int magic = virReadBufInt32BE(buf + offset);
        unsigned int len = virReadBufInt32BE(buf + offset + 4);
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315

        offset += 8;

        if ((offset + len) < offset)
            break;

        if ((offset + len) > buf_size)
            break;

        switch (magic) {
        case QCOW2_HDR_EXTENSION_END:
            goto done;

        case QCOW2_HDR_EXTENSION_BACKING_FORMAT:
            if (buf[offset+len] != '\0')
                break;
            *format = virStorageFileFormatTypeFromString(
                ((const char *)buf)+offset);
E
Eric Blake 已提交
316 317
            if (*format <= VIR_STORAGE_FILE_NONE)
                return -1;
318 319 320 321 322 323 324 325 326 327 328
        }

        offset += len;
    }

done:

    return 0;
}


329
static int
330
qcowXGetBackingStore(char **res,
331
                     int *format,
332
                     const unsigned char *buf,
333 334
                     size_t buf_size,
                     bool isQCow2)
335 336
{
    unsigned long long offset;
337
    unsigned int size;
338 339
    unsigned long long start;
    int version;
340 341

    *res = NULL;
342 343 344 345
    if (format)
        *format = VIR_STORAGE_FILE_AUTO;

    if (buf_size < QCOWX_HDR_BACKING_FILE_OFFSET+8+4)
346
        return BACKING_STORE_INVALID;
E
Eric Blake 已提交
347
    offset = virReadBufInt64BE(buf + QCOWX_HDR_BACKING_FILE_OFFSET);
348 349
    if (offset > buf_size)
        return BACKING_STORE_INVALID;
E
Eric Blake 已提交
350
    size = virReadBufInt32BE(buf + QCOWX_HDR_BACKING_FILE_SIZE);
E
Eric Blake 已提交
351 352 353
    if (size == 0) {
        if (format)
            *format = VIR_STORAGE_FILE_NONE;
354
        return BACKING_STORE_OK;
E
Eric Blake 已提交
355
    }
356 357 358 359
    if (offset + size > buf_size || offset + size < offset)
        return BACKING_STORE_INVALID;
    if (size + 1 == 0)
        return BACKING_STORE_INVALID;
360
    if (VIR_ALLOC_N(*res, size + 1) < 0)
361 362 363
        return BACKING_STORE_ERROR;
    memcpy(*res, buf + offset, size);
    (*res)[size] = '\0';
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387

    /*
     * Traditionally QCow2 files had a layout of
     *
     * [header]
     * [backingStoreName]
     *
     * Although the backingStoreName typically followed
     * the header immediately, this was not required by
     * the format. By specifying a higher byte offset for
     * the backing file offset in the header, it was
     * possible to leave space between the header and
     * start of backingStore.
     *
     * This hack is now used to store extensions to the
     * qcow2 format:
     *
     * [header]
     * [extensions]
     * [backingStoreName]
     *
     * Thus the file region to search for extensions is
     * between the end of the header (QCOW2_HDR_TOTAL_SIZE)
     * and the start of the backingStoreName (offset)
388 389 390
     *
     * for qcow2 v3 images, the length of the header
     * is stored at QCOW2v3_HDR_SIZE
391
     */
392 393 394 395 396 397 398 399 400 401
    if (isQCow2 && format) {
        version = virReadBufInt32BE(buf + QCOWX_HDR_VERSION);
        if (version == 2)
            start = QCOW2_HDR_TOTAL_SIZE;
        else
            start = virReadBufInt32BE(buf + QCOW2v3_HDR_SIZE);
        if (qcow2GetBackingStoreFormat(format, buf, buf_size,
                                       start, offset) < 0)
            return BACKING_STORE_INVALID;
    }
402

403 404 405 406
    return BACKING_STORE_OK;
}


407 408 409 410 411 412
static int
qcow1GetBackingStore(char **res,
                     int *format,
                     const unsigned char *buf,
                     size_t buf_size)
{
E
Eric Blake 已提交
413 414
    int ret;

415 416 417
    /* QCow1 doesn't have the extensions capability
     * used to store backing format */
    *format = VIR_STORAGE_FILE_AUTO;
E
Eric Blake 已提交
418 419 420 421
    ret = qcowXGetBackingStore(res, NULL, buf, buf_size, false);
    if (ret == 0 && *buf == '\0')
        *format = VIR_STORAGE_FILE_NONE;
    return ret;
422 423 424 425 426 427 428 429 430 431 432 433
}

static int
qcow2GetBackingStore(char **res,
                     int *format,
                     const unsigned char *buf,
                     size_t buf_size)
{
    return qcowXGetBackingStore(res, format, buf, buf_size, true);
}


434
static int
435
vmdk4GetBackingStore(char **res,
436
                     int *format,
437 438 439 440
                     const unsigned char *buf,
                     size_t buf_size)
{
    static const char prefix[] = "parentFileNameHint=\"";
441
    char *desc, *start, *end;
442
    size_t len;
443 444
    int ret = BACKING_STORE_ERROR;

445
    if (VIR_ALLOC_N(desc, STORAGE_MAX_HEAD + 1) < 0)
446
        goto cleanup;
447 448

    *res = NULL;
449 450 451 452 453 454 455 456
    /*
     * Technically this should have been VMDK, since
     * VMDK spec / VMWare impl only support VMDK backed
     * by VMDK. QEMU isn't following this though and
     * does probing on VMDK backing files, hence we set
     * AUTO
     */
    *format = VIR_STORAGE_FILE_AUTO;
457

458 459 460 461
    if (buf_size <= 0x200) {
        ret = BACKING_STORE_INVALID;
        goto cleanup;
    }
462
    len = buf_size - 0x200;
463 464
    if (len > STORAGE_MAX_HEAD)
        len = STORAGE_MAX_HEAD;
465 466 467
    memcpy(desc, buf + 0x200, len);
    desc[len] = '\0';
    start = strstr(desc, prefix);
468
    if (start == NULL) {
E
Eric Blake 已提交
469
        *format = VIR_STORAGE_FILE_NONE;
470 471 472
        ret = BACKING_STORE_OK;
        goto cleanup;
    }
473 474
    start += strlen(prefix);
    end = strchr(start, '"');
475 476 477 478 479
    if (end == NULL) {
        ret = BACKING_STORE_INVALID;
        goto cleanup;
    }
    if (end == start) {
E
Eric Blake 已提交
480
        *format = VIR_STORAGE_FILE_NONE;
481 482 483
        ret = BACKING_STORE_OK;
        goto cleanup;
    }
484
    *end = '\0';
485
    if (VIR_STRDUP(*res, start) < 0)
486 487 488 489 490 491 492
        goto cleanup;

    ret = BACKING_STORE_OK;

cleanup:
    VIR_FREE(desc);
    return ret;
493 494
}

495 496 497 498 499 500 501 502 503 504 505 506 507
static int
qedGetBackingStore(char **res,
                   int *format,
                   const unsigned char *buf,
                   size_t buf_size)
{
    unsigned long long flags;
    unsigned long offset, size;

    *res = NULL;
    /* Check if this image has a backing file */
    if (buf_size < QED_HDR_FEATURES_OFFSET+8)
        return BACKING_STORE_INVALID;
E
Eric Blake 已提交
508
    flags = virReadBufInt64LE(buf + QED_HDR_FEATURES_OFFSET);
E
Eric Blake 已提交
509 510
    if (!(flags & QED_F_BACKING_FILE)) {
        *format = VIR_STORAGE_FILE_NONE;
511
        return BACKING_STORE_OK;
E
Eric Blake 已提交
512
    }
513 514 515 516

    /* Parse the backing file */
    if (buf_size < QED_HDR_BACKING_FILE_OFFSET+8)
        return BACKING_STORE_INVALID;
E
Eric Blake 已提交
517
    offset = virReadBufInt32LE(buf + QED_HDR_BACKING_FILE_OFFSET);
518 519
    if (offset > buf_size)
        return BACKING_STORE_INVALID;
E
Eric Blake 已提交
520
    size = virReadBufInt32LE(buf + QED_HDR_BACKING_FILE_SIZE);
521 522 523 524
    if (size == 0)
        return BACKING_STORE_OK;
    if (offset + size > buf_size || offset + size < offset)
        return BACKING_STORE_INVALID;
525
    if (VIR_ALLOC_N(*res, size + 1) < 0)
526 527 528 529
        return BACKING_STORE_ERROR;
    memcpy(*res, buf + offset, size);
    (*res)[size] = '\0';

E
Eric Blake 已提交
530 531 532 533
    if (flags & QED_F_BACKING_FORMAT_NO_PROBE)
        *format = VIR_STORAGE_FILE_RAW;
    else
        *format = VIR_STORAGE_FILE_AUTO_SAFE;
534 535 536 537

    return BACKING_STORE_OK;
}

538
/**
539 540 541 542 543
 * Given a starting point START (either an original file name, or the
 * directory containing the original name, depending on START_IS_DIR)
 * and a possibly relative backing file NAME, compute the relative
 * DIRECTORY (optional) and CANONICAL (mandatory) location of the
 * backing file.  Return 0 on success, negative on error.
544
 */
545 546 547
static int ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3) ATTRIBUTE_NONNULL(5)
virFindBackingFile(const char *start, bool start_is_dir, const char *path,
                   char **directory, char **canonical)
548
{
549 550
    char *combined = NULL;
    int ret = -1;
551

552 553 554 555 556
    if (*path == '/') {
        /* Safe to cast away const */
        combined = (char *)path;
    } else {
        size_t d_len = start_is_dir ? strlen(start) : dir_len(start);
557

558 559 560 561 562 563 564 565
        if (d_len > INT_MAX) {
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("name too long: '%s'"), start);
            goto cleanup;
        } else if (d_len == 0) {
            start = ".";
            d_len = 1;
        }
566
        if (virAsprintf(&combined, "%.*s/%s", (int)d_len, start, path) < 0)
567
            goto cleanup;
568
    }
569

570 571
    if (directory && !(*directory = mdir_name(combined))) {
        virReportOOMError();
572 573
        goto cleanup;
    }
574

575 576 577 578 579 580 581
    if (virFileAccessibleAs(combined, F_OK, getuid(), getgid()) < 0) {
        virReportSystemError(errno,
                             _("Cannot access backing file '%s'"),
                             combined);
        goto cleanup;
    }

582 583 584
    if (!(*canonical = canonicalize_file_name(combined))) {
        virReportSystemError(errno,
                             _("Can't canonicalize path '%s'"), path);
585 586 587
        goto cleanup;
    }

588
    ret = 0;
589 590

cleanup:
591 592 593
    if (combined != path)
        VIR_FREE(combined);
    return ret;
594 595
}

596 597 598 599 600

static bool
virStorageFileMatchesMagic(int format,
                           unsigned char *buf,
                           size_t buflen)
601
{
602
    int mlen;
603 604
    int magicOffset = fileTypeInfo[format].magicOffset;
    const char *magic = fileTypeInfo[format].magic;
605

606
    if (magic == NULL)
607
        return false;
608

609
    /* Validate magic data */
610 611
    mlen = strlen(magic);
    if (magicOffset + mlen > buflen)
612
        return false;
613

614
    if (memcmp(buf + magicOffset, magic, mlen) != 0)
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
        return false;

    return true;
}


static bool
virStorageFileMatchesExtension(int format,
                               const char *path)
{
    if (fileTypeInfo[format].extension == NULL)
        return false;

    if (virFileHasSuffix(path, fileTypeInfo[format].extension))
        return true;

    return false;
}


static bool
virStorageFileMatchesVersion(int format,
                             unsigned char *buf,
                             size_t buflen)
{
640 641
    int version;
    size_t i;
642 643 644

    /* Validate version number info */
    if (fileTypeInfo[format].versionOffset == -1)
E
Eric Blake 已提交
645
        return false;
646

647 648 649 650
    /* -2 == non-versioned file format, so trivially match */
    if (fileTypeInfo[format].versionOffset == -2)
        return true;

651 652 653
    if ((fileTypeInfo[format].versionOffset + 4) > buflen)
        return false;

E
Eric Blake 已提交
654 655 656 657
    if (fileTypeInfo[format].endian == LV_LITTLE_ENDIAN)
        version = virReadBufInt32LE(buf + fileTypeInfo[format].versionOffset);
    else
        version = virReadBufInt32BE(buf + fileTypeInfo[format].versionOffset);
658

659 660 661 662 663 664 665 666
    for (i = 0;
         i < FILE_TYPE_VERSIONS_LAST && fileTypeInfo[format].versionNumbers[i];
         i++) {
        VIR_DEBUG("Compare detected version %d vs one of the expected versions %d",
                  version, fileTypeInfo[format].versionNumbers[i]);
        if (version == fileTypeInfo[format].versionNumbers[i])
            return true;
    }
667

668
    return false;
669
}
670

A
Adam Litke 已提交
671 672 673
static bool
virBackingStoreIsFile(const char *backing)
{
P
Peter Feiner 已提交
674 675
    /* Backing store is a network block device or Rados block device */
    if (STRPREFIX(backing, "nbd:") || STRPREFIX(backing, "rbd:"))
A
Adam Litke 已提交
676 677 678
        return false;
    return true;
}
679

E
Eric Blake 已提交
680 681 682 683 684 685
static int
virStorageFileProbeFormatFromBuf(const char *path,
                                 unsigned char *buf,
                                 size_t buflen)
{
    int format = VIR_STORAGE_FILE_RAW;
686
    size_t i;
E
Eric Blake 已提交
687 688 689 690
    int possibleFormat = VIR_STORAGE_FILE_RAW;
    VIR_DEBUG("path=%s", path);

    /* First check file magic */
691
    for (i = 0; i < VIR_STORAGE_FILE_LAST; i++) {
E
Eric Blake 已提交
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
        if (virStorageFileMatchesMagic(i, buf, buflen)) {
            if (!virStorageFileMatchesVersion(i, buf, buflen)) {
                possibleFormat = i;
                continue;
            }
            format = i;
            goto cleanup;
        }
    }

    if (possibleFormat != VIR_STORAGE_FILE_RAW)
        VIR_WARN("File %s matches %s magic, but version is wrong. "
                 "Please report new version to libvir-list@redhat.com",
                 path, virStorageFileFormatTypeToString(possibleFormat));

    /* No magic, so check file extension */
708
    for (i = 0; i < VIR_STORAGE_FILE_LAST; i++) {
E
Eric Blake 已提交
709 710 711 712 713 714 715 716 717 718 719 720
        if (virStorageFileMatchesExtension(i, path)) {
            format = i;
            goto cleanup;
        }
    }

cleanup:
    VIR_DEBUG("format=%d", format);
    return format;
}


721 722 723 724 725 726 727 728 729
static int
qcow2GetFeatures(virBitmapPtr *features,
                 int format,
                 unsigned char *buf,
                 ssize_t len)
{
    int version = -1;
    virBitmapPtr feat = NULL;
    uint64_t bits;
730
    size_t i;
731 732 733 734 735 736 737 738 739

    version = virReadBufInt32BE(buf + fileTypeInfo[format].versionOffset);

    if (version == 2)
        return 0;

    if (len < QCOW2v3_HDR_SIZE)
        return -1;

740
    if (!(feat = virBitmapNew(VIR_STORAGE_FILE_FEATURE_LAST)))
741 742 743 744 745 746 747 748 749 750 751 752 753 754
        return -1;

    /* todo: check for incompatible or autoclear features? */
    bits = virReadBufInt64BE(buf + QCOW2v3_HDR_FEATURES_COMPATIBLE);
    for (i = 0; i < QCOW2_COMPATIBLE_FEATURE_LAST; i++) {
        if (bits & ((uint64_t) 1 << i))
            ignore_value(virBitmapSetBit(feat, qcow2CompatibleFeatureArray[i]));
    }

    *features = feat;
    return 0;
}


755 756 757
/* Given a file descriptor FD open on PATH, and optionally opened from
 * a given DIRECTORY, return metadata about that file, assuming it has
 * the given FORMAT. */
E
Eric Blake 已提交
758
static virStorageFileMetadataPtr
E
Eric Blake 已提交
759 760
virStorageFileGetMetadataInternal(const char *path,
                                  int fd,
761
                                  const char *directory,
E
Eric Blake 已提交
762
                                  int format)
763
{
E
Eric Blake 已提交
764 765 766
    virStorageFileMetadata *meta = NULL;
    unsigned char *buf = NULL;
    ssize_t len = STORAGE_MAX_HEAD;
E
Eric Blake 已提交
767
    virStorageFileMetadata *ret = NULL;
E
Eric Blake 已提交
768 769 770
    struct stat sb;

    VIR_DEBUG("path=%s, fd=%d, format=%d", path, fd, format);
E
Eric Blake 已提交
771

772
    if (VIR_ALLOC(meta) < 0)
E
Eric Blake 已提交
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
        return NULL;

    if (fstat(fd, &sb) < 0) {
        virReportSystemError(errno,
                             _("cannot stat file '%s'"),
                             path);
        goto cleanup;
    }

    /* No header to probe for directories, but also no backing file */
    if (S_ISDIR(sb.st_mode))
        return meta;

    if (lseek(fd, 0, SEEK_SET) == (off_t)-1) {
        virReportSystemError(errno, _("cannot seek to start of '%s'"), path);
        goto cleanup;
    }

791
    if (VIR_ALLOC_N(buf, len) < 0)
E
Eric Blake 已提交
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
        goto cleanup;

    if ((len = read(fd, buf, len)) < 0) {
        virReportSystemError(errno, _("cannot read header '%s'"), path);
        goto cleanup;
    }

    if (format == VIR_STORAGE_FILE_AUTO)
        format = virStorageFileProbeFormatFromBuf(path, buf, len);

    if (format <= VIR_STORAGE_FILE_NONE ||
        format >= VIR_STORAGE_FILE_LAST) {
        virReportSystemError(EINVAL, _("unknown storage file format %d"),
                             format);
        goto cleanup;
    }
808

809 810 811
    /* XXX we should consider moving virStorageBackendUpdateVolInfo
     * code into this method, for non-magic files
     */
E
Eric Blake 已提交
812
    if (!fileTypeInfo[format].magic)
E
Eric Blake 已提交
813
        goto done;
814

815 816
    /* Optionally extract capacity from file */
    if (fileTypeInfo[format].sizeOffset != -1) {
E
Eric Blake 已提交
817 818
        if ((fileTypeInfo[format].sizeOffset + 8) > len)
            goto done;
819

E
Eric Blake 已提交
820 821 822 823 824 825
        if (fileTypeInfo[format].endian == LV_LITTLE_ENDIAN)
            meta->capacity = virReadBufInt64LE(buf +
                                               fileTypeInfo[format].sizeOffset);
        else
            meta->capacity = virReadBufInt64BE(buf +
                                               fileTypeInfo[format].sizeOffset);
826
        /* Avoid unlikely, but theoretically possible overflow */
E
Eric Blake 已提交
827 828
        if (meta->capacity > (ULLONG_MAX /
                              fileTypeInfo[format].sizeMultiplier))
E
Eric Blake 已提交
829
            goto done;
830 831
        meta->capacity *= fileTypeInfo[format].sizeMultiplier;
    }
832

833 834
    if (fileTypeInfo[format].qcowCryptOffset != -1) {
        int crypt_format;
835

E
Eric Blake 已提交
836 837
        crypt_format = virReadBufInt32BE(buf +
                                         fileTypeInfo[format].qcowCryptOffset);
838 839
        meta->encrypted = crypt_format != 0;
    }
840

841 842 843
    if (fileTypeInfo[format].getBackingStore != NULL) {
        char *backing;
        int backingFormat;
E
Eric Blake 已提交
844 845 846 847 848
        int store = fileTypeInfo[format].getBackingStore(&backing,
                                                         &backingFormat,
                                                         buf, len);
        if (store == BACKING_STORE_INVALID)
            goto done;
849

E
Eric Blake 已提交
850 851
        if (store == BACKING_STORE_ERROR)
            goto cleanup;
852

A
Adam Litke 已提交
853
        meta->backingStoreIsFile = false;
854
        if (backing != NULL) {
855
            if (VIR_STRDUP(meta->backingStore, backing) < 0) {
856
                VIR_FREE(backing);
E
Eric Blake 已提交
857
                goto cleanup;
858
            }
A
Adam Litke 已提交
859 860
            if (virBackingStoreIsFile(backing)) {
                meta->backingStoreIsFile = true;
861
                meta->backingStoreRaw = meta->backingStore;
862 863 864 865 866
                meta->backingStore = NULL;
                if (virFindBackingFile(directory ? directory : path,
                                       !!directory, backing,
                                       &meta->directory,
                                       &meta->backingStore) < 0) {
P
Philipp Hahn 已提交
867
                    /* the backing file is (currently) unavailable, treat this
868 869 870
                     * file as standalone:
                     * backingStoreRaw is kept to mark broken image chains */
                    meta->backingStoreIsFile = false;
P
Philipp Hahn 已提交
871
                    backingFormat = VIR_STORAGE_FILE_NONE;
872 873 874
                    VIR_WARN("Backing file '%s' of image '%s' is missing.",
                             meta->backingStoreRaw, path);

875
                }
A
Adam Litke 已提交
876
            }
877 878 879 880
            VIR_FREE(backing);
            meta->backingStoreFormat = backingFormat;
        } else {
            meta->backingStore = NULL;
E
Eric Blake 已提交
881
            meta->backingStoreFormat = VIR_STORAGE_FILE_NONE;
882 883 884
        }
    }

885 886 887 888 889 890 891 892
    if (fileTypeInfo[format].getFeatures != NULL &&
        fileTypeInfo[format].getFeatures(&meta->features, format, buf, len) < 0)
        goto cleanup;

    if (format == VIR_STORAGE_FILE_QCOW2 && meta->features &&
        VIR_STRDUP(meta->compat, "1.1") < 0)
        goto cleanup;

E
Eric Blake 已提交
893 894
done:
    ret = meta;
E
Eric Blake 已提交
895 896
    meta = NULL;

E
Eric Blake 已提交
897
cleanup:
E
Eric Blake 已提交
898 899
    virStorageFileFreeMetadata(meta);
    VIR_FREE(buf);
E
Eric Blake 已提交
900
    return ret;
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
}


/**
 * virStorageFileProbeFormatFromFD:
 *
 * Probe for the format of 'fd' (which is an open file descriptor
 * pointing to 'path'), returning the detected disk format.
 *
 * Callers are advised never to trust the returned 'format'
 * unless it is listed as VIR_STORAGE_FILE_RAW, since a
 * malicious guest can turn a file into any other non-raw
 * format at will.
 *
 * Best option: Don't use this function
 */
int
virStorageFileProbeFormatFromFD(const char *path, int fd)
{
    unsigned char *head;
    ssize_t len = STORAGE_MAX_HEAD;
    int ret = -1;
923 924 925 926 927 928 929 930 931 932 933 934 935
    struct stat sb;

    if (fstat(fd, &sb) < 0) {
        virReportSystemError(errno,
                             _("cannot stat file '%s'"),
                             path);
        return -1;
    }

    /* No header to probe for directories */
    if (S_ISDIR(sb.st_mode)) {
        return VIR_STORAGE_FILE_DIR;
    }
936

937
    if (VIR_ALLOC_N(head, len) < 0)
938
        return -1;
939

940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
    if (lseek(fd, 0, SEEK_SET) == (off_t)-1) {
        virReportSystemError(errno, _("cannot set to start of '%s'"), path);
        goto cleanup;
    }

    if ((len = read(fd, head, len)) < 0) {
        virReportSystemError(errno, _("cannot read header '%s'"), path);
        goto cleanup;
    }

    ret = virStorageFileProbeFormatFromBuf(path, head, len);

cleanup:
    VIR_FREE(head);
    return ret;
955
}
956

957 958 959 960 961 962 963 964 965 966 967 968 969 970 971

/**
 * virStorageFileProbeFormat:
 *
 * Probe for the format of 'path', returning the detected
 * disk format.
 *
 * Callers are advised never to trust the returned 'format'
 * unless it is listed as VIR_STORAGE_FILE_RAW, since a
 * malicious guest can turn a raw file into any other non-raw
 * format at will.
 *
 * Best option: Don't use this function
 */
int
972
virStorageFileProbeFormat(const char *path, uid_t uid, gid_t gid)
973 974 975
{
    int fd, ret;

976
    if ((fd = virFileOpenAs(path, O_RDONLY, 0, uid, gid, 0)) < 0) {
977
        virReportSystemError(-fd, _("Failed to open file '%s'"), path);
978 979 980 981 982
        return -1;
    }

    ret = virStorageFileProbeFormatFromFD(path, fd);

983
    VIR_FORCE_CLOSE(fd);
984 985 986 987 988 989 990

    return ret;
}

/**
 * virStorageFileGetMetadataFromFD:
 *
991 992
 * Extract metadata about the storage volume with the specified
 * image format. If image format is VIR_STORAGE_FILE_AUTO, it
993
 * will probe to automatically identify the format.  Does not recurse.
994
 *
995 996 997 998 999 1000 1001 1002
 * Callers are advised never to use VIR_STORAGE_FILE_AUTO as a
 * format, since a malicious guest can turn a raw file into any
 * other non-raw format at will.
 *
 * If the returned meta.backingStoreFormat is VIR_STORAGE_FILE_AUTO
 * it indicates the image didn't specify an explicit format for its
 * backing store. Callers are advised against probing for the
 * backing store format in this case.
1003
 *
1004
 * Caller MUST free the result after use via virStorageFileFreeMetadata.
1005
 */
1006
virStorageFileMetadataPtr
1007 1008
virStorageFileGetMetadataFromFD(const char *path,
                                int fd,
1009
                                int format)
1010
{
1011
    return virStorageFileGetMetadataInternal(path, fd, NULL, format);
1012 1013
}

1014 1015
/* Recursive workhorse for virStorageFileGetMetadata.  */
static virStorageFileMetadataPtr
1016 1017
virStorageFileGetMetadataRecurse(const char *path, const char *directory,
                                 int format, uid_t uid, gid_t gid,
1018 1019 1020
                                 bool allow_probe, virHashTablePtr cycle)
{
    int fd;
1021 1022 1023
    VIR_DEBUG("path=%s format=%d uid=%d gid=%d probe=%d",
              path, format, (int)uid, (int)gid, allow_probe);

1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
    virStorageFileMetadataPtr ret = NULL;

    if (virHashLookup(cycle, path)) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("backing store for %s is self-referential"),
                       path);
        return NULL;
    }
    if (virHashAddEntry(cycle, path, (void *)1) < 0)
        return NULL;

    if ((fd = virFileOpenAs(path, O_RDONLY, 0, uid, gid, 0)) < 0) {
1036
        virReportSystemError(-fd, _("Failed to open file '%s'"), path);
1037 1038 1039
        return NULL;
    }

1040
    ret = virStorageFileGetMetadataInternal(path, fd, directory, format);
1041 1042 1043 1044

    if (VIR_CLOSE(fd) < 0)
        VIR_WARN("could not close file %s", path);

1045
    if (ret && ret->backingStoreIsFile) {
1046 1047 1048 1049 1050 1051
        if (ret->backingStoreFormat == VIR_STORAGE_FILE_AUTO && !allow_probe)
            ret->backingStoreFormat = VIR_STORAGE_FILE_RAW;
        else if (ret->backingStoreFormat == VIR_STORAGE_FILE_AUTO_SAFE)
            ret->backingStoreFormat = VIR_STORAGE_FILE_AUTO;
        format = ret->backingStoreFormat;
        ret->backingMeta = virStorageFileGetMetadataRecurse(ret->backingStore,
1052
                                                            ret->directory,
1053 1054 1055 1056 1057 1058 1059 1060 1061
                                                            format,
                                                            uid, gid,
                                                            allow_probe,
                                                            cycle);
    }

    return ret;
}

1062 1063 1064
/**
 * virStorageFileGetMetadata:
 *
1065 1066
 * Extract metadata about the storage volume with the specified
 * image format. If image format is VIR_STORAGE_FILE_AUTO, it
1067 1068 1069 1070 1071
 * will probe to automatically identify the format.  Recurses through
 * the entire chain.
 *
 * Open files using UID and GID (or pass -1 for the current user/group).
 * Treat any backing files without explicit type as raw, unless ALLOW_PROBE.
1072
 *
1073 1074 1075 1076 1077 1078
 * Callers are advised never to use VIR_STORAGE_FILE_AUTO as a
 * format, since a malicious guest can turn a raw file into any
 * other non-raw format at will.
 *
 * If the returned meta.backingStoreFormat is VIR_STORAGE_FILE_AUTO
 * it indicates the image didn't specify an explicit format for its
1079 1080
 * backing store. Callers are advised against using ALLOW_PROBE, as
 * it would probe the backing store format in this case.
1081
 *
1082
 * Caller MUST free result after use via virStorageFileFreeMetadata.
1083
 */
1084 1085 1086 1087
virStorageFileMetadataPtr
virStorageFileGetMetadata(const char *path, int format,
                          uid_t uid, gid_t gid,
                          bool allow_probe)
1088
{
1089 1090 1091
    VIR_DEBUG("path=%s format=%d uid=%d gid=%d probe=%d",
              path, format, (int)uid, (int)gid, allow_probe);

1092 1093
    virHashTablePtr cycle = virHashCreate(5, NULL);
    virStorageFileMetadataPtr ret;
1094

1095 1096
    if (!cycle)
        return NULL;
1097

1098 1099
    if (format <= VIR_STORAGE_FILE_NONE)
        format = allow_probe ? VIR_STORAGE_FILE_AUTO : VIR_STORAGE_FILE_RAW;
1100
    ret = virStorageFileGetMetadataRecurse(path, NULL, format, uid, gid,
1101 1102
                                           allow_probe, cycle);
    virHashFree(cycle);
1103 1104
    return ret;
}
1105

1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
/**
 * virStorageFileChainCheckBroken
 *
 * If CHAIN is broken, set *brokenFile to the broken file name,
 * otherwise set it to NULL. Caller MUST free *brokenFile after use.
 * Return 0 on success, negative on error.
 */
int
virStorageFileChainGetBroken(virStorageFileMetadataPtr chain,
                             char **brokenFile)
{
    virStorageFileMetadataPtr tmp;
    int ret = -1;

    if (!chain)
        return 0;

    *brokenFile = NULL;

    tmp = chain;
    while (tmp) {
        /* Break if no backing store or backing store is not file */
       if (!tmp->backingStoreRaw)
           break;
       if (!tmp->backingStore) {
           if (VIR_STRDUP(*brokenFile, tmp->backingStoreRaw) < 0)
               goto error;
           break;
       }
       tmp = tmp->backingMeta;
    }

    ret = 0;

error:
    return ret;
}


1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
/**
 * virStorageFileFreeMetadata:
 *
 * Free pointers in passed structure and structure itself.
 */
void
virStorageFileFreeMetadata(virStorageFileMetadata *meta)
{
    if (!meta)
        return;

1156
    virStorageFileFreeMetadata(meta->backingMeta);
1157
    VIR_FREE(meta->backingStore);
1158
    VIR_FREE(meta->backingStoreRaw);
1159
    VIR_FREE(meta->compat);
1160
    VIR_FREE(meta->directory);
1161
    virBitmapFree(meta->features);
1162 1163
    VIR_FREE(meta);
}
1164

1165 1166 1167 1168 1169 1170
/**
 * virStorageFileResize:
 *
 * Change the capacity of the raw storage file at 'path'.
 */
int
1171 1172 1173 1174
virStorageFileResize(const char *path,
                     unsigned long long capacity,
                     unsigned long long orig_capacity,
                     bool pre_allocate)
1175
{
1176 1177
    int fd = -1;
    int ret = -1;
1178 1179 1180 1181 1182 1183
    int rc ATTRIBUTE_UNUSED;
    off_t offset ATTRIBUTE_UNUSED;
    off_t len ATTRIBUTE_UNUSED;

    offset = orig_capacity;
    len = capacity - orig_capacity;
1184 1185 1186 1187 1188 1189

    if ((fd = open(path, O_RDWR)) < 0) {
        virReportSystemError(errno, _("Unable to open '%s'"), path);
        goto cleanup;
    }

1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
    if (pre_allocate) {
#if HAVE_POSIX_FALLOCATE
        if ((rc = posix_fallocate(fd, offset, len)) != 0) {
            virReportSystemError(rc,
                                 _("Failed to pre-allocate space for "
                                   "file '%s'"), path);
            goto cleanup;
        }
#elif HAVE_SYS_SYSCALL_H && defined(SYS_fallocate)
        if (syscall(SYS_fallocate, fd, 0, offset, len) != 0) {
            virReportSystemError(errno,
1201
                                 _("Failed to pre-allocate space for "
1202 1203 1204 1205 1206
                                   "file '%s'"), path);
            goto cleanup;
        }
#else
        virReportError(VIR_ERR_OPERATION_UNSUPPORTED, "%s",
1207
                       _("preallocate is not supported on this platform"));
1208
        goto cleanup;
1209 1210 1211 1212 1213 1214 1215
#endif
    } else {
        if (ftruncate(fd, capacity) < 0) {
            virReportSystemError(errno,
                                 _("Failed to truncate file '%s'"), path);
            goto cleanup;
        }
1216 1217
    }

1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
    if (VIR_CLOSE(fd) < 0) {
        virReportSystemError(errno, _("Unable to save '%s'"), path);
        goto cleanup;
    }

    ret = 0;

cleanup:
    VIR_FORCE_CLOSE(fd);
    return ret;
1228 1229
}

1230 1231
#ifdef __linux__

1232 1233 1234
# ifndef NFS_SUPER_MAGIC
#  define NFS_SUPER_MAGIC 0x6969
# endif
1235 1236 1237 1238 1239 1240 1241 1242 1243
# ifndef OCFS2_SUPER_MAGIC
#  define OCFS2_SUPER_MAGIC 0x7461636f
# endif
# ifndef GFS2_MAGIC
#  define GFS2_MAGIC 0x01161970
# endif
# ifndef AFS_FS_MAGIC
#  define AFS_FS_MAGIC 0x6B414653
# endif
1244 1245 1246 1247 1248 1249
# ifndef SMB_SUPER_MAGIC
#  define SMB_SUPER_MAGIC 0x517B
# endif
# ifndef CIFS_SUPER_MAGIC
#  define CIFS_SUPER_MAGIC 0xFF534D42
# endif
1250 1251


1252 1253
int virStorageFileIsSharedFSType(const char *path,
                                 int fstypes)
1254
{
L
Laine Stump 已提交
1255
    char *dirpath, *p;
1256
    struct statfs sb;
L
Laine Stump 已提交
1257
    int statfs_ret;
1258

1259
    if (VIR_STRDUP(dirpath, path) < 0)
L
Laine Stump 已提交
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
        return -1;

    do {

        /* Try less and less of the path until we get to a
         * directory we can stat. Even if we don't have 'x'
         * permission on any directory in the path on the NFS
         * server (assuming it's NFS), we will be able to stat the
         * mount point, and that will properly tell us if the
         * fstype is NFS.
         */

        if ((p = strrchr(dirpath, '/')) == NULL) {
            virReportSystemError(EINVAL,
                         _("Invalid relative path '%s'"), path);
            VIR_FREE(dirpath);
            return -1;
        }

        if (p == dirpath)
            *(p+1) = '\0';
        else
            *p = '\0';

        statfs_ret = statfs(dirpath, &sb);

    } while ((statfs_ret < 0) && (p != dirpath));

    VIR_FREE(dirpath);

    if (statfs_ret < 0) {
1291 1292 1293 1294 1295 1296 1297 1298 1299
        virReportSystemError(errno,
                             _("cannot determine filesystem for '%s'"),
                             path);
        return -1;
    }

    VIR_DEBUG("Check if path %s with FS magic %lld is shared",
              path, (long long int)sb.f_type);

1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
    if ((fstypes & VIR_STORAGE_FILE_SHFS_NFS) &&
        (sb.f_type == NFS_SUPER_MAGIC))
        return 1;

    if ((fstypes & VIR_STORAGE_FILE_SHFS_GFS2) &&
        (sb.f_type == GFS2_MAGIC))
        return 1;
    if ((fstypes & VIR_STORAGE_FILE_SHFS_OCFS) &&
        (sb.f_type == OCFS2_SUPER_MAGIC))
        return 1;
    if ((fstypes & VIR_STORAGE_FILE_SHFS_AFS) &&
        (sb.f_type == AFS_FS_MAGIC))
1312
        return 1;
1313 1314 1315 1316 1317 1318
    if ((fstypes & VIR_STORAGE_FILE_SHFS_SMB) &&
        (sb.f_type == SMB_SUPER_MAGIC))
        return 1;
    if ((fstypes & VIR_STORAGE_FILE_SHFS_CIFS) &&
        (sb.f_type == CIFS_SUPER_MAGIC))
        return 1;
1319 1320 1321 1322

    return 0;
}
#else
1323 1324
int virStorageFileIsSharedFSType(const char *path ATTRIBUTE_UNUSED,
                                 int fstypes ATTRIBUTE_UNUSED)
1325 1326 1327 1328 1329
{
    /* XXX implement me :-) */
    return 0;
}
#endif
1330 1331 1332 1333 1334 1335 1336

int virStorageFileIsSharedFS(const char *path)
{
    return virStorageFileIsSharedFSType(path,
                                        VIR_STORAGE_FILE_SHFS_NFS |
                                        VIR_STORAGE_FILE_SHFS_GFS2 |
                                        VIR_STORAGE_FILE_SHFS_OCFS |
1337 1338 1339
                                        VIR_STORAGE_FILE_SHFS_AFS |
                                        VIR_STORAGE_FILE_SHFS_SMB |
                                        VIR_STORAGE_FILE_SHFS_CIFS);
1340
}
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350

int virStorageFileIsClusterFS(const char *path)
{
    /* These are coherent cluster filesystems known to be safe for
     * migration with cache != none
     */
    return virStorageFileIsSharedFSType(path,
                                        VIR_STORAGE_FILE_SHFS_GFS2 |
                                        VIR_STORAGE_FILE_SHFS_OCFS);
}
1351 1352

#ifdef LVS
1353 1354
int virStorageFileGetLVMKey(const char *path,
                            char **key)
1355 1356 1357 1358 1359
{
    /*
     *  # lvs --noheadings --unbuffered --nosuffix --options "uuid" LVNAME
     *    06UgP5-2rhb-w3Bo-3mdR-WeoL-pytO-SAa2ky
     */
1360
    int status;
1361 1362 1363 1364 1365 1366
    virCommandPtr cmd = virCommandNewArgList(
        LVS,
        "--noheadings", "--unbuffered", "--nosuffix",
        "--options", "uuid", path,
        NULL
        );
1367 1368 1369
    int ret = -1;

    *key = NULL;
1370 1371

    /* Run the program and capture its output */
1372 1373
    virCommandSetOutputBuffer(cmd, key);
    if (virCommandRun(cmd, &status) < 0)
1374 1375
        goto cleanup;

1376 1377 1378 1379 1380 1381
    /* Explicitly check status == 0, rather than passing NULL
     * to virCommandRun because we don't want to raise an actual
     * error in this scenario, just return a NULL key.
     */

    if (status == 0 && *key) {
1382
        char *nl;
1383
        char *tmp = *key;
1384 1385 1386 1387 1388 1389

        /* Find first non-space character */
        while (*tmp && c_isspace(*tmp)) {
            tmp++;
        }
        /* Kill leading spaces */
1390 1391
        if (tmp != *key)
            memmove(*key, tmp, strlen(tmp)+1);
1392 1393

        /* Kill trailing newline */
1394
        if ((nl = strchr(*key, '\n')))
1395 1396 1397
            *nl = '\0';
    }

1398
    ret = 0;
1399 1400

cleanup:
1401 1402 1403
    if (*key && STREQ(*key, ""))
        VIR_FREE(*key);

1404 1405
    virCommandFree(cmd);

1406
    return ret;
1407 1408
}
#else
1409 1410
int virStorageFileGetLVMKey(const char *path,
                            char **key ATTRIBUTE_UNUSED)
1411 1412
{
    virReportSystemError(ENOSYS, _("Unable to get LVM key for %s"), path);
1413
    return -1;
1414 1415 1416
}
#endif

1417
#ifdef WITH_UDEV
1418 1419
int virStorageFileGetSCSIKey(const char *path,
                             char **key)
1420
{
1421
    int status;
1422 1423 1424 1425 1426 1427 1428
    virCommandPtr cmd = virCommandNewArgList(
        "/lib/udev/scsi_id",
        "--replace-whitespace",
        "--whitelisted",
        "--device", path,
        NULL
        );
1429 1430 1431
    int ret = -1;

    *key = NULL;
1432 1433

    /* Run the program and capture its output */
1434 1435
    virCommandSetOutputBuffer(cmd, key);
    if (virCommandRun(cmd, &status) < 0)
1436 1437
        goto cleanup;

1438 1439 1440 1441 1442 1443
    /* Explicitly check status == 0, rather than passing NULL
     * to virCommandRun because we don't want to raise an actual
     * error in this scenario, just return a NULL key.
     */
    if (status == 0 && *key) {
        char *nl = strchr(*key, '\n');
1444 1445 1446 1447
        if (nl)
            *nl = '\0';
    }

1448 1449
    ret = 0;

1450
cleanup:
1451 1452 1453
    if (*key && STREQ(*key, ""))
        VIR_FREE(*key);

1454 1455
    virCommandFree(cmd);

1456
    return ret;
1457 1458
}
#else
1459 1460
int virStorageFileGetSCSIKey(const char *path,
                             char **key ATTRIBUTE_UNUSED)
1461 1462
{
    virReportSystemError(ENOSYS, _("Unable to get SCSI key for %s"), path);
1463
    return -1;
1464 1465
}
#endif
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507

/* Given a CHAIN that starts at the named file START, return a string
 * pointing to either START or within CHAIN that gives the preferred
 * name for the backing file NAME within that chain.  Pass NULL for
 * NAME to find the base of the chain.  If META is not NULL, set *META
 * to the point in the chain that describes NAME (or to NULL if the
 * backing element is not a file).  If PARENT is not NULL, set *PARENT
 * to the preferred name of the parent (or to NULL if NAME matches
 * START).  Since the results point within CHAIN, they must not be
 * independently freed.  */
const char *
virStorageFileChainLookup(virStorageFileMetadataPtr chain, const char *start,
                          const char *name, virStorageFileMetadataPtr *meta,
                          const char **parent)
{
    virStorageFileMetadataPtr owner;
    const char *tmp;

    if (!parent)
        parent = &tmp;

    *parent = NULL;
    if (name ? STREQ(start, name) || virFileLinkPointsTo(start, name) :
        !chain->backingStore) {
        if (meta)
            *meta = chain;
        return start;
    }

    owner = chain;
    *parent = start;
    while (owner) {
        if (!owner->backingStore)
            goto error;
        if (!name) {
            if (!owner->backingMeta ||
                !owner->backingMeta->backingStore)
                break;
        } else if (STREQ_NULLABLE(name, owner->backingStoreRaw) ||
                   STREQ(name, owner->backingStore)) {
            break;
        } else if (owner->backingStoreIsFile) {
1508 1509 1510 1511
            char *absName = NULL;
            if (virFindBackingFile(owner->directory, true, name,
                                   NULL, &absName) < 0)
                goto error;
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532
            if (absName && STREQ(absName, owner->backingStore)) {
                VIR_FREE(absName);
                break;
            }
            VIR_FREE(absName);
        }
        *parent = owner->backingStore;
        owner = owner->backingMeta;
    }
    if (!owner)
        goto error;
    if (meta)
        *meta = owner->backingMeta;
    return owner->backingStore;

error:
    *parent = NULL;
    if (meta)
        *meta = NULL;
    return NULL;
}