storage_backend_fs.c 48.8 KB
Newer Older
1 2 3
/*
 * storage_backend_fs.c: storage backend for FS and directory handling
 *
4
 * Copyright (C) 2007-2015 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17
 * Copyright (C) 2007-2008 Daniel P. Berrange
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
18
 * License along with this library.  If not, see
O
Osier Yang 已提交
19
 * <http://www.gnu.org/licenses/>.
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
 *
 * Author: Daniel P. Berrange <berrange@redhat.com>
 */

#include <config.h>

#include <sys/statvfs.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <stdio.h>
#include <dirent.h>
#include <errno.h>
#include <fcntl.h>
#include <unistd.h>
#include <string.h>

36 37 38 39
#include <libxml/parser.h>
#include <libxml/tree.h>
#include <libxml/xpath.h>

40
#include "virerror.h"
41
#include "storage_backend_fs.h"
42
#include "storage_util.h"
43
#include "storage_conf.h"
44
#include "virstoragefile.h"
45
#include "vircommand.h"
46
#include "viralloc.h"
47
#include "virxml.h"
E
Eric Blake 已提交
48
#include "virfile.h"
49
#include "virlog.h"
50
#include "virstring.h"
51

52
#define VIR_FROM_THIS VIR_FROM_STORAGE
53

54 55
VIR_LOG_INIT("storage.storage_backend_fs");

56 57 58 59
#define VIR_STORAGE_VOL_FS_OPEN_FLAGS    (VIR_STORAGE_VOL_OPEN_DEFAULT | \
                                          VIR_STORAGE_VOL_OPEN_DIR)
#define VIR_STORAGE_VOL_FS_PROBE_FLAGS   (VIR_STORAGE_VOL_FS_OPEN_FLAGS | \
                                          VIR_STORAGE_VOL_OPEN_NOERROR)
60

61
static int
62
virStorageBackendProbeTarget(virStorageSourcePtr target,
63 64
                             virStorageEncryptionPtr *encryption)
{
65
    int backingStoreFormat;
66 67
    int fd = -1;
    int ret = -1;
68
    int rc;
69
    virStorageSourcePtr meta = NULL;
E
Eric Blake 已提交
70
    struct stat sb;
71 72 73 74

    if (encryption)
        *encryption = NULL;

75 76 77 78
    if ((rc = virStorageBackendVolOpen(target->path, &sb,
                                       VIR_STORAGE_VOL_FS_PROBE_FLAGS)) < 0)
        return rc; /* Take care to propagate rc, it is not always -1 */
    fd = rc;
79

80
    if (virStorageBackendUpdateVolTargetInfoFD(target, fd, &sb) < 0)
81
        goto cleanup;
82

83
    if (S_ISDIR(sb.st_mode)) {
84 85 86 87 88 89 90 91 92
        if (virStorageBackendIsPloopDir(target->path)) {
            if (virStorageBackendRedoPloopUpdate(target, &sb, &fd,
                                                 VIR_STORAGE_VOL_FS_PROBE_FLAGS) < 0)
                goto cleanup;
        } else {
            target->format = VIR_STORAGE_FILE_DIR;
            ret = 0;
            goto cleanup;
        }
93
    }
94

95 96 97
    if (!(meta = virStorageFileGetMetadataFromFD(target->path,
                                                 fd,
                                                 VIR_STORAGE_FILE_AUTO,
98
                                                 &backingStoreFormat)))
99
        goto cleanup;
100

101
    if (meta->backingStoreRaw) {
102
        if (!(target->backingStore = virStorageSourceNewFromBacking(meta)))
103 104 105 106
            goto cleanup;

        target->backingStore->format = backingStoreFormat;

107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
        /* XXX: Remote storage doesn't play nicely with volumes backed by
         * remote storage. To avoid trouble, just fake the backing store is RAW
         * and put the string from the metadata as the path of the target. */
        if (!virStorageSourceIsLocalStorage(target->backingStore)) {
            virStorageSourceFree(target->backingStore);

            if (VIR_ALLOC(target->backingStore) < 0)
                goto cleanup;

            target->backingStore->type = VIR_STORAGE_TYPE_NETWORK;
            target->backingStore->path = meta->backingStoreRaw;
            meta->backingStoreRaw = NULL;
            target->backingStore->format = VIR_STORAGE_FILE_RAW;
        }

122
        if (target->backingStore->format == VIR_STORAGE_FILE_AUTO) {
123
            if ((rc = virStorageFileProbeFormat(target->backingStore->path,
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
                                                -1, -1)) < 0) {
                /* If the backing file is currently unavailable or is
                 * accessed via remote protocol only log an error, fake the
                 * format as RAW and continue. Returning -1 here would
                 * disable the whole storage pool, making it unavailable for
                 * even maintenance. */
                target->backingStore->format = VIR_STORAGE_FILE_RAW;
                virReportError(VIR_ERR_INTERNAL_ERROR,
                               _("cannot probe backing volume format: %s"),
                               target->backingStore->path);
            } else {
                target->backingStore->format = rc;
            }
        }
    }
139

J
Ján Tomko 已提交
140 141
    target->format = meta->format;

142 143
    /* Default to success below this point */
    ret = 0;
144

145
    if (meta->capacity)
146
        target->capacity = meta->capacity;
147

148
    if (encryption && meta->encryption) {
149 150
        *encryption = meta->encryption;
        meta->encryption = NULL;
151 152

        /* XXX ideally we'd fill in secret UUID here
E
Eric Blake 已提交
153
         * but we cannot guarantee 'conn' is non-NULL
154 155 156 157 158
         * at this point in time :-(  So we only fill
         * in secrets when someone first queries a vol
         */
    }

159
    virBitmapFree(target->features);
160 161
    target->features = meta->features;
    meta->features = NULL;
162

163
    if (meta->compat) {
164 165 166 167 168
        VIR_FREE(target->compat);
        target->compat = meta->compat;
        meta->compat = NULL;
    }

169
 cleanup:
170
    VIR_FORCE_CLOSE(fd);
171
    virStorageSourceFree(meta);
172 173
    return ret;

174 175 176
}

#if WITH_STORAGE_FS
177

178
# include <mntent.h>
179

180 181
struct _virNetfsDiscoverState {
    const char *host;
182
    virStoragePoolSourceList list;
183 184 185 186 187
};

typedef struct _virNetfsDiscoverState virNetfsDiscoverState;

static int
188
virStorageBackendFileSystemNetFindPoolSourcesFunc(char **const groups,
189 190 191 192
                                                  void *data)
{
    virNetfsDiscoverState *state = data;
    const char *name, *path;
193 194
    virStoragePoolSource *src = NULL;
    int ret = -1;
195 196 197

    path = groups[0];

198
    if (!(name = strrchr(path, '/'))) {
199 200
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("invalid netfs path (no /): %s"), path);
201
        goto cleanup;
202 203 204
    }
    name += 1;
    if (*name == '\0') {
205 206
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("invalid netfs path (ends in /): %s"), path);
207
        goto cleanup;
208 209
    }

210
    if (!(src = virStoragePoolSourceListNewSource(&state->list)))
211
        goto cleanup;
212

213
    if (VIR_ALLOC_N(src->hosts, 1) < 0)
214
        goto cleanup;
215
    src->nhost = 1;
216

217 218
    if (VIR_STRDUP(src->hosts[0].name, state->host) < 0 ||
        VIR_STRDUP(src->dir, path) < 0)
219
        goto cleanup;
220
    src->format = VIR_STORAGE_POOL_NETFS_NFS;
