virstoragefile.c 109.0 KB
Newer Older
1
/*
2
 * virstoragefile.c: file utility functions for FS storage backend
3
 *
E
Eric Blake 已提交
4
 * Copyright (C) 2007-2017 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 <unistd.h>
28
#include <fcntl.h>
29
#include <stdlib.h>
30
#include "viralloc.h"
31 32
#include "virxml.h"
#include "viruuid.h"
33
#include "virerror.h"
34
#include "virlog.h"
E
Eric Blake 已提交
35
#include "virfile.h"
36
#include "c-ctype.h"
37
#include "vircommand.h"
38
#include "virhash.h"
E
Eric Blake 已提交
39
#include "virendian.h"
40 41
#include "virstring.h"
#include "virutil.h"
42 43
#include "viruri.h"
#include "dirname.h"
44
#include "virbuffer.h"
45
#include "virjson.h"
46
#include "virstorageencryption.h"
47 48 49

#define VIR_FROM_THIS VIR_FROM_STORAGE

50 51
VIR_LOG_INIT("util.storagefile");

E
Eric Blake 已提交
52
VIR_ENUM_IMPL(virStorage, VIR_STORAGE_TYPE_LAST,
53
              "none",
E
Eric Blake 已提交
54
              "file",
55
              "block",
E
Eric Blake 已提交
56 57 58 59
              "dir",
              "network",
              "volume")

60 61
VIR_ENUM_IMPL(virStorageFileFormat,
              VIR_STORAGE_FILE_LAST,
E
Eric Blake 已提交
62
              "none",
63
              "raw", "dir", "bochs",
64 65 66
              "cloop", "dmg", "iso",
              "vpc", "vdi",
              /* Not direct file formats, but used for various drivers */
67
              "fat", "vhd", "ploop",
68 69
              /* Formats with backing file below here */
              "cow", "qcow", "qcow2", "qed", "vmdk")
70

71 72 73 74 75
VIR_ENUM_IMPL(virStorageFileFeature,
              VIR_STORAGE_FILE_FEATURE_LAST,
              "lazy_refcounts",
              )

76
VIR_ENUM_IMPL(virStorageNetProtocol, VIR_STORAGE_NET_PROTOCOL_LAST,
77
              "none",
78 79 80 81 82 83 84 85 86
              "nbd",
              "rbd",
              "sheepdog",
              "gluster",
              "iscsi",
              "http",
              "https",
              "ftp",
              "ftps",
87 88
              "tftp",
              "ssh")
89 90 91 92 93 94

VIR_ENUM_IMPL(virStorageNetHostTransport, VIR_STORAGE_NET_HOST_TRANS_LAST,
              "tcp",
              "unix",
              "rdma")

95 96 97 98 99
VIR_ENUM_IMPL(virStorageSourcePoolMode,
              VIR_STORAGE_SOURCE_POOL_MODE_LAST,
              "default",
              "host",
              "direct")
100

101 102 103 104
VIR_ENUM_IMPL(virStorageAuth,
              VIR_STORAGE_AUTH_TYPE_LAST,
              "none", "chap", "ceph")

105 106 107 108 109 110 111 112 113 114 115
enum lv_endian {
    LV_LITTLE_ENDIAN = 1, /* 1234 */
    LV_BIG_ENDIAN         /* 4321 */
};

enum {
    BACKING_STORE_OK,
    BACKING_STORE_INVALID,
    BACKING_STORE_ERROR,
};

D
Daniel P. Berrange 已提交
116
#define FILE_TYPE_VERSIONS_LAST 3
117

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
struct FileEncryptionInfo {
    int format; /* Encryption format to assign */

    int magicOffset; /* Byte offset of the magic */
    const char *magic; /* Optional string of magic */

    enum lv_endian endian; /* Endianness of file format */

    int versionOffset;    /* Byte offset from start of file
                           * where we find version number,
                           * -1 to always fail the version test,
                           * -2 to always pass the version test */
    int versionSize;      /* Size in bytes of version data (0, 2, or 4) */
    int versionNumbers[FILE_TYPE_VERSIONS_LAST];
                          /* Version numbers to validate. Zeroes are ignored. */

    int modeOffset; /* Byte offset of the format native encryption mode */
    char modeValue; /* Value expected at offset */
136 137

    int payloadOffset; /* start offset of the volume data (in 512 byte sectors) */
138 139
};

140 141
/* Either 'magic' or 'extension' *must* be provided */
struct FileTypeInfo {
142
    int magicOffset;    /* Byte offset of the magic */
143 144 145 146
    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 */
147

148 149
    int versionOffset;    /* Byte offset from start of file
                           * where we find version number,
150 151
                           * -1 to always fail the version test,
                           * -2 to always pass the version test */
152
    int versionSize;      /* Size in bytes of version data (0, 2, or 4) */
153 154
    int versionNumbers[FILE_TYPE_VERSIONS_LAST];
                          /* Version numbers to validate. Zeroes are ignored. */
155 156 157 158 159 160 161 162
    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_* */
163
    const struct FileEncryptionInfo *cryptInfo; /* Encryption info */
164
    int (*getBackingStore)(char **res, int *format,
E
Eric Blake 已提交
165
                           const char *buf, size_t buf_size);
166
    int (*getFeatures)(virBitmapPtr *features, int format,
E
Eric Blake 已提交
167
                       char *buf, ssize_t len);
168 169
};

170

171
static int cowGetBackingStore(char **, int *,
E
Eric Blake 已提交
172
                              const char *, size_t);
173
static int qcow1GetBackingStore(char **, int *,
E
Eric Blake 已提交
174
                                const char *, size_t);
175
static int qcow2GetBackingStore(char **, int *,
E
Eric Blake 已提交
176
                                const char *, size_t);
177
static int qcow2GetFeatures(virBitmapPtr *features, int format,
E
Eric Blake 已提交
178
                            char *buf, ssize_t len);
179
static int vmdk4GetBackingStore(char **, int *,
E
Eric Blake 已提交
180
                                const char *, size_t);
181
static int
E
Eric Blake 已提交
182
qedGetBackingStore(char **, int *, const char *, size_t);
183 184 185 186 187 188

#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)

189
#define QCOW1_HDR_CRYPT (QCOWX_HDR_IMAGE_SIZE+8+1+1+2)
190 191 192 193 194 195 196 197
#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

198 199 200 201 202 203 204
#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)

205
#define QED_HDR_FEATURES_OFFSET (4+4+4+4)
206 207
#define QED_HDR_IMAGE_SIZE (QED_HDR_FEATURES_OFFSET+8+8+8+8)
#define QED_HDR_BACKING_FILE_OFFSET (QED_HDR_IMAGE_SIZE+8)
208 209 210
#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 已提交
211

212 213
#define PLOOP_IMAGE_SIZE_OFFSET 36
#define PLOOP_SIZE_MULTIPLIER 512
214

215 216
#define LUKS_HDR_MAGIC_LEN 6
#define LUKS_HDR_VERSION_LEN 2
217 218 219 220
#define LUKS_HDR_CIPHER_NAME_LEN 32
#define LUKS_HDR_CIPHER_MODE_LEN 32
#define LUKS_HDR_HASH_SPEC_LEN 32
#define LUKS_HDR_PAYLOAD_LEN 4
221 222 223

/* Format described by qemu commit id '3e308f20e' */
#define LUKS_HDR_VERSION_OFFSET LUKS_HDR_MAGIC_LEN
224 225 226 227 228
#define LUKS_HDR_PAYLOAD_OFFSET (LUKS_HDR_MAGIC_LEN+\
                                 LUKS_HDR_VERSION_LEN+\
                                 LUKS_HDR_CIPHER_NAME_LEN+\
                                 LUKS_HDR_CIPHER_MODE_LEN+\
                                 LUKS_HDR_HASH_SPEC_LEN)
229

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
static struct FileEncryptionInfo const luksEncryptionInfo[] = {
    {
        .format = VIR_STORAGE_ENCRYPTION_FORMAT_LUKS,

        /* Magic is 'L','U','K','S', 0xBA, 0xBE */
        .magicOffset = 0,
        .magic = "\x4c\x55\x4b\x53\xba\xbe",
        .endian = LV_BIG_ENDIAN,

        .versionOffset  = LUKS_HDR_VERSION_OFFSET,
        .versionSize = LUKS_HDR_VERSION_LEN,
        .versionNumbers = {1},

        .modeOffset = -1,
        .modeValue = -1,
245 246

        .payloadOffset = LUKS_HDR_PAYLOAD_OFFSET,
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
    },
    { 0 }
};

static struct FileEncryptionInfo const qcow1EncryptionInfo[] = {
    {
        .format = VIR_STORAGE_ENCRYPTION_FORMAT_QCOW,

        .magicOffset = 0,
        .magic = NULL,
        .endian = LV_BIG_ENDIAN,

        .versionOffset  = -1,
        .versionSize = 0,
        .versionNumbers = {},

        .modeOffset = QCOW1_HDR_CRYPT,
        .modeValue = 1,
265 266

        .payloadOffset = -1,
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
    },
    { 0 }
};

static struct FileEncryptionInfo const qcow2EncryptionInfo[] = {
    {
        .format = VIR_STORAGE_ENCRYPTION_FORMAT_QCOW,

        .magicOffset = 0,
        .magic = NULL,
        .endian = LV_BIG_ENDIAN,

        .versionOffset  = -1,
        .versionSize = 0,
        .versionNumbers = {},

        .modeOffset = QCOW2_HDR_CRYPT,
        .modeValue = 1,
285 286

        .payloadOffset = -1,
287 288 289
    },
    { 0 }
};
290

291
static struct FileTypeInfo const fileTypeInfo[] = {
292
    [VIR_STORAGE_FILE_NONE] = { 0, NULL, NULL, LV_LITTLE_ENDIAN,
293
                                -1, 0, {0}, 0, 0, 0, NULL, NULL, NULL },
294
    [VIR_STORAGE_FILE_RAW] = { 0, NULL, NULL, LV_LITTLE_ENDIAN,
295 296 297
                               -1, 0, {0}, 0, 0, 0,
                               luksEncryptionInfo,
                               NULL, NULL },
298
    [VIR_STORAGE_FILE_DIR] = { 0, NULL, NULL, LV_LITTLE_ENDIAN,
299
                               -1, 0, {0}, 0, 0, 0, NULL, NULL, NULL },
300
    [VIR_STORAGE_FILE_BOCHS] = {
301 302
        /*"Bochs Virtual HD Image", */ /* Untested */
        0, NULL, NULL,
303
        LV_LITTLE_ENDIAN, 64, 4, {0x20000},
304
        32+16+16+4+4+4+4+4, 8, 1, NULL, NULL, NULL
305 306
    },
    [VIR_STORAGE_FILE_CLOOP] = {
307 308 309 310 311
        /* #!/bin/sh
           #V2.0 Format
           modprobe cloop file=$0 && mount -r -t iso9660 /dev/cloop $1
        */ /* Untested */
        0, NULL, NULL,
312
        LV_LITTLE_ENDIAN, -1, 0, {0},
313
        -1, 0, 0, NULL, NULL, NULL
314 315
    },
    [VIR_STORAGE_FILE_DMG] = {
316 317 318 319
        /* 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",
320
        0, -1, 0, {0},
321
        -1, 0, 0, NULL, NULL, NULL
322 323
    },
    [VIR_STORAGE_FILE_ISO] = {
324
        32769, "CD001", ".iso",
325
        LV_LITTLE_ENDIAN, -2, 0, {0},
326
        -1, 0, 0, NULL, NULL, NULL
327
    },
328 329
    [VIR_STORAGE_FILE_VPC] = {
        0, "conectix", NULL,
330
        LV_BIG_ENDIAN, 12, 4, {0x10000},
331
        8 + 4 + 4 + 8 + 4 + 4 + 2 + 2 + 4, 8, 1, NULL, NULL, NULL
332 333 334 335
    },
    /* TODO: add getBackingStore function */
    [VIR_STORAGE_FILE_VDI] = {
        64, "\x7f\x10\xda\xbe", ".vdi",
336
        LV_LITTLE_ENDIAN, 68, 4, {0x00010001},
337
        64 + 5 * 4 + 256 + 7 * 4, 8, 1, NULL, NULL, NULL},
338 339 340

    /* Not direct file formats, but used for various drivers */
    [VIR_STORAGE_FILE_FAT] = { 0, NULL, NULL, LV_LITTLE_ENDIAN,
341
                               -1, 0, {0}, 0, 0, 0, NULL, NULL, NULL },
342
    [VIR_STORAGE_FILE_VHD] = { 0, NULL, NULL, LV_LITTLE_ENDIAN,
343
                               -1, 0, {0}, 0, 0, 0, NULL, NULL, NULL },
344
    [VIR_STORAGE_FILE_PLOOP] = { 0, "WithouFreSpacExt", NULL, LV_LITTLE_ENDIAN,
345
                                 -2, 0, {0}, PLOOP_IMAGE_SIZE_OFFSET, 0,
346 347
                                 PLOOP_SIZE_MULTIPLIER, NULL, NULL, NULL },

348 349 350
    /* All formats with a backing store probe below here */
    [VIR_STORAGE_FILE_COW] = {
        0, "OOOM", NULL,
351
        LV_BIG_ENDIAN, 4, 4, {2},
352
        4+4+1024+4, 8, 1, NULL, cowGetBackingStore, NULL
353
    },
354
    [VIR_STORAGE_FILE_QCOW] = {
355
        0, "QFI", NULL,
356
        LV_BIG_ENDIAN, 4, 4, {1},
357 358 359
        QCOWX_HDR_IMAGE_SIZE, 8, 1,
        qcow1EncryptionInfo,
        qcow1GetBackingStore, NULL
360 361
    },
    [VIR_STORAGE_FILE_QCOW2] = {
362
        0, "QFI", NULL,
363
        LV_BIG_ENDIAN, 4, 4, {2, 3},
364 365 366
        QCOWX_HDR_IMAGE_SIZE, 8, 1,
        qcow2EncryptionInfo,
        qcow2GetBackingStore,
367
        qcow2GetFeatures
368
    },
A
Adam Litke 已提交
369 370
    [VIR_STORAGE_FILE_QED] = {
        /* http://wiki.qemu.org/Features/QED */
371
        0, "QED", NULL,
372
        LV_LITTLE_ENDIAN, -2, 0, {0},
373
        QED_HDR_IMAGE_SIZE, 8, 1, NULL, qedGetBackingStore, NULL
A
Adam Litke 已提交
374
    },
375
    [VIR_STORAGE_FILE_VMDK] = {
376
        0, "KDMV", NULL,
D
Daniel P. Berrange 已提交
377
        LV_LITTLE_ENDIAN, 4, 4, {1, 2, 3},
378
        4+4+4, 8, 512, NULL, vmdk4GetBackingStore, NULL
379
    },
380
};
381
verify(ARRAY_CARDINALITY(fileTypeInfo) == VIR_STORAGE_FILE_LAST);
382

383

384 385 386 387 388 389 390 391 392 393 394 395 396 397
/* 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);

398
static int
399
cowGetBackingStore(char **res,
400
                   int *format,
E
Eric Blake 已提交
401
                   const char *buf,
402 403 404 405
                   size_t buf_size)
{
#define COW_FILENAME_MAXLEN 1024
    *res = NULL;
406 407
    *format = VIR_STORAGE_FILE_AUTO;

408 409
    if (buf_size < 4+4+ COW_FILENAME_MAXLEN)
        return BACKING_STORE_INVALID;
E
Eric Blake 已提交
410 411
    if (buf[4+4] == '\0') { /* cow_header_v2.backing_file[0] */
        *format = VIR_STORAGE_FILE_NONE;
412
        return BACKING_STORE_OK;
E
Eric Blake 已提交
413
    }
