virstoragefile.c 137.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
 */

#include <config.h>
23
#include "virstoragefilebackend.h"
24

25
#include <unistd.h>
26
#include <fcntl.h>
27
#include "viralloc.h"
28 29
#include "virxml.h"
#include "viruuid.h"
30
#include "virerror.h"
31
#include "virlog.h"
E
Eric Blake 已提交
32
#include "virfile.h"
33
#include "c-ctype.h"
34
#include "vircommand.h"
35
#include "virhash.h"
E
Eric Blake 已提交
36
#include "virendian.h"
37 38
#include "virstring.h"
#include "virutil.h"
39 40
#include "viruri.h"
#include "dirname.h"
41
#include "virbuffer.h"
42
#include "virjson.h"
43
#include "virstorageencryption.h"
44
#include "virsecret.h"
45 46 47

#define VIR_FROM_THIS VIR_FROM_STORAGE

48 49
VIR_LOG_INIT("util.storagefile");

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

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

69 70 71 72 73
VIR_ENUM_IMPL(virStorageFileFeature,
              VIR_STORAGE_FILE_FEATURE_LAST,
              "lazy_refcounts",
              )

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

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

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

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

104 105 106 107 108 109 110 111 112 113 114
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 已提交
115
#define FILE_TYPE_VERSIONS_LAST 3
116

117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
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 */
135 136

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

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

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

169

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

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

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

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

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

211 212
#define PLOOP_IMAGE_SIZE_OFFSET 36
#define PLOOP_SIZE_MULTIPLIER 512
213

214 215
#define LUKS_HDR_MAGIC_LEN 6
#define LUKS_HDR_VERSION_LEN 2
216 217 218 219
#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
220 221 222

/* Format described by qemu commit id '3e308f20e' */
#define LUKS_HDR_VERSION_OFFSET LUKS_HDR_MAGIC_LEN
223 224 225 226 227
#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)
228

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
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,
244 245

        .payloadOffset = LUKS_HDR_PAYLOAD_OFFSET,
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
    },
    { 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,
264 265

        .payloadOffset = -1,
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
    },
    { 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,
284 285

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

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

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

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

382

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

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

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

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

419 420 421

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

        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;
459
            *format = virStorageFileFormatTypeFromString(buf+offset);
E
Eric Blake 已提交
460 461
            if (*format <= VIR_STORAGE_FILE_NONE)
                return -1;
462 463 464 465 466
        }

        offset += len;
    }

467
 done:
468 469 470 471 472

    return 0;
}


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

    *res = NULL;
486 487 488 489
    if (format)
        *format = VIR_STORAGE_FILE_AUTO;

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

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

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

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

554 555 556 557
    return BACKING_STORE_OK;
}


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

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

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


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

596
    if (VIR_ALLOC_N(desc, VIR_STORAGE_MAX_HEADER) < 0)
597
        goto cleanup;
598 599

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

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

    ret = BACKING_STORE_OK;

641
 cleanup:
642 643
    VIR_FREE(desc);
    return ret;
644 645
}

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

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

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

    return BACKING_STORE_OK;
}

689 690

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

698
    if (magic == NULL)
699
        return false;
700

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

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

    return true;
}


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

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

    return false;
}


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

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

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

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

750
    if ((versionOffset + versionSize) > buflen)
751 752
        return false;

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

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

778
    return false;
779
}
780

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

    if (!backing)
        return false;

    colon = strchr(backing, ':');
    slash = strchr(backing, '/');
792 793 794 795 796

    /* 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 已提交
797 798 799
        return false;
    return true;
}
800

E
Eric Blake 已提交
801

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

    if (!virStorageIsFile(backing))
        return false;

    return true;
}


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

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

856
 cleanup:
E
Eric Blake 已提交
857 858 859 860 861
    VIR_DEBUG("format=%d", format);
    return format;
}


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

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

    if (version == 2)
        return 0;

    if (len < QCOW2v3_HDR_SIZE)
        return -1;

881
    if (!(feat = virBitmapNew(VIR_STORAGE_FILE_FEATURE_LAST)))
882 883 884 885 886 887 888 889 890 891 892 893 894 895
        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;
}


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

    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) {
920 921
        int crypt_format;

922 923 924
        if (info->modeOffset >= len)
            return false;

925 926
        crypt_format = virReadBufInt32BE(buf + info->modeOffset);
        if (crypt_format != info->modeValue)
927 928 929 930 931 932 933 934 935
            return false;

        return true;
    } else {
        return false;
    }
}


936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
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;
}


953 954 955 956 957
/* 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 */
958
int
959
virStorageFileGetMetadataInternal(virStorageSourcePtr meta,
960 961
                                  char *buf,
                                  size_t len,
962
                                  int *backingFormat)
963
{
964
    int dummy;
965
    int ret = -1;
966
    size_t i;
E
Eric Blake 已提交
967

968 969 970
    if (!backingFormat)
        backingFormat = &dummy;

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

974
    if (meta->format == VIR_STORAGE_FILE_AUTO)
975
        meta->format = virStorageFileProbeFormatFromBuf(meta->path, buf, len);
976

977 978 979 980
    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 已提交
981 982
        goto cleanup;
    }
983

984 985 986 987
    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)) {
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
                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;
                    }
                }
1003 1004
                meta->encryption->payload_offset =
                    virStorageFileGetEncryptionPayloadOffset(&fileTypeInfo[meta->format].cryptInfo[i], buf);
1005 1006 1007 1008
            }
        }
    }

1009 1010 1011
    /* XXX we should consider moving virStorageBackendUpdateVolInfo
     * code into this method, for non-magic files
     */
1012
    if (!fileTypeInfo[meta->format].magic)
E
Eric Blake 已提交
1013
        goto done;
1014

1015
    /* Optionally extract capacity from file */
1016 1017
    if (fileTypeInfo[meta->format].sizeOffset != -1) {
        if ((fileTypeInfo[meta->format].sizeOffset + 8) > len)
E
Eric Blake 已提交
1018
            goto done;
1019

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

1033
    VIR_FREE(meta->backingStoreRaw);
1034 1035
    if (fileTypeInfo[meta->format].getBackingStore != NULL) {
        int store = fileTypeInfo[meta->format].getBackingStore(&meta->backingStoreRaw,
1036 1037
                                                               backingFormat,
                                                               buf, len);
E
Eric Blake 已提交
1038 1039
        if (store == BACKING_STORE_INVALID)
            goto done;
1040

E
Eric Blake 已提交
1041 1042
        if (store == BACKING_STORE_ERROR)
            goto cleanup;
1043 1044
    }

1045 1046
    if (fileTypeInfo[meta->format].getFeatures != NULL &&
        fileTypeInfo[meta->format].getFeatures(&meta->features, meta->format, buf, len) < 0)
1047 1048
        goto cleanup;

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

1053
 done:
1054
    ret = 0;
E
Eric Blake 已提交
1055

1056
 cleanup:
E
Eric Blake 已提交
1057
    return ret;
1058 1059 1060 1061
}


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

1083 1084
    if ((fd = virFileOpenAs(path, O_RDONLY, 0, uid, gid, 0)) < 0) {
        virReportSystemError(-fd, _("Failed to open file '%s'"), path);
1085 1086 1087
        return -1;
    }

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

1093 1094
    /* No header to probe for directories */
    if (S_ISDIR(sb.st_mode)) {
1095 1096
        ret = VIR_STORAGE_FILE_DIR;
        goto cleanup;
1097
    }
1098 1099 1100 1101 1102 1103

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

1104
    if ((len = virFileReadHeaderFD(fd, len, &header)) < 0) {
1105 1106 1107 1108
        virReportSystemError(errno, _("cannot read header '%s'"), path);
        goto cleanup;
    }

1109
    ret = virStorageFileProbeFormatFromBuf(path, header, len);
1110

1111
 cleanup:
1112
    VIR_FREE(header);
1113
    VIR_FORCE_CLOSE(fd);
1114 1115 1116 1117

    return ret;
}

1118

1119
static virStorageSourcePtr
1120 1121 1122
virStorageFileMetadataNew(const char *path,
                          int format)
{
1123
    virStorageSourcePtr ret = NULL;
1124 1125 1126 1127 1128 1129 1130

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

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

1131 1132
    if (VIR_STRDUP(ret->path, path) < 0)
        goto error;
1133 1134 1135 1136

    return ret;

 error:
1137
    virStorageSourceFree(ret);
1138 1139 1140 1141
    return NULL;
}


1142 1143 1144 1145 1146
/**
 * virStorageFileGetMetadataFromBuf:
 * @path: name of file, for error messages
 * @buf: header bytes from @path
 * @len: length of @buf
1147
 * @format: format of the storage file
1148
 * @backingFormat: format of @backing
1149
 *
1150 1151 1152
 * 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.
1153
 *
1154 1155 1156 1157 1158 1159 1160
 * 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.
1161
 *
1162
 * Caller MUST free the result after use via virStorageSourceFree.
1163
 */
1164
virStorageSourcePtr
1165 1166 1167
virStorageFileGetMetadataFromBuf(const char *path,
                                 char *buf,
                                 size_t len,
1168
                                 int format,
1169
                                 int *backingFormat)
1170
{
1171
    virStorageSourcePtr ret = NULL;
1172 1173 1174 1175
    int dummy;

    if (!backingFormat)
        backingFormat = &dummy;
1176

1177
    if (!(ret = virStorageFileMetadataNew(path, format)))
1178
        return NULL;
1179

1180 1181 1182 1183 1184
    if (virStorageFileGetMetadataInternal(ret, buf, len,
                                          backingFormat) < 0) {
        virStorageSourceFree(ret);
        return NULL;
    }
1185

1186
    return ret;
1187 1188 1189
}