221

222
    ret = 0;
223
 cleanup:
224
    return ret;
225 226
}

227

228
static int
229
virStorageBackendFileSystemNetFindNFSPoolSources(virNetfsDiscoverState *state)
230
{
231 232
    int ret = -1;

233 234 235 236 237 238 239 240 241 242 243 244 245 246
    /*
     *  # showmount --no-headers -e HOSTNAME
     *  /tmp   *
     *  /A dir demo1.foo.bar,demo2.foo.bar
     *
     * Extract directory name (including possible interior spaces ...).
     */

    const char *regexes[] = {
        "^(/.*\\S) +\\S+$"
    };
    int vars[] = {
        1
    };
247 248 249 250 251 252 253 254 255 256 257

    virCommandPtr cmd = NULL;

    cmd = virCommandNewArgList(SHOWMOUNT,
                               "--no-headers",
                               "--exports",
                               state->host,
                               NULL);

    if (virCommandRunRegex(cmd, 1, regexes, vars,
                           virStorageBackendFileSystemNetFindPoolSourcesFunc,
258
                           state, NULL, NULL) < 0)
259
        goto cleanup;
260

261 262 263
    ret = 0;

 cleanup:
264
    virCommandFree(cmd);
265
    return ret;
266 267 268 269 270 271 272 273
}


static char *
virStorageBackendFileSystemNetFindPoolSources(virConnectPtr conn ATTRIBUTE_UNUSED,
                                              const char *srcSpec,
                                              unsigned int flags)
{
274 275 276 277 278 279 280 281
    virNetfsDiscoverState state = {
        .host = NULL,
        .list = {
            .type = VIR_STORAGE_POOL_NETFS,
            .nsources = 0,
            .sources = NULL
        }
    };
282
    virStoragePoolSourcePtr source = NULL;
283
    char *ret = NULL;
284
    size_t i;
285 286
    int retNFS = -1;
    int retGluster = 0;
287

E
Eric Blake 已提交
288 289
    virCheckFlags(0, NULL);

290
    if (!srcSpec) {
291 292
        virReportError(VIR_ERR_INVALID_ARG, "%s",
                       _("hostname must be specified for netfs sources"));
293 294 295 296 297 298
        return NULL;
    }

    if (!(source = virStoragePoolDefParseSourceString(srcSpec,
                                                      VIR_STORAGE_POOL_NETFS)))
        return NULL;
299

300
    if (source->nhost != 1) {
301 302
        virReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s",
                       _("Expected exactly 1 host for the storage pool"));
303 304 305 306
        goto cleanup;
    }

    state.host = source->hosts[0].name;
307

308
    retNFS = virStorageBackendFileSystemNetFindNFSPoolSources(&state);
309

310 311
    retGluster = virStorageBackendFindGlusterPoolSources(state.host,
                                                         VIR_STORAGE_POOL_NETFS_GLUSTERFS,
312
                                                         &state.list, false);
313 314 315 316

    if (retGluster < 0)
        goto cleanup;

317
    /* If both fail, then we won't return an empty list - return an error */
318 319 320 321
    if (retNFS < 0 && retGluster == 0) {
        virReportError(VIR_ERR_OPERATION_FAILED,
                       _("no storage pools were found on host '%s'"),
                       state.host);
322
        goto cleanup;
323
    }
324

325
    if (!(ret = virStoragePoolSourceListFormat(&state.list)))
326 327 328
        goto cleanup;

 cleanup:
329
    for (i = 0; i < state.list.nsources; i++)
330 331
        virStoragePoolSourceClear(&state.list.sources[i]);
    VIR_FREE(state.list.sources);
332

333
    virStoragePoolSourceFree(source);
334
    return ret;
335 336
}

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
/**
 * @pool storage pool to check FS types
 *
 * Determine if storage pool FS types are properly set up
 *
 * Return 0 if everything's OK, -1 on error
 */
static int
virStorageBackendFileSystemIsValid(virStoragePoolObjPtr pool)
{
    if (pool->def->type == VIR_STORAGE_POOL_NETFS) {
        if (pool->def->source.nhost != 1) {
            virReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s",
                           _("expected exactly 1 host for the storage pool"));
            return -1;
        }
        if (pool->def->source.hosts[0].name == NULL) {
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           "%s", _("missing source host"));
            return -1;
        }
        if (pool->def->source.dir == NULL) {
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           "%s", _("missing source path"));
            return -1;
        }
    } else {
        if (pool->def->source.ndevice != 1) {
365 366 367 368 369 370 371
            if (pool->def->source.ndevice == 0)
                virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                               _("missing source device"));
            else
                virReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s",
                               _("expected exactly 1 device for the "
                                 "storage pool"));
372 373 374 375 376
            return -1;
        }
    }
    return 0;
}
377

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410

/**
 * virStorageBackendFileSystemGetPoolSource
 * @pool: storage pool object pointer
 *
 * Allocate/return a string representing the FS storage pool source.
 * It is up to the caller to VIR_FREE the allocated string
 */
static char *
virStorageBackendFileSystemGetPoolSource(virStoragePoolObjPtr pool)
{
    char *src = NULL;

    if (pool->def->type == VIR_STORAGE_POOL_NETFS) {
        if (pool->def->source.format == VIR_STORAGE_POOL_NETFS_CIFS) {
            if (virAsprintf(&src, "//%s/%s",
                            pool->def->source.hosts[0].name,
                            pool->def->source.dir) < 0)
                return NULL;
        } else {
            if (virAsprintf(&src, "%s:%s",
                            pool->def->source.hosts[0].name,
                            pool->def->source.dir) < 0)
                return NULL;
        }
    } else {
        if (VIR_STRDUP(src, pool->def->source.devices[0].path) < 0)
            return NULL;
    }
    return src;
}


411 412 413 414 415 416 417 418
/**
 * @pool storage pool to check for status
 *
 * Determine if a storage pool is already mounted
 *
 * Return 0 if not mounted, 1 if mounted, -1 on error
 */
static int
419 420
virStorageBackendFileSystemIsMounted(virStoragePoolObjPtr pool)
{
421
    int ret = -1;
422
    char *src = NULL;
423
    FILE *mtab;
424 425
    struct mntent ent;
    char buf[1024];
426 427

    if ((mtab = fopen(_PATH_MOUNTED, "r")) == NULL) {
428
        virReportSystemError(errno,
429 430
                             _("cannot read mount list '%s'"),
                             _PATH_MOUNTED);
431
        goto cleanup;
432 433
    }

434
    while ((getmntent_r(mtab, &ent, buf, sizeof(buf))) != NULL) {
435 436 437 438 439
        if (!(src = virStorageBackendFileSystemGetPoolSource(pool)))
            goto cleanup;

        if (STREQ(ent.mnt_dir, pool->def->target.path) &&
            STREQ(ent.mnt_fsname, src)) {
440 441
            ret = 1;
            goto cleanup;
442
        }
443 444

        VIR_FREE(src);
445 446
    }

447 448 449
    ret = 0;

 cleanup:
450
    VIR_FORCE_FCLOSE(mtab);
451
    VIR_FREE(src);
452
    return ret;
453 454 455 456 457 458 459 460 461 462 463
}

/**
 * @pool storage pool to mount
 *
 * Ensure that a FS storage pool is mounted on its target location.
 * If already mounted, this is a no-op
 *
 * Returns 0 if successfully mounted, -1 on error
 */