414

415
    if (VIR_STRNDUP(*res, (const char*)buf + 4 + 4, COW_FILENAME_MAXLEN) < 0)
416 417 418 419
        return BACKING_STORE_ERROR;
    return BACKING_STORE_OK;
}

420 421 422

static int
qcow2GetBackingStoreFormat(int *format,
E
Eric Blake 已提交
423
                           const char *buf,
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
                           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 已提交
442 443
        unsigned int magic = virReadBufInt32BE(buf + offset);
        unsigned int len = virReadBufInt32BE(buf + offset + 4);
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461

        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 已提交
462 463
            if (*format <= VIR_STORAGE_FILE_NONE)
                return -1;
464 465 466 467 468
        }

        offset += len;
    }

469
 done:
470 471 472 473 474

    return 0;
}


475
static int
476
qcowXGetBackingStore(char **res,
477
                     int *format,
E
Eric Blake 已提交
478
                     const char *buf,
479 480
                     size_t buf_size,
                     bool isQCow2)
481 482
{
    unsigned long long offset;
483
    unsigned int size;
484 485
    unsigned long long start;
    int version;
486 487

    *res = NULL;
488 489 490 491
    if (format)
        *format = VIR_STORAGE_FILE_AUTO;

    if (buf_size < QCOWX_HDR_BACKING_FILE_OFFSET+8+4)
492
        return BACKING_STORE_INVALID;
E
Eric Blake 已提交
493
    offset = virReadBufInt64BE(buf + QCOWX_HDR_BACKING_FILE_OFFSET);
494 495
    if (offset > buf_size)
        return BACKING_STORE_INVALID;
496 497 498 499 500 501 502

    if (offset == 0) {
        if (format)
            *format = VIR_STORAGE_FILE_NONE;
        return BACKING_STORE_OK;
    }

E
Eric Blake 已提交
503
    size = virReadBufInt32BE(buf + QCOWX_HDR_BACKING_FILE_SIZE);
E
Eric Blake 已提交
504 505 506
    if (size == 0) {
        if (format)
            *format = VIR_STORAGE_FILE_NONE;
507
        return BACKING_STORE_OK;
E
Eric Blake 已提交
508
    }
509
    if (size > 1023)
510
        return BACKING_STORE_INVALID;
511
    if (offset + size > buf_size || offset + size < offset)
512
        return BACKING_STORE_INVALID;
513
    if (VIR_ALLOC_N(*res, size + 1) < 0)
514 515 516
        return BACKING_STORE_ERROR;
    memcpy(*res, buf + offset, size);
    (*res)[size] = '\0';
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540

    /*
     * 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)
541 542 543
     *
     * for qcow2 v3 images, the length of the header
     * is stored at QCOW2v3_HDR_SIZE
544
     */
545 546 547 548 549 550 551 552 553 554
    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;
    }
555

556 557 558 559
    return BACKING_STORE_OK;
}


560 561 562
static int
qcow1GetBackingStore(char **res,
                     int *format,
E
Eric Blake 已提交
563
                     const char *buf,
564 565
                     size_t buf_size)
{
E
Eric Blake 已提交
566 567
    int ret;

568 569 570
    /* QCow1 doesn't have the extensions capability
     * used to store backing format */
    *format = VIR_STORAGE_FILE_AUTO;
E
Eric Blake 已提交
571 572 573 574
    ret = qcowXGetBackingStore(res, NULL, buf, buf_size, false);
    if (ret == 0 && *buf == '\0')
        *format = VIR_STORAGE_FILE_NONE;
    return ret;
575 576 577 578 579
}

static int
qcow2GetBackingStore(char **res,
                     int *format,
E
Eric Blake 已提交
580
                     const char *buf,
581 582 583 584 585 586
                     size_t buf_size)
{
    return qcowXGetBackingStore(res, format, buf, buf_size, true);
}


587
static int
588
vmdk4GetBackingStore(char **res,
589
                     int *format,
E
Eric Blake 已提交
590
                     const char *buf,
591 592 593
                     size_t buf_size)
{
    static const char prefix[] = "parentFileNameHint=\"";
594
    char *desc, *start, *end;
595
    size_t len;
596 597
    int ret = BACKING_STORE_ERROR;

598
    if (VIR_ALLOC_N(desc, VIR_STORAGE_MAX_HEADER) < 0)
599
        goto cleanup;
600 601

    *res = NULL;
602 603
    /*
     * Technically this should have been VMDK, since
J
Ján Tomko 已提交
604
     * VMDK spec / VMware impl only support VMDK backed
605 606 607 608 609
     * by VMDK. QEMU isn't following this though and
     * does probing on VMDK backing files, hence we set
     * AUTO
     */
    *format = VIR_STORAGE_FILE_AUTO;
610

611 612 613 614
    if (buf_size <= 0x200) {
        ret = BACKING_STORE_INVALID;
        goto cleanup;
    }
615
    len = buf_size - 0x200;
616 617
    if (len > VIR_STORAGE_MAX_HEADER)
        len = VIR_STORAGE_MAX_HEADER;
618 619 620
    memcpy(desc, buf + 0x200, len);
    desc[len] = '\0';
    start = strstr(desc, prefix);
621
    if (start == NULL) {
E
Eric Blake 已提交
622
        *format = VIR_STORAGE_FILE_NONE;
623 624 625
        ret = BACKING_STORE_OK;
        goto cleanup;
    }
626 627
    start += strlen(prefix);
    end = strchr(start, '"');
628 629 630 631 632
    if (end == NULL) {
        ret = BACKING_STORE_INVALID;
        goto cleanup;
    }
    if (end == start) {
E
Eric Blake 已提交
633
        *format = VIR_STORAGE_FILE_NONE;
634 635 636
        ret = BACKING_STORE_OK;
        goto cleanup;
    }
637
    *end = '\0';
638
    if (VIR_STRDUP(*res, start) < 0)
639 640 641 642
        goto cleanup;

    ret = BACKING_STORE_OK;

643
 cleanup:
644 645
    VIR_FREE(desc);
    return ret;
646 647
}

648 649 650
static int
qedGetBackingStore(char **res,
                   int *format,
E
Eric Blake 已提交
651
                   const char *buf,
652 653 654 655 656 657 658 659 660
                   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 已提交
661
    flags = virReadBufInt64LE(buf + QED_HDR_FEATURES_OFFSET);
E
Eric Blake 已提交
662 663
    if (!(flags & QED_F_BACKING_FILE)) {
        *format = VIR_STORAGE_FILE_NONE;
664
        return BACKING_STORE_OK;
E
Eric Blake 已提交
665
    }
666 667 668 669

    /* Parse the backing file */
    if (buf_size < QED_HDR_BACKING_FILE_OFFSET+8)
        return BACKING_STORE_INVALID;
E
Eric Blake 已提交
670
    offset = virReadBufInt32LE(buf + QED_HDR_BACKING_FILE_OFFSET);
671 672
    if (offset > buf_size)
        return BACKING_STORE_INVALID;
E
Eric Blake 已提交
673
    size = virReadBufInt32LE(buf + QED_HDR_BACKING_FILE_SIZE);
674 675 676 677
    if (size == 0)
        return BACKING_STORE_OK;
    if (offset + size > buf_size || offset + size < offset)
        return BACKING_STORE_INVALID;
678
    if (VIR_ALLOC_N(*res, size + 1) < 0)
679 680 681 682
        return BACKING_STORE_ERROR;
    memcpy(*res, buf + offset, size);
    (*res)[size] = '\0';

E
Eric Blake 已提交
683 684 685 686
    if (flags & QED_F_BACKING_FORMAT_NO_PROBE)
        *format = VIR_STORAGE_FILE_RAW;
    else
        *format = VIR_STORAGE_FILE_AUTO_SAFE;
687 688 689 690

    return BACKING_STORE_OK;
}

691 692

static bool
693 694
virStorageFileMatchesMagic(int magicOffset,
                           const char *magic,
E
Eric Blake 已提交
695
                           char *buf,
696
                           size_t buflen)
697
{
698
    int mlen;
699

700
    if (magic == NULL)
701
        return false;
702

703
    /* Validate magic data */
704 705
    mlen = strlen(magic);
    if (magicOffset + mlen > buflen)
706
        return false;
707

708
    if (memcmp(buf + magicOffset, magic, mlen) != 0)
709 710 711 712 713 714 715
        return false;

    return true;
}


static bool
716
virStorageFileMatchesExtension(const char *extension,
717 718
                               const char *path)
{
719
    if (extension == NULL)
720 721
        return false;

722
    if (virFileHasSuffix(path, extension))
723 724 725 726 727 728 729
        return true;

    return false;
}


static bool
730 731 732 733
virStorageFileMatchesVersion(int versionOffset,
                             int versionSize,
                             const int *versionNumbers,
                             int endian,
E
Eric Blake 已提交
734
                             char *buf,
735 736
                             size_t buflen)
{
737
    int version;
738
    size_t i;
739 740

    /* Validate version number info */
741
    if (versionOffset == -1)
E
Eric Blake 已提交
742
        return false;
743

744
    /* -2 == non-versioned file format, so trivially match */
745
    if (versionOffset == -2)
746 747
        return true;

748
    /* A positive versionOffset, requires using a valid versionSize */
749
    if (versionSize != 2 && versionSize != 4)
750 751
        return false;

752
    if ((versionOffset + versionSize) > buflen)
753 754
        return false;

755 756
    if (endian == LV_LITTLE_ENDIAN) {
        if (versionSize == 4)
757
            version = virReadBufInt32LE(buf +
758
                                        versionOffset);
759 760
        else
            version = virReadBufInt16LE(buf +
761
                                        versionOffset);
762
    } else {
763
        if (versionSize == 4)
764
            version = virReadBufInt32BE(buf +
765
                                        versionOffset);
766 767
        else
            version = virReadBufInt16BE(buf +
768
                                        versionOffset);
769
    }
770

771
    for (i = 0;
772
         i < FILE_TYPE_VERSIONS_LAST && versionNumbers[i];
773 774
         i++) {
        VIR_DEBUG("Compare detected version %d vs one of the expected versions %d",
775 776
                  version, versionNumbers[i]);
        if (version == versionNumbers[i])
777 778
            return true;
    }
779

780
    return false;
781
}
782

783 784
bool
virStorageIsFile(const char *backing)
A
Adam Litke 已提交
785
{
786 787 788 789 790 791 792 793
    char *colon;
    char *slash;

    if (!backing)
        return false;

    colon = strchr(backing, ':');
    slash = strchr(backing, '/');
794 795 796 797 798

    /* Reject anything that looks like a protocol (such as nbd: or
     * rbd:); if someone really does want a relative file name that
     * includes ':', they can always prefix './'.  */
    if (colon && (!slash || colon < slash))
A
Adam Litke 已提交
799 800 801
        return false;
    return true;
}
802

E
Eric Blake 已提交
803

804
bool
805 806 807 808 809 810 811 812 813 814 815 816
virStorageIsRelative(const char *backing)
{
    if (backing[0] == '/')
        return false;

    if (!virStorageIsFile(backing))
        return false;

    return true;
}