1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
/**
 * 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)

1209
{
1210 1211
    virStorageSourcePtr ret = NULL;
    virStorageSourcePtr meta = NULL;
1212
    char *buf = NULL;
1213
    ssize_t len = VIR_STORAGE_MAX_HEADER;
1214
    struct stat sb;
1215
    int dummy;
1216

1217 1218
    if (!backingFormat)
        backingFormat = &dummy;
1219

1220
    *backingFormat = VIR_STORAGE_FILE_NONE;
1221

1222 1223
    if (fstat(fd, &sb) < 0) {
        virReportSystemError(errno,
1224 1225
                             _("cannot stat file '%s'"), path);
        return NULL;
1226 1227
    }

1228 1229 1230
    if (!(meta = virStorageFileMetadataNew(path, format)))
        return NULL;

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

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

    if ((len = virFileReadHeaderFD(fd, len, &buf)) < 0) {
1247
        virReportSystemError(errno, _("cannot read header '%s'"), meta->path);
1248 1249 1250
        goto cleanup;
    }

1251 1252
    if (virStorageFileGetMetadataInternal(meta, buf, len, backingFormat) < 0)
        goto cleanup;
1253

1254 1255 1256 1257
    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;
1258

1259 1260
    ret = meta;
    meta = NULL;
1261

1262 1263 1264
 cleanup:
    virStorageSourceFree(meta);
    VIR_FREE(buf);
1265
    return ret;
1266 1267
}

1268

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

1283 1284
    *brokenFile = NULL;

1285 1286 1287
    if (!chain)
        return 0;

1288
    for (tmp = chain; virStorageSourceIsBacking(tmp); tmp = tmp->backingStore) {
1289 1290
        /* Break when we hit end of chain; report error if we detected
         * a missing backing file, infinite loop, or other error */
1291
        if (!tmp->backingStore && tmp->backingStoreRaw) {
1292 1293
            if (VIR_STRDUP(*brokenFile, tmp->backingStoreRaw) < 0)
                return -1;
1294

1295 1296 1297
           return 0;
        }
    }
1298

1299
    return 0;
1300 1301 1302
}


1303 1304 1305 1306 1307 1308
/**
 * virStorageFileResize:
 *
 * Change the capacity of the raw storage file at 'path'.
 */
int
1309 1310 1311
virStorageFileResize(const char *path,
                     unsigned long long capacity,
                     bool pre_allocate)
1312
{
1313 1314
    int fd = -1;
    int ret = -1;
1315
    int rc;
1316 1317 1318 1319 1320 1321

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

1322
    if (pre_allocate) {
1323
        if ((rc = virFileAllocate(fd, 0, capacity)) != 0) {
1324 1325 1326 1327 1328 1329 1330 1331
            if (rc == -2) {
                virReportError(VIR_ERR_OPERATION_UNSUPPORTED, "%s",
                               _("preallocate is not supported on this platform"));
            } else {
                virReportSystemError(errno,
                                     _("Failed to pre-allocate space for "
                                       "file '%s'"), path);
            }
1332 1333
            goto cleanup;
        }
1334 1335 1336 1337 1338 1339
    }

    if (ftruncate(fd, capacity) < 0) {
        virReportSystemError(errno,
                             _("Failed to truncate file '%s'"), path);
        goto cleanup;
1340 1341
    }

1342 1343 1344 1345 1346 1347 1348
    if (VIR_CLOSE(fd) < 0) {
        virReportSystemError(errno, _("Unable to save '%s'"), path);
        goto cleanup;
    }

    ret = 0;

1349
 cleanup:
1350 1351
    VIR_FORCE_CLOSE(fd);
    return ret;
1352 1353
}

1354 1355 1356 1357 1358 1359

int virStorageFileIsClusterFS(const char *path)
{
    /* These are coherent cluster filesystems known to be safe for
     * migration with cache != none
     */
1360 1361 1362
    return virFileIsSharedFSType(path,
                                 VIR_FILE_SHFS_GFS2 |
                                 VIR_FILE_SHFS_OCFS);
1363
}
1364 1365

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

    *key = NULL;
1382 1383

    /* Run the program and capture its output */
1384 1385
    virCommandSetOutputBuffer(cmd, key);
    if (virCommandRun(cmd, &status) < 0)
1386 1387
        goto cleanup;

1388 1389 1390 1391 1392 1393
    /* 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) {
1394
        char *nl;
1395
        char *tmp = *key;
1396 1397

        /* Find first non-space character */
1398
        while (*tmp && c_isspace(*tmp))
1399 1400
            tmp++;
        /* Kill leading spaces */
1401 1402
        if (tmp != *key)
            memmove(*key, tmp, strlen(tmp)+1);
1403 1404

        /* Kill trailing newline */
1405
        if ((nl = strchr(*key, '\n')))
1406 1407 1408
            *nl = '\0';
    }

1409
    ret = 0;
1410

1411
 cleanup:
1412 1413 1414
    if (*key && STREQ(*key, ""))
        VIR_FREE(*key);

1415 1416
    virCommandFree(cmd);

1417
    return ret;
1418 1419
}
#else
1420 1421
int virStorageFileGetLVMKey(const char *path,
                            char **key ATTRIBUTE_UNUSED)
1422 1423
{
    virReportSystemError(ENOSYS, _("Unable to get LVM key for %s"), path);
1424
    return -1;
1425 1426 1427
}
#endif

1428
#ifdef WITH_UDEV
1429 1430
int virStorageFileGetSCSIKey(const char *path,
                             char **key)
1431
{
1432
    int status;
1433 1434 1435 1436 1437 1438
    virCommandPtr cmd = virCommandNewArgList("/lib/udev/scsi_id",
                                             "--replace-whitespace",
                                             "--whitelisted",
                                             "--device", path,
                                             NULL
                                             );
1439 1440 1441
    int ret = -1;

    *key = NULL;
1442 1443

    /* Run the program and capture its output */
1444 1445
    virCommandSetOutputBuffer(cmd, key);
    if (virCommandRun(cmd, &status) < 0)
1446 1447
        goto cleanup;

1448 1449 1450 1451 1452 1453
    /* 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');
1454 1455 1456 1457
        if (nl)
            *nl = '\0';
    }

1458 1459
    ret = 0;

1460
 cleanup:
1461 1462 1463
    if (*key && STREQ(*key, ""))
        VIR_FREE(*key);

1464 1465
    virCommandFree(cmd);

1466
    return ret;
1467 1468
}
#else
1469 1470
int virStorageFileGetSCSIKey(const char *path,
                             char **key ATTRIBUTE_UNUSED)
1471 1472
{
    virReportSystemError(ENOSYS, _("Unable to get SCSI key for %s"), path);
1473
    return -1;
1474 1475
}
#endif
1476

1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524

/**
 * 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;
}


1525 1526 1527 1528 1529 1530
int
virStorageFileParseChainIndex(const char *diskTarget,
                              const char *name,
                              unsigned int *chainIndex)
{
    unsigned int idx = 0;
1531
    char *target = NULL;
1532 1533 1534 1535
    int ret = 0;

    *chainIndex = 0;

1536 1537
    if (!name || !diskTarget)
        return 0;
1538

1539 1540
    if (virStorageFileParseBackingStoreStr(name, &target, &idx) < 0)
        return 0;
1541

1542
    if (idx == 0)
1543 1544
        goto cleanup;

1545
    if (STRNEQ(diskTarget, target)) {
1546 1547
        virReportError(VIR_ERR_INVALID_ARG,
                       _("requested target '%s' does not match target '%s'"),
1548
                       target, diskTarget);
1549 1550 1551 1552 1553 1554 1555
        ret = -1;
        goto cleanup;
    }

    *chainIndex = idx;

 cleanup:
1556
    VIR_FREE(target);
1557 1558 1559
    return ret;
}

1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570

/**
 * virStorageSourceIsBacking:
 * @src: storage source
 *
 * Returns true if @src is a eligible backing store structure. Useful
 * for iterators.
 */
bool
virStorageSourceIsBacking(const virStorageSource *src)
{
P
Peter Krempa 已提交
1571
    return src && src->type != VIR_STORAGE_TYPE_NONE;
1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
}

/**
 * virStorageSourceHasBacking:
 * @src: storage source
 *
 * Returns true if @src has backing store/chain.
 */
bool
virStorageSourceHasBacking(const virStorageSource *src)
{
P
Peter Krempa 已提交
1583 1584
    return virStorageSourceIsBacking(src) && src->backingStore &&
           src->backingStore->type != VIR_STORAGE_TYPE_NONE;
1585 1586 1587
}


E
Eric Blake 已提交
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
/* 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.
1598
 */
1599
virStorageSourcePtr
1600
virStorageFileChainLookup(virStorageSourcePtr chain,
1601
                          virStorageSourcePtr startFrom,
1602
                          const char *name,
1603
                          unsigned int idx,
1604
                          virStorageSourcePtr *parent)
1605
{
1606
    virStorageSourcePtr prev;
1607
    const char *start = chain->path;
1608
    char *parentDir = NULL;
E
Eric Blake 已提交
1609
    bool nameIsFile = virStorageIsFile(name);
1610 1611

    if (!parent)
1612
        parent = &prev;
1613
    *parent = NULL;
1614 1615

    if (startFrom) {
1616 1617
        while (virStorageSourceIsBacking(chain) &&
               chain != startFrom->backingStore)
1618
            chain = chain->backingStore;
1619

1620
        *parent = startFrom;
1621 1622
    }

1623
    while (virStorageSourceIsBacking(chain)) {
1624
        if (!name && !idx) {
1625
            if (!virStorageSourceHasBacking(chain))
1626
                break;
1627
        } else if (idx) {
1628 1629
            VIR_DEBUG("%u: %s", chain->id, chain->path);
            if (idx == chain->id)
1630
                break;
E
Eric Blake 已提交
1631
        } else {
1632
            if (STREQ_NULLABLE(name, chain->relPath) ||
1633
                STREQ_NULLABLE(name, chain->path))
1634
                break;
1635 1636

            if (nameIsFile && virStorageSourceIsLocalStorage(chain)) {
1637 1638
                if (*parent && virStorageSourceIsLocalStorage(*parent))
                    parentDir = mdir_name((*parent)->path);
1639 1640 1641 1642 1643 1644
                else
                    ignore_value(VIR_STRDUP_QUIET(parentDir, "."));

                if (!parentDir) {
                    virReportOOMError();
                    goto error;
1645 1646
                }

E
Eric Blake 已提交
1647
                int result = virFileRelLinkPointsTo(parentDir, name,
1648
                                                    chain->path);
1649 1650

                VIR_FREE(parentDir);
1651

E
Eric Blake 已提交
1652 1653
                if (result < 0)
                    goto error;
1654

E
Eric Blake 已提交
1655 1656 1657
                if (result > 0)
                    break;
            }
1658
        }
1659
        *parent = chain;
1660
        chain = chain->backingStore;
1661
    }
1662

1663
    if (!virStorageSourceIsBacking(chain))
1664
        goto error;
1665

1666
    return chain;
1667

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


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

    VIR_FREE(def->name);
    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);
}