static int
464 465
virStorageBackendFileSystemMount(virStoragePoolObjPtr pool)
{
466
    char *src = NULL;
467 468 469
    /* 'mount -t auto' doesn't seem to auto determine nfs (or cifs),
     *  while plain 'mount' does. We have to craft separate argvs to
     *  accommodate this */
470 471 472 473
    bool netauto = (pool->def->type == VIR_STORAGE_POOL_NETFS &&
                    pool->def->source.format == VIR_STORAGE_POOL_NETFS_AUTO);
    bool glusterfs = (pool->def->type == VIR_STORAGE_POOL_NETFS &&
                      pool->def->source.format == VIR_STORAGE_POOL_NETFS_GLUSTERFS);
474 475
    bool cifsfs = (pool->def->type == VIR_STORAGE_POOL_NETFS &&
                   pool->def->source.format == VIR_STORAGE_POOL_NETFS_CIFS);
476 477
    virCommandPtr cmd = NULL;
    int ret = -1;
478
    int rc;
479

480 481
    if (virStorageBackendFileSystemIsValid(pool) < 0)
        return -1;
482

J
Jim Meyering 已提交
483
    /* Short-circuit if already mounted */
484 485 486 487 488 489
    if ((rc = virStorageBackendFileSystemIsMounted(pool)) != 0) {
        if (rc == 1) {
            virReportError(VIR_ERR_OPERATION_INVALID,
                           _("Target '%s' is already mounted"),
                           pool->def->target.path);
        }
490
        return -1;
491 492
    }

493 494
    if (!(src = virStorageBackendFileSystemGetPoolSource(pool)))
        return -1;
495

496 497 498 499 500 501
    if (netauto)
        cmd = virCommandNewArgList(MOUNT,
                                   src,
                                   pool->def->target.path,
                                   NULL);
    else if (glusterfs)
502 503
        cmd = virCommandNewArgList(MOUNT,
                                   "-t",
504
                                   virStoragePoolFormatFileSystemNetTypeToString(pool->def->source.format),
505 506 507 508 509
                                   src,
                                   "-o",
                                   "direct-io-mode=1",
                                   pool->def->target.path,
                                   NULL);
510 511 512 513 514 515 516 517 518
    else if (cifsfs)
        cmd = virCommandNewArgList(MOUNT,
                                   "-t",
                                   virStoragePoolFormatFileSystemNetTypeToString(pool->def->source.format),
                                   src,
                                   pool->def->target.path,
                                   "-o",
                                   "guest",
                                   NULL);
519 520 521 522 523 524 525 526 527 528 529 530 531 532
    else
        cmd = virCommandNewArgList(MOUNT,
                                   "-t",
                                   (pool->def->type == VIR_STORAGE_POOL_FS ?
                                    virStoragePoolFormatFileSystemTypeToString(pool->def->source.format) :
                                    virStoragePoolFormatFileSystemNetTypeToString(pool->def->source.format)),
                                   src,
                                   pool->def->target.path,
                                   NULL);

    if (virCommandRun(cmd, NULL) < 0)
        goto cleanup;

    ret = 0;
533
 cleanup:
534
    virCommandFree(cmd);
535
    VIR_FREE(src);
536
    return ret;
537 538 539 540 541 542
}

/**
 * @pool storage pool to unmount
 *
 * Ensure that a FS storage pool is not mounted on its target location.
543
 * If already unmounted, this is a no-op.
544 545 546 547
 *
 * Returns 0 if successfully unmounted, -1 on error
 */
static int
548 549
virStorageBackendFileSystemUnmount(virStoragePoolObjPtr pool)
{
550 551
    virCommandPtr cmd = NULL;
    int ret = -1;
552
    int rc;
553

554 555
    if (virStorageBackendFileSystemIsValid(pool) < 0)
        return -1;
556 557

    /* Short-circuit if already unmounted */
558 559
    if ((rc = virStorageBackendFileSystemIsMounted(pool)) != 1)
        return rc;
560

561 562 563
    cmd = virCommandNewArgList(UMOUNT,
                               pool->def->target.path,
                               NULL);
564

565 566 567 568
    if (virCommandRun(cmd, NULL) < 0)
        goto cleanup;

    ret = 0;
569
 cleanup:
570 571
    virCommandFree(cmd);
    return ret;
572 573 574 575
}
#endif /* WITH_STORAGE_FS */


576
static int
577
virStorageBackendFileSystemCheck(virStoragePoolObjPtr pool,
578 579 580
                                 bool *isActive)
{
    if (pool->def->type == VIR_STORAGE_POOL_DIR) {
581
        *isActive = virFileExists(pool->def->target.path);
582 583 584
#if WITH_STORAGE_FS
    } else {
        int ret;
585
        *isActive = false;
586 587 588 589

        if (virStorageBackendFileSystemIsValid(pool) < 0)
            return -1;

590 591 592 593 594 595 596 597 598 599 600 601
        if ((ret = virStorageBackendFileSystemIsMounted(pool)) != 0) {
            if (ret < 0)
                return -1;
            *isActive = true;
        }
#endif /* WITH_STORAGE_FS */
    }

    return 0;
}

#if WITH_STORAGE_FS
602 603 604 605
/**
 * @conn connection to report errors against
 * @pool storage pool to start
 *
606 607
 * Starts a directory or FS based storage pool.  The underlying source
 * device will be mounted for FS based pools.
608 609 610 611
 *
 * Returns 0 on success, -1 on error
 */
static int
612
virStorageBackendFileSystemStart(virConnectPtr conn ATTRIBUTE_UNUSED,
613 614
                                 virStoragePoolObjPtr pool)
{
615 616
    if (pool->def->type != VIR_STORAGE_POOL_DIR &&
        virStorageBackendFileSystemMount(pool) < 0)
617 618 619 620 621 622
        return -1;

    return 0;
}
#endif /* WITH_STORAGE_FS */

O
Osier Yang 已提交
623

624 625
/* some platforms don't support mkfs */
#ifdef MKFS
O
Osier Yang 已提交
626 627 628 629 630 631 632
static int
virStorageBackendExecuteMKFS(const char *device,
                             const char *format)
{
    int ret = 0;
    virCommandPtr cmd = NULL;

J
Ján Tomko 已提交
633 634
    cmd = virCommandNewArgList(MKFS, "-t", format, NULL);

635 636 637
    /* use the force, otherwise mkfs.xfs won't overwrite existing fs.
     * Similarly mkfs.ext2, mkfs.ext3, and mkfs.ext4 require supplying -F
     * and mkfs.vfat uses -I */
J
Ján Tomko 已提交
638 639
    if (STREQ(format, "xfs"))
        virCommandAddArg(cmd, "-f");
640 641 642 643 644 645
    else if (STREQ(format, "ext2") ||
             STREQ(format, "ext3") ||
             STREQ(format, "ext4"))
        virCommandAddArg(cmd, "-F");
    else if (STREQ(format, "vfat"))
        virCommandAddArg(cmd, "-I");
J
Ján Tomko 已提交
646 647

    virCommandAddArg(cmd, device);
O
Osier Yang 已提交
648 649 650 651 652 653 654 655

    if (virCommandRun(cmd, NULL) < 0) {
        virReportSystemError(errno,
                             _("Failed to make filesystem of "
                               "type '%s' on device '%s'"),
                             format, device);
        ret = -1;
    }
656 657

    virCommandFree(cmd);
O
Osier Yang 已提交
658 659
    return ret;
}
660 661 662 663 664
#else /* #ifdef MKFS */
static int
virStorageBackendExecuteMKFS(const char *device ATTRIBUTE_UNUSED,
                             const char *format ATTRIBUTE_UNUSED)
{
665 666 667 668 669
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   _("mkfs is not supported on this platform: "
                     "Failed to make filesystem of "
                     "type '%s' on device '%s'"),
                   format, device);