817
static int
E
Eric Blake 已提交
818
virStorageFileProbeFormatFromBuf(const char *path,
E
Eric Blake 已提交
819
                                 char *buf,
E
Eric Blake 已提交
820 821 822
                                 size_t buflen)
{
    int format = VIR_STORAGE_FILE_RAW;
823
    size_t i;
E
Eric Blake 已提交
824
    int possibleFormat = VIR_STORAGE_FILE_RAW;
825
    VIR_DEBUG("path=%s, buf=%p, buflen=%zu", path, buf, buflen);
E
Eric Blake 已提交
826 827

    /* First check file magic */
828
    for (i = 0; i < VIR_STORAGE_FILE_LAST; i++) {
829 830 831 832 833 834 835 836 837 838
        if (virStorageFileMatchesMagic(
                fileTypeInfo[i].magicOffset,
                fileTypeInfo[i].magic,
                buf, buflen)) {
            if (!virStorageFileMatchesVersion(
                    fileTypeInfo[i].versionOffset,
                    fileTypeInfo[i].versionSize,
                    fileTypeInfo[i].versionNumbers,
                    fileTypeInfo[i].endian,
                    buf, buflen)) {
E
Eric Blake 已提交
839 840 841 842 843 844 845 846 847 848 849 850 851 852
                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 */
853
    for (i = 0; i < VIR_STORAGE_FILE_LAST; i++) {
854 855
        if (virStorageFileMatchesExtension(
                fileTypeInfo[i].extension, path)) {
E
Eric Blake 已提交
856 857 858 859 860
            format = i;
            goto cleanup;
        }
    }

861
 cleanup:
E
Eric Blake 已提交
862 863 864 865 866
    VIR_DEBUG("format=%d", format);
    return format;
}


867 868 869
static int
qcow2GetFeatures(virBitmapPtr *features,
                 int format,
E
Eric Blake 已提交
870
                 char *buf,
871 872 873 874 875
                 ssize_t len)
{
    int version = -1;
    virBitmapPtr feat = NULL;
    uint64_t bits;
876
    size_t i;
877 878 879 880 881 882 883 884 885

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

    if (version == 2)
        return 0;

    if (len < QCOW2v3_HDR_SIZE)
        return -1;

886
    if (!(feat = virBitmapNew(VIR_STORAGE_FILE_FEATURE_LAST)))
887 888 889 890 891 892 893 894 895 896 897 898 899 900
        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;
}


901 902 903 904 905 906
static bool
virStorageFileHasEncryptionFormat(const struct FileEncryptionInfo *info,
                                  char *buf,
                                  size_t len)
{
    if (!info->magic && info->modeOffset == -1)
907
        return false; /* Shouldn't happen - expect at least one */
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924

    if (info->magic) {
        if (!virStorageFileMatchesMagic(info->magicOffset,
                                        info->magic,
                                        buf, len))
            return false;

        if (info->versionOffset != -1 &&
            !virStorageFileMatchesVersion(info->versionOffset,
                                          info->versionSize,
                                          info->versionNumbers,
                                          info->endian,
                                          buf, len))
            return false;

        return true;
    } else if (info->modeOffset != -1) {
925 926
        int crypt_format;

927 928 929
        if (info->modeOffset >= len)
            return false;

930 931
        crypt_format = virReadBufInt32BE(buf + info->modeOffset);
        if (crypt_format != info->modeValue)
932 933 934 935 936 937 938 939 940
            return false;

        return true;
    } else {
        return false;
    }
}


941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
static int
virStorageFileGetEncryptionPayloadOffset(const struct FileEncryptionInfo *info,
                                         char *buf)
{
    int payload_offset = -1;

    if (info->payloadOffset != -1) {
        if (info->endian == LV_LITTLE_ENDIAN)
            payload_offset = virReadBufInt32LE(buf + info->payloadOffset);
        else
            payload_offset = virReadBufInt32BE(buf + info->payloadOffset);
    }

    return payload_offset;
}


958 959 960 961 962
/* Given a header in BUF with length LEN, as parsed from the storage file
 * assuming it has the given FORMAT, populate information into META
 * with information about the file and its backing store. Return format
 * of the backing store as BACKING_FORMAT. PATH and FORMAT have to be
 * pre-populated in META */
963
int
964
virStorageFileGetMetadataInternal(virStorageSourcePtr meta,
965 966
                                  char *buf,
                                  size_t len,
967
                                  int *backingFormat)
968
{
969
    int dummy;
970
    int ret = -1;
971
    size_t i;
E
Eric Blake 已提交
972

973 974 975
    if (!backingFormat)
        backingFormat = &dummy;

976 977
    VIR_DEBUG("path=%s, buf=%p, len=%zu, meta->format=%d",
              meta->path, buf, len, meta->format);
E
Eric Blake 已提交
978

979
    if (meta->format == VIR_STORAGE_FILE_AUTO)
980
        meta->format = virStorageFileProbeFormatFromBuf(meta->path, buf, len);
981

982 983 984 985
    if (meta->format <= VIR_STORAGE_FILE_NONE ||
        meta->format >= VIR_STORAGE_FILE_LAST) {
        virReportSystemError(EINVAL, _("unknown storage file meta->format %d"),
                             meta->format);
E
Eric Blake 已提交
986 987
        goto cleanup;
    }
988

989 990 991 992
    if (fileTypeInfo[meta->format].cryptInfo != NULL) {
        for (i = 0; fileTypeInfo[meta->format].cryptInfo[i].format != 0; i++) {
            if (virStorageFileHasEncryptionFormat(&fileTypeInfo[meta->format].cryptInfo[i],
                                                  buf, len)) {
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
                int expt_fmt = fileTypeInfo[meta->format].cryptInfo[i].format;
                if (!meta->encryption) {
                    if (VIR_ALLOC(meta->encryption) < 0)
                        goto cleanup;

                    meta->encryption->format = expt_fmt;
                } else {
                    if (meta->encryption->format != expt_fmt) {
                        virReportError(VIR_ERR_XML_ERROR,
                                       _("encryption format %d doesn't match "
                                         "expected format %d"),
                                       meta->encryption->format, expt_fmt);
                        goto cleanup;
                    }
                }
1008 1009
                meta->encryption->payload_offset =
                    virStorageFileGetEncryptionPayloadOffset(&fileTypeInfo[meta->format].cryptInfo[i], buf);
1010 1011 1012 1013
            }
        }
    }

1014 1015 1016
    /* XXX we should consider moving virStorageBackendUpdateVolInfo
     * code into this method, for non-magic files
     */
1017
    if (!fileTypeInfo[meta->format].magic)
E
Eric Blake 已提交
1018
        goto done;
1019

1020
    /* Optionally extract capacity from file */
1021 1022
    if (fileTypeInfo[meta->format].sizeOffset != -1) {
        if ((fileTypeInfo[meta->format].sizeOffset + 8) > len)
E
Eric Blake 已提交
1023
            goto done;
1024

1025
        if (fileTypeInfo[meta->format].endian == LV_LITTLE_ENDIAN)
E
Eric Blake 已提交
1026
            meta->capacity = virReadBufInt64LE(buf +
1027
                                               fileTypeInfo[meta->format].sizeOffset);
E
Eric Blake 已提交
1028 1029
        else
            meta->capacity = virReadBufInt64BE(buf +
1030
                                               fileTypeInfo[meta->format].sizeOffset);
1031
        /* Avoid unlikely, but theoretically possible overflow */
E
Eric Blake 已提交
1032
        if (meta->capacity > (ULLONG_MAX /
1033
                              fileTypeInfo[meta->format].sizeMultiplier))
E
Eric Blake 已提交
1034
            goto done;
1035
        meta->capacity *= fileTypeInfo[meta->format].sizeMultiplier;
1036
    }
1037

1038
    VIR_FREE(meta->backingStoreRaw);
1039 1040
    if (fileTypeInfo[meta->format].getBackingStore != NULL) {
        int store = fileTypeInfo[meta->format].getBackingStore(&meta->backingStoreRaw,
1041
                                                         backingFormat,
E
Eric Blake 已提交
1042 1043 1044
                                                         buf, len);
        if (store == BACKING_STORE_INVALID)
            goto done;
1045

E
Eric Blake 已提交
1046 1047
        if (store == BACKING_STORE_ERROR)
            goto cleanup;
1048 1049
    }

1050 1051
    if (fileTypeInfo[meta->format].getFeatures != NULL &&
        fileTypeInfo[meta->format].getFeatures(&meta->features, meta->format, buf, len) < 0)
1052 1053
        goto cleanup;

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

1058
 done:
1059
    ret = 0;
E
Eric Blake 已提交
1060

1061
 cleanup:
E
Eric Blake 已提交
1062
    return ret;
1063 1064 1065 1066
}


/**
1067
 * virStorageFileProbeFormat:
1068
 *
1069 1070
 * Probe for the format of 'path', returning the detected
 * disk format.
1071 1072 1073
 *
 * Callers are advised never to trust the returned 'format'
 * unless it is listed as VIR_STORAGE_FILE_RAW, since a
1074
 * malicious guest can turn a raw file into any other non-raw
1075 1076 1077 1078 1079
 * format at will.
 *
 * Best option: Don't use this function
 */
int
1080
virStorageFileProbeFormat(const char *path, uid_t uid, gid_t gid)
1081
{
1082
    int fd;
1083
    int ret = -1;
1084
    struct stat sb;
1085 1086
    ssize_t len = VIR_STORAGE_MAX_HEADER;
    char *header = NULL;
1087

1088 1089
    if ((fd = virFileOpenAs(path, O_RDONLY, 0, uid, gid, 0)) < 0) {
        virReportSystemError(-fd, _("Failed to open file '%s'"), path);
1090 1091 1092
        return -1;
    }

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

1098 1099
    /* No header to probe for directories */
    if (S_ISDIR(sb.st_mode)) {
1100 1101
        ret = VIR_STORAGE_FILE_DIR;
        goto cleanup;
1102
    }
1103 1104 1105 1106 1107 1108

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

1109
    if ((len = virFileReadHeaderFD(fd, len, &header)) < 0) {
1110 1111 1112 1113
        virReportSystemError(errno, _("cannot read header '%s'"), path);
        goto cleanup;
    }

1114
    ret = virStorageFileProbeFormatFromBuf(path, header, len);
1115

1116
 cleanup:
1117
    VIR_FREE(header);
1118
    VIR_FORCE_CLOSE(fd);
1119 1120 1121 1122

    return ret;
}

1123

1124
static virStorageSourcePtr
1125 1126 1127
virStorageFileMetadataNew(const char *path,
                          int format)
{
1128
    virStorageSourcePtr ret = NULL;
1129 1130 1131 1132 1133 1134 1135

    if (VIR_ALLOC(ret) < 0)
        return NULL;

    ret->format = format;
    ret->type = VIR_STORAGE_TYPE_FILE;

1136 1137
    if (VIR_STRDUP(ret->path, path) < 0)
        goto error;
1138 1139 1140 1141

    return ret;

 error:
1142
    virStorageSourceFree(ret);
1143 1144 1145 1146
    return NULL;
}


1147 1148 1149 1150 1151
/**
 * virStorageFileGetMetadataFromBuf:
 * @path: name of file, for error messages
 * @buf: header bytes from @path
 * @len: length of @buf
1152
 * @format: format of the storage file
1153
 * @backingFormat: format of @backing
1154
 *
1155 1156 1157
 * Extract metadata about the storage volume with the specified image format.
 * If image format is VIR_STORAGE_FILE_AUTO, it will probe to automatically
 * identify the format.  Does not recurse.
1158
 *
1159 1160 1161 1162 1163 1164 1165
 * Callers are advised never to use VIR_STORAGE_FILE_AUTO as a format on a file
 * that might be raw if that file will then be passed to a guest, since a
 * malicious guest can turn a raw file into any other non-raw format at will.
 *
 * If the returned @backingFormat 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.
1166
 *
1167
 * Caller MUST free the result after use via virStorageSourceFree.
1168
 */
1169
virStorageSourcePtr
1170 1171 1172
virStorageFileGetMetadataFromBuf(const char *path,
                                 char *buf,
                                 size_t len,
1173
                                 int format,
1174
                                 int *backingFormat)
1175
{
1176
    virStorageSourcePtr ret = NULL;
1177 1178 1179 1180
    int dummy;

    if (!backingFormat)
        backingFormat = &dummy;
1181

1182
    if (!(ret = virStorageFileMetadataNew(path, format)))
1183
        return NULL;
1184

1185 1186 1187 1188 1189
    if (virStorageFileGetMetadataInternal(ret, buf, len,
                                          backingFormat) < 0) {
        virStorageSourceFree(ret);
        return NULL;
    }
1190

1191
    return ret;
1192 1193 1194
}


1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
/**
 * virStorageFileGetMetadataFromFD:
 *
 * Extract metadata about the storage volume with the specified
 * image format. If image format is VIR_STORAGE_FILE_AUTO, it
 * will probe to automatically identify the format.  Does not recurse.
 *
 * 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.
 *
 * Caller MUST free the result after use via virStorageSourceFree.
 */
virStorageSourcePtr
virStorageFileGetMetadataFromFD(const char *path,
                                int fd,
                                int format,
                                int *backingFormat)

1214
{
1215 1216
    virStorageSourcePtr ret = NULL;
    virStorageSourcePtr meta = NULL;
1217
    char *buf = NULL;
1218
    ssize_t len = VIR_STORAGE_MAX_HEADER;
1219
    struct stat sb;
1220
    int dummy;
1221

1222 1223
    if (!backingFormat)
        backingFormat = &dummy;
1224

1225
    *backingFormat = VIR_STORAGE_FILE_NONE;
1226

1227 1228
    if (fstat(fd, &sb) < 0) {
        virReportSystemError(errno,
1229 1230
                             _("cannot stat file '%s'"), path);
        return NULL;
1231 1232
    }

1233 1234 1235
    if (!(meta = virStorageFileMetadataNew(path, format)))
        return NULL;

1236
    if (S_ISDIR(sb.st_mode)) {
1237 1238
        /* No header to probe for directories, but also no backing file. Just
         * update the metadata.*/
1239 1240
        meta->type = VIR_STORAGE_TYPE_DIR;
        meta->format = VIR_STORAGE_FILE_DIR;
1241 1242
        ret = meta;
        meta = NULL;
1243 1244 1245 1246
        goto cleanup;
    }

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

    if ((len = virFileReadHeaderFD(fd, len, &buf)) < 0) {
1252
        virReportSystemError(errno, _("cannot read header '%s'"), meta->path);
1253 1254 1255
        goto cleanup;
    }

1256 1257
    if (virStorageFileGetMetadataInternal(meta, buf, len, backingFormat) < 0)
        goto cleanup;
1258

1259 1260 1261 1262
    if (S_ISREG(sb.st_mode))
        meta->type = VIR_STORAGE_TYPE_FILE;
    else if (S_ISBLK(sb.st_mode))
        meta->type = VIR_STORAGE_TYPE_BLOCK;
1263

1264 1265
    ret = meta;
    meta = NULL;
1266

1267 1268 1269
 cleanup:
    virStorageSourceFree(meta);
    VIR_FREE(buf);
1270
    return ret;
1271 1272
}

1273

1274 1275 1276 1277 1278
/**
 * virStorageFileChainCheckBroken
 *
 * If CHAIN is broken, set *brokenFile to the broken file name,
 * otherwise set it to NULL. Caller MUST free *brokenFile after use.
1279 1280
 * Return 0 on success (including when brokenFile is set), negative on
 * error (allocation failure).
1281 1282
 */
int
1283
virStorageFileChainGetBroken(virStorageSourcePtr chain,
1284 1285
                             char **brokenFile)
{
1286
    virStorageSourcePtr tmp;
1287

1288 1289
    *brokenFile = NULL;

1290 1291 1292
    if (!chain)
        return 0;

1293
    for (tmp = chain; tmp; tmp = tmp->backingStore) {
1294 1295
        /* Break when we hit end of chain; report error if we detected
         * a missing backing file, infinite loop, or other error */
1296
        if (!tmp->backingStore && tmp->backingStoreRaw) {
1297 1298
            if (VIR_STRDUP(*brokenFile, tmp->backingStoreRaw) < 0)
                return -1;
1299

1300 1301 1302
           return 0;
        }
    }
1303

1304
    return 0;
1305 1306 1307
}


1308 1309 1310 1311 1312 1313
/**
 * virStorageFileResize:
 *
 * Change the capacity of the raw storage file at 'path'.
 */
int
1314 1315 1316 1317
virStorageFileResize(const char *path,
                     unsigned long long capacity,
                     unsigned long long orig_capacity,
                     bool pre_allocate)
1318
{
1319 1320
    int fd = -1;
    int ret = -1;
1321 1322 1323 1324 1325 1326
    int rc ATTRIBUTE_UNUSED;
    off_t offset ATTRIBUTE_UNUSED;
    off_t len ATTRIBUTE_UNUSED;

    offset = orig_capacity;
    len = capacity - orig_capacity;
1327 1328 1329 1330 1331 1332

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

1333
    if (pre_allocate) {
1334 1335 1336 1337
        if (safezero(fd, offset, len) != 0) {
            virReportSystemError(errno,
                                 _("Failed to pre-allocate space for "
                                   "file '%s'"), path);
1338 1339 1340 1341 1342 1343 1344 1345
            goto cleanup;
        }
    } else {
        if (ftruncate(fd, capacity) < 0) {
            virReportSystemError(errno,
                                 _("Failed to truncate file '%s'"), path);
            goto cleanup;
        }
1346 1347
    }

1348 1349 1350 1351 1352 1353 1354
    if (VIR_CLOSE(fd) < 0) {
        virReportSystemError(errno, _("Unable to save '%s'"), path);
        goto cleanup;
    }

    ret = 0;

1355
 cleanup:
1356 1357
    VIR_FORCE_CLOSE(fd);
    return ret;
1358 1359
}

1360 1361 1362 1363 1364 1365

int virStorageFileIsClusterFS(const char *path)
{
    /* These are coherent cluster filesystems known to be safe for
     * migration with cache != none
     */
1366 1367 1368
    return virFileIsSharedFSType(path,
                                 VIR_FILE_SHFS_GFS2 |
                                 VIR_FILE_SHFS_OCFS);
1369
}
1370 1371

#ifdef LVS
1372 1373
int virStorageFileGetLVMKey(const char *path,
                            char **key)
1374 1375 1376 1377 1378
{
    /*
     *  # lvs --noheadings --unbuffered --nosuffix --options "uuid" LVNAME
     *    06UgP5-2rhb-w3Bo-3mdR-WeoL-pytO-SAa2ky
     */
1379
    int status;
1380 1381 1382 1383 1384 1385
    virCommandPtr cmd = virCommandNewArgList(
        LVS,
        "--noheadings", "--unbuffered", "--nosuffix",
        "--options", "uuid", path,
        NULL
        );
1386 1387 1388
    int ret = -1;

    *key = NULL;
1389 1390

    /* Run the program and capture its output */
1391 1392
    virCommandSetOutputBuffer(cmd, key);
    if (virCommandRun(cmd, &status) < 0)
1393 1394
        goto cleanup;

1395 1396 1397 1398 1399 1400
    /* 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) {
1401
        char *nl;
1402
        char *tmp = *key;
1403 1404

        /* Find first non-space character */
1405
        while (*tmp && c_isspace(*tmp))
1406 1407
            tmp++;
        /* Kill leading spaces */
1408 1409
        if (tmp != *key)
            memmove(*key, tmp, strlen(tmp)+1);
1410 1411

        /* Kill trailing newline */
1412
        if ((nl = strchr(*key, '\n')))
1413 1414 1415
            *nl = '\0';
    }

1416
    ret = 0;
1417

1418
 cleanup:
1419 1420 1421
    if (*key && STREQ(*key, ""))
        VIR_FREE(*key);

1422 1423
    virCommandFree(cmd);

1424
    return ret;
1425 1426
}
#else
1427 1428
int virStorageFileGetLVMKey(const char *path,
                            char **key ATTRIBUTE_UNUSED)
1429 1430
{
    virReportSystemError(ENOSYS, _("Unable to get LVM key for %s"), path);
1431
    return -1;
1432 1433 1434
}
#endif

1435
#ifdef WITH_UDEV
1436 1437
int virStorageFileGetSCSIKey(const char *path,
                             char **key)
1438
{
1439
    int status;
1440 1441 1442 1443 1444 1445 1446
    virCommandPtr cmd = virCommandNewArgList(
        "/lib/udev/scsi_id",
        "--replace-whitespace",
        "--whitelisted",
        "--device", path,
        NULL
        );
1447 1448 1449
    int ret = -1;

    *key = NULL;
1450 1451

    /* Run the program and capture its output */
1452 1453
    virCommandSetOutputBuffer(cmd, key);
    if (virCommandRun(cmd, &status) < 0)
1454 1455
        goto cleanup;

1456 1457 1458 1459 1460 1461
    /* 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');
1462 1463 1464 1465
        if (nl)
            *nl = '\0';
    }

1466 1467
    ret = 0;

1468
 cleanup:
1469 1470 1471
    if (*key && STREQ(*key, ""))
        VIR_FREE(*key);

1472 1473
    virCommandFree(cmd);

1474
    return ret;
1475 1476
}
#else
1477 1478
int virStorageFileGetSCSIKey(const char *path,
                             char **key ATTRIBUTE_UNUSED)
1479 1480
{
    virReportSystemError(ENOSYS, _("Unable to get SCSI key for %s"), path);
1481
    return -1;
1482 1483
}
#endif
1484

1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532

/**
 * virStorageFileParseBackingStoreStr:
 * @str: backing store specifier string to parse
 * @target: returns target device portion of the string
 * @chainIndex: returns the backing store portion of the string
 *
 * Parses the backing store specifier string such as vda[1], or sda into
 * components and returns them via arguments. If the string did not specify an
 * index, 0 is assumed.
 *
 * Returns 0 on success -1 on error
 */
int
virStorageFileParseBackingStoreStr(const char *str,
                                   char **target,
                                   unsigned int *chainIndex)
{
    char **strings = NULL;
    size_t nstrings;
    unsigned int idx = 0;
    char *suffix;
    int ret = -1;

    *chainIndex = 0;

    if (!(strings = virStringSplitCount(str, "[", 2, &nstrings)))
        return -1;

    if (nstrings == 2) {
        if (virStrToLong_uip(strings[1], &suffix, 10, &idx) < 0 ||
            STRNEQ(suffix, "]"))
            goto cleanup;
    }

    if (target &&
        VIR_STRDUP(*target, strings[0]) < 0)
        goto cleanup;

    *chainIndex = idx;
    ret = 0;

 cleanup:
    virStringListFreeCount(strings, nstrings);
    return ret;
}


1533 1534 1535 1536 1537 1538
int
virStorageFileParseChainIndex(const char *diskTarget,
                              const char *name,
                              unsigned int *chainIndex)
{
    unsigned int idx = 0;
1539
    char *target = NULL;
1540 1541 1542 1543
    int ret = 0;

    *chainIndex = 0;

1544 1545
    if (!name || !diskTarget)
        return 0;
1546

1547 1548
    if (virStorageFileParseBackingStoreStr(name, &target, &idx) < 0)
        return 0;
1549

1550
    if (idx == 0)
1551 1552
        goto cleanup;

1553
    if (STRNEQ(diskTarget, target)) {
1554 1555
        virReportError(VIR_ERR_INVALID_ARG,
                       _("requested target '%s' does not match target '%s'"),
1556
                       target, diskTarget);
1557 1558 1559 1560 1561 1562 1563
        ret = -1;
        goto cleanup;
    }

    *chainIndex = idx;

 cleanup:
1564
    VIR_FREE(target);
1565 1566 1567
    return ret;
}

E
Eric Blake 已提交
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
/* Given a @chain, look for the backing store @name that is a backing file
 * of @startFrom (or any member of @chain if @startFrom is NULL) and return
 * that location within the chain.  @chain must always point to the top of
 * the chain.  Pass NULL for @name and 0 for @idx to find the base of the
 * chain.  Pass nonzero @idx to find the backing source according to its
 * position in the backing chain.  If @parent is not NULL, set *@parent to
 * the preferred name of the parent (or to NULL if @name matches the start
 * of the chain).  Since the results point within @chain, they must not be
 * independently freed. Reports an error and returns NULL if @name is not
 * found.
1578
 */
1579
virStorageSourcePtr
1580
virStorageFileChainLookup(virStorageSourcePtr chain,
1581
                          virStorageSourcePtr startFrom,
1582
                          const char *name,
1583
                          unsigned int idx,
1584
                          virStorageSourcePtr *parent)
1585
{
1586
    virStorageSourcePtr prev;
1587
    const char *start = chain->path;
1588
    char *parentDir = NULL;
E
Eric Blake 已提交
1589
    bool nameIsFile = virStorageIsFile(name);
1590
    size_t i = 0;
1591 1592

    if (!parent)
1593
        parent = &prev;
1594
    *parent = NULL;
1595 1596

    if (startFrom) {
E
Eric Blake 已提交
1597
        while (chain && chain != startFrom->backingStore) {
1598 1599 1600
            chain = chain->backingStore;
            i++;
        }
1601 1602 1603 1604 1605 1606 1607 1608 1609

        if (idx && idx < i) {
            virReportError(VIR_ERR_INVALID_ARG,
                           _("requested backing store index %u is above '%s' "
                             "in chain for '%s'"),
                           idx, NULLSTR(startFrom->path), NULLSTR(start));
            return NULL;
        }

1610
        *parent = startFrom;
1611 1612
    }

E
Eric Blake 已提交
1613
    while (chain) {
1614
        if (!name && !idx) {
1615
            if (!chain->backingStore)
1616
                break;
1617 1618 1619 1620
        } else if (idx) {
            VIR_DEBUG("%zu: %s", i, chain->path);
            if (idx == i)
                break;
E
Eric Blake 已提交
1621
        } else {
1622 1623
            if (STREQ_NULLABLE(name, chain->relPath) ||
                STREQ(name, chain->path))
1624
                break;
1625 1626

            if (nameIsFile && virStorageSourceIsLocalStorage(chain)) {
1627 1628
                if (*parent && virStorageSourceIsLocalStorage(*parent))
                    parentDir = mdir_name((*parent)->path);
1629 1630 1631 1632 1633 1634
                else
                    ignore_value(VIR_STRDUP_QUIET(parentDir, "."));

                if (!parentDir) {
                    virReportOOMError();
                    goto error;
1635 1636
                }

E
Eric Blake 已提交
1637
                int result = virFileRelLinkPointsTo(parentDir, name,
1638
                                                    chain->path);
1639 1640

                VIR_FREE(parentDir);
1641

E
Eric Blake 已提交
1642 1643
                if (result < 0)
                    goto error;
1644

E
Eric Blake 已提交
1645 1646 1647
                if (result > 0)
                    break;
            }
1648
        }
1649
        *parent = chain;
1650
        chain = chain->backingStore;
1651
        i++;
1652
    }
1653

E
Eric Blake 已提交
1654
    if (!chain)
1655
        goto error;
1656

1657
    return chain;
1658

1659
 error:
1660 1661
    if (idx) {
        virReportError(VIR_ERR_INVALID_ARG,
1662 1663
                       _("could not find backing store index %u in chain "
                         "for '%s'"),
1664
                       idx, NULLSTR(start));
1665
    } else if (name) {
E
Eric Blake 已提交
1666 1667 1668
        if (startFrom)
            virReportError(VIR_ERR_INVALID_ARG,
                           _("could not find image '%s' beneath '%s' in "
1669 1670
                             "chain for '%s'"), name, NULLSTR(startFrom->path),
                           NULLSTR(start));
E
Eric Blake 已提交
1671 1672 1673
        else
            virReportError(VIR_ERR_INVALID_ARG,
                           _("could not find image '%s' in chain for '%s'"),
1674
                           name, NULLSTR(start));
1675
    } else {
1676 1677
        virReportError(VIR_ERR_INVALID_ARG,
                       _("could not find base image in chain for '%s'"),
1678
                       NULLSTR(start));
1679
    }
1680 1681 1682
    *parent = NULL;
    return NULL;
}
1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712


void
virStorageNetHostDefClear(virStorageNetHostDefPtr def)
{
    if (!def)
        return;

    VIR_FREE(def->name);
    VIR_FREE(def->port);
    VIR_FREE(def->socket);
}


void
virStorageNetHostDefFree(size_t nhosts,
                         virStorageNetHostDefPtr hosts)
{
    size_t i;

    if (!hosts)
        return;

    for (i = 0; i < nhosts; i++)
        virStorageNetHostDefClear(&hosts[i]);

    VIR_FREE(hosts);
}


1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723
static void
virStoragePermsFree(virStoragePermsPtr def)
{
    if (!def)
        return;

    VIR_FREE(def->label);
    VIR_FREE(def);
}


1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755
virStorageNetHostDefPtr
virStorageNetHostDefCopy(size_t nhosts,
                         virStorageNetHostDefPtr hosts)
{
    virStorageNetHostDefPtr ret = NULL;
    size_t i;

    if (VIR_ALLOC_N(ret, nhosts) < 0)
        goto error;

    for (i = 0; i < nhosts; i++) {
        virStorageNetHostDefPtr src = &hosts[i];
        virStorageNetHostDefPtr dst = &ret[i];

        dst->transport = src->transport;

        if (VIR_STRDUP(dst->name, src->name) < 0)
            goto error;

        if (VIR_STRDUP(dst->port, src->port) < 0)
            goto error;

        if (VIR_STRDUP(dst->socket, src->socket) < 0)
            goto error;
    }

    return ret;

 error:
    virStorageNetHostDefFree(nhosts, ret);
    return NULL;
}
1756 1757


1758 1759 1760 1761 1762 1763 1764 1765
void
virStorageAuthDefFree(virStorageAuthDefPtr authdef)
{
    if (!authdef)
        return;

    VIR_FREE(authdef->username);
    VIR_FREE(authdef->secrettype);
1766
    virSecretLookupDefClear(&authdef->seclookupdef);
1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
    VIR_FREE(authdef);
}


virStorageAuthDefPtr
virStorageAuthDefCopy(const virStorageAuthDef *src)
{
    virStorageAuthDefPtr ret;

    if (VIR_ALLOC(ret) < 0)
        return NULL;

    if (VIR_STRDUP(ret->username, src->username) < 0)
        goto error;
    /* Not present for storage pool, but used for disk source */
    if (VIR_STRDUP(ret->secrettype, src->secrettype) < 0)
        goto error;
    ret->authType = src->authType;
1785 1786 1787 1788

    if (virSecretLookupDefCopy(&ret->seclookupdef, &src->seclookupdef) < 0)
        goto error;

1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800
    return ret;

 error:
    virStorageAuthDefFree(ret);
    return NULL;
}


static virStorageAuthDefPtr
virStorageAuthDefParseXML(xmlXPathContextPtr ctxt)
{
    virStorageAuthDefPtr authdef = NULL;
1801
    xmlNodePtr secretnode = NULL;
1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829
    char *username = NULL;
    char *authtype = NULL;

    if (VIR_ALLOC(authdef) < 0)
        return NULL;

    if (!(username = virXPathString("string(./@username)", ctxt))) {
        virReportError(VIR_ERR_XML_ERROR, "%s",
                       _("missing username for auth"));
        goto error;
    }
    authdef->username = username;
    username = NULL;

    authdef->authType = VIR_STORAGE_AUTH_TYPE_NONE;
    authtype = virXPathString("string(./@type)", ctxt);
    if (authtype) {
        /* Used by the storage pool instead of the secret type field
         * to define whether chap or ceph being used
         */
        if ((authdef->authType = virStorageAuthTypeFromString(authtype)) < 0) {
            virReportError(VIR_ERR_CONFIG_UNSUPPORTED,
                           _("unknown auth type '%s'"), authtype);
            goto error;
        }
        VIR_FREE(authtype);
    }

1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
    if (!(secretnode = virXPathNode("./secret ", ctxt))) {
        virReportError(VIR_ERR_XML_ERROR, "%s",
                       _("Missing <secret> element in auth"));
        goto error;
    }

    /* Used by the domain disk xml parsing in order to ensure the
     * <secret type='%s' value matches the expected secret type for
     * the style of disk (iscsi is chap, nbd is ceph). For some reason
     * the virSecretUsageType{From|To}String() cannot be linked here
     * and because only the domain parsing code cares - just keep
     * it as a string.
     */
    authdef->secrettype = virXMLPropString(secretnode, "type");

    if (virSecretLookupParseSecret(secretnode, &authdef->seclookupdef) < 0)
1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891
        goto error;

    return authdef;

 error:
    VIR_FREE(authtype);
    VIR_FREE(username);
    virStorageAuthDefFree(authdef);
    return NULL;
}


virStorageAuthDefPtr
virStorageAuthDefParse(xmlDocPtr xml, xmlNodePtr root)
{
    xmlXPathContextPtr ctxt = NULL;
    virStorageAuthDefPtr authdef = NULL;

    ctxt = xmlXPathNewContext(xml);
    if (ctxt == NULL) {
        virReportOOMError();
        goto cleanup;
    }

    ctxt->node = root;
    authdef = virStorageAuthDefParseXML(ctxt);

 cleanup:
    xmlXPathFreeContext(ctxt);
    return authdef;
}


int
virStorageAuthDefFormat(virBufferPtr buf,
                        virStorageAuthDefPtr authdef)
{
    if (authdef->authType == VIR_STORAGE_AUTH_TYPE_NONE) {
        virBufferEscapeString(buf, "<auth username='%s'>\n", authdef->username);
    } else {
        virBufferAsprintf(buf, "<auth type='%s' ",
                          virStorageAuthTypeToString(authdef->authType));
        virBufferEscapeString(buf, "username='%s'>\n", authdef->username);
    }

    virBufferAdjustIndent(buf, 2);
1892 1893
    virSecretLookupFormatSecret(buf, authdef->secrettype,
                                &authdef->seclookupdef);
1894 1895 1896 1897 1898 1899 1900
    virBufferAdjustIndent(buf, -2);
    virBufferAddLit(buf, "</auth>\n");

    return 0;
}


1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915
virSecurityDeviceLabelDefPtr
virStorageSourceGetSecurityLabelDef(virStorageSourcePtr src,
                                    const char *model)
{
    size_t i;

    for (i = 0; i < src->nseclabels; i++) {
        if (STREQ_NULLABLE(src->seclabels[i]->model, model))
            return src->seclabels[i];
    }

    return NULL;
}


1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980
static void
virStorageSourceSeclabelsClear(virStorageSourcePtr def)
{
    size_t i;

    if (def->seclabels) {
        for (i = 0; i < def->nseclabels; i++)
            virSecurityDeviceLabelDefFree(def->seclabels[i]);
        VIR_FREE(def->seclabels);
    }
}


static int
virStorageSourceSeclabelsCopy(virStorageSourcePtr to,
                              const virStorageSource *from)
{
    size_t i;

    if (from->nseclabels == 0)
        return 0;

    if (VIR_ALLOC_N(to->seclabels, from->nseclabels) < 0)
        return -1;
    to->nseclabels = from->nseclabels;

    for (i = 0; i < to->nseclabels; i++) {
        if (!(to->seclabels[i] = virSecurityDeviceLabelDefCopy(from->seclabels[i])))
            goto error;
    }

    return 0;

 error:
    virStorageSourceSeclabelsClear(to);
    return -1;
}


static virStorageTimestampsPtr
virStorageTimestampsCopy(const virStorageTimestamps *src)
{
    virStorageTimestampsPtr ret;

    if (VIR_ALLOC(ret) < 0)
        return NULL;

    memcpy(ret, src, sizeof(*src));

    return ret;
}


static virStoragePermsPtr
virStoragePermsCopy(const virStoragePerms *src)
{
    virStoragePermsPtr ret;

    if (VIR_ALLOC(ret) < 0)
        return NULL;

    ret->mode = src->mode;
    ret->uid = src->uid;
    ret->gid = src->gid;

1981
    if (VIR_STRDUP(ret->label, src->label) < 0)
1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038
        goto error;

    return ret;

 error:
    virStoragePermsFree(ret);
    return NULL;
}


static virStorageSourcePoolDefPtr
virStorageSourcePoolDefCopy(const virStorageSourcePoolDef *src)
{
    virStorageSourcePoolDefPtr ret;

    if (VIR_ALLOC(ret) < 0)
        return NULL;

    ret->voltype = src->voltype;
    ret->pooltype = src->pooltype;
    ret->actualtype = src->actualtype;
    ret->mode = src->mode;

    if (VIR_STRDUP(ret->pool, src->pool) < 0 ||
        VIR_STRDUP(ret->volume, src->volume) < 0)
        goto error;

    return ret;

 error:
    virStorageSourcePoolDefFree(ret);
    return NULL;
}


/**
 * virStorageSourcePtr:
 *
 * Deep-copies a virStorageSource structure. If @backing chain is true
 * then also copies the backing chain recursively, otherwise just
 * the top element is copied. This function doesn't copy the
 * storage driver access structure and thus the struct needs to be initialized
 * separately.
 */
virStorageSourcePtr
virStorageSourceCopy(const virStorageSource *src,
                     bool backingChain)
{
    virStorageSourcePtr ret = NULL;

    if (VIR_ALLOC(ret) < 0)
        return NULL;

    ret->type = src->type;
    ret->protocol = src->protocol;
    ret->format = src->format;
    ret->capacity = src->capacity;
2039
    ret->allocation = src->allocation;
2040
    ret->has_allocation = src->has_allocation;
2041
    ret->physical = src->physical;
2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052
    ret->readonly = src->readonly;
    ret->shared = src->shared;

    /* storage driver metadata are not copied */
    ret->drv = NULL;

    if (VIR_STRDUP(ret->path, src->path) < 0 ||
        VIR_STRDUP(ret->volume, src->volume) < 0 ||
        VIR_STRDUP(ret->driverName, src->driverName) < 0 ||
        VIR_STRDUP(ret->relPath, src->relPath) < 0 ||
        VIR_STRDUP(ret->backingStoreRaw, src->backingStoreRaw) < 0 ||
2053
        VIR_STRDUP(ret->snapshot, src->snapshot) < 0 ||
2054
        VIR_STRDUP(ret->configFile, src->configFile) < 0 ||
2055 2056
        VIR_STRDUP(ret->nodeformat, src->nodeformat) < 0 ||
        VIR_STRDUP(ret->nodebacking, src->nodebacking) < 0 ||
2057 2058 2059
        VIR_STRDUP(ret->compat, src->compat) < 0)
        goto error;

2060 2061 2062 2063 2064 2065
    if (src->nhosts) {
        if (!(ret->hosts = virStorageNetHostDefCopy(src->nhosts, src->hosts)))
            goto error;

        ret->nhosts = src->nhosts;
    }
2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107

    if (src->srcpool &&
        !(ret->srcpool = virStorageSourcePoolDefCopy(src->srcpool)))
        goto error;

    if (src->features &&
        !(ret->features = virBitmapNewCopy(src->features)))
        goto error;

    if (src->encryption &&
        !(ret->encryption = virStorageEncryptionCopy(src->encryption)))
        goto error;

    if (src->perms &&
        !(ret->perms = virStoragePermsCopy(src->perms)))
        goto error;

    if (src->timestamps &&
        !(ret->timestamps = virStorageTimestampsCopy(src->timestamps)))
        goto error;

    if (virStorageSourceSeclabelsCopy(ret, src) < 0)
        goto error;

    if (src->auth &&
        !(ret->auth = virStorageAuthDefCopy(src->auth)))
        goto error;

    if (backingChain && src->backingStore) {
        if (!(ret->backingStore = virStorageSourceCopy(src->backingStore,
                                                       true)))
            goto error;
    }

    return ret;

 error:
    virStorageSourceFree(ret);
    return NULL;
}


2108 2109 2110 2111
/**
 * virStorageSourceInitChainElement:
 * @newelem: New backing chain element disk source
 * @old: Existing top level disk source
N
Nitesh Konkar 已提交
2112
 * @transferLabels: Transfer security labels.
2113 2114 2115 2116 2117
 *
 * Transfers relevant information from the existing disk source to the new
 * backing chain element if they weren't supplied so that labelling info
 * and possibly other stuff is correct.
 *
2118 2119
 * If @transferLabels is true, security labels from the existing disk are copied
 * to the new disk. Otherwise the default domain imagelabel label will be used.
2120 2121 2122 2123 2124 2125
 *
 * Returns 0 on success, -1 on error.
 */
int
virStorageSourceInitChainElement(virStorageSourcePtr newelem,
                                 virStorageSourcePtr old,
2126
                                 bool transferLabels)
2127 2128 2129
{
    int ret = -1;

2130 2131
    if (transferLabels &&
        !newelem->seclabels &&
2132 2133 2134
        virStorageSourceSeclabelsCopy(newelem, old) < 0)
        goto cleanup;

2135 2136 2137 2138
    if (!newelem->driverName &&
        VIR_STRDUP(newelem->driverName, old->driverName) < 0)
        goto cleanup;

2139 2140 2141 2142 2143 2144 2145 2146 2147 2148
    newelem->shared = old->shared;
    newelem->readonly = old->readonly;

    ret = 0;

 cleanup:
    return ret;
}


2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161
void
virStorageSourcePoolDefFree(virStorageSourcePoolDefPtr def)
{
    if (!def)
        return;

    VIR_FREE(def->pool);
    VIR_FREE(def->volume);

    VIR_FREE(def);
}


2162
int
2163
virStorageSourceGetActualType(const virStorageSource *def)
2164 2165 2166 2167 2168 2169 2170 2171
{
    if (def->type == VIR_STORAGE_TYPE_VOLUME && def->srcpool)
        return def->srcpool->actualtype;

    return def->type;
}


2172
bool
2173
virStorageSourceIsLocalStorage(const virStorageSource *src)
2174
{
2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190
    virStorageType type = virStorageSourceGetActualType(src);

    switch (type) {
    case VIR_STORAGE_TYPE_FILE:
    case VIR_STORAGE_TYPE_BLOCK:
    case VIR_STORAGE_TYPE_DIR:
        return true;

    case VIR_STORAGE_TYPE_NETWORK:
    case VIR_STORAGE_TYPE_VOLUME:
    case VIR_STORAGE_TYPE_LAST:
    case VIR_STORAGE_TYPE_NONE:
        return false;
    }

    return false;
2191 2192 2193
}


2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210
/**
 * virStorageSourceIsEmpty:
 *
 * @src: disk source to check
 *
 * Returns true if the guest disk has no associated host storage source
 * (such as an empty cdrom drive).
 */
bool
virStorageSourceIsEmpty(virStorageSourcePtr src)
{
    if (virStorageSourceIsLocalStorage(src) && !src->path)
        return true;

    if (src->type == VIR_STORAGE_TYPE_NONE)
        return true;

2211 2212 2213 2214
    if (src->type == VIR_STORAGE_TYPE_NETWORK &&
        src->protocol == VIR_STORAGE_NET_PROTOCOL_NONE)
        return true;

2215 2216 2217 2218
    return false;
}


2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232
/**
 * virStorageSourceIsBlockLocal:
 * @src: disk source definition
 *
 * Returns true if @src describes a locally accessible block storage source.
 * This includes block devices and host-mapped iSCSI volumes.
 */
bool
virStorageSourceIsBlockLocal(const virStorageSource *src)
{
    return virStorageSourceGetActualType(src) == VIR_STORAGE_TYPE_BLOCK;
}


2233
/**
2234
 * virStorageSourceBackingStoreClear:
2235 2236 2237 2238 2239 2240
 *
 * @src: disk source to clear
 *
 * Clears information about backing store of the current storage file.
 */
void
2241
virStorageSourceBackingStoreClear(virStorageSourcePtr def)
2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254
{
    if (!def)
        return;

    VIR_FREE(def->relPath);
    VIR_FREE(def->backingStoreRaw);

    /* recursively free backing chain */
    virStorageSourceFree(def->backingStore);
    def->backingStore = NULL;
}


2255 2256 2257 2258 2259 2260 2261
void
virStorageSourceClear(virStorageSourcePtr def)
{
    if (!def)
        return;

    VIR_FREE(def->path);
2262
    VIR_FREE(def->volume);
2263 2264
    VIR_FREE(def->snapshot);
    VIR_FREE(def->configFile);
2265 2266
    virStorageSourcePoolDefFree(def->srcpool);
    VIR_FREE(def->driverName);
E
Eric Blake 已提交
2267 2268
    virBitmapFree(def->features);
    VIR_FREE(def->compat);
2269
    virStorageEncryptionFree(def->encryption);
2270
    virStorageSourceSeclabelsClear(def);
2271
    virStoragePermsFree(def->perms);
E
Eric Blake 已提交
2272
    VIR_FREE(def->timestamps);
2273 2274

    virStorageNetHostDefFree(def->nhosts, def->hosts);
2275
    virStorageAuthDefFree(def->auth);
2276

2277 2278 2279
    VIR_FREE(def->nodebacking);
    VIR_FREE(def->nodeformat);

2280
    virStorageSourceBackingStoreClear(def);
2281 2282

    memset(def, 0, sizeof(*def));
2283
}
2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294


void
virStorageSourceFree(virStorageSourcePtr def)
{
    if (!def)
        return;

    virStorageSourceClear(def);
    VIR_FREE(def);
}
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306


static virStorageSourcePtr
virStorageSourceNewFromBackingRelative(virStorageSourcePtr parent,
                                       const char *rel)
{
    char *dirname = NULL;
    virStorageSourcePtr ret;

    if (VIR_ALLOC(ret) < 0)
        return NULL;

2307 2308 2309 2310
    /* store relative name */
    if (VIR_STRDUP(ret->relPath, parent->backingStoreRaw) < 0)
        goto error;

2311 2312
    if (!(dirname = mdir_name(parent->path))) {
        virReportOOMError();
2313
        goto error;
2314
    }
2315

2316 2317
    if (STRNEQ(dirname, "/")) {
        if (virAsprintf(&ret->path, "%s/%s", dirname, rel) < 0)
2318 2319
            goto error;
    } else {
2320 2321 2322 2323 2324
        if (virAsprintf(&ret->path, "/%s", rel) < 0)
            goto error;
    }

    if (virStorageSourceGetActualType(parent) == VIR_STORAGE_TYPE_NETWORK) {
2325 2326 2327 2328
        ret->type = VIR_STORAGE_TYPE_NETWORK;

        /* copy the host network part */
        ret->protocol = parent->protocol;
2329 2330 2331 2332 2333 2334 2335
        if (parent->nhosts) {
            if (!(ret->hosts = virStorageNetHostDefCopy(parent->nhosts,
                                                        parent->hosts)))
                goto error;

            ret->nhosts = parent->nhosts;
        }
2336 2337 2338

        if (VIR_STRDUP(ret->volume, parent->volume) < 0)
            goto error;
2339 2340 2341
    } else {
        /* set the type to _FILE, the caller shall update it to the actual type */
        ret->type = VIR_STORAGE_TYPE_FILE;
2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369
    }

 cleanup:
    VIR_FREE(dirname);
    return ret;

 error:
    virStorageSourceFree(ret);
    ret = NULL;
    goto cleanup;
}


static int
virStorageSourceParseBackingURI(virStorageSourcePtr src,
                                const char *path)
{
    virURIPtr uri = NULL;
    char **scheme = NULL;
    int ret = -1;

    if (!(uri = virURIParse(path))) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("failed to parse backing file location '%s'"),
                       path);
        goto cleanup;
    }

2370 2371 2372 2373 2374
    if (VIR_ALLOC(src->hosts) < 0)
        goto cleanup;

    src->nhosts = 1;

2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402
    if (!(scheme = virStringSplit(uri->scheme, "+", 2)))
        goto cleanup;

    if (!scheme[0] ||
        (src->protocol = virStorageNetProtocolTypeFromString(scheme[0])) < 0) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("invalid backing protocol '%s'"),
                       NULLSTR(scheme[0]));
        goto cleanup;
    }

    if (scheme[1] &&
        (src->hosts->transport = virStorageNetHostTransportTypeFromString(scheme[1])) < 0) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("invalid protocol transport type '%s'"),
                       scheme[1]);
        goto cleanup;
    }

    /* handle socket stored as a query */
    if (uri->query) {
        if (VIR_STRDUP(src->hosts->socket, STRSKIP(uri->query, "socket=")) < 0)
            goto cleanup;
    }

    /* XXX We currently don't support auth, so don't bother parsing it */

    /* possibly skip the leading slash */