1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731
static void
virStoragePermsFree(virStoragePermsPtr def)
{
    if (!def)
        return;

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


1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746
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;
1747
        dst->port = src->port;
1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761

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

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

    return ret;

 error:
    virStorageNetHostDefFree(nhosts, ret);
    return NULL;
}
1762 1763


1764 1765 1766 1767 1768 1769 1770 1771
void
virStorageAuthDefFree(virStorageAuthDefPtr authdef)
{
    if (!authdef)
        return;

    VIR_FREE(authdef->username);
    VIR_FREE(authdef->secrettype);
1772
    virSecretLookupDefClear(&authdef->seclookupdef);
1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
    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;
1791 1792 1793 1794

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

1795 1796 1797 1798 1799 1800 1801 1802
    return ret;

 error:
    virStorageAuthDefFree(ret);
    return NULL;
}


1803 1804 1805
virStorageAuthDefPtr
virStorageAuthDefParse(xmlNodePtr node,
                       xmlXPathContextPtr ctxt)
1806
{
1807
    xmlNodePtr saveNode = ctxt->node;
1808
    virStorageAuthDefPtr authdef = NULL;
1809
    virStorageAuthDefPtr ret = NULL;
1810
    xmlNodePtr secretnode = NULL;
1811 1812
    char *authtype = NULL;

1813 1814
    ctxt->node = node;

1815
    if (VIR_ALLOC(authdef) < 0)
1816
        goto cleanup;
1817

1818
    if (!(authdef->username = virXPathString("string(./@username)", ctxt))) {
1819 1820
        virReportError(VIR_ERR_XML_ERROR, "%s",
                       _("missing username for auth"));
1821
        goto cleanup;
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832
    }

    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);
1833
            goto cleanup;
1834 1835 1836
        }
    }

1837 1838 1839
    if (!(secretnode = virXPathNode("./secret ", ctxt))) {
        virReportError(VIR_ERR_XML_ERROR, "%s",
                       _("Missing <secret> element in auth"));
1840
        goto cleanup;
1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852
    }

    /* 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)
1853
        goto cleanup;
1854

1855
    VIR_STEAL_PTR(ret, authdef);
1856

1857
 cleanup:
1858 1859
    VIR_FREE(authtype);
    virStorageAuthDefFree(authdef);
1860
    ctxt->node = saveNode;
1861 1862

    return ret;
1863 1864 1865
}


1866
void
1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878
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);
1879 1880
    virSecretLookupFormatSecret(buf, authdef->secrettype,
                                &authdef->seclookupdef);
1881 1882 1883 1884 1885
    virBufferAdjustIndent(buf, -2);
    virBufferAddLit(buf, "</auth>\n");
}


1886 1887 1888 1889 1890 1891 1892
void
virStoragePRDefFree(virStoragePRDefPtr prd)
{
    if (!prd)
        return;

    VIR_FREE(prd->path);
1893
    VIR_FREE(prd->mgralias);
1894 1895 1896 1897 1898 1899 1900
    VIR_FREE(prd);
}


virStoragePRDefPtr
virStoragePRDefParseXML(xmlXPathContextPtr ctxt)
{
1901 1902
    virStoragePRDefPtr prd;
    virStoragePRDefPtr ret = NULL;
1903 1904 1905 1906 1907 1908 1909 1910
    char *managed = NULL;
    char *type = NULL;
    char *path = NULL;
    char *mode = NULL;

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

1911
    if (!(managed = virXPathString("string(./@managed)", ctxt))) {
1912
        virReportError(VIR_ERR_XML_ERROR, "%s",
1913
                       _("missing @managed attribute for <reservations/>"));
1914 1915 1916
        goto cleanup;
    }

1917
    if ((prd->managed = virTristateBoolTypeFromString(managed)) <= 0) {
1918
        virReportError(VIR_ERR_XML_ERROR,
1919
                       _("invalid value for 'managed': %s"), managed);
1920 1921 1922
        goto cleanup;
    }

1923 1924 1925
    type = virXPathString("string(./source[1]/@type)", ctxt);
    path = virXPathString("string(./source[1]/@path)", ctxt);
    mode = virXPathString("string(./source[1]/@mode)", ctxt);
1926

1927
    if (prd->managed == VIR_TRISTATE_BOOL_NO || type || path || mode) {
1928
        if (!type) {
1929
            virReportError(VIR_ERR_XML_ERROR, "%s",
1930
                           _("missing connection type for <reservations/>"));
1931 1932 1933
            goto cleanup;
        }

1934 1935 1936
        if (!path) {
            virReportError(VIR_ERR_XML_ERROR, "%s",
                           _("missing path for <reservations/>"));
1937 1938 1939
            goto cleanup;
        }

1940 1941 1942 1943 1944
        if (!mode) {
            virReportError(VIR_ERR_XML_ERROR, "%s",
                           _("missing connection mode for <reservations/>"));
            goto cleanup;
        }
1945
    }
1946

1947 1948 1949 1950 1951 1952
    if (type && STRNEQ(type, "unix")) {
        virReportError(VIR_ERR_XML_ERROR,
                       _("unsupported connection type for <reservations/>: %s"),
                       type);
        goto cleanup;
    }
1953

1954 1955 1956 1957 1958
    if (mode && STRNEQ(mode, "client")) {
        virReportError(VIR_ERR_XML_ERROR,
                       _("unsupported connection mode for <reservations/>: %s"),
                       mode);
        goto cleanup;
1959 1960
    }

1961
    VIR_STEAL_PTR(prd->path, path);
1962
    VIR_STEAL_PTR(ret, prd);
1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975

 cleanup:
    VIR_FREE(mode);
    VIR_FREE(path);
    VIR_FREE(type);
    VIR_FREE(managed);
    virStoragePRDefFree(prd);
    return ret;
}


void
virStoragePRDefFormat(virBufferPtr buf,
1976 1977
                      virStoragePRDefPtr prd,
                      bool migratable)
1978
{
1979 1980
    virBufferAsprintf(buf, "<reservations managed='%s'",
                      virTristateBoolTypeToString(prd->managed));
1981 1982
    if (prd->path &&
        (prd->managed == VIR_TRISTATE_BOOL_NO || !migratable)) {
1983 1984 1985 1986 1987 1988 1989
        virBufferAddLit(buf, ">\n");
        virBufferAdjustIndent(buf, 2);
        virBufferAddLit(buf, "<source type='unix'");
        virBufferEscapeString(buf, " path='%s'", prd->path);
        virBufferAddLit(buf, " mode='client'/>\n");
        virBufferAdjustIndent(buf, -2);
        virBufferAddLit(buf, "</reservations>\n");
1990 1991 1992 1993 1994 1995
    } else {
        virBufferAddLit(buf, "/>\n");
    }
}


1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
bool
virStoragePRDefIsEqual(virStoragePRDefPtr a,
                       virStoragePRDefPtr b)
{
    if (!a && !b)
        return true;

    if (!a || !b)
        return false;

2006
    if (a->managed != b->managed ||
2007 2008 2009 2010 2011 2012 2013
        STRNEQ_NULLABLE(a->path, b->path))
        return false;

    return true;
}


2014 2015 2016 2017 2018 2019 2020
bool
virStoragePRDefIsManaged(virStoragePRDefPtr prd)
{
    return prd && prd->managed == VIR_TRISTATE_BOOL_YES;
}


2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034
bool
virStorageSourceChainHasManagedPR(virStorageSourcePtr src)
{
    virStorageSourcePtr n;

    for (n = src; virStorageSourceIsBacking(n); n = n->backingStore) {
        if (virStoragePRDefIsManaged(src->pr))
            return true;
    }

    return false;
}


2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057
static virStoragePRDefPtr
virStoragePRDefCopy(virStoragePRDefPtr src)
{
    virStoragePRDefPtr copy = NULL;
    virStoragePRDefPtr ret = NULL;

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

    copy->managed = src->managed;

    if (VIR_STRDUP(copy->path, src->path) < 0 ||
        VIR_STRDUP(copy->mgralias, src->mgralias) < 0)
        goto cleanup;

    VIR_STEAL_PTR(ret, copy);

 cleanup:
    virStoragePRDefFree(copy);
    return ret;
}


2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072
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;
}


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 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137
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;

2138
    if (VIR_STRDUP(ret->label, src->label) < 0)
2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191
        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;

2192
    ret->id = src->id;
2193 2194 2195 2196
    ret->type = src->type;
    ret->protocol = src->protocol;
    ret->format = src->format;
    ret->capacity = src->capacity;
2197
    ret->allocation = src->allocation;
2198
    ret->has_allocation = src->has_allocation;
2199
    ret->physical = src->physical;
2200 2201
    ret->readonly = src->readonly;
    ret->shared = src->shared;
2202 2203
    ret->haveTLS = src->haveTLS;
    ret->tlsFromConfig = src->tlsFromConfig;
2204
    ret->detected = src->detected;
2205 2206
    ret->debugLevel = src->debugLevel;
    ret->debug = src->debug;
2207 2208 2209 2210
    ret->iomode = src->iomode;
    ret->cachemode = src->cachemode;
    ret->discard = src->discard;
    ret->detect_zeroes = src->detect_zeroes;
2211 2212 2213 2214 2215 2216 2217 2218

    /* 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->relPath, src->relPath) < 0 ||
        VIR_STRDUP(ret->backingStoreRaw, src->backingStoreRaw) < 0 ||
2219
        VIR_STRDUP(ret->snapshot, src->snapshot) < 0 ||
2220
        VIR_STRDUP(ret->configFile, src->configFile) < 0 ||
2221
        VIR_STRDUP(ret->nodeformat, src->nodeformat) < 0 ||
2222
        VIR_STRDUP(ret->nodestorage, src->nodestorage) < 0 ||
2223 2224 2225
        VIR_STRDUP(ret->compat, src->compat) < 0 ||
        VIR_STRDUP(ret->tlsAlias, src->tlsAlias) < 0 ||
        VIR_STRDUP(ret->tlsCertdir, src->tlsCertdir) < 0)
2226 2227
        goto error;

2228 2229 2230 2231 2232 2233
    if (src->nhosts) {
        if (!(ret->hosts = virStorageNetHostDefCopy(src->nhosts, src->hosts)))
            goto error;

        ret->nhosts = src->nhosts;
    }
2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261

    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;

2262 2263 2264 2265
    if (src->pr &&
        !(ret->pr = virStoragePRDefCopy(src->pr)))
        goto error;

2266 2267 2268
    if (virStorageSourceInitiatorCopy(&ret->initiator, &src->initiator))
        goto error;

2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282
    if (backingChain && src->backingStore) {
        if (!(ret->backingStore = virStorageSourceCopy(src->backingStore,
                                                       true)))
            goto error;
    }

    return ret;

 error:
    virStorageSourceFree(ret);
    return NULL;
}


2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325
/**
 * virStorageSourceIsSameLocation:
 *
 * Returns true if the sources @a and @b point to the same storage location.
 * This does not compare any other configuration option
 */