670 671 672
    return -1;
}
#endif /* #ifdef MKFS */
O
Osier Yang 已提交
673 674 675 676 677 678 679 680 681 682

static int
virStorageBackendMakeFileSystem(virStoragePoolObjPtr pool,
                                unsigned int flags)
{
    const char *device = NULL, *format = NULL;
    bool ok_to_mkfs = false;
    int ret = -1;

    if (pool->def->source.devices == NULL) {
683 684 685
        virReportError(VIR_ERR_OPERATION_INVALID,
                       _("No source device specified when formatting pool '%s'"),
                       pool->def->name);
O
Osier Yang 已提交
686 687 688 689 690 691 692 693
        goto error;
    }

    device = pool->def->source.devices[0].path;
    format = virStoragePoolFormatFileSystemTypeToString(pool->def->source.format);
    VIR_DEBUG("source device: '%s' format: '%s'", device, format);

    if (!virFileExists(device)) {
694 695 696
        virReportError(VIR_ERR_OPERATION_INVALID,
                       _("Source device does not exist when formatting pool '%s'"),
                       pool->def->name);
O
Osier Yang 已提交
697 698 699 700 701 702
        goto error;
    }

    if (flags & VIR_STORAGE_POOL_BUILD_OVERWRITE) {
        ok_to_mkfs = true;
    } else if (flags & VIR_STORAGE_POOL_BUILD_NO_OVERWRITE &&
703
               virStorageBackendDeviceIsEmpty(device, format, true)) {
O
Osier Yang 已提交
704 705 706
        ok_to_mkfs = true;
    }

707
    if (ok_to_mkfs)
O
Osier Yang 已提交
708 709
        ret = virStorageBackendExecuteMKFS(device, format);

710
 error:
O
Osier Yang 已提交
711 712 713
    return ret;
}

714 715 716 717

/**
 * @conn connection to report errors against
 * @pool storage pool to build
E
Eric Blake 已提交
718
 * @flags controls the pool formatting behaviour
719 720 721
 *
 * Build a directory or FS based storage pool.
 *
722 723 724 725 726 727 728 729 730
 * If no flag is set, it only makes the directory.
 *
 * If VIR_STORAGE_POOL_BUILD_NO_OVERWRITE set, it probes to determine if
 * any filesystem already exists on the target device, returning an error
 * if one exists. If no filesystem already exists, use mkfs to format the
 * target device.
 *
 * If VIR_STORAGE_POOL_BUILD_OVERWRITE is set, mkfs is always executed and
 * any existing data on the target device is overwritten unconditionally.
O
Osier Yang 已提交
731
 *
732
 * The underlying source device is mounted for FS based pools.
733 734 735 736
 *
 * Returns 0 on success, -1 on error
 */
static int
737
virStorageBackendFileSystemBuild(virConnectPtr conn ATTRIBUTE_UNUSED,
738
                                 virStoragePoolObjPtr pool,
E
Eric Blake 已提交
739
                                 unsigned int flags)
740
{
741
    int ret = -1;
O
Osier Yang 已提交
742 743
    char *parent = NULL;
    char *p = NULL;
744
    mode_t mode;
745 746
    bool needs_create_as_uid;
    unsigned int dir_create_flags;
747

O
Osier Yang 已提交
748 749 750
    virCheckFlags(VIR_STORAGE_POOL_BUILD_OVERWRITE |
                  VIR_STORAGE_POOL_BUILD_NO_OVERWRITE, ret);

751 752 753
    VIR_EXCLUSIVE_FLAGS_GOTO(VIR_STORAGE_POOL_BUILD_OVERWRITE,
                             VIR_STORAGE_POOL_BUILD_NO_OVERWRITE,
                             error);
E
Eric Blake 已提交
754

755
    if (VIR_STRDUP(parent, pool->def->target.path) < 0)
756 757
        goto error;
    if (!(p = strrchr(parent, '/'))) {
758 759 760
        virReportError(VIR_ERR_INVALID_ARG,
                       _("path '%s' is not absolute"),
                       pool->def->target.path);
761
        goto error;
762 763
    }

764 765 766 767
    if (p != parent) {
        /* assure all directories in the path prior to the final dir
         * exist, with default uid/gid/mode. */
        *p = '\0';
768 769
        if (virFileMakePath(parent) < 0) {
            virReportSystemError(errno, _("cannot create path '%s'"),
770 771 772 773 774
                                 parent);
            goto error;
        }
    }

775 776 777 778 779 780 781 782
    dir_create_flags = VIR_DIR_CREATE_ALLOW_EXIST;
    needs_create_as_uid = (pool->def->type == VIR_STORAGE_POOL_NETFS);
    mode = pool->def->target.perms.mode;

    if (mode == (mode_t) -1 &&
        (needs_create_as_uid || !virFileExists(pool->def->target.path)))
        mode = VIR_STORAGE_DEFAULT_POOL_PERM_MODE;
    if (needs_create_as_uid)
783
        dir_create_flags |= VIR_DIR_CREATE_AS_UID;
784

785 786 787
    /* Now create the final dir in the path with the uid/gid/mode
     * requested in the config. If the dir already exists, just set
     * the perms. */
788 789 790 791 792
    if (virDirCreate(pool->def->target.path,
                     mode,
                     pool->def->target.perms.uid,
                     pool->def->target.perms.gid,
                     dir_create_flags) < 0)
793
        goto error;
O
Osier Yang 已提交
794 795 796 797 798 799 800

    if (flags != 0) {
        ret = virStorageBackendMakeFileSystem(pool, flags);
    } else {
        ret = 0;
    }

801
 error:
802 803
    VIR_FREE(parent);
    return ret;
804 805 806 807 808 809 810 811
}


/**
 * Iterate over the pool's directory and enumerate all disk images
 * within it. This is non-recursive.
 */