2403 2404
    if (uri->path &&
        VIR_STRDUP(src->path,
2405 2406 2407 2408 2409
                   *uri->path == '/' ? uri->path + 1 : uri->path) < 0)
        goto cleanup;

    if (src->protocol == VIR_STORAGE_NET_PROTOCOL_GLUSTER) {
        char *tmp;
2410 2411 2412 2413 2414 2415 2416

        if (!src->path) {
            virReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s",
                           _("missing volume name and path for gluster volume"));
            goto cleanup;
        }

2417 2418
        if (!(tmp = strchr(src->path, '/')) ||
            tmp == src->path) {
2419
            virReportError(VIR_ERR_CONFIG_UNSUPPORTED,
2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444
                           _("missing volume name or file name in "
                             "gluster source path '%s'"), src->path);
            goto cleanup;
        }

        src->volume = src->path;

        if (VIR_STRDUP(src->path, tmp) < 0)
            goto cleanup;

        tmp[0] = '\0';
    }

    if (uri->port > 0) {
        if (virAsprintf(&src->hosts->port, "%d", uri->port) < 0)
            goto cleanup;
    }

    if (VIR_STRDUP(src->hosts->name, uri->server) < 0)
        goto cleanup;

    ret = 0;

 cleanup:
    virURIFree(uri);