bool
virStorageSourceIsSameLocation(virStorageSourcePtr a,
                               virStorageSourcePtr b)
{
    size_t i;

    /* there are multiple possibilities to define an empty source */
    if (virStorageSourceIsEmpty(a) &&
        virStorageSourceIsEmpty(b))
        return true;

    if (virStorageSourceGetActualType(a) != virStorageSourceGetActualType(b))
        return false;

    if (STRNEQ_NULLABLE(a->path, b->path) ||
        STRNEQ_NULLABLE(a->volume, b->volume) ||
        STRNEQ_NULLABLE(a->snapshot, b->snapshot))
        return false;

    if (a->type == VIR_STORAGE_TYPE_NETWORK) {
        if (a->protocol != b->protocol ||
            a->nhosts != b->nhosts)
            return false;

        for (i = 0; i < a->nhosts; i++) {
            if (a->hosts[i].transport != b->hosts[i].transport ||
                a->hosts[i].port != b->hosts[i].port ||
                STRNEQ_NULLABLE(a->hosts[i].name, b->hosts[i].name) ||
                STRNEQ_NULLABLE(a->hosts[i].socket, b->hosts[i].socket))
                return false;
        }
    }

    return true;
}


2326 2327 2328 2329
/**
 * virStorageSourceInitChainElement:
 * @newelem: New backing chain element disk source
 * @old: Existing top level disk source
N
Nitesh Konkar 已提交
2330
 * @transferLabels: Transfer security labels.
2331 2332 2333 2334 2335
 *
 * 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.
 *
2336 2337
 * 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.
2338 2339 2340 2341 2342 2343
 *
 * Returns 0 on success, -1 on error.
 */
int
virStorageSourceInitChainElement(virStorageSourcePtr newelem,
                                 virStorageSourcePtr old,
2344
                                 bool transferLabels)
2345 2346 2347
{
    int ret = -1;

2348 2349
    if (transferLabels &&
        !newelem->seclabels &&
2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362
        virStorageSourceSeclabelsCopy(newelem, old) < 0)
        goto cleanup;

    newelem->shared = old->shared;
    newelem->readonly = old->readonly;

    ret = 0;

 cleanup:
    return ret;
}


2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375
void
virStorageSourcePoolDefFree(virStorageSourcePoolDefPtr def)
{
    if (!def)
        return;

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

    VIR_FREE(def);
}


2376
int
2377
virStorageSourceGetActualType(const virStorageSource *def)
2378 2379 2380 2381 2382 2383 2384 2385
{
    if (def->type == VIR_STORAGE_TYPE_VOLUME && def->srcpool)
        return def->srcpool->actualtype;

    return def->type;
}


2386
bool
2387
virStorageSourceIsLocalStorage(const virStorageSource *src)
2388
{
2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404
    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;
2405 2406 2407
}


2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424
/**
 * 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;

2425 2426 2427 2428
    if (src->type == VIR_STORAGE_TYPE_NETWORK &&
        src->protocol == VIR_STORAGE_NET_PROTOCOL_NONE)
        return true;

2429 2430 2431 2432
    return false;
}


2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446
/**
 * 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;
}


2447
/**
2448
 * virStorageSourceBackingStoreClear:
2449 2450 2451 2452 2453 2454
 *
 * @src: disk source to clear
 *
 * Clears information about backing store of the current storage file.
 */
void
2455
virStorageSourceBackingStoreClear(virStorageSourcePtr def)
2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468
{
    if (!def)
        return;

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

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


2469 2470 2471 2472 2473 2474 2475
void
virStorageSourceClear(virStorageSourcePtr def)
{
    if (!def)
        return;

    VIR_FREE(def->path);
2476
    VIR_FREE(def->volume);
2477 2478
    VIR_FREE(def->snapshot);
    VIR_FREE(def->configFile);
2479
    virStorageSourcePoolDefFree(def->srcpool);
E
Eric Blake 已提交
2480 2481
    virBitmapFree(def->features);
    VIR_FREE(def->compat);
2482
    virStorageEncryptionFree(def->encryption);
2483
    virStoragePRDefFree(def->pr);
2484
    virStorageSourceSeclabelsClear(def);
2485
    virStoragePermsFree(def->perms);
E
Eric Blake 已提交
2486
    VIR_FREE(def->timestamps);
2487 2488

    virStorageNetHostDefFree(def->nhosts, def->hosts);
2489
    virStorageAuthDefFree(def->auth);
2490
    virObjectUnref(def->privateData);
2491

2492
    VIR_FREE(def->nodestorage);
2493 2494
    VIR_FREE(def->nodeformat);

2495
    virStorageSourceBackingStoreClear(def);
2496

2497 2498 2499
    VIR_FREE(def->tlsAlias);
    VIR_FREE(def->tlsCertdir);

2500 2501
    virStorageSourceInitiatorClear(&def->initiator);

2502
    memset(def, 0, sizeof(*def));
2503
}
2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514


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

    virStorageSourceClear(def);
    VIR_FREE(def);
}
2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526


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

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

2527 2528 2529 2530
    /* store relative name */
    if (VIR_STRDUP(ret->relPath, parent->backingStoreRaw) < 0)
        goto error;

2531 2532
    if (!(dirname = mdir_name(parent->path))) {
        virReportOOMError();
2533
        goto error;
2534
    }
2535

2536 2537
    if (STRNEQ(dirname, "/")) {
        if (virAsprintf(&ret->path, "%s/%s", dirname, rel) < 0)
2538 2539
            goto error;
    } else {
2540 2541 2542 2543 2544
        if (virAsprintf(&ret->path, "/%s", rel) < 0)
            goto error;
    }

    if (virStorageSourceGetActualType(parent) == VIR_STORAGE_TYPE_NETWORK) {
2545 2546 2547 2548
        ret->type = VIR_STORAGE_TYPE_NETWORK;

        /* copy the host network part */
        ret->protocol = parent->protocol;
2549 2550 2551 2552 2553 2554 2555
        if (parent->nhosts) {
            if (!(ret->hosts = virStorageNetHostDefCopy(parent->nhosts,
                                                        parent->hosts)))
                goto error;

            ret->nhosts = parent->nhosts;
        }
2556 2557 2558

        if (VIR_STRDUP(ret->volume, parent->volume) < 0)
            goto error;
2559 2560 2561
    } else {
        /* set the type to _FILE, the caller shall update it to the actual type */
        ret->type = VIR_STORAGE_TYPE_FILE;
2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576
    }

 cleanup:
    VIR_FREE(dirname);
    return ret;

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


static int
virStorageSourceParseBackingURI(virStorageSourcePtr src,
2577
                                const char *uristr)
2578 2579
{
    virURIPtr uri = NULL;
2580
    const char *path = NULL;
2581 2582 2583
    char **scheme = NULL;
    int ret = -1;

2584
    if (!(uri = virURIParse(uristr))) {
2585 2586
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("failed to parse backing file location '%s'"),
2587
                       uristr);
2588 2589 2590
        goto cleanup;
    }

2591 2592 2593 2594 2595
    if (VIR_ALLOC(src->hosts) < 0)
        goto cleanup;

    src->nhosts = 1;

2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622
    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 */

2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639
    /* uri->path is NULL if the URI does not contain slash after host:
     * transport://host:port */
    if (uri->path)
        path = uri->path;
    else
        path = "";

    /* possibly skip the leading slash  */
    if (path[0] == '/')
        path++;

    /* NBD allows empty export name (path) */
    if (src->protocol == VIR_STORAGE_NET_PROTOCOL_NBD &&
        path[0] == '\0')
        path = NULL;

    if (VIR_STRDUP(src->path, path) < 0)
2640 2641 2642 2643
        goto cleanup;

    if (src->protocol == VIR_STORAGE_NET_PROTOCOL_GLUSTER) {
        char *tmp;
2644 2645 2646 2647 2648 2649 2650

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

2651 2652
        if (!(tmp = strchr(src->path, '/')) ||
            tmp == src->path) {
2653
            virReportError(VIR_ERR_CONFIG_UNSUPPORTED,
2654 2655 2656 2657 2658 2659 2660
                           _("missing volume name or file name in "
                             "gluster source path '%s'"), src->path);
            goto cleanup;
        }

        src->volume = src->path;

2661
        if (VIR_STRDUP(src->path, tmp + 1) < 0)
2662 2663 2664 2665 2666
            goto cleanup;

        tmp[0] = '\0';
    }

2667
    src->hosts->port = uri->port;
2668 2669 2670 2671 2672 2673 2674 2675

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

    ret = 0;

 cleanup:
    virURIFree(uri);
2676
    virStringListFree(scheme);
2677 2678 2679 2680
    return ret;
}


2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703
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;
2704
        if (virStringParsePort(port, &src->hosts[src->nhosts - 1].port) < 0)
2705 2706 2707 2708 2709 2710
            goto error;
    }

    parts = virStringSplit(hostport, "\\:", 0);
    if (!parts)
        goto error;
2711 2712
    src->hosts[src->nhosts-1].name = virStringListJoin((const char **)parts, ":");
    virStringListFree(parts);
2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748
    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].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';
    }

2749 2750 2751 2752 2753 2754 2755
    /* snapshot name */
    if ((p = strchr(src->path, '@'))) {
        if (VIR_STRDUP(src->snapshot, p + 1) < 0)
            goto error;
        *p = '\0';
    }