static int
812
virStorageBackendFileSystemRefresh(virConnectPtr conn ATTRIBUTE_UNUSED,
813 814 815 816 817
                                   virStoragePoolObjPtr pool)
{
    DIR *dir;
    struct dirent *ent;
    struct statvfs sb;
818
    struct stat statbuf;
819
    virStorageVolDefPtr vol = NULL;
820
    virStorageSourcePtr target = NULL;
E
Eric Blake 已提交
821
    int direrr;
822
    int fd = -1, ret = -1;
823

J
Ján Tomko 已提交
824
    if (virDirOpen(&dir, pool->def->target.path) < 0)
825
        goto cleanup;
826

E
Eric Blake 已提交
827
    while ((direrr = virDirRead(dir, &ent, pool->def->target.path)) > 0) {
828
        int err;
829

830 831 832 833 834 835
        if (virStringHasControlChars(ent->d_name)) {
            VIR_WARN("Ignoring file with control characters under '%s'",
                     pool->def->target.path);
            continue;
        }

836
        if (VIR_ALLOC(vol) < 0)
837
            goto cleanup;
838

839
        if (VIR_STRDUP(vol->name, ent->d_name) < 0)
840
            goto cleanup;
841

842
        vol->type = VIR_STORAGE_VOL_FILE;
843
        vol->target.format = VIR_STORAGE_FILE_RAW; /* Real value is filled in during probe */
844 845 846
        if (virAsprintf(&vol->target.path, "%s/%s",
                        pool->def->target.path,
                        vol->name) == -1)
847
            goto cleanup;
848

849
        if (VIR_STRDUP(vol->key, vol->target.path) < 0)
850
            goto cleanup;
851

852
        if ((err = virStorageBackendProbeTarget(&vol->target,
853
                                                &vol->target.encryption)) < 0) {
854
            if (err == -2) {
855
                /* Silently ignore non-regular files,
856
                 * eg 'lost+found', dangling symbolic link */
857 858
                virStorageVolDefFree(vol);
                vol = NULL;
859
                continue;
860
            } else if (err == -3) {
861 862 863 864 865
                /* The backing file is currently unavailable, its format is not
                 * explicitly specified, the probe to auto detect the format
                 * failed: continue with faked RAW format, since AUTO will
                 * break virStorageVolTargetDefFormat() generating the line
                 * <format type='...'/>. */
866
            } else {
867
                goto cleanup;
868
            }
869 870
        }

871 872 873 874
        /* directory based volume */
        if (vol->target.format == VIR_STORAGE_FILE_DIR)
            vol->type = VIR_STORAGE_VOL_DIR;

875 876 877
        if (vol->target.format == VIR_STORAGE_FILE_PLOOP)
            vol->type = VIR_STORAGE_VOL_PLOOP;

878
        if (vol->target.backingStore) {
879 880
            ignore_value(virStorageBackendUpdateVolTargetInfo(VIR_STORAGE_VOL_FILE,
                                                              vol->target.backingStore,
881
                                                              false,
882
                                                              VIR_STORAGE_VOL_OPEN_DEFAULT, 0));
883 884 885
            /* If this failed, the backing file is currently unavailable,
             * the capacity, allocation, owner, group and mode are unknown.
             * An error message was raised, but we just continue. */
886 887
        }

888
        if (VIR_APPEND_ELEMENT(pool->volumes.objs, pool->volumes.count, vol) < 0)
889
            goto cleanup;
890
    }
E
Eric Blake 已提交
891
    if (direrr < 0)
892
        goto cleanup;
J
Ján Tomko 已提交
893
    VIR_DIR_CLOSE(dir);
894
    vol = NULL;
895

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
    if (VIR_ALLOC(target))
        goto cleanup;

    if ((fd = open(pool->def->target.path, O_RDONLY)) < 0) {
        virReportSystemError(errno,
                             _("cannot open path '%s'"),
                             pool->def->target.path);
        goto cleanup;
    }

    if (fstat(fd, &statbuf) < 0) {
        virReportSystemError(errno,
                             _("cannot stat path '%s'"),
                             pool->def->target.path);
        goto cleanup;
    }

    if (virStorageBackendUpdateVolTargetInfoFD(target, fd, &statbuf) < 0)
        goto cleanup;

    /* VolTargetInfoFD doesn't update capacity correctly for the pool case */
917
    if (statvfs(pool->def->target.path, &sb) < 0) {
918
        virReportSystemError(errno,
919 920
                             _("cannot statvfs path '%s'"),
                             pool->def->target.path);
921
        goto cleanup;
922
    }
923

924 925 926
    pool->def->capacity = ((unsigned long long)sb.f_frsize *
                           (unsigned long long)sb.f_blocks);
    pool->def->available = ((unsigned long long)sb.f_bfree *
927
                            (unsigned long long)sb.f_frsize);
928 929
    pool->def->allocation = pool->def->capacity - pool->def->available;

930 931 932 933 934 935
    pool->def->target.perms.mode = target->perms->mode;
    pool->def->target.perms.uid = target->perms->uid;
    pool->def->target.perms.gid = target->perms->gid;
    VIR_FREE(pool->def->target.perms.label);
    if (VIR_STRDUP(pool->def->target.perms.label, target->perms->label) < 0)
        goto cleanup;
936

937 938
    ret = 0;
 cleanup:
J
Ján Tomko 已提交
939
    VIR_DIR_CLOSE(dir);
940
    VIR_FORCE_CLOSE(fd);
941
    virStorageVolDefFree(vol);
942 943 944 945
    virStorageSourceFree(target);
    if (ret < 0)
        virStoragePoolObjClearVols(pool);
    return ret;
946 947 948 949 950
}


/**
 * @conn connection to report errors against
951
 * @pool storage pool to stop
952
 *
953 954
 * Stops a file storage pool.  The underlying source device is unmounted
 * for FS based pools.  Any cached data about volumes is released.
955
 *
956
 * Returns 0 on success, -1 on error.
957 958 959
 */
#if WITH_STORAGE_FS
static int
960
virStorageBackendFileSystemStop(virConnectPtr conn ATTRIBUTE_UNUSED,
961 962
                                virStoragePoolObjPtr pool)
{
963
    if (virStorageBackendFileSystemUnmount(pool) < 0)
964 965 966 967 968 969 970 971 972
        return -1;

    return 0;
}
#endif /* WITH_STORAGE_FS */


/**
 * @conn connection to report errors against
973
 * @pool storage pool to delete
974
 *
975
 * Delete a directory based storage pool
976 977 978 979
 *
 * Returns 0 on success, -1 on error
 */
static int
980
virStorageBackendFileSystemDelete(virConnectPtr conn ATTRIBUTE_UNUSED,
981
                                  virStoragePoolObjPtr pool,
E
Eric Blake 已提交
982
                                  unsigned int flags)
983
{
E
Eric Blake 已提交
984 985
    virCheckFlags(0, -1);

986 987
    /* XXX delete all vols first ? */

988
    if (rmdir(pool->def->target.path) < 0) {
989
        virReportSystemError(errno,
990
                             _("failed to remove pool '%s'"),
991
                             pool->def->target.path);
992 993 994 995 996 997 998 999
        return -1;
    }

    return 0;
}


/**
1000 1001 1002 1003
 * Set up a volume definition to be added to a pool's volume list, but
 * don't do any file creation or allocation. By separating the two processes,
 * we allow allocation progress reporting (by polling the volume's 'info'
 * function), and can drop the parent pool lock during the (slow) allocation.
1004 1005
 */
static int
1006
virStorageBackendFileSystemVolCreate(virConnectPtr conn ATTRIBUTE_UNUSED,
1007 1008 1009 1010
                                     virStoragePoolObjPtr pool,
                                     virStorageVolDefPtr vol)
{

1011 1012
    if (vol->target.format == VIR_STORAGE_FILE_DIR)
        vol->type = VIR_STORAGE_VOL_DIR;
O
Olga Krishtal 已提交
1013 1014
    else if (vol->target.format == VIR_STORAGE_FILE_PLOOP)
        vol->type = VIR_STORAGE_VOL_PLOOP;
1015 1016
    else
        vol->type = VIR_STORAGE_VOL_FILE;
1017

1018 1019 1020 1021 1022 1023 1024 1025
    /* Volumes within a directory pools are not recursive; do not
     * allow escape to ../ or a subdir */
    if (strchr(vol->name, '/')) {
        virReportError(VIR_ERR_OPERATION_INVALID,
                       _("volume name '%s' cannot contain '/'"), vol->name);
        return -1;
    }

R
Ryota Ozaki 已提交
1026
    VIR_FREE(vol->target.path);
1027 1028
    if (virAsprintf(&vol->target.path, "%s/%s",
                    pool->def->target.path,
1029
                    vol->name) == -1)
1030
        return -1;
1031

1032 1033 1034 1035 1036 1037 1038
    if (virFileExists(vol->target.path)) {
        virReportError(VIR_ERR_OPERATION_INVALID,
                       _("volume target path '%s' already exists"),
                       vol->target.path);
        return -1;
    }

R
Ryota Ozaki 已提交
1039
    VIR_FREE(vol->key);
1040
    return VIR_STRDUP(vol->key, vol->target.path);
1041 1042
}