2445
    virStringListFree(scheme);
2446 2447 2448 2449
    return ret;
}


2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479
static int
virStorageSourceRBDAddHost(virStorageSourcePtr src,
                           char *hostport)
{
    char *port;
    size_t skip;
    char **parts;

    if (VIR_EXPAND_N(src->hosts, src->nhosts, 1) < 0)
        return -1;

    if ((port = strchr(hostport, ']'))) {
        /* ipv6, strip brackets */
        hostport += 1;
        skip = 3;
    } else {
        port = strstr(hostport, "\\:");
        skip = 2;
    }

    if (port) {
        *port = '\0';
        port += skip;
        if (VIR_STRDUP(src->hosts[src->nhosts - 1].port, port) < 0)
            goto error;
    }

    parts = virStringSplit(hostport, "\\:", 0);
    if (!parts)
        goto error;
2480 2481
    src->hosts[src->nhosts-1].name = virStringListJoin((const char **)parts, ":");
    virStringListFree(parts);
2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518
    if (!src->hosts[src->nhosts-1].name)
        goto error;

    src->hosts[src->nhosts-1].transport = VIR_STORAGE_NET_HOST_TRANS_TCP;
    src->hosts[src->nhosts-1].socket = NULL;

    return 0;

 error:
    VIR_FREE(src->hosts[src->nhosts-1].port);
    VIR_FREE(src->hosts[src->nhosts-1].name);
    return -1;
}