2756 2757 2758 2759 2760 2761 2762 2763
    /* pool vs. image name */
    if ((p = strchr(src->path, '/'))) {
        VIR_STEAL_PTR(src->volume, src->path);
        if (VIR_STRDUP(src->path, p + 1) < 0)
            goto error;
        *p = '\0';
    }

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 2791 2792 2793
    /* 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,
2794
                           virSecretUsageTypeToString(VIR_SECRET_USAGE_TYPE_CEPH)) < 0)
2795 2796
                goto error;
            src->auth = authdef;
2797
            src->authInherited = true;
2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825
            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;
            }
        }

2826 2827 2828 2829
        if (STRPREFIX(p, "conf=") &&
            VIR_STRDUP(src->configFile, p + strlen("conf=")) < 0)
            goto error;

2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841
        p = next;
    }
    VIR_FREE(options);
    return 0;

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


2842
static int
2843 2844
virStorageSourceParseNBDColonString(const char *nbdstr,
                                    virStorageSourcePtr src)
2845 2846 2847 2848
{
    char **backing = NULL;
    int ret = -1;

2849 2850 2851 2852 2853 2854
    if (!(backing = virStringSplit(nbdstr, ":", 0)))
        goto cleanup;

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

    if (VIR_ALLOC_N(src->hosts, 1) < 0)
2855 2856
        goto cleanup;

2857 2858 2859 2860 2861 2862 2863 2864
    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]) {
2865
        virReportError(VIR_ERR_INTERNAL_ERROR,
2866 2867
                       _("missing remote information in '%s' for protocol nbd"),
                       nbdstr);
2868
        goto cleanup;
2869 2870 2871 2872 2873 2874 2875
    } 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;
        }
2876

2877
        if (VIR_STRDUP(src->hosts->socket, backing[2]) < 0)
2878 2879
            goto cleanup;

2880 2881 2882
   } else {
        if (VIR_STRDUP(src->hosts->name, backing[1]) < 0)
            goto cleanup;
2883

2884 2885 2886 2887 2888 2889
        if (!backing[2]) {
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("missing port in nbd string '%s'"),
                           nbdstr);
            goto cleanup;
        }
2890

2891
        if (virStringParsePort(backing[2], &src->hosts->port) < 0)
2892 2893
            goto cleanup;
    }
2894

2895 2896 2897 2898
    if (backing[3] && STRPREFIX(backing[3], "exportname=")) {
        if (VIR_STRDUP(src->path, backing[3] + strlen("exportname=")) < 0)
            goto cleanup;
    }
2899

2900
    ret = 0;
2901

2902
 cleanup:
2903
    virStringListFree(backing);
2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938

    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;
2939 2940

    case VIR_STORAGE_NET_PROTOCOL_RBD:
2941 2942 2943 2944 2945
        if (virStorageSourceParseRBDColonString(path, src) < 0)
            goto cleanup;
        break;

    case VIR_STORAGE_NET_PROTOCOL_SHEEPDOG:
2946 2947 2948 2949
    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"),
2950
                       protocol);
2951 2952 2953 2954 2955 2956 2957 2958 2959
        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:
2960
    case VIR_STORAGE_NET_PROTOCOL_SSH:
2961
    case VIR_STORAGE_NET_PROTOCOL_VXHS:
2962 2963
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("malformed backing store path for protocol %s"),
2964
                       protocol);
2965 2966 2967 2968 2969 2970
        goto cleanup;
    }

    ret = 0;

 cleanup:
2971
    VIR_FREE(protocol);
2972 2973 2974 2975
    return ret;
}


2976 2977 2978 2979 2980
static int
virStorageSourceParseBackingJSONInternal(virStorageSourcePtr src,
                                         virJSONValuePtr json);


2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002
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;
}


3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030
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;

3031
    if (!(uri = virJSONValueObjectGetString(json, "url"))) {
3032
        virReportError(VIR_ERR_INVALID_ARG, "%s",
3033
                       _("missing 'url' in JSON backing volume definition"));
3034 3035 3036 3037 3038 3039 3040
        return -1;
    }

    return virStorageSourceParseBackingJSONUriStr(src, uri, protocol);
}


3041 3042 3043 3044
static int
virStorageSourceParseBackingJSONInetSocketAddress(virStorageNetHostDefPtr host,
                                                  virJSONValuePtr json)
{
3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056
    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");
3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067

    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 ||
3068
        virStringParsePort(port, &host->port) < 0)
3069 3070 3071 3072 3073 3074
        return -1;

    return 0;
}


3075
static int
3076 3077
virStorageSourceParseBackingJSONSocketAddress(virStorageNetHostDefPtr host,
                                              virJSONValuePtr json)
3078
{
3079 3080 3081 3082 3083 3084 3085 3086 3087
    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;
    }
3088

3089
    if (!(type = virJSONValueObjectGetString(json, "type"))) {
3090 3091 3092
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing socket address type in "
                         "JSON backing volume definition"));
3093 3094 3095
        return -1;
    }

3096
    if (STREQ(type, "tcp") || STREQ(type, "inet")) {
3097
        return virStorageSourceParseBackingJSONInetSocketAddress(host, json);
3098

3099 3100
    } else if (STREQ(type, "unix")) {
        host->transport = VIR_STORAGE_NET_HOST_TRANS_UNIX;
3101

3102 3103 3104 3105 3106 3107 3108
        socket = virJSONValueObjectGetString(json, "path");

        /* check for old spelling for gluster protocol */
        if (!socket)
            socket = virJSONValueObjectGetString(json, "socket");

        if (!socket) {
3109 3110
            virReportError(VIR_ERR_INVALID_ARG, "%s",
                           _("missing socket path for udp backing server in "
3111
                             "JSON backing volume definition"));
3112 3113 3114 3115 3116
            return -1;
        }

        if (VIR_STRDUP(host->socket, socket) < 0)
            return -1;
3117
    } else {
3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151
        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;
    }

3152 3153 3154
    src->type = VIR_STORAGE_TYPE_NETWORK;
    src->protocol = VIR_STORAGE_NET_PROTOCOL_GLUSTER;

3155
    if (VIR_STRDUP(src->volume, volume) < 0 ||
3156
        VIR_STRDUP(src->path, path) < 0)
3157 3158 3159
        return -1;

    nservers = virJSONValueArraySize(server);
3160
    if (nservers == 0) {
3161 3162 3163
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("at least 1 server is necessary in "
                         "JSON backing definition for gluster volume"));
3164 3165

        return -1;
3166 3167 3168 3169 3170 3171 3172
    }

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

    for (i = 0; i < nservers; i++) {
3173 3174
        if (virStorageSourceParseBackingJSONSocketAddress(src->hosts + i,
                                                          virJSONValueArrayGet(server, i)) < 0)
3175 3176 3177 3178 3179 3180 3181
            return -1;
    }

    return 0;
}


3182 3183 3184 3185 3186
static int
virStorageSourceParseBackingJSONiSCSI(virStorageSourcePtr src,
                                      virJSONValuePtr json,
                                      int opaque ATTRIBUTE_UNUSED)
{
3187 3188 3189
    const char *transport = virJSONValueObjectGetString(json, "transport");
    const char *portal = virJSONValueObjectGetString(json, "portal");
    const char *target = virJSONValueObjectGetString(json, "target");
3190
    const char *lun = virJSONValueObjectGetStringOrNumber(json, "lun");
3191
    const char *uri;
3192 3193
    char *port;
    int ret = -1;
3194 3195 3196 3197 3198 3199

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

3200 3201
    src->type = VIR_STORAGE_TYPE_NETWORK;
    src->protocol = VIR_STORAGE_NET_PROTOCOL_ISCSI;
3202

3203 3204 3205
    if (!lun)
        lun = "0";

3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233
    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;

3234 3235
    if ((port = strrchr(src->hosts->name, ':')) &&
        !strchr(port, ']')) {
3236
        if (virStringParsePort(port + 1, &src->hosts->port) < 0)
3237 3238 3239 3240 3241
            goto cleanup;

        *port = '\0';
    }

3242
    if (virAsprintf(&src->path, "%s/%s", target, lun) < 0)
3243 3244 3245 3246 3247 3248
        goto cleanup;

    ret = 0;

 cleanup:
    return ret;
3249 3250 3251
}


3252 3253 3254 3255 3256 3257 3258 3259 3260
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");
3261
    virJSONValuePtr server = virJSONValueObjectGetObject(json, "server");
3262

3263
    if (!path && !host && !server) {
3264
        virReportError(VIR_ERR_INVALID_ARG, "%s",
3265 3266
                       _("missing host specification of NBD server in JSON "
                         "backing volume definition"));
3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279
        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;

3280 3281
    if (server) {
        if (virStorageSourceParseBackingJSONSocketAddress(src->hosts, server) < 0)
3282 3283
            return -1;
    } else {
3284 3285 3286 3287 3288 3289 3290 3291
        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;
3292

3293
            if (virStringParsePort(port, &src->hosts[0].port) < 0)
3294 3295
                return -1;
        }
3296 3297 3298 3299 3300 3301
    }

    return 0;
}


3302 3303 3304 3305 3306 3307
static int
virStorageSourceParseBackingJSONSheepdog(virStorageSourcePtr src,
                                         virJSONValuePtr json,
                                         int opaque ATTRIBUTE_UNUSED)
{
    const char *filename;
3308 3309
    const char *vdi = virJSONValueObjectGetString(json, "vdi");
    virJSONValuePtr server = virJSONValueObjectGetObject(json, "server");
3310 3311 3312 3313 3314 3315 3316 3317

    /* 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 */
3318 3319 3320
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing sheepdog URI in JSON backing volume definition"));
        return -1;
3321 3322
    }

3323 3324
    src->type = VIR_STORAGE_TYPE_NETWORK;
    src->protocol = VIR_STORAGE_NET_PROTOCOL_SHEEPDOG;
3325

3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342
    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;
3343 3344 3345
}


3346 3347 3348 3349 3350 3351 3352 3353
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");
3354
    virJSONValuePtr server = virJSONValueObjectGetObject(json, "server");
3355