1043
static int createFileDir(virConnectPtr conn ATTRIBUTE_UNUSED,
1044
                         virStoragePoolObjPtr pool,
1045
                         virStorageVolDefPtr vol,
1046
                         virStorageVolDefPtr inputvol,
E
Eric Blake 已提交
1047 1048
                         unsigned int flags)
{
1049 1050
    int err;

E
Eric Blake 已提交
1051 1052
    virCheckFlags(0, -1);

1053
    if (inputvol) {
1054 1055 1056
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       "%s",
                       _("cannot copy from volume to a directory volume"));
1057 1058 1059
        return -1;
    }

1060 1061 1062 1063 1064 1065 1066
    if (vol->target.backingStore) {
        virReportError(VIR_ERR_NO_SUPPORT, "%s",
                       _("backing storage not supported for directories volumes"));
        return -1;
    }


1067 1068 1069 1070
    if ((err = virDirCreate(vol->target.path,
                            (vol->target.perms->mode == (mode_t) -1 ?
                             VIR_STORAGE_DEFAULT_VOL_PERM_MODE :
                             vol->target.perms->mode),
1071 1072
                            vol->target.perms->uid,
                            vol->target.perms->gid,
1073
                            (pool->def->type == VIR_STORAGE_POOL_NETFS
1074
                             ? VIR_DIR_CREATE_AS_UID : 0))) < 0) {
1075 1076
        return -1;
    }
1077

1078 1079
    return 0;
}
1080

1081
static int
1082
_virStorageBackendFileSystemVolBuild(virConnectPtr conn,
1083
                                     virStoragePoolObjPtr pool,
1084
                                     virStorageVolDefPtr vol,
1085 1086
                                     virStorageVolDefPtr inputvol,
                                     unsigned int flags)
1087
{
1088
    virStorageBackendBuildVolFrom create_func;
1089

1090
    if (inputvol) {
1091
        if (vol->target.encryption != NULL) {
1092 1093 1094 1095
            virReportError(VIR_ERR_CONFIG_UNSUPPORTED,
                           "%s", _("storage pool does not support "
                                   "building encrypted volumes from "
                                   "other volumes"));
1096 1097
            return -1;
        }
1098
        create_func = virStorageBackendGetBuildVolFromFunction(vol,
1099
                                                               inputvol);
1100 1101
        if (!create_func)
            return -1;
1102 1103
    } else if (vol->target.format == VIR_STORAGE_FILE_RAW &&
               vol->target.encryption == NULL) {
1104
        create_func = virStorageBackendCreateRaw;
1105
    } else if (vol->target.format == VIR_STORAGE_FILE_DIR) {
1106
        create_func = createFileDir;
1107 1108
    } else if (vol->target.format == VIR_STORAGE_FILE_PLOOP) {
        create_func = virStorageBackendCreatePloop;
1109
    } else {
1110
        create_func = virStorageBackendCreateQemuImg;
1111 1112
    }

1113
    if (create_func(conn, pool, vol, inputvol, flags) < 0)
1114
        return -1;
1115 1116 1117
    return 0;
}

1118 1119
/**
 * Allocate a new file as a volume. This is either done directly
1120
 * for raw/sparse files, or by calling qemu-img for
1121 1122 1123 1124
 * special kinds of files
 */
static int
virStorageBackendFileSystemVolBuild(virConnectPtr conn,
1125
                                    virStoragePoolObjPtr pool,
1126
                                    virStorageVolDefPtr vol,
1127 1128
                                    unsigned int flags)
{
1129 1130 1131
    virCheckFlags(VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA |
                  VIR_STORAGE_VOL_CREATE_REFLINK,
                  -1);
1132 1133

    return _virStorageBackendFileSystemVolBuild(conn, pool, vol, NULL, flags);
1134 1135 1136 1137 1138 1139 1140
}

/*
 * Create a storage vol using 'inputvol' as input
 */
static int
virStorageBackendFileSystemVolBuildFrom(virConnectPtr conn,
1141
                                        virStoragePoolObjPtr pool,
1142 1143
                                        virStorageVolDefPtr vol,
                                        virStorageVolDefPtr inputvol,
E
Eric Blake 已提交
1144 1145
                                        unsigned int flags)
{
1146 1147 1148
    virCheckFlags(VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA |
                  VIR_STORAGE_VOL_CREATE_REFLINK,
                  -1);
E
Eric Blake 已提交
1149

1150
    return _virStorageBackendFileSystemVolBuild(conn, pool, vol, inputvol, flags);
1151
}
1152 1153

/**
1154
 * Remove a volume - no support for BLOCK and NETWORK yet
1155 1156
 */
static int
1157
virStorageBackendFileSystemVolDelete(virConnectPtr conn ATTRIBUTE_UNUSED,
1158 1159
                                     virStoragePoolObjPtr pool ATTRIBUTE_UNUSED,
                                     virStorageVolDefPtr vol,
E
Eric Blake 已提交
1160
                                     unsigned int flags)
1161
{
E
Eric Blake 已提交
1162 1163
    virCheckFlags(0, -1);

1164
    switch ((virStorageVolType) vol->type) {
1165
    case VIR_STORAGE_VOL_FILE:
1166 1167
    case VIR_STORAGE_VOL_DIR:
        if (virFileRemove(vol->target.path, vol->target.perms->uid,
J
John Ferlan 已提交
1168
                          vol->target.perms->gid) < 0) {
1169 1170
            /* Silently ignore failures where the vol has already gone away */
            if (errno != ENOENT) {
1171 1172 1173 1174 1175 1176 1177 1178
                if (vol->type == VIR_STORAGE_VOL_FILE)
                    virReportSystemError(errno,
                                         _("cannot unlink file '%s'"),
                                         vol->target.path);
                else
                    virReportSystemError(errno,
                                         _("cannot remove directory '%s'"),
                                         vol->target.path);
1179 1180 1181 1182
                return -1;
            }
        }
        break;
O
Olga Krishtal 已提交
1183
    case VIR_STORAGE_VOL_PLOOP:
1184 1185 1186
        if (virFileDeleteTree(vol->target.path) < 0)
            return -1;
        break;
1187 1188
    case VIR_STORAGE_VOL_BLOCK:
    case VIR_STORAGE_VOL_NETWORK:
1189 1190
    case VIR_STORAGE_VOL_NETDIR:
    case VIR_STORAGE_VOL_LAST:
1191 1192 1193
        virReportError(VIR_ERR_NO_SUPPORT,
                       _("removing block or network volumes is not supported: %s"),
                       vol->target.path);
1194
        return -1;
1195 1196 1197 1198 1199
    }
    return 0;
}


1200 1201 1202 1203
/* virStorageBackendFileSystemLoadDefaultSecrets:
 * @conn: Connection pointer to fetch secret
 * @vol: volume being refreshed
 *
1204 1205
 * If the volume had a secret generated, we need to regenerate the
 * encryption secret information
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
 *
 * Returns 0 if no secret or secret setup was successful,
 * -1 on failures w/ error message set
 */