int
virStorageSourceParseRBDColonString(const char *rbdstr,
                                    virStorageSourcePtr src)
{
    char *options = NULL;
    char *p, *e, *next;
    virStorageAuthDefPtr authdef = NULL;

    /* optionally skip the "rbd:" prefix if provided */
    if (STRPREFIX(rbdstr, "rbd:"))
        rbdstr += strlen("rbd:");

    if (VIR_STRDUP(src->path, rbdstr) < 0)
        goto error;

    p = strchr(src->path, ':');
    if (p) {
        if (VIR_STRDUP(options, p + 1) < 0)
            goto error;
        *p = '\0';
    }

2519 2520 2521 2522 2523 2524 2525
    /* snapshot name */
    if ((p = strchr(src->path, '@'))) {
        if (VIR_STRDUP(src->snapshot, p + 1) < 0)
            goto error;
        *p = '\0';
    }

2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586
    /* options */
    if (!options)
        return 0; /* all done */

    p = options;
    while (*p) {
        /* find : delimiter or end of string */
        for (e = p; *e && *e != ':'; ++e) {
            if (*e == '\\') {
                e++;
                if (*e == '\0')
                    break;
            }
        }
        if (*e == '\0') {
            next = e;    /* last kv pair */
        } else {
            next = e + 1;
            *e = '\0';
        }

        if (STRPREFIX(p, "id=")) {
            /* formulate authdef for src->auth */
            if (VIR_ALLOC(authdef) < 0)
                goto error;

            if (VIR_STRDUP(authdef->username, p + strlen("id=")) < 0)
                goto error;

            if (VIR_STRDUP(authdef->secrettype,
                           virStorageAuthTypeToString(VIR_STORAGE_AUTH_TYPE_CEPHX)) < 0)
                goto error;
            src->auth = authdef;
            authdef = NULL;

            /* Cannot formulate a secretType (eg, usage or uuid) given
             * what is provided.
             */
        }
        if (STRPREFIX(p, "mon_host=")) {
            char *h, *sep;

            h = p + strlen("mon_host=");
            while (h < e) {
                for (sep = h; sep < e; ++sep) {
                    if (*sep == '\\' && (sep[1] == ',' ||
                                         sep[1] == ';' ||
                                         sep[1] == ' ')) {
                        *sep = '\0';
                        sep += 2;
                        break;
                    }
                }

                if (virStorageSourceRBDAddHost(src, h) < 0)
                    goto error;

                h = sep;
            }
        }

2587 2588 2589 2590
        if (STRPREFIX(p, "conf=") &&
            VIR_STRDUP(src->configFile, p + strlen("conf=")) < 0)
            goto error;

2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602
        p = next;
    }
    VIR_FREE(options);
    return 0;

 error:
    VIR_FREE(options);
    virStorageAuthDefFree(authdef);
    return -1;
}


2603
static int
2604 2605
virStorageSourceParseNBDColonString(const char *nbdstr,
                                    virStorageSourcePtr src)
2606 2607 2608 2609
{
    char **backing = NULL;
    int ret = -1;

2610 2611 2612 2613 2614 2615
    if (!(backing = virStringSplit(nbdstr, ":", 0)))
        goto cleanup;

    /* we know that backing[0] now equals to "nbd" */

    if (VIR_ALLOC_N(src->hosts, 1) < 0)
2616 2617
        goto cleanup;

2618 2619 2620 2621 2622 2623 2624 2625
    src->nhosts = 1;
    src->hosts->transport = VIR_STORAGE_NET_HOST_TRANS_TCP;

    /* format: [] denotes optional sections, uppercase are variable strings
     * nbd:unix:/PATH/TO/SOCKET[:exportname=EXPORTNAME]
     * nbd:HOSTNAME:PORT[:exportname=EXPORTNAME]
     */
    if (!backing[1]) {
2626
        virReportError(VIR_ERR_INTERNAL_ERROR,
2627 2628
                       _("missing remote information in '%s' for protocol nbd"),
                       nbdstr);
2629
        goto cleanup;
2630 2631 2632 2633 2634 2635 2636
    } else if (STREQ(backing[1], "unix")) {
        if (!backing[2]) {
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("missing unix socket path in nbd backing string %s"),
                           nbdstr);
            goto cleanup;
        }
2637

2638
        if (VIR_STRDUP(src->hosts->socket, backing[2]) < 0)
2639 2640
            goto cleanup;

2641 2642 2643
   } else {
        if (VIR_STRDUP(src->hosts->name, backing[1]) < 0)
            goto cleanup;
2644

2645 2646 2647 2648 2649 2650
        if (!backing[2]) {
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("missing port in nbd string '%s'"),
                           nbdstr);
            goto cleanup;
        }
2651

2652 2653 2654
        if (VIR_STRDUP(src->hosts->port, backing[2]) < 0)
            goto cleanup;
    }
2655

2656 2657 2658 2659
    if (backing[3] && STRPREFIX(backing[3], "exportname=")) {
        if (VIR_STRDUP(src->path, backing[3] + strlen("exportname=")) < 0)
            goto cleanup;
    }
2660

2661
    ret = 0;
2662

2663
 cleanup:
2664
    virStringListFree(backing);
2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699

    return ret;
}


static int
virStorageSourceParseBackingColon(virStorageSourcePtr src,
                                  const char *path)
{
    char *protocol = NULL;
    const char *p;
    int ret = -1;

    if (!(p = strchr(path, ':'))) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("invalid backing protocol string '%s'"),
                       path);
        goto cleanup;
    }

    if (VIR_STRNDUP(protocol, path, p - path) < 0)
        goto cleanup;

    if ((src->protocol = virStorageNetProtocolTypeFromString(protocol)) < 0) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("invalid backing protocol '%s'"),
                       protocol);
        goto cleanup;
    }

    switch ((virStorageNetProtocol) src->protocol) {
    case VIR_STORAGE_NET_PROTOCOL_NBD:
        if (virStorageSourceParseNBDColonString(path, src) < 0)
            goto cleanup;
        break;
2700 2701

    case VIR_STORAGE_NET_PROTOCOL_RBD:
2702 2703 2704 2705 2706
        if (virStorageSourceParseRBDColonString(path, src) < 0)
            goto cleanup;
        break;

    case VIR_STORAGE_NET_PROTOCOL_SHEEPDOG:
2707 2708 2709 2710
    case VIR_STORAGE_NET_PROTOCOL_LAST:
    case VIR_STORAGE_NET_PROTOCOL_NONE:
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("backing store parser is not implemented for protocol %s"),
2711
                       protocol);
2712 2713 2714 2715 2716 2717 2718 2719 2720
        goto cleanup;

    case VIR_STORAGE_NET_PROTOCOL_HTTP:
    case VIR_STORAGE_NET_PROTOCOL_HTTPS:
    case VIR_STORAGE_NET_PROTOCOL_FTP:
    case VIR_STORAGE_NET_PROTOCOL_FTPS:
    case VIR_STORAGE_NET_PROTOCOL_TFTP:
    case VIR_STORAGE_NET_PROTOCOL_ISCSI:
    case VIR_STORAGE_NET_PROTOCOL_GLUSTER:
2721
    case VIR_STORAGE_NET_PROTOCOL_SSH:
2722 2723
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("malformed backing store path for protocol %s"),
2724
                       protocol);
2725 2726 2727 2728 2729 2730
        goto cleanup;
    }

    ret = 0;

 cleanup:
2731
    VIR_FREE(protocol);
2732 2733 2734 2735
    return ret;
}


2736 2737 2738 2739 2740
static int
virStorageSourceParseBackingJSONInternal(virStorageSourcePtr src,
                                         virJSONValuePtr json);


2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762
static int
virStorageSourceParseBackingJSONPath(virStorageSourcePtr src,
                                     virJSONValuePtr json,
                                     int type)
{
    const char *path;

    if (!(path = virJSONValueObjectGetString(json, "filename"))) {
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing 'filename' field in JSON backing volume "
                         "definition"));
        return -1;
    }

    if (VIR_STRDUP(src->path, path) < 0)
        return -1;

    src->type = type;
    return 0;
}


2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790
static int
virStorageSourceParseBackingJSONUriStr(virStorageSourcePtr src,
                                       const char *uri,
                                       int protocol)
{
    if (virStorageSourceParseBackingURI(src, uri) < 0)
        return -1;

    if (src->protocol != protocol) {
        virReportError(VIR_ERR_INVALID_ARG,
                       _("expected protocol '%s' but got '%s' in URI JSON volume "
                         "definition"),
                       virStorageNetProtocolTypeToString(protocol),
                       virStorageNetProtocolTypeToString(src->protocol));
        return -1;
    }

    return 0;
}


static int
virStorageSourceParseBackingJSONUri(virStorageSourcePtr src,
                                    virJSONValuePtr json,
                                    int protocol)
{
    const char *uri;

2791
    if (!(uri = virJSONValueObjectGetString(json, "url"))) {
2792
        virReportError(VIR_ERR_INVALID_ARG, "%s",
2793
                       _("missing 'url' in JSON backing volume definition"));
2794 2795 2796 2797 2798 2799 2800
        return -1;
    }

    return virStorageSourceParseBackingJSONUriStr(src, uri, protocol);
}


2801 2802 2803 2804
static int
virStorageSourceParseBackingJSONInetSocketAddress(virStorageNetHostDefPtr host,
                                                  virJSONValuePtr json)
{
2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816
    const char *hostname;
    const char *port;

    if (!json) {
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing remote server specification in JSON "
                         "backing volume definition"));
        return -1;
    }

    hostname = virJSONValueObjectGetString(json, "host");
    port = virJSONValueObjectGetString(json, "port");
2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834

    if (!hostname) {
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing hostname for tcp backing server in "
                         "JSON backing volume definition"));
        return -1;
    }

    host->transport = VIR_STORAGE_NET_HOST_TRANS_TCP;

    if (VIR_STRDUP(host->name, hostname) < 0 ||
        VIR_STRDUP(host->port, port) < 0)
        return -1;

    return 0;
}


2835
static int
2836 2837
virStorageSourceParseBackingJSONSocketAddress(virStorageNetHostDefPtr host,
                                              virJSONValuePtr json)
2838
{
2839 2840 2841 2842 2843 2844 2845 2846 2847
    const char *type;
    const char *socket;

    if (!json) {
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing remote server specification in JSON "
                         "backing volume definition"));
        return -1;
    }
2848

2849
    if (!(type = virJSONValueObjectGetString(json, "type"))) {
2850 2851 2852
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing socket address type in "
                         "JSON backing volume definition"));
2853 2854 2855
        return -1;
    }

2856
    if (STREQ(type, "tcp") || STREQ(type, "inet")) {
2857
        return virStorageSourceParseBackingJSONInetSocketAddress(host, json);
2858

2859 2860
    } else if (STREQ(type, "unix")) {
        host->transport = VIR_STORAGE_NET_HOST_TRANS_UNIX;
2861

2862
        if (!(socket = virJSONValueObjectGetString(json, "socket"))) {
2863 2864
            virReportError(VIR_ERR_INVALID_ARG, "%s",
                           _("missing socket path for udp backing server in "
2865
                             "JSON backing volume definition"));
2866 2867 2868 2869 2870
            return -1;
        }

        if (VIR_STRDUP(host->socket, socket) < 0)
            return -1;
2871
    } else {
2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("backing store protocol '%s' is not yet supported"),
                       type);
        return -1;
    }

    return 0;
}


static int
virStorageSourceParseBackingJSONGluster(virStorageSourcePtr src,
                                        virJSONValuePtr json,
                                        int opaque ATTRIBUTE_UNUSED)
{
    const char *uri = virJSONValueObjectGetString(json, "filename");
    const char *volume = virJSONValueObjectGetString(json, "volume");
    const char *path = virJSONValueObjectGetString(json, "path");
    virJSONValuePtr server = virJSONValueObjectGetArray(json, "server");
    size_t nservers;
    size_t i;

    /* legacy URI based syntax passed via 'filename' option */
    if (uri)
        return virStorageSourceParseBackingJSONUriStr(src, uri,
                                                      VIR_STORAGE_NET_PROTOCOL_GLUSTER);

    if (!volume || !path || !server) {
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing 'volume', 'path' or 'server' attribute in "
                         "JSON backing definition for gluster volume"));
        return -1;
    }

2906 2907 2908
    src->type = VIR_STORAGE_TYPE_NETWORK;
    src->protocol = VIR_STORAGE_NET_PROTOCOL_GLUSTER;

2909 2910 2911 2912 2913 2914 2915 2916 2917 2918
    if (VIR_STRDUP(src->volume, volume) < 0 ||
        virAsprintf(&src->path, "/%s", path) < 0)
        return -1;

    nservers = virJSONValueArraySize(server);

    if (nservers < 1) {
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("at least 1 server is necessary in "
                         "JSON backing definition for gluster volume"));
2919 2920

        return -1;
2921 2922 2923 2924 2925 2926 2927
    }

    if (VIR_ALLOC_N(src->hosts, nservers) < 0)
        return -1;
    src->nhosts = nservers;

    for (i = 0; i < nservers; i++) {
2928 2929
        if (virStorageSourceParseBackingJSONSocketAddress(src->hosts + i,
                                                          virJSONValueArrayGet(server, i)) < 0)
2930 2931 2932 2933 2934 2935 2936
            return -1;
    }

    return 0;
}


2937 2938 2939 2940 2941
static int
virStorageSourceParseBackingJSONiSCSI(virStorageSourcePtr src,
                                      virJSONValuePtr json,
                                      int opaque ATTRIBUTE_UNUSED)
{
2942 2943 2944
    const char *transport = virJSONValueObjectGetString(json, "transport");
    const char *portal = virJSONValueObjectGetString(json, "portal");
    const char *target = virJSONValueObjectGetString(json, "target");
2945
    const char *uri;
2946 2947 2948 2949
    char *port;
    unsigned int lun = 0;
    char *fulltarget = NULL;
    int ret = -1;
2950 2951 2952 2953 2954 2955

    /* legacy URI based syntax passed via 'filename' option */
    if ((uri = virJSONValueObjectGetString(json, "filename")))
        return virStorageSourceParseBackingJSONUriStr(src, uri,
                                                      VIR_STORAGE_NET_PROTOCOL_ISCSI);

2956 2957
    src->type = VIR_STORAGE_TYPE_NETWORK;
    src->protocol = VIR_STORAGE_NET_PROTOCOL_ISCSI;
2958

2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008
    if (VIR_ALLOC(src->hosts) < 0)
        goto cleanup;

    src->nhosts = 1;

    if (STRNEQ_NULLABLE(transport, "tcp")) {
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("only TCP transport is supported for iSCSI volumes"));
        goto cleanup;
    }

    src->hosts->transport = VIR_STORAGE_NET_HOST_TRANS_TCP;

    if (!portal) {
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing 'portal' address in iSCSI backing definition"));
        goto cleanup;
    }

    if (!target) {
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing 'target' in iSCSI backing definition"));
        goto cleanup;
    }

    if (VIR_STRDUP(src->hosts->name, portal) < 0)
        goto cleanup;

    if ((port = strchr(src->hosts->name, ':'))) {
        if (VIR_STRDUP(src->hosts->port, port + 1) < 0)
            goto cleanup;

        if (strlen(src->hosts->port) == 0)
            VIR_FREE(src->hosts->port);

        *port = '\0';
    }

    ignore_value(virJSONValueObjectGetNumberUint(json, "lun", &lun));

    if (virAsprintf(&fulltarget, "%s/%u", target, lun) < 0)
        goto cleanup;

    VIR_STEAL_PTR(src->path, fulltarget);

    ret = 0;

 cleanup:
    VIR_FREE(fulltarget);
    return ret;