3356
    if (!(host || server) || !path) {
3357
        virReportError(VIR_ERR_INVALID_ARG, "%s",
3358
                       _("missing host/server or path of SSH JSON backing "
3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372
                         "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;

3373 3374 3375 3376 3377 3378
    if (server) {
        if (virStorageSourceParseBackingJSONInetSocketAddress(src->hosts,
                                                              server) < 0)
            return -1;
    } else {
        src->hosts[0].transport = VIR_STORAGE_NET_HOST_TRANS_TCP;
3379

3380
        if (VIR_STRDUP(src->hosts[0].name, host) < 0 ||
3381
            virStringParsePort(port, &src->hosts[0].port) < 0)
3382 3383
            return -1;
    }
3384 3385 3386 3387 3388

    return 0;
}


3389 3390 3391 3392 3393 3394
static int
virStorageSourceParseBackingJSONRBD(virStorageSourcePtr src,
                                    virJSONValuePtr json,
                                    int opaque ATTRIBUTE_UNUSED)
{
    const char *filename;
3395 3396 3397 3398 3399 3400 3401 3402
    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");
    size_t nservers;
    size_t i;
    int ret = -1;
3403 3404 3405 3406 3407 3408 3409 3410

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

3411 3412 3413 3414 3415 3416
    if (!pool || !image) {
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("missing pool or image name in ceph backing volume "
                         "JSON specification"));
        return -1;
    }
3417

3418 3419 3420
    if (VIR_STRDUP(src->volume, pool) < 0 ||
        VIR_STRDUP(src->path, image) < 0 ||
        VIR_STRDUP(src->snapshot, snapshot) < 0 ||
3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441
        VIR_STRDUP(src->configFile, conf) < 0)
        goto cleanup;

    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:
    return ret;
3442 3443
}

3444 3445 3446 3447 3448 3449 3450 3451 3452 3453
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);
}
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

static int
virStorageSourceParseBackingJSONVxHS(virStorageSourcePtr src,
                                     virJSONValuePtr json,
                                     int opaque ATTRIBUTE_UNUSED)
{
    const char *vdisk_id = virJSONValueObjectGetString(json, "vdisk-id");
    virJSONValuePtr server = virJSONValueObjectGetObject(json, "server");

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

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

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

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

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

    return 0;
}


3489 3490 3491 3492 3493 3494 3495 3496
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},
3497 3498
    {"host_device", virStorageSourceParseBackingJSONPath, VIR_STORAGE_TYPE_BLOCK},
    {"host_cdrom", virStorageSourceParseBackingJSONPath, VIR_STORAGE_TYPE_BLOCK},
3499 3500 3501 3502 3503
    {"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},
3504
    {"gluster", virStorageSourceParseBackingJSONGluster, 0},
3505
    {"iscsi", virStorageSourceParseBackingJSONiSCSI, 0},
3506
    {"nbd", virStorageSourceParseBackingJSONNbd, 0},
3507
    {"sheepdog", virStorageSourceParseBackingJSONSheepdog, 0},
3508
    {"ssh", virStorageSourceParseBackingJSONSSH, 0},
3509
    {"rbd", virStorageSourceParseBackingJSONRBD, 0},
3510
    {"raw", virStorageSourceParseBackingJSONRaw, 0},
3511
    {"vxhs", virStorageSourceParseBackingJSONVxHS, 0},
3512 3513 3514 3515 3516
};



static int
3517 3518
virStorageSourceParseBackingJSONInternal(virStorageSourcePtr src,
                                         virJSONValuePtr json)
3519
{
3520
    virJSONValuePtr deflattened = NULL;
3521 3522
    virJSONValuePtr file;
    const char *drvname;
3523
    char *str = NULL;
3524 3525 3526
    size_t i;
    int ret = -1;

3527 3528
    if (!(deflattened = virJSONValueObjectDeflatten(json)))
        goto cleanup;
3529

3530 3531 3532
    if (!(file = virJSONValueObjectGetObject(deflattened, "file"))) {
        str = virJSONValueToString(json, false);
        virReportError(VIR_ERR_INVALID_ARG,
3533
                       _("JSON backing volume definition '%s' lacks 'file' object"),
3534 3535
                       NULLSTR(str));
        goto cleanup;
3536 3537 3538
    }

    if (!(drvname = virJSONValueObjectGetString(file, "driver"))) {
3539 3540
        str = virJSONValueToString(json, false);
        virReportError(VIR_ERR_INVALID_ARG,
3541
                       _("JSON backing volume definition '%s' lacks driver name"),
3542
                       NULLSTR(str));
3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557
        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:
3558
    VIR_FREE(str);
3559
    virJSONValueFree(deflattened);
3560 3561 3562 3563
    return ret;
}


3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580
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;
}


3581
virStorageSourcePtr
3582 3583
virStorageSourceNewFromBackingAbsolute(const char *path)
{
3584
    const char *json;
3585
    virStorageSourcePtr ret;
3586
    int rc;
3587 3588 3589 3590 3591 3592 3593

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

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

3594 3595
        if (VIR_STRDUP(ret->path, path) < 0)
            goto error;
3596 3597 3598
    } else {
        ret->type = VIR_STORAGE_TYPE_NETWORK;

3599 3600
        VIR_DEBUG("parsing backing store string: '%s'", path);

3601
        /* handle URI formatted backing stores */
3602 3603 3604 3605 3606 3607 3608 3609 3610
        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;
3611

3612
        virStorageSourceNetworkAssignDefaultPorts(ret);
3613 3614 3615 3616 3617 3618 3619 3620

        /* Some of the legacy parsers parse authentication data since they are
         * also used in other places. For backing store detection the
         * authentication data would be invalid anyways, so we clear it */
        if (ret->auth) {
            virStorageAuthDefFree(ret->auth);
            ret->auth = NULL;
        }
3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654
    }

    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;
                }
            }
        }
3655 3656

        /* copy parent's labelling and other top level stuff */
3657
        if (virStorageSourceInitChainElement(ret, parent, true) < 0)
3658
            goto error;
3659

3660
        ret->readonly = true;
3661
        ret->detected = true;
3662 3663 3664
    }

    return ret;
3665 3666 3667 3668

 error:
    virStorageSourceFree(ret);
    return NULL;
3669
}
3670 3671


3672
/**
3673 3674 3675
 * @src: disk source definition structure
 * @fd: file descriptor
 * @sb: stat buffer
3676
 *
3677 3678 3679 3680 3681
 * 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.
3682 3683
 */
int
3684 3685 3686
virStorageSourceUpdatePhysicalSize(virStorageSourcePtr src,
                                   int fd,
                                   struct stat const *sb)
3687 3688
{
    off_t end;
3689
    virStorageType actual_type = virStorageSourceGetActualType(src);
3690

3691 3692 3693 3694 3695
    switch (actual_type) {
    case VIR_STORAGE_TYPE_FILE:
    case VIR_STORAGE_TYPE_NETWORK:
        src->physical = sb->st_size;
        break;
3696

3697 3698 3699
    case VIR_STORAGE_TYPE_BLOCK:
        if ((end = lseek(fd, 0, SEEK_END)) == (off_t) -1) {
            virReportSystemError(errno, _("failed to seek to end of '%s'"),
3700
                                 src->path);
3701 3702
            return -1;
        }
3703 3704

        src->physical = end;
3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715
        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,
3716 3717 3718
                       _("cannot retrieve physical for path '%s' type '%s'"),
                       NULLSTR(src->path),
                       virStorageTypeToString(actual_type));
3719 3720
        return -1;
        break;
3721 3722
    }

3723
    return 0;
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 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791
/**
 * @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;
}


3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830
/**
 * @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;
    }

3831
    if (format == VIR_STORAGE_FILE_RAW && !src->encryption) {
3832
        src->capacity = src->physical;
3833 3834
    } else if ((meta = virStorageFileGetMetadataFromBuf(src->path, buf,
                                                        len, format, NULL))) {
3835
        src->capacity = meta->capacity ? meta->capacity : src->physical;
3836 3837 3838
        if (src->encryption && meta->encryption)
            src->encryption->payload_offset = meta->encryption->payload_offset;
    } else {
3839
        goto cleanup;
3840
    }
3841

3842 3843 3844
    if (src->encryption && src->encryption->payload_offset != -1)
        src->capacity -= src->encryption->payload_offset * 512;

3845 3846 3847 3848 3849 3850 3851 3852
    ret = 0;

 cleanup:
    virStorageSourceFree(meta);
    return ret;
}


3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875
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);
    }

3876
    if (virBufferCheckError(&buf) < 0)
3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911
        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:
3912
    virStringListFreeCount(tmp, ntmp);
3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059
    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);
4060
    virStringListFreeCount(components, ncomponents);
4061 4062 4063 4064 4065
    VIR_FREE(linkpath);
    VIR_FREE(currentpath);

    return ret;
}
4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084


/**
 * 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;

4085
    virFileRemoveLastComponent(ret);
4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110

    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;

4111
    for (next = top; virStorageSourceIsBacking(next); next = next->backingStore) {
4112
        if (!next->relPath) {
4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147
            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;
}
4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173


/*
 * 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:
4174
    virStringListFree(version);
4175 4176
    return ret;
}
4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207


/**
 * 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;
}
4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222


/**
 * 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 已提交
4223
                               unsigned int *idx)
4224 4225 4226
{
    virStorageSourcePtr tmp;

E
Eric Blake 已提交
4227 4228
    if (idx)
        *idx = 0;
4229

4230
    for (tmp = top; virStorageSourceIsBacking(tmp); tmp = tmp->backingStore) {
4231
        if ((tmp->nodeformat && STREQ(tmp->nodeformat, nodeName)) ||
4232
            (tmp->nodestorage && STREQ(tmp->nodestorage, nodeName)))
4233 4234
            return tmp;

E
Eric Blake 已提交
4235 4236
        if (idx)
            (*idx)++;
4237 4238
    }

E
Eric Blake 已提交
4239 4240
    if (idx)
        *idx = 0;
4241 4242
    return NULL;
}
4243 4244


4245
static unsigned int
4246 4247 4248 4249
virStorageSourceNetworkDefaultPort(virStorageNetProtocol protocol)
{
    switch (protocol) {
        case VIR_STORAGE_NET_PROTOCOL_HTTP:
4250
            return 80;
4251 4252

        case VIR_STORAGE_NET_PROTOCOL_HTTPS:
4253
            return 443;
4254 4255

        case VIR_STORAGE_NET_PROTOCOL_FTP:
4256
            return 21;
4257 4258

        case VIR_STORAGE_NET_PROTOCOL_FTPS:
4259
            return 990;
4260 4261

        case VIR_STORAGE_NET_PROTOCOL_TFTP:
4262
            return 69;
4263 4264

        case VIR_STORAGE_NET_PROTOCOL_SHEEPDOG:
4265
            return 7000;
4266 4267

        case VIR_STORAGE_NET_PROTOCOL_NBD:
4268
            return 10809;
4269 4270

        case VIR_STORAGE_NET_PROTOCOL_SSH:
4271
            return 22;
4272 4273

        case VIR_STORAGE_NET_PROTOCOL_ISCSI:
4274
            return 3260;
4275

4276
        case VIR_STORAGE_NET_PROTOCOL_GLUSTER:
4277
            return 24007;
4278 4279

        case VIR_STORAGE_NET_PROTOCOL_RBD:
4280
            /* we don't provide a default for RBD */