static int
virStorageBackendFileSystemLoadDefaultSecrets(virConnectPtr conn,
                                              virStorageVolDefPtr vol)
{
    virSecretPtr sec;
    virStorageEncryptionSecretPtr encsec = NULL;

1217
    if (!vol->target.encryption || vol->target.encryption->nsecrets != 0)
1218 1219
        return 0;

1220 1221 1222 1223 1224 1225 1226
    /* The encryption secret for qcow2 and luks volumes use the path
     * to the volume, so look for a secret with the path. If not found,
     * then we cannot generate the secret after a refresh (or restart).
     * This may be the case if someone didn't follow instructions and created
     * a usage string that although matched with the secret usage string,
     * didn't contain the path to the volume. We won't error in that case,
     * but we also cannot find the secret. */
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
    if (!(sec = virSecretLookupByUsage(conn, VIR_SECRET_USAGE_TYPE_VOLUME,
                                       vol->target.path)))
        return 0;

    if (VIR_ALLOC_N(vol->target.encryption->secrets, 1) < 0 ||
        VIR_ALLOC(encsec) < 0) {
        VIR_FREE(vol->target.encryption->secrets);
        virObjectUnref(sec);
        return -1;
    }

    vol->target.encryption->nsecrets = 1;
    vol->target.encryption->secrets[0] = encsec;

    encsec->type = VIR_STORAGE_ENCRYPTION_SECRET_TYPE_PASSPHRASE;
J
John Ferlan 已提交
1242 1243
    encsec->seclookupdef.type = VIR_SECRET_LOOKUP_TYPE_UUID;
    virSecretGetUUID(sec, encsec->seclookupdef.u.uuid);
1244 1245 1246 1247 1248 1249
    virObjectUnref(sec);

    return 0;
}


1250 1251 1252 1253 1254 1255 1256 1257
/**
 * Update info about a volume's capacity/allocation
 */
static int
virStorageBackendFileSystemVolRefresh(virConnectPtr conn,
                                      virStoragePoolObjPtr pool ATTRIBUTE_UNUSED,
                                      virStorageVolDefPtr vol)
{
1258 1259
    int ret;

1260
    /* Refresh allocation / capacity / permissions info in case its changed */
1261 1262 1263
    if ((ret = virStorageBackendUpdateVolInfo(vol, false,
                                              VIR_STORAGE_VOL_FS_OPEN_FLAGS,
                                              0)) < 0)
1264 1265
        return ret;

N
Nehal J Wani 已提交
1266
    /* Load any secrets if possible */
1267
    return virStorageBackendFileSystemLoadDefaultSecrets(conn, vol);
1268 1269
}

1270 1271 1272 1273 1274 1275 1276 1277
static int
virStorageBackendFilesystemResizeQemuImg(const char *path,
                                         unsigned long long capacity)
{
    int ret = -1;
    char *img_tool;
    virCommandPtr cmd = NULL;

1278
    img_tool = virFindFileInPath("qemu-img");
1279
    if (!img_tool) {
1280
        virReportError(VIR_ERR_INTERNAL_ERROR,
1281
                       "%s", _("unable to find qemu-img"));
1282 1283 1284
        return -1;
    }

1285 1286 1287 1288
    /* Round capacity as qemu-img resize errors out on sizes which are not
     * a multiple of 512 */
    capacity = VIR_ROUND_UP(capacity, 512);

1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
    cmd = virCommandNew(img_tool);
    virCommandAddArgList(cmd, "resize", path, NULL);
    virCommandAddArgFormat(cmd, "%llu", capacity);

    ret = virCommandRun(cmd, NULL);

    VIR_FREE(img_tool);
    virCommandFree(cmd);

    return ret;
}

/**
 * Resize a volume
 */
static int
virStorageBackendFileSystemVolResize(virConnectPtr conn ATTRIBUTE_UNUSED,
                                     virStoragePoolObjPtr pool ATTRIBUTE_UNUSED,
                                     virStorageVolDefPtr vol,
                                     unsigned long long capacity,
                                     unsigned int flags)
{
1311 1312
    virCheckFlags(VIR_STORAGE_VOL_RESIZE_ALLOCATE |
                  VIR_STORAGE_VOL_RESIZE_SHRINK, -1);
1313 1314 1315 1316 1317

    bool pre_allocate = flags & VIR_STORAGE_VOL_RESIZE_ALLOCATE;

    if (vol->target.format == VIR_STORAGE_FILE_RAW) {
        return virStorageFileResize(vol->target.path, capacity,
1318
                                    vol->target.allocation, pre_allocate);
1319 1320
    } else if (vol->target.format == VIR_STORAGE_FILE_PLOOP) {
        return virStoragePloopResize(vol, capacity);
1321 1322 1323 1324 1325 1326 1327
    } else {
        if (pre_allocate) {
            virReportError(VIR_ERR_OPERATION_UNSUPPORTED, "%s",
                           _("preallocate is only supported for raw "
                             "type volume"));
            return -1;
        }
1328 1329 1330

        return virStorageBackendFilesystemResizeQemuImg(vol->target.path,
                                                        capacity);
1331
    }
1332 1333
}

1334

1335 1336 1337 1338
virStorageBackend virStorageBackendDirectory = {
    .type = VIR_STORAGE_POOL_DIR,

    .buildPool = virStorageBackendFileSystemBuild,
1339
    .checkPool = virStorageBackendFileSystemCheck,
1340 1341
    .refreshPool = virStorageBackendFileSystemRefresh,
    .deletePool = virStorageBackendFileSystemDelete,
1342
    .buildVol = virStorageBackendFileSystemVolBuild,
1343
    .buildVolFrom = virStorageBackendFileSystemVolBuildFrom,
1344 1345 1346
    .createVol = virStorageBackendFileSystemVolCreate,
    .refreshVol = virStorageBackendFileSystemVolRefresh,
    .deleteVol = virStorageBackendFileSystemVolDelete,
1347
    .resizeVol = virStorageBackendFileSystemVolResize,
1348 1349
    .uploadVol = virStorageBackendVolUploadLocal,
    .downloadVol = virStorageBackendVolDownloadLocal,
1350
    .wipeVol = virStorageBackendVolWipeLocal,
1351 1352 1353 1354 1355 1356 1357
};

#if WITH_STORAGE_FS
virStorageBackend virStorageBackendFileSystem = {
    .type = VIR_STORAGE_POOL_FS,

    .buildPool = virStorageBackendFileSystemBuild,
1358
    .checkPool = virStorageBackendFileSystemCheck,
1359 1360 1361 1362
    .startPool = virStorageBackendFileSystemStart,
    .refreshPool = virStorageBackendFileSystemRefresh,
    .stopPool = virStorageBackendFileSystemStop,
    .deletePool = virStorageBackendFileSystemDelete,
1363
    .buildVol = virStorageBackendFileSystemVolBuild,
1364
    .buildVolFrom = virStorageBackendFileSystemVolBuildFrom,
1365 1366 1367
    .createVol = virStorageBackendFileSystemVolCreate,
    .refreshVol = virStorageBackendFileSystemVolRefresh,
    .deleteVol = virStorageBackendFileSystemVolDelete,
1368
    .resizeVol = virStorageBackendFileSystemVolResize,
1369 1370
    .uploadVol = virStorageBackendVolUploadLocal,
    .downloadVol = virStorageBackendVolDownloadLocal,
1371
    .wipeVol = virStorageBackendVolWipeLocal,
1372 1373 1374 1375 1376
};
virStorageBackend virStorageBackendNetFileSystem = {
    .type = VIR_STORAGE_POOL_NETFS,

    .buildPool = virStorageBackendFileSystemBuild,
1377
    .checkPool = virStorageBackendFileSystemCheck,
1378
    .startPool = virStorageBackendFileSystemStart,
1379
    .findPoolSources = virStorageBackendFileSystemNetFindPoolSources,
1380 1381 1382
    .refreshPool = virStorageBackendFileSystemRefresh,
    .stopPool = virStorageBackendFileSystemStop,
    .deletePool = virStorageBackendFileSystemDelete,
1383
    .buildVol = virStorageBackendFileSystemVolBuild,
1384
    .buildVolFrom = virStorageBackendFileSystemVolBuildFrom,
1385 1386 1387
    .createVol = virStorageBackendFileSystemVolCreate,
    .refreshVol = virStorageBackendFileSystemVolRefresh,
    .deleteVol = virStorageBackendFileSystemVolDelete,
1388
    .resizeVol = virStorageBackendFileSystemVolResize,
1389 1390
    .uploadVol = virStorageBackendVolUploadLocal,
    .downloadVol = virStorageBackendVolDownloadLocal,
1391
    .wipeVol = virStorageBackendVolWipeLocal,
1392
};
1393
#endif /* WITH_STORAGE_FS */
1394 1395