3009 3010 3011
}


3012 3013 3014 3015 3016 3017 3018 3019 3020
static int
virStorageSourceParseBackingJSONNbd(virStorageSourcePtr src,
                                    virJSONValuePtr json,
                                    int opaque ATTRIBUTE_UNUSED)
{
    const char *path = virJSONValueObjectGetString(json, "path");
    const char *host = virJSONValueObjectGetString(json, "host");
    const char *port = virJSONValueObjectGetString(json, "port");
    const char *export = virJSONValueObjectGetString(json, "export");
3021
    virJSONValuePtr server = virJSONValueObjectGetObject(json, "server");
3022

3023
    if (!path && !host && !server) {
3024
        virReportError(VIR_ERR_INVALID_ARG, "%s",
3025 3026
                       _("missing host specification of NBD server in JSON "
                         "backing volume definition"));
3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039
        return -1;
    }

    src->type = VIR_STORAGE_TYPE_NETWORK;
    src->protocol = VIR_STORAGE_NET_PROTOCOL_NBD;

    if (VIR_STRDUP(src->path, export) < 0)
        return -1;

    if (VIR_ALLOC_N(src->hosts, 1) < 0)
        return -1;
    src->nhosts = 1;

3040 3041
    if (server) {
        if (virStorageSourceParseBackingJSONSocketAddress(src->hosts, server) < 0)
3042 3043
            return -1;
    } else {
3044 3045 3046 3047 3048 3049 3050 3051
        if (path) {
            src->hosts[0].transport = VIR_STORAGE_NET_HOST_TRANS_UNIX;
            if (VIR_STRDUP(src->hosts[0].socket, path) < 0)
                return -1;
        } else {
            src->hosts[0].transport = VIR_STORAGE_NET_HOST_TRANS_TCP;
            if (VIR_STRDUP(src->hosts[0].name, host) < 0)
                return -1;
3052

3053 3054 3055
            if (VIR_STRDUP(src->hosts[0].port, port) < 0)
                return -1;
        }
3056 3057 3058 3059 3060 3061
    }

    return 0;
}


3062 3063 3064 3065 3066 3067
static int
virStorageSourceParseBackingJSONSheepdog(virStorageSourcePtr src,
                                         virJSONValuePtr json,
                                         int opaque ATTRIBUTE_UNUSED)
{
    const char *filename;
3068 3069
    const char *vdi = virJSONValueObjectGetString(json, "vdi");
    virJSONValuePtr server = virJSONValueObjectGetObject(json, "server");
3070 3071 3072 3073 3074 3075 3076 3077

    /* legacy URI based syntax passed via 'filename' option */
    if ((filename = virJSONValueObjectGetString(json, "filename"))) {
        if (strstr(filename, "://"))
            return virStorageSourceParseBackingJSONUriStr(src, filename,
                                                          VIR_STORAGE_NET_PROTOCOL_SHEEPDOG);

        /* libvirt doesn't implement a parser for the legacy non-URI syntax */
3078 3079 3080
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing sheepdog URI in JSON backing volume definition"));
        return -1;
3081 3082
    }

3083 3084
    src->type = VIR_STORAGE_TYPE_NETWORK;
    src->protocol = VIR_STORAGE_NET_PROTOCOL_SHEEPDOG;
3085

3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102
    if (!vdi) {
        virReportError(VIR_ERR_INVALID_ARG, "%s", _("missing sheepdog vdi name"));
        return -1;
    }

    if (VIR_STRDUP(src->path, vdi) < 0)
        return -1;

    if (VIR_ALLOC(src->hosts) < 0)
        return -1;

    src->nhosts = 1;

    if (virStorageSourceParseBackingJSONSocketAddress(src->hosts, server) < 0)
        return -1;

    return 0;
3103 3104 3105
}


3106 3107 3108 3109 3110 3111 3112 3113
static int
virStorageSourceParseBackingJSONSSH(virStorageSourcePtr src,
                                    virJSONValuePtr json,
                                    int opaque ATTRIBUTE_UNUSED)
{
    const char *path = virJSONValueObjectGetString(json, "path");
    const char *host = virJSONValueObjectGetString(json, "host");
    const char *port = virJSONValueObjectGetString(json, "port");
3114
    virJSONValuePtr server = virJSONValueObjectGetObject(json, "server");
3115

3116
    if (!(host || server) || !path) {
3117
        virReportError(VIR_ERR_INVALID_ARG, "%s",
3118
                       _("missing host/server or path of SSH JSON backing "
3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132
                         "volume definition"));
        return -1;
    }

    src->type = VIR_STORAGE_TYPE_NETWORK;
    src->protocol = VIR_STORAGE_NET_PROTOCOL_SSH;

    if (VIR_STRDUP(src->path, path) < 0)
        return -1;

    if (VIR_ALLOC_N(src->hosts, 1) < 0)
        return -1;
    src->nhosts = 1;

3133 3134 3135 3136 3137 3138 3139 3140 3141 3142
    if (server) {
        if (virStorageSourceParseBackingJSONInetSocketAddress(src->hosts,
                                                              server) < 0)
            return -1;
    } else {
        src->hosts[0].transport = VIR_STORAGE_NET_HOST_TRANS_TCP;
        if (VIR_STRDUP(src->hosts[0].name, host) < 0 ||
            VIR_STRDUP(src->hosts[0].port, port) < 0)
            return -1;
    }
3143 3144 3145 3146 3147

    return 0;
}


3148 3149 3150 3151 3152 3153
static int
virStorageSourceParseBackingJSONRBD(virStorageSourcePtr src,
                                    virJSONValuePtr json,
                                    int opaque ATTRIBUTE_UNUSED)
{
    const char *filename;
3154 3155 3156 3157 3158 3159 3160 3161 3162
    const char *pool = virJSONValueObjectGetString(json, "pool");
    const char *image = virJSONValueObjectGetString(json, "image");
    const char *conf = virJSONValueObjectGetString(json, "conf");
    const char *snapshot = virJSONValueObjectGetString(json, "snapshot");
    virJSONValuePtr servers = virJSONValueObjectGetArray(json, "server");
    char *fullname = NULL;
    size_t nservers;
    size_t i;
    int ret = -1;
3163 3164 3165 3166 3167 3168 3169 3170

    src->type = VIR_STORAGE_TYPE_NETWORK;
    src->protocol = VIR_STORAGE_NET_PROTOCOL_RBD;

    /* legacy syntax passed via 'filename' option */
    if ((filename = virJSONValueObjectGetString(json, "filename")))
        return virStorageSourceParseRBDColonString(filename, src);

3171 3172 3173 3174 3175 3176
    if (!pool || !image) {
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing pool or image name in ceph backing volume "
                         "JSON specification"));
        return -1;
    }
3177

3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208
    /* currently we need to store the pool name and image name together, since
     * the rest of the code is not prepared for it */
    if (virAsprintf(&fullname, "%s/%s", pool, image) < 0)
        return -1;

    if (VIR_STRDUP(src->snapshot, snapshot) < 0 ||
        VIR_STRDUP(src->configFile, conf) < 0)
        goto cleanup;

    VIR_STEAL_PTR(src->path, fullname);

    if (servers) {
        nservers = virJSONValueArraySize(servers);

        if (VIR_ALLOC_N(src->hosts, nservers) < 0)
            goto cleanup;

        src->nhosts = nservers;

        for (i = 0; i < nservers; i++) {
            if (virStorageSourceParseBackingJSONInetSocketAddress(src->hosts + i,
                                                                  virJSONValueArrayGet(servers, i)) < 0)
                goto cleanup;
        }
    }

    ret = 0;
 cleanup:
    VIR_FREE(fullname);

    return ret;
3209 3210
}

3211 3212 3213 3214 3215 3216 3217 3218 3219 3220
static int
virStorageSourceParseBackingJSONRaw(virStorageSourcePtr src,
                                    virJSONValuePtr json,
                                    int opaque ATTRIBUTE_UNUSED)
{
    /* There are no interesting attributes in raw driver.
     * Treat it as pass-through.
     */
    return virStorageSourceParseBackingJSONInternal(src, json);
}
3221

3222 3223 3224 3225 3226 3227 3228 3229
struct virStorageSourceJSONDriverParser {
    const char *drvname;
    int (*func)(virStorageSourcePtr src, virJSONValuePtr json, int opaque);
    int opaque;
};

static const struct virStorageSourceJSONDriverParser jsonParsers[] = {
    {"file", virStorageSourceParseBackingJSONPath, VIR_STORAGE_TYPE_FILE},
3230 3231
    {"host_device", virStorageSourceParseBackingJSONPath, VIR_STORAGE_TYPE_BLOCK},
    {"host_cdrom", virStorageSourceParseBackingJSONPath, VIR_STORAGE_TYPE_BLOCK},
3232 3233 3234 3235 3236
    {"http", virStorageSourceParseBackingJSONUri, VIR_STORAGE_NET_PROTOCOL_HTTP},
    {"https", virStorageSourceParseBackingJSONUri, VIR_STORAGE_NET_PROTOCOL_HTTPS},
    {"ftp", virStorageSourceParseBackingJSONUri, VIR_STORAGE_NET_PROTOCOL_FTP},
    {"ftps", virStorageSourceParseBackingJSONUri, VIR_STORAGE_NET_PROTOCOL_FTPS},
    {"tftp", virStorageSourceParseBackingJSONUri, VIR_STORAGE_NET_PROTOCOL_TFTP},
3237
    {"gluster", virStorageSourceParseBackingJSONGluster, 0},
3238
    {"iscsi", virStorageSourceParseBackingJSONiSCSI, 0},
3239
    {"nbd", virStorageSourceParseBackingJSONNbd, 0},
3240
    {"sheepdog", virStorageSourceParseBackingJSONSheepdog, 0},
3241
    {"ssh", virStorageSourceParseBackingJSONSSH, 0},
3242
    {"rbd", virStorageSourceParseBackingJSONRBD, 0},
3243
    {"raw", virStorageSourceParseBackingJSONRaw, 0},
3244 3245 3246 3247 3248
};



static int
3249 3250
virStorageSourceParseBackingJSONInternal(virStorageSourcePtr src,
                                         virJSONValuePtr json)
3251 3252 3253 3254
{
    virJSONValuePtr fixedroot = NULL;
    virJSONValuePtr file;
    const char *drvname;
3255
    char *str = NULL;
3256 3257 3258
    size_t i;
    int ret = -1;

3259
    if (!(file = virJSONValueObjectGetObject(json, "file"))) {
3260
        if (!(fixedroot = virJSONValueObjectDeflatten(json)))
3261 3262
            goto cleanup;

3263 3264 3265 3266 3267 3268 3269
        if (!(file = virJSONValueObjectGetObject(fixedroot, "file"))) {
            str = virJSONValueToString(json, false);
            virReportError(VIR_ERR_INVALID_ARG,
                           _("JSON backing volume defintion '%s' lacks 'file' object"),
                           NULLSTR(str));
            goto cleanup;
        }
3270 3271 3272
    }

    if (!(drvname = virJSONValueObjectGetString(file, "driver"))) {
3273 3274 3275 3276
        str = virJSONValueToString(json, false);
        virReportError(VIR_ERR_INVALID_ARG,
                       _("JSON backing volume defintion '%s' lacks driver name"),
                       NULLSTR(str));
3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291
        goto cleanup;
    }

    for (i = 0; i < ARRAY_CARDINALITY(jsonParsers); i++) {
        if (STREQ(drvname, jsonParsers[i].drvname)) {
            ret = jsonParsers[i].func(src, file, jsonParsers[i].opaque);
            goto cleanup;
        }
    }

    virReportError(VIR_ERR_INTERNAL_ERROR,
                   _("missing parser implementation for JSON backing volume "
                     "driver '%s'"), drvname);

 cleanup:
3292
    VIR_FREE(str);
3293 3294 3295 3296 3297
    virJSONValueFree(fixedroot);
    return ret;
}


3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314
static int
virStorageSourceParseBackingJSON(virStorageSourcePtr src,
                                 const char *json)
{
    virJSONValuePtr root = NULL;
    int ret = -1;

    if (!(root = virJSONValueFromString(json)))
        return -1;

    ret = virStorageSourceParseBackingJSONInternal(src, root);

    virJSONValueFree(root);
    return ret;
}


3315
virStorageSourcePtr
3316 3317
virStorageSourceNewFromBackingAbsolute(const char *path)
{
3318
    const char *json;
3319
    virStorageSourcePtr ret;
3320
    int rc;
3321 3322 3323 3324 3325 3326 3327

    if (VIR_ALLOC(ret) < 0)
        return NULL;

    if (virStorageIsFile(path)) {
        ret->type = VIR_STORAGE_TYPE_FILE;

3328 3329
        if (VIR_STRDUP(ret->path, path) < 0)
            goto error;
3330 3331 3332
    } else {
        ret->type = VIR_STORAGE_TYPE_NETWORK;

3333 3334
        VIR_DEBUG("parsing backing store string: '%s'", path);

3335
        /* handle URI formatted backing stores */
3336 3337 3338 3339 3340 3341 3342 3343 3344
        if ((json = STRSKIP(path, "json:")))
            rc = virStorageSourceParseBackingJSON(ret, json);
        else if (strstr(path, "://"))
            rc = virStorageSourceParseBackingURI(ret, path);
        else
            rc = virStorageSourceParseBackingColon(ret, path);

        if (rc < 0)
            goto error;
3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378
    }

    return ret;

 error:
    virStorageSourceFree(ret);
    return NULL;
}


virStorageSourcePtr
virStorageSourceNewFromBacking(virStorageSourcePtr parent)
{
    struct stat st;
    virStorageSourcePtr ret;

    if (virStorageIsRelative(parent->backingStoreRaw))
        ret = virStorageSourceNewFromBackingRelative(parent,
                                                     parent->backingStoreRaw);
    else
        ret = virStorageSourceNewFromBackingAbsolute(parent->backingStoreRaw);

    if (ret) {
        /* possibly update local type */
        if (ret->type == VIR_STORAGE_TYPE_FILE) {
            if (stat(ret->path, &st) == 0) {
                if (S_ISDIR(st.st_mode)) {
                    ret->type = VIR_STORAGE_TYPE_DIR;
                    ret->format = VIR_STORAGE_FILE_DIR;
                } else if (S_ISBLK(st.st_mode)) {
                    ret->type = VIR_STORAGE_TYPE_BLOCK;
                }
            }
        }
3379 3380

        /* copy parent's labelling and other top level stuff */
3381
        if (virStorageSourceInitChainElement(ret, parent, true) < 0)
3382
            goto error;
3383 3384 3385
    }

    return ret;
3386 3387 3388 3389

 error:
    virStorageSourceFree(ret);
    return NULL;
3390
}
3391 3392


3393
/**
3394 3395 3396
 * @src: disk source definition structure
 * @fd: file descriptor
 * @sb: stat buffer
3397
 *
3398 3399 3400 3401 3402
 * Updates src->physical depending on the actual type of storage being used.
 * To be called for domain storage source reporting as the volume code does
 * not set/use the 'type' field for the voldef->source.target
 *
 * Returns 0 on success, -1 on error.
3403 3404
 */