4281
            return 0;
4282

4283
        case VIR_STORAGE_NET_PROTOCOL_VXHS:
4284 4285
            return 9999;

4286 4287
        case VIR_STORAGE_NET_PROTOCOL_LAST:
        case VIR_STORAGE_NET_PROTOCOL_NONE:
4288
            return 0;
4289 4290
    }

4291
    return 0;
4292
}
4293 4294


4295
void
4296 4297 4298 4299 4300 4301
virStorageSourceNetworkAssignDefaultPorts(virStorageSourcePtr src)
{
    size_t i;

    for (i = 0; i < src->nhosts; i++) {
        if (src->hosts[i].transport == VIR_STORAGE_NET_HOST_TRANS_TCP &&
4302 4303
            src->hosts[i].port == 0)
            src->hosts[i].port = virStorageSourceNetworkDefaultPort(src->protocol);
4304 4305
    }
}
4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325


int
virStorageSourcePrivateDataParseRelPath(xmlXPathContextPtr ctxt,
                                        virStorageSourcePtr src)
{
    src->relPath = virXPathString("string(./relPath)", ctxt);
    return 0;
}


int
virStorageSourcePrivateDataFormatRelPath(virStorageSourcePtr src,
                                         virBufferPtr buf)
{
    if (src->relPath)
        virBufferEscapeString(buf, "<relPath>%s</relPath>\n", src->relPath);

    return 0;
}
4326

4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360
void
virStorageSourceInitiatorParseXML(xmlXPathContextPtr ctxt,
                                  virStorageSourceInitiatorDefPtr initiator)
{
    initiator->iqn = virXPathString("string(./initiator/iqn/@name)", ctxt);
}

void
virStorageSourceInitiatorFormatXML(virStorageSourceInitiatorDefPtr initiator,
                                   virBufferPtr buf)
{
    if (!initiator->iqn)
        return;

    virBufferAddLit(buf, "<initiator>\n");
    virBufferAdjustIndent(buf, 2);
    virBufferEscapeString(buf, "<iqn name='%s'/>\n", initiator->iqn);
    virBufferAdjustIndent(buf, -2);
    virBufferAddLit(buf, "</initiator>\n");
}

int
virStorageSourceInitiatorCopy(virStorageSourceInitiatorDefPtr dest,
                              const virStorageSourceInitiatorDef *src)
{
    return VIR_STRDUP(dest->iqn, src->iqn);
}

void
virStorageSourceInitiatorClear(virStorageSourceInitiatorDefPtr initiator)
{
    VIR_FREE(initiator->iqn);
}

4361 4362 4363 4364 4365 4366 4367
static bool
virStorageFileIsInitialized(const virStorageSource *src)
{
    return src && src->drv;
}


4368 4369 4370
static int
virStorageFileGetBackendForSupportCheck(const virStorageSource *src,
                                        virStorageFileBackendPtr *backend)
4371 4372 4373 4374
{
    int actualType;


4375 4376 4377 4378 4379 4380 4381 4382 4383
    if (!src) {
        *backend = NULL;
        return 0;
    }

    if (src->drv) {
        *backend = src->drv->backend;
        return 0;
    }
4384 4385 4386

    actualType = virStorageSourceGetActualType(src);

4387 4388 4389
    if (virStorageFileBackendForType(actualType, src->protocol, false, backend) < 0)
        return -1;

4390
    return 0;
4391 4392 4393
}


4394
static int
4395 4396 4397
virStorageFileSupportsBackingChainTraversal(virStorageSourcePtr src)
{
    virStorageFileBackendPtr backend;
4398
    int rv;
4399

4400 4401 4402 4403 4404 4405
    rv = virStorageFileGetBackendForSupportCheck(src, &backend);
    if (rv < 0)
        return -1;

    if (!backend)
        return 0;
4406 4407 4408

    return backend->storageFileGetUniqueIdentifier &&
           backend->storageFileRead &&
4409
           backend->storageFileAccess ? 1 : 0;
4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420
}


/**
 * virStorageFileSupportsSecurityDriver:
 *
 * @src: a storage file structure
 *
 * Check if a storage file supports operations needed by the security
 * driver to perform labelling
 */
4421
int
4422 4423 4424
virStorageFileSupportsSecurityDriver(const virStorageSource *src)
{
    virStorageFileBackendPtr backend;
4425
    int rv;
4426

4427 4428 4429 4430 4431
    rv = virStorageFileGetBackendForSupportCheck(src, &backend);
    if (rv < 0)
        return -1;
    if (backend == NULL)
        return 0;
4432

4433
    return backend->storageFileChown ? 1 : 0;
4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444
}


/**
 * virStorageFileSupportsAccess:
 *
 * @src: a storage file structure
 *
 * Check if a storage file supports checking if the storage source is accessible
 * for the given vm.
 */
4445
int
4446 4447 4448
virStorageFileSupportsAccess(const virStorageSource *src)
{
    virStorageFileBackendPtr backend;
4449
    int ret;
4450

4451 4452 4453 4454 4455
    ret = virStorageFileGetBackendForSupportCheck(src, &backend);
    if (ret < 0)
        return -1;
    if (backend == NULL)
        return 0;
4456

4457
    return backend->storageFileAccess ? 1 : 0;
4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505
}


void
virStorageFileDeinit(virStorageSourcePtr src)
{
    if (!virStorageFileIsInitialized(src))
        return;

    if (src->drv->backend &&
        src->drv->backend->backendDeinit)
        src->drv->backend->backendDeinit(src);

    VIR_FREE(src->drv);
}


/**
 * virStorageFileInitAs:
 *
 * @src: storage source definition
 * @uid: uid used to access the file, or -1 for current uid
 * @gid: gid used to access the file, or -1 for current gid
 *
 * Initialize a storage source to be used with storage driver. Use the provided
 * uid and gid if possible for the operations.
 *
 * Returns 0 if the storage file was successfully initialized, -1 if the
 * initialization failed. Libvirt error is reported.
 */
int
virStorageFileInitAs(virStorageSourcePtr src,
                     uid_t uid, gid_t gid)
{
    int actualType = virStorageSourceGetActualType(src);
    if (VIR_ALLOC(src->drv) < 0)
        return -1;

    if (uid == (uid_t) -1)
        src->drv->uid = geteuid();
    else
        src->drv->uid = uid;

    if (gid == (gid_t) -1)
        src->drv->gid = getegid();
    else
        src->drv->gid = gid;

4506 4507 4508 4509
    if (virStorageFileBackendForType(actualType,
                                     src->protocol,
                                     true,
                                     &src->drv->backend) < 0)
4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650
        goto error;

    if (src->drv->backend->backendInit &&
        src->drv->backend->backendInit(src) < 0)
        goto error;

    return 0;

 error:
    VIR_FREE(src->drv);
    return -1;
}


/**
 * virStorageFileInit:
 *
 * See virStorageFileInitAs. The file is initialized to be accessed by the
 * current user.
 */
int
virStorageFileInit(virStorageSourcePtr src)
{
    return virStorageFileInitAs(src, -1, -1);
}


/**
 * virStorageFileCreate: Creates an empty storage file via storage driver
 *
 * @src: file structure pointing to the file
 *
 * Returns 0 on success, -2 if the function isn't supported by the backend,
 * -1 on other failure. Errno is set in case of failure.
 */
int
virStorageFileCreate(virStorageSourcePtr src)
{
    int ret;

    if (!virStorageFileIsInitialized(src) ||
        !src->drv->backend->storageFileCreate) {
        errno = ENOSYS;
        return -2;
    }

    ret = src->drv->backend->storageFileCreate(src);

    VIR_DEBUG("created storage file %p: ret=%d, errno=%d",
              src, ret, errno);

    return ret;
}


/**
 * virStorageFileUnlink: Unlink storage file via storage driver
 *
 * @src: file structure pointing to the file
 *
 * Unlinks the file described by the @file structure.
 *
 * Returns 0 on success, -2 if the function isn't supported by the backend,
 * -1 on other failure. Errno is set in case of failure.
 */
int
virStorageFileUnlink(virStorageSourcePtr src)
{
    int ret;

    if (!virStorageFileIsInitialized(src) ||
        !src->drv->backend->storageFileUnlink) {
        errno = ENOSYS;
        return -2;
    }

    ret = src->drv->backend->storageFileUnlink(src);

    VIR_DEBUG("unlinked storage file %p: ret=%d, errno=%d",
              src, ret, errno);

    return ret;
}


/**
 * virStorageFileStat: returns stat struct of a file via storage driver
 *
 * @src: file structure pointing to the file
 * @stat: stat structure to return data
 *
 * Returns 0 on success, -2 if the function isn't supported by the backend,
 * -1 on other failure. Errno is set in case of failure.
*/
int
virStorageFileStat(virStorageSourcePtr src,
                   struct stat *st)
{
    int ret;

    if (!virStorageFileIsInitialized(src) ||
        !src->drv->backend->storageFileStat) {
        errno = ENOSYS;
        return -2;
    }

    ret = src->drv->backend->storageFileStat(src, st);

    VIR_DEBUG("stat of storage file %p: ret=%d, errno=%d",
              src, ret, errno);

    return ret;
}


/**
 * virStorageFileRead: read bytes from a file into a buffer
 *
 * @src: file structure pointing to the file
 * @offset: number of bytes to skip in the storage file
 * @len: maximum number of bytes read from the storage file
 * @buf: buffer to read the data into. (buffer shall be freed by caller)
 *
 * Returns the count of bytes read on success and -1 on failure, -2 if the
 * function isn't supported by the backend.
 * Libvirt error is reported on failure.
 */
ssize_t
virStorageFileRead(virStorageSourcePtr src,
                   size_t offset,
                   size_t len,
                   char **buf)
{
    ssize_t ret;

    if (!virStorageFileIsInitialized(src)) {
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("storage file backend not initialized"));
        return -1;
    }

4651
    if (!src->drv->backend->storageFileRead)
4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682
        return -2;

    ret = src->drv->backend->storageFileRead(src, offset, len, buf);

    VIR_DEBUG("read '%zd' bytes from storage '%p' starting at offset '%zu'",
              ret, src, offset);

    return ret;
}