1396 1397 1398 1399 1400 1401 1402 1403
typedef struct _virStorageFileBackendFsPriv virStorageFileBackendFsPriv;
typedef virStorageFileBackendFsPriv *virStorageFileBackendFsPrivPtr;

struct _virStorageFileBackendFsPriv {
    char *canonpath; /* unique file identifier (canonical path) */
};


1404 1405 1406 1407 1408 1409 1410
static void
virStorageFileBackendFileDeinit(virStorageSourcePtr src)
{
    VIR_DEBUG("deinitializing FS storage file %p (%s:%s)", src,
              virStorageTypeToString(virStorageSourceGetActualType(src)),
              src->path);

1411 1412 1413 1414
    virStorageFileBackendFsPrivPtr priv = src->drv->priv;

    VIR_FREE(priv->canonpath);
    VIR_FREE(priv);
1415 1416 1417
}


1418
static int
1419
virStorageFileBackendFileInit(virStorageSourcePtr src)
1420
{
1421 1422
    virStorageFileBackendFsPrivPtr priv = NULL;

1423
    VIR_DEBUG("initializing FS storage file %p (%s:%s)[%u:%u]", src,
1424
              virStorageTypeToString(virStorageSourceGetActualType(src)),
1425 1426
              src->path,
              (unsigned int)src->drv->uid, (unsigned int)src->drv->gid);
1427

1428 1429 1430 1431 1432
    if (VIR_ALLOC(priv) < 0)
        return -1;

    src->drv->priv = priv;

1433 1434
    return 0;
}
1435 1436


1437 1438 1439 1440
static int
virStorageFileBackendFileCreate(virStorageSourcePtr src)
{
    int fd = -1;
1441
    mode_t mode = S_IRUSR;
1442

1443 1444 1445 1446
    if (!src->readonly)
        mode |= S_IWUSR;

    if ((fd = virFileOpenAs(src->path, O_WRONLY | O_TRUNC | O_CREAT, mode,
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
                            src->drv->uid, src->drv->gid, 0)) < 0) {
        errno = -fd;
        return -1;
    }

    VIR_FORCE_CLOSE(fd);
    return 0;
}


1457 1458 1459 1460
static int
virStorageFileBackendFileUnlink(virStorageSourcePtr src)
{
    return unlink(src->path);
1461 1462 1463 1464
}


static int
1465
virStorageFileBackendFileStat(virStorageSourcePtr src,
1466 1467
                              struct stat *st)
{
1468
    return stat(src->path, st);
1469 1470 1471
}


1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499
static ssize_t
virStorageFileBackendFileReadHeader(virStorageSourcePtr src,
                                    ssize_t max_len,
                                    char **buf)
{
    int fd = -1;
    ssize_t ret = -1;

    if ((fd = virFileOpenAs(src->path, O_RDONLY, 0,
                            src->drv->uid, src->drv->gid, 0)) < 0) {
        virReportSystemError(-fd, _("Failed to open file '%s'"),
                             src->path);
        return -1;
    }

    if ((ret = virFileReadHeaderFD(fd, max_len, buf)) < 0) {
        virReportSystemError(errno,
                             _("cannot read header '%s'"), src->path);
        goto cleanup;
    }

 cleanup:
    VIR_FORCE_CLOSE(fd);

    return ret;
}


1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516
static const char *
virStorageFileBackendFileGetUniqueIdentifier(virStorageSourcePtr src)
{
    virStorageFileBackendFsPrivPtr priv = src->drv->priv;

    if (!priv->canonpath) {
        if (!(priv->canonpath = canonicalize_file_name(src->path))) {
            virReportSystemError(errno, _("can't canonicalize path '%s'"),
                                 src->path);
            return NULL;
        }
    }

    return priv->canonpath;
}


1517 1518 1519 1520 1521 1522 1523 1524 1525
static int
virStorageFileBackendFileAccess(virStorageSourcePtr src,
                                int mode)
{
    return virFileAccessibleAs(src->path, mode,
                               src->drv->uid, src->drv->gid);
}


1526
static int
1527
virStorageFileBackendFileChown(const virStorageSource *src,
1528 1529 1530 1531 1532 1533 1534
                               uid_t uid,
                               gid_t gid)
{
    return chown(src->path, uid, gid);
}


1535
virStorageFileBackend virStorageFileBackendFile = {
E
Eric Blake 已提交
1536
    .type = VIR_STORAGE_TYPE_FILE,
1537

1538 1539 1540
    .backendInit = virStorageFileBackendFileInit,
    .backendDeinit = virStorageFileBackendFileDeinit,

1541
    .storageFileCreate = virStorageFileBackendFileCreate,
1542 1543
    .storageFileUnlink = virStorageFileBackendFileUnlink,
    .storageFileStat = virStorageFileBackendFileStat,
1544
    .storageFileReadHeader = virStorageFileBackendFileReadHeader,
1545
    .storageFileAccess = virStorageFileBackendFileAccess,
1546
    .storageFileChown = virStorageFileBackendFileChown,
1547 1548

    .storageFileGetUniqueIdentifier = virStorageFileBackendFileGetUniqueIdentifier,
1549 1550 1551 1552
};


virStorageFileBackend virStorageFileBackendBlock = {
E
Eric Blake 已提交
1553
    .type = VIR_STORAGE_TYPE_BLOCK,
1554

1555 1556 1557
    .backendInit = virStorageFileBackendFileInit,
    .backendDeinit = virStorageFileBackendFileDeinit,

1558
    .storageFileStat = virStorageFileBackendFileStat,
1559
    .storageFileReadHeader = virStorageFileBackendFileReadHeader,
1560
    .storageFileAccess = virStorageFileBackendFileAccess,
1561
    .storageFileChown = virStorageFileBackendFileChown,
1562 1563

    .storageFileGetUniqueIdentifier = virStorageFileBackendFileGetUniqueIdentifier,
1564 1565 1566
};


1567 1568 1569 1570 1571 1572
virStorageFileBackend virStorageFileBackendDir = {
    .type = VIR_STORAGE_TYPE_DIR,

    .backendInit = virStorageFileBackendFileInit,
    .backendDeinit = virStorageFileBackendFileDeinit,

1573
    .storageFileAccess = virStorageFileBackendFileAccess,
1574
    .storageFileChown = virStorageFileBackendFileChown,
1575

1576 1577
    .storageFileGetUniqueIdentifier = virStorageFileBackendFileGetUniqueIdentifier,
};