int
3405 3406 3407
virStorageSourceUpdatePhysicalSize(virStorageSourcePtr src,
                                   int fd,
                                   struct stat const *sb)
3408 3409
{
    off_t end;
3410
    virStorageType actual_type = virStorageSourceGetActualType(src);
3411

3412 3413 3414 3415 3416
    switch (actual_type) {
    case VIR_STORAGE_TYPE_FILE:
    case VIR_STORAGE_TYPE_NETWORK:
        src->physical = sb->st_size;
        break;
3417

3418 3419 3420
    case VIR_STORAGE_TYPE_BLOCK:
        if ((end = lseek(fd, 0, SEEK_END)) == (off_t) -1) {
            virReportSystemError(errno, _("failed to seek to end of '%s'"),
3421
                                 src->path);
3422 3423
            return -1;
        }
3424 3425

        src->physical = end;
3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441
        break;

    case VIR_STORAGE_TYPE_DIR:
        src->physical = 0;
        break;

    /* We shouldn't get VOLUME, but the switch requires all cases */
    case VIR_STORAGE_TYPE_VOLUME:
    case VIR_STORAGE_TYPE_NONE:
    case VIR_STORAGE_TYPE_LAST:
        virReportError(VIR_ERR_INTERNAL_ERROR,
                      _("cannot retrieve physical for path '%s' type '%s'"),
                      NULLSTR(src->path),
                      virStorageTypeToString(actual_type));
        return -1;
        break;
3442 3443
    }

3444
    return 0;
3445 3446 3447
}


3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512
/**
 * @src: disk source definition structure
 * @fd: file descriptor
 * @sb: stat buffer
 *
 * Update the capacity, allocation, physical values for the storage @src
 * Shared between the domain storage source for an inactive domain and the
 * voldef source target as the result is not affected by the 'type' field.
 *
 * Returns 0 on success, -1 on error.
 */
int
virStorageSourceUpdateBackingSizes(virStorageSourcePtr src,
                                   int fd,
                                   struct stat const *sb)
{
    /* Get info for normal formats */
    if (S_ISREG(sb->st_mode) || fd == -1) {
#ifndef WIN32
        src->allocation = (unsigned long long)sb->st_blocks *
            (unsigned long long)DEV_BSIZE;
#else
        src->allocation = sb->st_size;
#endif
        /* Regular files may be sparse, so logical size (capacity) is not same
         * as actual allocation above
         */
        src->capacity = sb->st_size;

        /* Allocation tracks when the file is sparse, physical is the
         * last offset of the file. */
        src->physical = sb->st_size;
    } else if (S_ISDIR(sb->st_mode)) {
        src->allocation = 0;
        src->capacity = 0;
        src->physical = 0;
    } else if (fd >= 0) {
        off_t end;

        /* XXX this is POSIX compliant, but doesn't work for CHAR files,
         * only BLOCK. There is a Linux specific ioctl() for getting
         * size of both CHAR / BLOCK devices we should check for in
         * configure
         *
         * NB. Because we configure with AC_SYS_LARGEFILE, off_t
         * should be 64 bits on all platforms.  For block devices, we
         * have to seek (safe even if someone else is writing) to
         * determine physical size, and assume that allocation is the
         * same as physical (but can refine that assumption later if
         * qemu is still running).
         */
        if ((end = lseek(fd, 0, SEEK_END)) == (off_t)-1) {
            virReportSystemError(errno,
                                 _("failed to seek to end of %s"), src->path);
            return -1;
        }
        src->physical = end;
        src->allocation = end;
        src->capacity = end;
    }

    return 0;
}


3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551
/**
 * @src: disk source definition structure
 * @buf: buffer to the storage file header
 * @len: length of the storage file header
 * @probe: allow probe
 *
 * Update the storage @src capacity. This may involve probing the storage
 * @src in order to "see" if we can recognize what exists.
 *
 * Returns 0 on success, -1 on error.
 */
int
virStorageSourceUpdateCapacity(virStorageSourcePtr src,
                               char *buf,
                               ssize_t len,
                               bool probe)
{
    int ret = -1;
    virStorageSourcePtr meta = NULL;
    int format = src->format;

    /* Raw files: capacity is physical size.  For all other files: if
     * the metadata has a capacity, use that, otherwise fall back to
     * physical size.  */
    if (format == VIR_STORAGE_FILE_NONE) {
        if (!probe) {
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("no disk format for %s and probing is disabled"),
                           src->path);
            goto cleanup;
        }

        if ((format = virStorageFileProbeFormatFromBuf(src->path,
                                                       buf, len)) < 0)
            goto cleanup;

        src->format = format;
    }

3552
    if (format == VIR_STORAGE_FILE_RAW && !src->encryption) {
3553
        src->capacity = src->physical;
3554 3555
    } else if ((meta = virStorageFileGetMetadataFromBuf(src->path, buf,
                                                        len, format, NULL))) {
3556
        src->capacity = meta->capacity ? meta->capacity : src->physical;
3557 3558 3559
        if (src->encryption && meta->encryption)
            src->encryption->payload_offset = meta->encryption->payload_offset;
    } else {
3560
        goto cleanup;
3561
    }
3562

3563 3564 3565
    if (src->encryption && src->encryption->payload_offset != -1)
        src->capacity -= src->encryption->payload_offset * 512;

3566 3567 3568 3569 3570 3571 3572 3573
    ret = 0;

 cleanup:
    virStorageSourceFree(meta);
    return ret;
}


3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596
static char *
virStorageFileCanonicalizeFormatPath(char **components,
                                     size_t ncomponents,
                                     bool beginSlash,
                                     bool beginDoubleSlash)
{
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    size_t i;
    char *ret = NULL;

    if (beginSlash)
        virBufferAddLit(&buf, "/");

    if (beginDoubleSlash)
        virBufferAddLit(&buf, "/");

    for (i = 0; i < ncomponents; i++) {
        if (i != 0)
            virBufferAddLit(&buf, "/");

        virBufferAdd(&buf, components[i], -1);
    }

3597
    if (virBufferCheckError(&buf) < 0)
3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632
        return NULL;

    /* if the output string is empty just return an empty string */
    if (!(ret = virBufferContentAndReset(&buf)))
        ignore_value(VIR_STRDUP(ret, ""));

    return ret;
}


static int
virStorageFileCanonicalizeInjectSymlink(const char *path,
                                        size_t at,
                                        char ***components,
                                        size_t *ncomponents)
{
    char **tmp = NULL;
    char **next;
    size_t ntmp = 0;
    int ret = -1;

    if (!(tmp = virStringSplitCount(path, "/", 0, &ntmp)))
        goto cleanup;

    /* prepend */
    for (next = tmp; *next; next++) {
        if (VIR_INSERT_ELEMENT(*components, at, *ncomponents, *next) < 0)
            goto cleanup;

        at++;
    }

    ret = 0;

 cleanup:
3633
    virStringListFreeCount(tmp, ntmp);
3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780
    return ret;
}


char *
virStorageFileCanonicalizePath(const char *path,
                               virStorageFileSimplifyPathReadlinkCallback cb,
                               void *cbdata)
{
    virHashTablePtr cycle = NULL;
    bool beginSlash = false;
    bool beginDoubleSlash = false;
    char **components = NULL;
    size_t ncomponents = 0;
    char *linkpath = NULL;
    char *currentpath = NULL;
    size_t i = 0;
    size_t j = 0;
    int rc;
    char *ret = NULL;

    if (path[0] == '/') {
        beginSlash = true;

        if (path[1] == '/' && path[2] != '/')
            beginDoubleSlash = true;
    }

    if (!(cycle = virHashCreate(10, NULL)))
        goto cleanup;

    if (!(components = virStringSplitCount(path, "/", 0, &ncomponents)))
        goto cleanup;

    j = 0;
    while (j < ncomponents) {
        /* skip slashes */
        if (STREQ(components[j], "")) {
            VIR_FREE(components[j]);
            VIR_DELETE_ELEMENT(components, j, ncomponents);
            continue;
        }
        j++;
    }

    while (i < ncomponents) {
        /* skip '.'s unless it's the last one remaining */
        if (STREQ(components[i], ".") &&
            (beginSlash || ncomponents  > 1)) {
            VIR_FREE(components[i]);
            VIR_DELETE_ELEMENT(components, i, ncomponents);
            continue;
        }

        /* resolve changes to parent directory */
        if (STREQ(components[i], "..")) {
            if (!beginSlash &&
                (i == 0 || STREQ(components[i - 1], ".."))) {
                i++;
                continue;
            }

            VIR_FREE(components[i]);
            VIR_DELETE_ELEMENT(components, i, ncomponents);

            if (i != 0) {
                VIR_FREE(components[i - 1]);
                VIR_DELETE_ELEMENT(components, i - 1, ncomponents);
                i--;
            }

            continue;
        }

        /* check if the actual path isn't resulting into a symlink */
        if (!(currentpath = virStorageFileCanonicalizeFormatPath(components,
                                                                 i + 1,
                                                                 beginSlash,
                                                                 beginDoubleSlash)))
            goto cleanup;

        if ((rc = cb(currentpath, &linkpath, cbdata)) < 0)
            goto cleanup;

        if (rc == 0) {
            if (virHashLookup(cycle, currentpath)) {
                virReportSystemError(ELOOP,
                                     _("Failed to canonicalize path '%s'"), path);
                goto cleanup;
            }

            if (virHashAddEntry(cycle, currentpath, (void *) 1) < 0)
                goto cleanup;

            if (linkpath[0] == '/') {
                /* kill everything from the beginning including the actual component */
                i++;
                while (i--) {
                    VIR_FREE(components[0]);
                    VIR_DELETE_ELEMENT(components, 0, ncomponents);
                }
                beginSlash = true;

                if (linkpath[1] == '/' && linkpath[2] != '/')
                    beginDoubleSlash = true;
                else
                    beginDoubleSlash = false;

                i = 0;
            } else {
                VIR_FREE(components[i]);
                VIR_DELETE_ELEMENT(components, i, ncomponents);
            }

            if (virStorageFileCanonicalizeInjectSymlink(linkpath,
                                                        i,
                                                        &components,
                                                        &ncomponents) < 0)
                goto cleanup;

            j = 0;
            while (j < ncomponents) {
                /* skip slashes */
                if (STREQ(components[j], "")) {
                    VIR_FREE(components[j]);
                    VIR_DELETE_ELEMENT(components, j, ncomponents);
                    continue;
                }
                j++;
            }

            VIR_FREE(linkpath);
            VIR_FREE(currentpath);

            continue;
        }

        VIR_FREE(currentpath);

        i++;
    }

    ret = virStorageFileCanonicalizeFormatPath(components, ncomponents,
                                               beginSlash, beginDoubleSlash);

 cleanup:
    virHashFree(cycle);
3781
    virStringListFreeCount(components, ncomponents);
3782 3783 3784 3785 3786
    VIR_FREE(linkpath);
    VIR_FREE(currentpath);

    return ret;
}
3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805


/**
 * virStorageFileRemoveLastPathComponent:
 *
 * @path: Path string to remove the last component from
 *
 * Removes the last path component of a path. This function is designed to be
 * called on file paths only (no trailing slashes in @path). Caller is
 * responsible to free the returned string.
 */
static char *
virStorageFileRemoveLastPathComponent(const char *path)
{
    char *ret;

    if (VIR_STRDUP(ret, path ? path : "") < 0)
        return NULL;

3806
    virFileRemoveLastComponent(ret);
3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832

    return ret;
}


/*
 * virStorageFileGetRelativeBackingPath:
 *
 * Resolve relative path to be written to the overlay of @top image when
 * collapsing the backing chain between @top and @base.
 *
 * Returns 0 on success; 1 if backing chain isn't relative and -1 on error.
 */
int
virStorageFileGetRelativeBackingPath(virStorageSourcePtr top,
                                     virStorageSourcePtr base,
                                     char **relpath)
{
    virStorageSourcePtr next;
    char *tmp = NULL;
    char *path = NULL;
    char ret = -1;

    *relpath = NULL;

    for (next = top; next; next = next->backingStore) {
3833
        if (!next->relPath) {
3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868
            ret = 1;
            goto cleanup;
        }

        if (!(tmp = virStorageFileRemoveLastPathComponent(path)))
            goto cleanup;

        VIR_FREE(path);

        if (virAsprintf(&path, "%s%s", tmp, next->relPath) < 0)
            goto cleanup;

        VIR_FREE(tmp);

        if (next == base)
            break;
    }

    if (next != base) {
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("failed to resolve relative backing name: "
                         "base image is not in backing chain"));
        goto cleanup;
    }

    *relpath = path;
    path = NULL;

    ret = 0;

 cleanup:
    VIR_FREE(path);
    VIR_FREE(tmp);
    return ret;
}
3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894


/*
 * virStorageFileCheckCompat
 */
int
virStorageFileCheckCompat(const char *compat)
{
    char **version;
    unsigned int result;
    int ret = -1;

    if (!compat)
        return 0;

    version = virStringSplit(compat, ".", 2);
    if (!version || !version[1] ||
        virStrToLong_ui(version[0], NULL, 10, &result) < 0 ||
        virStrToLong_ui(version[1], NULL, 10, &result) < 0) {
        virReportError(VIR_ERR_XML_ERROR, "%s",
                       _("forbidden characters in 'compat' attribute"));
        goto cleanup;
    }
    ret = 0;

 cleanup:
3895
    virStringListFree(version);
3896 3897
    return ret;
}
3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928


/**
 * virStorageSourceIsRelative:
 * @src: storage source to check
 *
 * Returns true if given storage source definition is a relative path.
 */
bool
virStorageSourceIsRelative(virStorageSourcePtr src)
{
    virStorageType actual_type = virStorageSourceGetActualType(src);

    if (!src->path)
        return false;

    switch (actual_type) {
    case VIR_STORAGE_TYPE_FILE:
    case VIR_STORAGE_TYPE_BLOCK:
    case VIR_STORAGE_TYPE_DIR:
        return src->path[0] != '/';

    case VIR_STORAGE_TYPE_NETWORK:
    case VIR_STORAGE_TYPE_VOLUME:
    case VIR_STORAGE_TYPE_NONE:
    case VIR_STORAGE_TYPE_LAST:
        return false;
    }

    return false;
}
3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943


/**
 * virStorageSourceFindByNodeName:
 * @top: backing chain top
 * @nodeName: node name to find in backing chain
 * @index: if provided the index in the backing chain
 *
 * Looks up the given storage source in the backing chain and returns the
 * pointer to it. If @index is passed then it's filled by the index in the
 * backing chain. On failure NULL is returned and no error is reported.
 */
virStorageSourcePtr
virStorageSourceFindByNodeName(virStorageSourcePtr top,
                               const char *nodeName,
E
Eric Blake 已提交
3944
                               unsigned int *idx)
3945 3946 3947
{
    virStorageSourcePtr tmp;

E
Eric Blake 已提交
3948 3949
    if (idx)
        *idx = 0;
3950 3951

    for (tmp = top; tmp; tmp = tmp->backingStore) {
3952 3953
        if ((tmp->nodeformat && STREQ(tmp->nodeformat, nodeName)) ||
            (tmp->nodebacking && STREQ(tmp->nodebacking, nodeName)))
3954 3955
            return tmp;

E
Eric Blake 已提交
3956 3957
        if (idx)
            (*idx)++;
3958 3959
    }

E
Eric Blake 已提交
3960 3961
    if (idx)
        *idx = 0;
3962 3963
    return NULL;
}