/*
 * virStorageFileGetUniqueIdentifier: Get a unique string describing the volume
 *
 * @src: file structure pointing to the file
 *
 * Returns a string uniquely describing a single volume (canonical path).
 * The string shall not be freed and is valid until the storage file is
 * deinitialized. Returns NULL on error and sets a libvirt error code */
const char *
virStorageFileGetUniqueIdentifier(virStorageSourcePtr src)
{
    if (!virStorageFileIsInitialized(src)) {
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("storage file backend not initialized"));
        return NULL;
    }

    if (!src->drv->backend->storageFileGetUniqueIdentifier) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("unique storage file identifier not implemented for "
4683
                         "storage type %s (protocol: %s)'"),
4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805
                       virStorageTypeToString(src->type),
                       virStorageNetProtocolTypeToString(src->protocol));
        return NULL;
    }

    return src->drv->backend->storageFileGetUniqueIdentifier(src);
}


/**
 * virStorageFileAccess: Check accessibility of a storage file
 *
 * @src: storage file to check access permissions
 * @mode: accessibility check options (see man 2 access)
 *
 * Returns 0 on success, -1 on error and sets errno. No libvirt
 * error is reported. Returns -2 if the operation isn't supported
 * by libvirt storage backend.
 */
int
virStorageFileAccess(virStorageSourcePtr src,
                     int mode)
{
    if (!virStorageFileIsInitialized(src) ||
        !src->drv->backend->storageFileAccess) {
        errno = ENOSYS;
        return -2;
    }

    return src->drv->backend->storageFileAccess(src, mode);
}


/**
 * virStorageFileChown: Change owner of a storage file
 *
 * @src: storage file to change owner of
 * @uid: new owner id
 * @gid: new group id
 *
 * Returns 0 on success, -1 on error and sets errno. No libvirt
 * error is reported. Returns -2 if the operation isn't supported
 * by libvirt storage backend.
 */
int
virStorageFileChown(const virStorageSource *src,
                    uid_t uid,
                    gid_t gid)
{
    if (!virStorageFileIsInitialized(src) ||
        !src->drv->backend->storageFileChown) {
        errno = ENOSYS;
        return -2;
    }

    VIR_DEBUG("chown of storage file %p to %u:%u",
              src, (unsigned int)uid, (unsigned int)gid);

    return src->drv->backend->storageFileChown(src, uid, gid);
}


/**
 * virStorageFileReportBrokenChain:
 *
 * @errcode: errno when accessing @src
 * @src: inaccessible file in the backing chain of @parent
 * @parent: root virStorageSource being checked
 *
 * Reports the correct error message if @src is missing in the backing chain
 * for @parent.
 */
void
virStorageFileReportBrokenChain(int errcode,
                                virStorageSourcePtr src,
                                virStorageSourcePtr parent)
{
    if (src->drv) {
        unsigned int access_user = src->drv->uid;
        unsigned int access_group = src->drv->gid;

        if (src == parent) {
            virReportSystemError(errcode,
                                 _("Cannot access storage file '%s' "
                                   "(as uid:%u, gid:%u)"),
                                 src->path, access_user, access_group);
        } else {
            virReportSystemError(errcode,
                                 _("Cannot access backing file '%s' "
                                   "of storage file '%s' (as uid:%u, gid:%u)"),
                                 src->path, parent->path, access_user, access_group);
        }
    } else {
        if (src == parent) {
            virReportSystemError(errcode,
                                 _("Cannot access storage file '%s'"),
                                 src->path);
        } else {
            virReportSystemError(errcode,
                                 _("Cannot access backing file '%s' "
                                   "of storage file '%s'"),
                                 src->path, parent->path);
        }
    }
}


/* Recursive workhorse for virStorageFileGetMetadata.  */
static int
virStorageFileGetMetadataRecurse(virStorageSourcePtr src,
                                 virStorageSourcePtr parent,
                                 uid_t uid, gid_t gid,
                                 bool report_broken,
                                 virHashTablePtr cycle,
                                 unsigned int depth)
{
    int ret = -1;
    const char *uniqueName;
    char *buf = NULL;
    ssize_t headerLen;
    virStorageSourcePtr backingStore = NULL;
    int backingFormat;
4806
    int rv;
4807

4808
    VIR_DEBUG("path=%s format=%d uid=%u gid=%u",
4809
              src->path, src->format,
4810
              (unsigned int)uid, (unsigned int)gid);
4811 4812

    /* exit if we can't load information about the current image */
4813 4814 4815
    rv = virStorageFileSupportsBackingChainTraversal(src);
    if (rv <= 0)
        return rv;
4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838

    if (virStorageFileInitAs(src, uid, gid) < 0)
        return -1;

    if (virStorageFileAccess(src, F_OK) < 0) {
        virStorageFileReportBrokenChain(errno, src, parent);
        goto cleanup;
    }

    if (!(uniqueName = virStorageFileGetUniqueIdentifier(src)))
        goto cleanup;

    if (virHashLookup(cycle, uniqueName)) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("backing store for %s (%s) is self-referential"),
                       src->path, uniqueName);
        goto cleanup;
    }

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

    if ((headerLen = virStorageFileRead(src, 0, VIR_STORAGE_MAX_HEADER,
4839 4840 4841 4842 4843 4844 4845
                                        &buf)) < 0) {
        if (headerLen == -2)
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("storage file reading is not supported for "
                             "storage type %s (protocol: %s)"),
                           virStorageTypeToString(src->type),
                           virStorageNetProtocolTypeToString(src->protocol));
4846
        goto cleanup;
4847
    }
4848 4849 4850 4851 4852 4853 4854 4855 4856

    if (virStorageFileGetMetadataInternal(src, buf, headerLen,
                                          &backingFormat) < 0)
        goto cleanup;

    if (src->backingStoreRaw) {
        if (!(backingStore = virStorageSourceNewFromBacking(src)))
            goto cleanup;

4857
        if (backingFormat == VIR_STORAGE_FILE_AUTO)
4858 4859 4860 4861 4862 4863 4864 4865
            backingStore->format = VIR_STORAGE_FILE_RAW;
        else if (backingFormat == VIR_STORAGE_FILE_AUTO_SAFE)
            backingStore->format = VIR_STORAGE_FILE_AUTO;
        else
            backingStore->format = backingFormat;

        if ((ret = virStorageFileGetMetadataRecurse(backingStore, parent,
                                                    uid, gid,
4866
                                                    report_broken,
4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920
                                                    cycle, depth + 1)) < 0) {
            if (report_broken)
                goto cleanup;

            /* if we fail somewhere midway, just accept and return a
             * broken chain */
            ret = 0;
            goto cleanup;
        }
    } else {
        /* add terminator */
        if (VIR_ALLOC(backingStore) < 0)
            goto cleanup;
    }

    src->backingStore = backingStore;
    backingStore = NULL;
    ret = 0;

 cleanup:
    if (virStorageSourceHasBacking(src))
        src->backingStore->id = depth;
    VIR_FREE(buf);
    virStorageFileDeinit(src);
    virStorageSourceFree(backingStore);
    return ret;
}


/**
 * virStorageFileGetMetadata:
 *
 * 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.  Recurses through
 * the entire chain.
 *
 * Open files using UID and GID (or pass -1 for the current user/group).
 * Treat any backing files without explicit type as raw, unless ALLOW_PROBE.
 *
 * Callers are advised never to use VIR_STORAGE_FILE_AUTO as a
 * format, since a malicious guest can turn a raw file into any
 * other non-raw format at will.
 *
 * If @report_broken is true, the whole function fails with a possibly sane
 * error instead of just returning a broken chain.
 *
 * Caller MUST free result after use via virStorageSourceFree.
 */
int
virStorageFileGetMetadata(virStorageSourcePtr src,
                          uid_t uid, gid_t gid,
                          bool report_broken)
{
4921
    VIR_DEBUG("path=%s format=%d uid=%u gid=%u report_broken=%d",
4922
              src->path, src->format, (unsigned int)uid, (unsigned int)gid,
4923
              report_broken);
4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939

    virHashTablePtr cycle = NULL;
    virStorageType actualType = virStorageSourceGetActualType(src);
    int ret = -1;

    if (!(cycle = virHashCreate(5, NULL)))
        return -1;

    if (src->format <= VIR_STORAGE_FILE_NONE) {
        if (actualType == VIR_STORAGE_TYPE_DIR)
            src->format = VIR_STORAGE_FILE_DIR;
        else
            src->format = VIR_STORAGE_FILE_RAW;
    }

    ret = virStorageFileGetMetadataRecurse(src, src, uid, gid,
4940
                                           report_broken, cycle, 1);
4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955

    virHashFree(cycle);
    return ret;
}


/**
 * virStorageFileGetBackingStoreStr:
 * @src: storage object
 *
 * Extracts the backing store string as stored in the storage volume described
 * by @src and returns it to the user. Caller is responsible for freeing it.
 * In case when the string can't be retrieved or does not exist NULL is
 * returned.
 */
4956 4957 4958
int
virStorageFileGetBackingStoreStr(virStorageSourcePtr src,
                                 char **backing)
4959 4960 4961 4962
{
    virStorageSourcePtr tmp = NULL;
    char *buf = NULL;
    ssize_t headerLen;
4963 4964 4965 4966
    int ret = -1;
    int rv;

    *backing = NULL;
4967 4968 4969

    /* exit if we can't load information about the current image */
    if (!virStorageFileSupportsBackingChainTraversal(src))
4970
        return 0;
4971

4972 4973 4974 4975 4976 4977 4978
    rv = virStorageFileAccess(src, F_OK);
    if (rv == -2)
        return 0;
    if (rv < 0) {
        virStorageFileReportBrokenChain(errno, src, src);
        return -1;
    }
4979 4980

    if ((headerLen = virStorageFileRead(src, 0, VIR_STORAGE_MAX_HEADER,
4981 4982 4983 4984 4985
                                        &buf)) < 0) {
        if (headerLen == -2)
            return 0;
        return -1;
    }
4986 4987 4988 4989 4990 4991 4992

    if (!(tmp = virStorageSourceCopy(src, false)))
        goto cleanup;

    if (virStorageFileGetMetadataInternal(tmp, buf, headerLen, NULL) < 0)
        goto cleanup;

4993 4994 4995
    VIR_STEAL_PTR(*backing, tmp->backingStoreRaw);

    ret = 0;
4996 4997 4998 4999 5000 5001 5002

 cleanup:
    VIR_FREE(buf);
    virStorageSourceFree(tmp);

    return ret;
}