storage_backend.c 48.4 KB
Newer Older
1
/*
2
 * storage_backend.c: internal storage driver backend contract
3
 *
4
 * Copyright (C) 2007-2011 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 * Copyright (C) 2007-2008 Daniel P. Berrange
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 * Author: Daniel P. Berrange <berrange@redhat.com>
 */

#include <config.h>

#include <string.h>
27
#include <stdio.h>
D
Daniel P. Berrange 已提交
28
#if HAVE_REGEX_H
29
# include <regex.h>
D
Daniel P. Berrange 已提交
30
#endif
31
#include <sys/types.h>
E
Eric Blake 已提交
32
#include <sys/wait.h>
33
#include <unistd.h>
34 35 36
#include <fcntl.h>
#include <stdint.h>
#include <sys/stat.h>
37
#include <sys/param.h>
38
#include <dirent.h>
39
#include "dirname.h"
40 41 42 43
#ifdef __linux__
# include <sys/ioctl.h>
# include <linux/fs.h>
#endif
44 45

#if HAVE_SELINUX
46
# include <selinux/selinux.h>
47
#endif
48

49
#include "datatypes.h"
50
#include "virterror_internal.h"
D
Daniel P. Berrange 已提交
51 52
#include "util.h"
#include "memory.h"
53
#include "internal.h"
54
#include "secret_conf.h"
55
#include "uuid.h"
56
#include "storage_file.h"
D
Daniel P. Berrange 已提交
57
#include "storage_backend.h"
58
#include "logging.h"
59
#include "files.h"
60
#include "command.h"
61

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

81 82
#define VIR_FROM_THIS VIR_FROM_STORAGE

83 84 85 86 87 88 89 90 91 92 93 94 95 96
static virStorageBackendPtr backends[] = {
#if WITH_STORAGE_DIR
    &virStorageBackendDirectory,
#endif
#if WITH_STORAGE_FS
    &virStorageBackendFileSystem,
    &virStorageBackendNetFileSystem,
#endif
#if WITH_STORAGE_LVM
    &virStorageBackendLogical,
#endif
#if WITH_STORAGE_ISCSI
    &virStorageBackendISCSI,
#endif
97 98 99
#if WITH_STORAGE_SCSI
    &virStorageBackendSCSI,
#endif
D
Dave Allan 已提交
100 101 102
#if WITH_STORAGE_MPATH
    &virStorageBackendMpath,
#endif
103 104 105 106 107
#if WITH_STORAGE_DISK
    &virStorageBackendDisk,
#endif
    NULL
};
108

109 110 111 112 113 114 115 116
static int track_allocation_progress = 0;

enum {
    TOOL_QEMU_IMG,
    TOOL_KVM_IMG,
    TOOL_QCOW_CREATE,
};

117 118 119
#define READ_BLOCK_SIZE_DEFAULT  (1024 * 1024)
#define WRITE_BLOCK_SIZE_DEFAULT (4 * 1024)

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

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

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
#ifdef __linux__
    if (ioctl(fd, BLKBSZGET, &wbytes) < 0) {
        wbytes = 0;
    }
#endif
    if ((wbytes == 0) && fstat(fd, &st) == 0)
        wbytes = st.st_blksize;
    if (wbytes < WRITE_BLOCK_SIZE_DEFAULT)
        wbytes = WRITE_BLOCK_SIZE_DEFAULT;

    if (VIR_ALLOC_N(zerobuf, wbytes) < 0) {
        ret = -errno;
        virReportOOMError();
        goto cleanup;
    }
161

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

    remain = *total;

    while (amtread != 0) {
        int amtleft;

173 174
        if (remain < rbytes)
            rbytes = remain;
175

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

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

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

            }
208
        } while ((amtleft -= interval) > 0);
209 210
    }

211
    if (VIR_CLOSE(inputfd) < 0) {
212
        ret = -errno;
213
        virReportSystemError(errno,
214 215 216 217 218 219 220 221 222
                             _("cannot close file '%s'"),
                             inputvol->target.path);
        goto cleanup;
    }
    inputfd = -1;

    *total -= remain;

cleanup:
223
    VIR_FORCE_CLOSE(inputfd);
224

225
    VIR_FREE(zerobuf);
226 227
    VIR_FREE(buf);

228 229 230
    return ret;
}

231
static int
232
virStorageBackendCreateBlockFrom(virConnectPtr conn ATTRIBUTE_UNUSED,
233
                                 virStoragePoolObjPtr pool ATTRIBUTE_UNUSED,
234 235 236 237 238 239 240
                                 virStorageVolDefPtr vol,
                                 virStorageVolDefPtr inputvol,
                                 unsigned int flags ATTRIBUTE_UNUSED)
{
    int fd = -1;
    int ret = -1;
    unsigned long long remain;
241 242 243
    struct stat st;
    gid_t gid;
    uid_t uid;
244 245

    if ((fd = open(vol->target.path, O_RDWR)) < 0) {
246
        virReportSystemError(errno,
247 248 249 250 251 252 253 254
                             _("cannot create path '%s'"),
                             vol->target.path);
        goto cleanup;
    }

    remain = vol->allocation;

    if (inputvol) {
255
        int res = virStorageBackendCopyToFD(vol, inputvol,
256
                                            fd, &remain, 0);
257 258 259 260
        if (res < 0)
            goto cleanup;
    }

261
    if (fstat(fd, &st) == -1) {
262
        virReportSystemError(errno, _("stat of '%s' failed"),
263 264 265 266 267 268
                             vol->target.path);
        goto cleanup;
    }
    uid = (vol->target.perms.uid != st.st_uid) ? vol->target.perms.uid : -1;
    gid = (vol->target.perms.gid != st.st_gid) ? vol->target.perms.gid : -1;
    if (((uid != -1) || (gid != -1))
269
        && (fchown(fd, uid, gid) < 0)) {
270
        virReportSystemError(errno,
271
                             _("cannot chown '%s' to (%u, %u)"),
272
                             vol->target.path, uid, gid);
273 274 275
        goto cleanup;
    }
    if (fchmod(fd, vol->target.perms.mode) < 0) {
276
        virReportSystemError(errno,
277 278 279 280
                             _("cannot set mode of '%s' to %04o"),
                             vol->target.path, vol->target.perms.mode);
        goto cleanup;
    }
281
    if (VIR_CLOSE(fd) < 0) {
282
        virReportSystemError(errno,
283 284 285 286 287 288 289 290
                             _("cannot close file '%s'"),
                             vol->target.path);
        goto cleanup;
    }
    fd = -1;

    ret = 0;
cleanup:
291
    VIR_FORCE_CLOSE(fd);
292 293 294 295

    return ret;
}

E
Eric Blake 已提交
296 297 298 299
static int
createRawFile(int fd, virStorageVolDefPtr vol,
              virStorageVolDefPtr inputvol)
{
300 301
    int ret = 0;
    unsigned long long remain;
302

303 304
    /* Seek to the final size, so the capacity is available upfront
     * for progress reporting */
E
Eric Blake 已提交
305
    if (ftruncate(fd, vol->capacity) < 0) {
306
        ret = -errno;
307
        virReportSystemError(errno,
308
                             _("cannot extend file '%s'"),
E
Eric Blake 已提交
309
                             vol->target.path);
310 311 312
        goto cleanup;
    }

E
Eric Blake 已提交
313
    remain = vol->allocation;
314

E
Eric Blake 已提交
315 316
    if (inputvol) {
        ret = virStorageBackendCopyToFD(vol, inputvol, fd, &remain, 1);
317
        if (ret < 0) {
318
            goto cleanup;
319
        }
320 321 322 323 324 325 326 327 328 329 330 331 332 333
    }

    if (remain) {
        if (track_allocation_progress) {

            while (remain) {
                /* Allocate in chunks of 512MiB: big-enough chunk
                 * size and takes approx. 9s on ext3. A progress
                 * update every 9s is a fair-enough trade-off
                 */
                unsigned long long bytes = 512 * 1024 * 1024;

                if (bytes > remain)
                    bytes = remain;
334
                if (safezero(fd, 0, vol->allocation - remain, bytes) < 0) {
335
                    ret = -errno;
J
Jiri Denemark 已提交
336
                    virReportSystemError(errno, _("cannot fill file '%s'"),
E
Eric Blake 已提交
337
                                         vol->target.path);
338 339 340 341 342
                    goto cleanup;
                }
                remain -= bytes;
            }
        } else { /* No progress bars to be shown */
343
            if (safezero(fd, 0, 0, remain) < 0) {
344
                ret = -errno;
J
Jiri Denemark 已提交
345
                virReportSystemError(errno, _("cannot fill file '%s'"),
E
Eric Blake 已提交
346
                                     vol->target.path);
347 348 349
                goto cleanup;
            }
        }
350

351 352 353
    }

    if (fsync(fd) < 0) {
354
        ret = -errno;
355
        virReportSystemError(errno, _("cannot sync data to file '%s'"),
E
Eric Blake 已提交
356
                             vol->target.path);
357
        goto cleanup;
358 359
    }

360 361 362 363 364 365 366 367 368
cleanup:
    return ret;
}

int
virStorageBackendCreateRaw(virConnectPtr conn ATTRIBUTE_UNUSED,
                           virStoragePoolObjPtr pool,
                           virStorageVolDefPtr vol,
                           virStorageVolDefPtr inputvol,
E
Eric Blake 已提交
369
                           unsigned int flags)
370 371
{
    int ret = -1;
E
Eric Blake 已提交
372 373 374 375 376 377
    int fd = -1;
    uid_t uid;
    gid_t gid;
    int operation_flags;

    virCheckFlags(0, -1);
378 379 380 381 382

    if (vol->target.encryption != NULL) {
        virStorageReportError(VIR_ERR_NO_SUPPORT,
                              "%s", _("storage pool does not support encrypted "
                                      "volumes"));
383 384
        goto cleanup;
    }
385

E
Eric Blake 已提交
386 387
    uid = (vol->target.perms.uid == -1) ? getuid() : vol->target.perms.uid;
    gid = (vol->target.perms.gid == -1) ? getgid() : vol->target.perms.gid;
388
    operation_flags = VIR_FILE_OPEN_FORCE_PERMS;
E
Eric Blake 已提交
389
    if (pool->def->type == VIR_STORAGE_POOL_NETFS)
390
        operation_flags |= VIR_FILE_OPEN_AS_UID;
E
Eric Blake 已提交
391

392 393 394 395
    if ((fd = virFileOpenAs(vol->target.path,
                            O_RDWR | O_CREAT | O_EXCL,
                            vol->target.perms.mode, uid, gid,
                            operation_flags)) < 0) {
E
Eric Blake 已提交
396 397 398 399 400 401
        virReportSystemError(-fd,
                             _("cannot create path '%s'"),
                             vol->target.path);
        goto cleanup;
    }

E
Eric Blake 已提交
402
    if ((ret = createRawFile(fd, vol, inputvol)) < 0) {
E
Eric Blake 已提交
403 404 405 406
        virReportSystemError(-fd,
                             _("cannot create path '%s'"),
                             vol->target.path);
        ret = -1;
407
    }
408 409

cleanup:
E
Eric Blake 已提交
410
    VIR_FORCE_CLOSE(fd);
411 412 413
    return ret;
}

414 415 416 417 418 419 420 421 422
static int
virStorageGenerateSecretUUID(virConnectPtr conn,
                             unsigned char *uuid)
{
    unsigned attempt;

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

        virSecretFree(tmp);
    }

434 435
    virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                          _("too many conflicts when generating an uuid"));
436 437 438 439

    return -1;
}

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

453 454 455
    if (conn->secretDriver == NULL ||
        conn->secretDriver->lookupByUUID == NULL ||
        conn->secretDriver->defineXML == NULL ||
456
        conn->secretDriver->setValue == NULL) {
457
        virStorageReportError(VIR_ERR_NO_SUPPORT, "%s",
458 459 460 461 462 463
                              _("secret storage not supported"));
        goto cleanup;
    }

    enc = vol->target.encryption;
    if (enc->nsecrets != 0) {
464
        virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
465 466 467 468 469 470
                              _("secrets already defined"));
        goto cleanup;
    }

    if (VIR_ALLOC(enc_secret) < 0 || VIR_REALLOC_N(enc->secrets, 1) < 0 ||
        VIR_ALLOC(def) < 0) {
471
        virReportOOMError();
472 473 474 475 476
        goto cleanup;
    }

    def->ephemeral = 0;
    def->private = 0;
477
    if (virStorageGenerateSecretUUID(conn, def->uuid) < 0)
478
        goto cleanup;
479

480 481 482
    def->usage_type = VIR_SECRET_USAGE_TYPE_VOLUME;
    def->usage.volume = strdup(vol->target.path);
    if (def->usage.volume == NULL) {
483
        virReportOOMError();
484 485
        goto cleanup;
    }
486
    xml = virSecretDefFormat(def);
487 488 489 490 491 492 493 494 495 496 497 498
    virSecretDefFree(def);
    def = NULL;
    if (xml == NULL)
        goto cleanup;

    secret = conn->secretDriver->defineXML(conn, xml, 0);
    if (secret == NULL) {
        VIR_FREE(xml);
        goto cleanup;
    }
    VIR_FREE(xml);

499
    if (virStorageGenerateQcowPassphrase(value) < 0)
500 501 502 503 504 505
        goto cleanup;

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

    enc_secret->type = VIR_STORAGE_ENCRYPTION_SECRET_TYPE_PASSPHRASE;
506
    memcpy(enc_secret->uuid, secret->uuid, VIR_UUID_BUFLEN);
507 508 509 510 511 512 513 514 515
    enc->format = VIR_STORAGE_ENCRYPTION_FORMAT_QCOW;
    enc->secrets[0] = enc_secret; /* Space for secrets[0] allocated above */
    enc_secret = NULL;
    enc->nsecrets = 1;

    ret = 0;

cleanup:
    if (secret != NULL) {
516 517
        if (ret != 0 &&
            conn->secretDriver->undefine != NULL)
518 519 520
            conn->secretDriver->undefine(secret);
        virSecretFree(secret);
    }
521
    virBufferFreeAndReset(&buf);
522 523 524 525 526
    virSecretDefFree(def);
    VIR_FREE(enc_secret);
    return ret;
}

527 528 529 530 531
struct hookdata {
    virStorageVolDefPtr vol;
    bool skip;
};

532
static int virStorageBuildSetUIDHook(void *data) {
533 534 535 536 537
    struct hookdata *tmp = data;
    virStorageVolDefPtr vol = tmp->vol;

    if (tmp->skip)
        return 0;
538

539
    if (virSetUIDGID(vol->target.perms.uid, vol->target.perms.gid) < 0)
540
        return -1;
541

542 543 544
    return 0;
}

545
static int virStorageBackendCreateExecCommand(virStoragePoolObjPtr pool,
546
                                              virStorageVolDefPtr vol,
547
                                              virCommandPtr cmd) {
548 549 550 551
    struct stat st;
    gid_t gid;
    uid_t uid;
    int filecreated = 0;
552
    struct hookdata data = {vol, false};
553 554

    if ((pool->def->type == VIR_STORAGE_POOL_NETFS)
555 556 557 558 559
        && (((getuid() == 0)
             && (vol->target.perms.uid != -1)
             && (vol->target.perms.uid != 0))
            || ((vol->target.perms.gid != -1)
                && (vol->target.perms.gid != getgid())))) {
560 561 562 563

        virCommandSetPreExecHook(cmd, virStorageBuildSetUIDHook, &data);

        if (virCommandRun(cmd, NULL) == 0) {
564 565 566 567 568
            /* command was successfully run, check if the file was created */
            if (stat(vol->target.path, &st) >=0)
                filecreated = 1;
        }
    }
569 570 571

    data.skip = true;

572
    if (!filecreated) {
573
        if (virCommandRun(cmd, NULL) < 0) {
574 575 576
            return -1;
        }
        if (stat(vol->target.path, &st) < 0) {
577
            virReportSystemError(errno,
578
                                 _("failed to create %s"), vol->target.path);
579 580 581 582 583 584 585 586
            return -1;
        }
    }

    uid = (vol->target.perms.uid != st.st_uid) ? vol->target.perms.uid : -1;
    gid = (vol->target.perms.gid != st.st_gid) ? vol->target.perms.gid : -1;
    if (((uid != -1) || (gid != -1))
        && (chown(vol->target.path, uid, gid) < 0)) {
587
        virReportSystemError(errno,
588
                             _("cannot chown %s to (%u, %u)"),
589
                             vol->target.path, uid, gid);
590 591 592
        return -1;
    }
    if (chmod(vol->target.path, vol->target.perms.mode) < 0) {
593
        virReportSystemError(errno,
594 595 596 597 598 599 600
                             _("cannot set mode of '%s' to %04o"),
                             vol->target.path, vol->target.perms.mode);
        return -1;
    }
    return 0;
}

601 602 603 604 605 606 607 608 609 610 611 612 613
enum {
    QEMU_IMG_BACKING_FORMAT_NONE = 0,
    QEMU_IMG_BACKING_FORMAT_FLAG,
    QEMU_IMG_BACKING_FORMAT_OPTIONS,
};

static int virStorageBackendQEMUImgBackingFormat(const char *qemuimg)
{
    char *help = NULL;
    char *start;
    char *end;
    char *tmp;
    int ret = -1;
614
    int exitstatus;
615
    virCommandPtr cmd = virCommandNewArgList(qemuimg, "-h", NULL);
616

617 618 619
    virCommandAddEnvString(cmd, "LC_ALL=C");
    virCommandSetOutputBuffer(cmd, &help);
    virCommandClearCaps(cmd);
620

621 622 623
    /* qemuimg doesn't return zero exit status on -h,
     * therefore we need to provide pointer for storing
     * exit status, although we don't parse it any later */
624
    if (virCommandRun(cmd, &exitstatus) < 0)
625 626 627 628
        goto cleanup;

    start = strstr(help, " create ");
    end = strstr(start, "\n");
629 630
    if (((tmp = strstr(start, "-F fmt")) && tmp < end) ||
        ((tmp = strstr(start, "-F backing_fmt")) && tmp < end))
631 632 633 634 635 636 637
        ret = QEMU_IMG_BACKING_FORMAT_FLAG;
    else if ((tmp = strstr(start, "[-o options]")) && tmp < end)
        ret = QEMU_IMG_BACKING_FORMAT_OPTIONS;
    else
        ret = QEMU_IMG_BACKING_FORMAT_NONE;

cleanup:
638
    virCommandFree(cmd);
639 640 641 642 643
    VIR_FREE(help);
    return ret;
}


644 645
static int
virStorageBackendCreateQemuImg(virConnectPtr conn,
646
                               virStoragePoolObjPtr pool,
647
                               virStorageVolDefPtr vol,
648 649
                               virStorageVolDefPtr inputvol,
                               unsigned int flags ATTRIBUTE_UNUSED)
650
{
651
    int ret = -1;
652
    char *create_tool;
653
    int imgformat = -1;
654 655
    virCommandPtr cmd = NULL;
    bool do_encryption = (vol->target.encryption != NULL);
656
    unsigned long long int size_arg;
657

658
    const char *type = virStorageFileFormatTypeToString(vol->target.format);
659
    const char *backingType = vol->backingStore.path ?
660
        virStorageFileFormatTypeToString(vol->backingStore.format) : NULL;
661 662 663 664 665 666

    const char *inputBackingPath = (inputvol ? inputvol->backingStore.path
                                             : NULL);
    const char *inputPath = inputvol ? inputvol->target.path : NULL;
    /* Treat input block devices as 'raw' format */
    const char *inputType = inputPath ?
667 668 669 670
        virStorageFileFormatTypeToString(inputvol->type == VIR_STORAGE_VOL_BLOCK ?
                                         VIR_STORAGE_FILE_RAW :
                                         inputvol->target.format) :
        NULL;
671 672

    if (type == NULL) {
673
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
674 675 676 677 678
                              _("unknown storage vol type %d"),
                              vol->target.format);
        return -1;
    }
    if (inputvol && inputType == NULL) {
679
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
680 681 682 683 684 685
                              _("unknown storage vol type %d"),
                              inputvol->target.format);
        return -1;
    }

    if (vol->backingStore.path) {
686 687
        int accessRetCode = -1;
        char *absolutePath = NULL;
688 689 690 691 692 693 694 695

        /* XXX: Not strictly required: qemu-img has an option a different
         * backing store, not really sure what use it serves though, and it
         * may cause issues with lvm. Untested essentially.
         */
        if (inputvol &&
            (!inputBackingPath ||
             STRNEQ(inputBackingPath, vol->backingStore.path))) {
696
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
E
Eric Blake 已提交
697
                                  "%s", _("a different backing store cannot "
698 699 700 701 702
                                          "be specified."));
            return -1;
        }

        if (backingType == NULL) {
703
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
704 705 706 707
                                  _("unknown storage vol backing store type %d"),
                                  vol->backingStore.format);
            return -1;
        }
708 709 710 711 712 713 714 715 716 717 718 719 720 721

        /* Convert relative backing store paths to absolute paths for access
         * validation.
         */
        if ('/' != *(vol->backingStore.path) &&
            virAsprintf(&absolutePath, "%s/%s", pool->def->target.path,
                        vol->backingStore.path) < 0) {
            virReportOOMError();
            return -1;
        }
        accessRetCode = access(absolutePath ? absolutePath
                               : vol->backingStore.path, R_OK);
        VIR_FREE(absolutePath);
        if (accessRetCode != 0) {
722
            virReportSystemError(errno,
723 724 725 726 727 728
                                 _("inaccessible backing store volume %s"),
                                 vol->backingStore.path);
            return -1;
        }
    }

729
    if (do_encryption) {
730 731
        virStorageEncryptionPtr enc;

732 733
        if (vol->target.format != VIR_STORAGE_FILE_QCOW &&
            vol->target.format != VIR_STORAGE_FILE_QCOW2) {
734
            virStorageReportError(VIR_ERR_NO_SUPPORT,
735 736 737 738
                                  _("qcow volume encryption unsupported with "
                                    "volume format %s"), type);
            return -1;
        }
739 740 741
        enc = vol->target.encryption;
        if (enc->format != VIR_STORAGE_ENCRYPTION_FORMAT_QCOW &&
            enc->format != VIR_STORAGE_ENCRYPTION_FORMAT_DEFAULT) {
742
            virStorageReportError(VIR_ERR_NO_SUPPORT,
743 744 745 746
                                  _("unsupported volume encryption format %d"),
                                  vol->target.encryption->format);
            return -1;
        }
747
        if (enc->nsecrets > 1) {
748
            virStorageReportError(VIR_ERR_XML_ERROR, "%s",
749 750 751
                                  _("too many secrets for qcow encryption"));
            return -1;
        }
752 753 754 755 756
        if (enc->format == VIR_STORAGE_ENCRYPTION_FORMAT_DEFAULT ||
            enc->nsecrets == 0) {
            if (virStorageGenerateQcowEncryption(conn, vol) < 0)
                return -1;
        }
757 758
    }

759
    /* Size in KB */
760
    size_arg = VIR_DIV_UP(vol->capacity, 1024);
761 762 763 764 765 766 767

    /* KVM is usually ahead of qemu on features, so try that first */
    create_tool = virFindFileInPath("kvm-img");
    if (!create_tool)
        create_tool = virFindFileInPath("qemu-img");

    if (!create_tool) {
768
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
769
                              "%s", _("unable to find kvm-img or qemu-img"));
770 771 772
        return -1;
    }

773 774 775 776
    imgformat = virStorageBackendQEMUImgBackingFormat(create_tool);
    if (imgformat < 0)
        goto cleanup;

777 778
    cmd = virCommandNew(create_tool);

779
    if (inputvol) {
780 781 782 783
        virCommandAddArgList(cmd, "convert", "-f", inputType, "-O", type,
                             inputPath, vol->target.path, NULL);

        if (do_encryption) {
784
            if (imgformat == QEMU_IMG_BACKING_FORMAT_OPTIONS) {
785
                virCommandAddArgList(cmd, "-o", "encryption=on", NULL);
786
            } else {
787
                virCommandAddArg(cmd, "-e");
788 789 790
            }
        }

791
    } else if (vol->backingStore.path) {
792 793 794
        virCommandAddArgList(cmd, "create", "-f", type,
                             "-b", vol->backingStore.path, NULL);

795 796
        switch (imgformat) {
        case QEMU_IMG_BACKING_FORMAT_FLAG:
797
            virCommandAddArgList(cmd, "-F", backingType, vol->target.path,
798 799
                                 NULL);
            virCommandAddArgFormat(cmd, "%lluK", size_arg);
800 801 802

            if (do_encryption)
                virCommandAddArg(cmd, "-e");
803 804 805
            break;

        case QEMU_IMG_BACKING_FORMAT_OPTIONS:
806 807 808
            virCommandAddArg(cmd, "-o");
            virCommandAddArgFormat(cmd, "backing_fmt=%s%s", backingType,
                                   do_encryption ? ",encryption=on" : "");
809 810
            virCommandAddArg(cmd, vol->target.path);
            virCommandAddArgFormat(cmd, "%lluK", size_arg);
811
            break;
812 813 814 815 816

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

817 818
            virCommandAddArg(cmd, vol->target.path);
            virCommandAddArgFormat(cmd, "%lluK", size_arg);
819 820 821
            if (do_encryption)
                virCommandAddArg(cmd, "-e");
        }
822
    } else {
823
        virCommandAddArgList(cmd, "create", "-f", type,
824 825
                             vol->target.path, NULL);
        virCommandAddArgFormat(cmd, "%lluK", size_arg);
826 827

        if (do_encryption) {
828
            if (imgformat == QEMU_IMG_BACKING_FORMAT_OPTIONS) {
829
                virCommandAddArgList(cmd, "-o", "encryption=on", NULL);
830
            } else {
831
                virCommandAddArg(cmd, "-e");
832 833
            }
        }
834
    }
835

836 837
    ret = virStorageBackendCreateExecCommand(pool, vol, cmd);
cleanup:
838
    VIR_FREE(create_tool);
839
    virCommandFree(cmd);
840

841
    return ret;
842 843 844 845 846 847 848
}

/*
 * Xen removed the fully-functional qemu-img, and replaced it
 * with a partially functional qcow-create. Go figure ??!?
 */
static int
849
virStorageBackendCreateQcowCreate(virConnectPtr conn ATTRIBUTE_UNUSED,
850
                                  virStoragePoolObjPtr pool,
851
                                  virStorageVolDefPtr vol,
852 853
                                  virStorageVolDefPtr inputvol,
                                  unsigned int flags ATTRIBUTE_UNUSED)
854
{
855
    int ret;
E
Eric Blake 已提交
856
    char *size;
857
    virCommandPtr cmd;
858 859

    if (inputvol) {
860
        virStorageReportError(VIR_ERR_INTERNAL_ERROR, "%s",
861 862 863 864
                              _("cannot copy from volume with qcow-create"));
        return -1;
    }

865
    if (vol->target.format != VIR_STORAGE_FILE_QCOW2) {
866
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
867 868 869 870 871
                              _("unsupported storage vol type %d"),
                              vol->target.format);
        return -1;
    }
    if (vol->backingStore.path != NULL) {
872
        virStorageReportError(VIR_ERR_NO_SUPPORT, "%s",
873
                              _("copy-on-write image not supported with "
874
                                      "qcow-create"));
875 876
        return -1;
    }
877
    if (vol->target.encryption != NULL) {
878
        virStorageReportError(VIR_ERR_NO_SUPPORT,
879 880 881 882
                              "%s", _("encrypted volumes not supported with "
                                      "qcow-create"));
        return -1;
    }
883 884

    /* Size in MB - yes different units to qemu-img :-( */
885 886
    if (virAsprintf(&size, "%llu",
                    VIR_DIV_UP(vol->capacity, (1024 * 1024))) < 0) {
E
Eric Blake 已提交
887 888 889
        virReportOOMError();
        return -1;
    }
890

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

893 894
    ret = virStorageBackendCreateExecCommand(pool, vol, cmd);
    virCommandFree(cmd);
E
Eric Blake 已提交
895
    VIR_FREE(size);
896

897
    return ret;
898 899
}

900
virStorageBackendBuildVolFrom
901
virStorageBackendFSImageToolTypeToFunc(int tool_type)
902 903 904 905 906 907 908 909
{
    switch (tool_type) {
    case TOOL_KVM_IMG:
    case TOOL_QEMU_IMG:
        return virStorageBackendCreateQemuImg;
    case TOOL_QCOW_CREATE:
        return virStorageBackendCreateQcowCreate;
    default:
910
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
                              _("Unknown file create tool type '%d'."),
                              tool_type);
    }

    return NULL;
}

int
virStorageBackendFindFSImageTool(char **tool)
{
    int tool_type = -1;
    char *tmp = NULL;

    if ((tmp = virFindFileInPath("kvm-img")) != NULL) {
        tool_type = TOOL_KVM_IMG;
    } else if ((tmp = virFindFileInPath("qemu-img")) != NULL) {
        tool_type = TOOL_QEMU_IMG;
    } else if ((tmp = virFindFileInPath("qcow-create")) != NULL) {
        tool_type = TOOL_QCOW_CREATE;
    }

    if (tool)
        *tool = tmp;
    else
        VIR_FREE(tmp);

    return tool_type;
}

940
virStorageBackendBuildVolFrom
941
virStorageBackendGetBuildVolFromFunction(virStorageVolDefPtr vol,
942 943 944 945 946 947 948 949 950 951 952
                                         virStorageVolDefPtr inputvol)
{
    int tool_type;

    if (!inputvol)
        return NULL;

    /* If either volume is a non-raw file vol, we need to use an external
     * tool for converting
     */
    if ((vol->type == VIR_STORAGE_VOL_FILE &&
953
         vol->target.format != VIR_STORAGE_FILE_RAW) ||
954
        (inputvol->type == VIR_STORAGE_VOL_FILE &&
955
         inputvol->target.format != VIR_STORAGE_FILE_RAW)) {
956

D
Daniel P. Berrange 已提交
957
        if ((tool_type = virStorageBackendFindFSImageTool(NULL)) < 0) {
958
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
959 960 961 962 963
                                  "%s", _("creation of non-raw file images is "
                                          "not supported without qemu-img."));
            return NULL;
        }

964
        return virStorageBackendFSImageToolTypeToFunc(tool_type);
965 966
    }

967 968 969 970
    if (vol->type == VIR_STORAGE_VOL_BLOCK)
        return virStorageBackendCreateBlockFrom;
    else
        return virStorageBackendCreateRaw;
971
}
972

973

974 975
virStorageBackendPtr
virStorageBackendForType(int type) {
976
    unsigned int i;
977
    for (i = 0; backends[i]; i++)
978 979 980
        if (backends[i]->type == type)
            return backends[i];

981
    virStorageReportError(VIR_ERR_INTERNAL_ERROR,
982 983 984 985 986
                          _("missing backend for pool type %d"), type);
    return NULL;
}


987 988 989
/*
 * Allows caller to silently ignore files with improper mode
 *
990 991
 * Returns -1 on error, -2 if file mode is unexpected or the
 * volume is a dangling symbolic link.
992
 */
993
int
994
virStorageBackendVolOpenCheckMode(const char *path, unsigned int flags)
995
{
996 997
    int fd, mode = 0;
    struct stat sb;
998
    char *base = last_component(path);
999

1000
    if ((fd = open(path, O_RDONLY|O_NONBLOCK|O_NOCTTY)) < 0) {
1001 1002 1003 1004 1005 1006
        if ((errno == ENOENT || errno == ELOOP) &&
            lstat(path, &sb) == 0) {
            VIR_WARN("ignoring dangling symlink '%s'", path);
            return -2;
        }

1007
        virReportSystemError(errno,
1008
                             _("cannot open volume '%s'"),
1009
                             path);
1010 1011 1012
        return -1;
    }

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

    if (S_ISREG(sb.st_mode))
        mode = VIR_STORAGE_VOL_OPEN_REG;
    else if (S_ISCHR(sb.st_mode))
        mode = VIR_STORAGE_VOL_OPEN_CHAR;
    else if (S_ISBLK(sb.st_mode))
        mode = VIR_STORAGE_VOL_OPEN_BLOCK;
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
    else if (S_ISDIR(sb.st_mode)) {
        mode = VIR_STORAGE_VOL_OPEN_DIR;

        if (STREQ(base, ".") ||
            STREQ(base, "..")) {
            VIR_FORCE_CLOSE(fd);
            VIR_INFO("Skipping special dir '%s'", base);
            return -2;
        }
    }
1037 1038

    if (!(mode & flags)) {
1039
        VIR_FORCE_CLOSE(fd);
1040
        VIR_INFO("Skipping volume '%s'", path);
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062

        if (mode & VIR_STORAGE_VOL_OPEN_ERROR) {
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
                                  _("unexpected storage mode for '%s'"), path);
            return -1;
        }

        return -2;
    }

    return fd;
}

int virStorageBackendVolOpen(const char *path)
{
    return virStorageBackendVolOpenCheckMode(path,
                                             VIR_STORAGE_VOL_OPEN_DEFAULT);
}

int
virStorageBackendUpdateVolTargetInfo(virStorageVolTargetPtr target,
                                     unsigned long long *allocation,
1063 1064
                                     unsigned long long *capacity,
                                     unsigned int openflags)
1065 1066 1067
{
    int ret, fd;

1068 1069
    if ((ret = virStorageBackendVolOpenCheckMode(target->path,
                                                 openflags)) < 0)
1070 1071 1072
        return ret;

    fd = ret;
1073
    ret = virStorageBackendUpdateVolTargetInfoFD(target,
1074 1075 1076
                                                 fd,
                                                 allocation,
                                                 capacity);
1077

1078
    VIR_FORCE_CLOSE(fd);
1079 1080 1081 1082

    return ret;
}

1083
int
1084 1085 1086
virStorageBackendUpdateVolInfoFlags(virStorageVolDefPtr vol,
                                    int withCapacity,
                                    unsigned int openflags)
1087 1088 1089
{
    int ret;

1090
    if ((ret = virStorageBackendUpdateVolTargetInfo(&vol->target,
1091 1092 1093
                                    &vol->allocation,
                                    withCapacity ? &vol->capacity : NULL,
                                    openflags)) < 0)
1094 1095 1096
        return ret;

    if (vol->backingStore.path &&
1097
        (ret = virStorageBackendUpdateVolTargetInfo(&vol->backingStore,
1098 1099
                                            NULL, NULL,
                                            VIR_STORAGE_VOL_OPEN_DEFAULT)) < 0)
1100 1101 1102 1103 1104
        return ret;

    return 0;
}

1105 1106 1107 1108 1109 1110 1111
int virStorageBackendUpdateVolInfo(virStorageVolDefPtr vol,
                                   int withCapacity)
{
    return virStorageBackendUpdateVolInfoFlags(vol, withCapacity,
                                               VIR_STORAGE_VOL_OPEN_DEFAULT);
}

1112 1113 1114 1115
/*
 * virStorageBackendUpdateVolTargetInfoFD:
 * @conn: connection to report errors on
 * @target: target definition ptr of volume to update
1116
 * @fd: fd of storage volume to update, via virStorageBackendOpenVol*
1117 1118 1119
 * @allocation: If not NULL, updated allocation information will be stored
 * @capacity: If not NULL, updated capacity info will be stored
 *
1120
 * Returns 0 for success, -1 on a legitimate error condition.
1121
 */
1122
int
1123
virStorageBackendUpdateVolTargetInfoFD(virStorageVolTargetPtr target,
1124 1125 1126
                                       int fd,
                                       unsigned long long *allocation,
                                       unsigned long long *capacity)
1127 1128 1129 1130 1131 1132 1133
{
    struct stat sb;
#if HAVE_SELINUX
    security_context_t filecon = NULL;
#endif

    if (fstat(fd, &sb) < 0) {
1134
        virReportSystemError(errno,
1135
                             _("cannot stat file '%s'"),
1136
                             target->path);
1137 1138 1139
        return -1;
    }

1140 1141
    if (allocation) {
        if (S_ISREG(sb.st_mode)) {
1142
#ifndef WIN32
1143
            *allocation = (unsigned long long)sb.st_blocks *
1144
                          (unsigned long long)DEV_BSIZE;
D
Daniel P. Berrange 已提交
1145
#else
1146
            *allocation = sb.st_size;
D
Daniel P. Berrange 已提交
1147
#endif
1148 1149 1150 1151 1152
            /* Regular files may be sparse, so logical size (capacity) is not same
             * as actual allocation above
             */
            if (capacity)
                *capacity = sb.st_size;
1153 1154 1155 1156 1157
        } else if (S_ISDIR(sb.st_mode)) {
            *allocation = 0;
            if (capacity)
                *capacity = 0;

1158 1159
        } else {
            off_t end;
E
Eric Blake 已提交
1160
            /* XXX this is POSIX compliant, but doesn't work for CHAR files,
1161 1162 1163 1164 1165 1166
             * only BLOCK. There is a Linux specific ioctl() for getting
             * size of both CHAR / BLOCK devices we should check for in
             * configure
             */
            end = lseek(fd, 0, SEEK_END);
            if (end == (off_t)-1) {
1167
                virReportSystemError(errno,
1168 1169 1170 1171 1172 1173 1174
                                     _("cannot seek to end of file '%s'"),
                                     target->path);
                return -1;
            }
            *allocation = end;
            if (capacity)
                *capacity = end;
1175 1176 1177
        }
    }

1178 1179 1180
    target->perms.mode = sb.st_mode & S_IRWXUGO;
    target->perms.uid = sb.st_uid;
    target->perms.gid = sb.st_gid;
1181

1182
    VIR_FREE(target->perms.label);
1183 1184

#if HAVE_SELINUX
1185
    /* XXX: make this a security driver call */
1186
    if (fgetfilecon(fd, &filecon) == -1) {
1187
        if (errno != ENODATA && errno != ENOTSUP) {
1188
            virReportSystemError(errno,
1189
                                 _("cannot get file context of '%s'"),
1190
                                 target->path);
1191 1192
            return -1;
        } else {
1193
            target->perms.label = NULL;
1194 1195
        }
    } else {
1196
        target->perms.label = strdup(filecon);
1197
        freecon(filecon);
1198
        if (target->perms.label == NULL) {
1199
            virReportOOMError();
1200 1201
            return -1;
        }
1202 1203
    }
#else
1204
    target->perms.label = NULL;
1205 1206 1207 1208 1209
#endif

    return 0;
}

D
Dave Allan 已提交
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244

struct diskType {
    int part_table_type;
    unsigned short offset;
    unsigned short length;
    unsigned long long magic;
};


static struct diskType const disk_types[] = {
    { VIR_STORAGE_POOL_DISK_LVM2, 0x218, 8, 0x31303020324D564CULL },
    { VIR_STORAGE_POOL_DISK_GPT,  0x200, 8, 0x5452415020494645ULL },
    { VIR_STORAGE_POOL_DISK_DVH,  0x0,   4, 0x41A9E50BULL },
    { VIR_STORAGE_POOL_DISK_MAC,  0x0,   2, 0x5245ULL },
    { VIR_STORAGE_POOL_DISK_BSD,  0x40,  4, 0x82564557ULL },
    { VIR_STORAGE_POOL_DISK_SUN,  0x1fc, 2, 0xBEDAULL },
    /*
     * NOTE: pc98 is funky; the actual signature is 0x55AA (just like dos), so
     * we can't use that.  At the moment I'm relying on the "dummy" IPL
     * bootloader data that comes from parted.  Luckily, the chances of running
     * into a pc98 machine running libvirt are approximately nil.
     */
    /*{ 0x1fe, 2, 0xAA55UL },*/
    { VIR_STORAGE_POOL_DISK_PC98, 0x0,   8, 0x314C5049000000CBULL },
    /*
     * NOTE: the order is important here; some other disk types (like GPT and
     * and PC98) also have 0x55AA at this offset.  For that reason, the DOS
     * one must be the last one.
     */
    { VIR_STORAGE_POOL_DISK_DOS,  0x1fe, 2, 0xAA55ULL },
    { -1,                         0x0,   0, 0x0ULL },
};


int
1245 1246
virStorageBackendDetectBlockVolFormatFD(virStorageVolTargetPtr target,
                                        int fd)
D
Dave Allan 已提交
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
{
    int i;
    off_t start;
    unsigned char buffer[1024];
    ssize_t bytes;

    /* make sure to set the target format "unknown" to begin with */
    target->format = VIR_STORAGE_POOL_DISK_UNKNOWN;

    start = lseek(fd, 0, SEEK_SET);
    if (start < 0) {
1258
        virReportSystemError(errno,
D
Dave Allan 已提交
1259 1260 1261 1262 1263 1264
                             _("cannot seek to beginning of file '%s'"),
                             target->path);
        return -1;
    }
    bytes = saferead(fd, buffer, sizeof(buffer));
    if (bytes < 0) {
1265
        virReportSystemError(errno,
D
Dave Allan 已提交
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
                             _("cannot read beginning of file '%s'"),
                             target->path);
        return -1;
    }

    for (i = 0; disk_types[i].part_table_type != -1; i++) {
        if (disk_types[i].offset + disk_types[i].length > bytes)
            continue;
        if (memcmp(buffer+disk_types[i].offset, &disk_types[i].magic,
            disk_types[i].length) == 0) {
            target->format = disk_types[i].part_table_type;
            break;
        }
    }

    return 0;
}


1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
/*
 * Given a volume path directly in /dev/XXX, iterate over the
 * entries in the directory pool->def->target.path and find the
 * first symlink pointing to the volume path.
 *
 * If, the target.path is /dev/, then return the original volume
 * path.
 *
 * If no symlink is found, then return the original volume path
 *
 * Typically target.path is one of the /dev/disk/by-XXX dirs
 * with stable paths.
 */
char *
1299
virStorageBackendStablePath(virStoragePoolObjPtr pool,
1300
                            const char *devpath)
1301 1302 1303
{
    DIR *dh;
    struct dirent *dent;
1304
    char *stablepath;
1305
    int opentries = 0;
1306 1307 1308 1309 1310

    /* Short circuit if pool has no target, or if its /dev */
    if (pool->def->target.path == NULL ||
        STREQ(pool->def->target.path, "/dev") ||
        STREQ(pool->def->target.path, "/dev/"))
1311
        goto ret_strdup;
1312

1313 1314 1315 1316 1317 1318
    /* Skip whole thing for a pool which isn't in /dev
     * so we don't mess will filesystem/dir based pools
     */
    if (!STRPREFIX(pool->def->target.path, "/dev"))
        goto ret_strdup;

1319 1320 1321
    /* We loop here because /dev/disk/by-{id,path} may not have existed
     * before we started this operation, so we have to give it some time to
     * get created.
1322
     */
1323
 reopen:
1324
    if ((dh = opendir(pool->def->target.path)) == NULL) {
1325 1326 1327 1328 1329
        opentries++;
        if (errno == ENOENT && opentries < 50) {
            usleep(100 * 1000);
            goto reopen;
        }
1330
        virReportSystemError(errno,
1331 1332
                             _("cannot read dir '%s'"),
                             pool->def->target.path);
1333 1334 1335
        return NULL;
    }

1336 1337 1338 1339 1340
    /* The pool is pointing somewhere like /dev/disk/by-path
     * or /dev/disk/by-id, so we need to check all symlinks in
     * the target directory and figure out which one points
     * to this device node
     */
1341 1342 1343 1344
    while ((dent = readdir(dh)) != NULL) {
        if (dent->d_name[0] == '.')
            continue;

1345 1346 1347
        if (virAsprintf(&stablepath, "%s/%s",
                        pool->def->target.path,
                        dent->d_name) == -1) {
1348
            virReportOOMError();
1349 1350 1351 1352 1353 1354 1355 1356 1357
            closedir(dh);
            return NULL;
        }

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

1358
        VIR_FREE(stablepath);
1359 1360 1361 1362
    }

    closedir(dh);

1363
 ret_strdup:
1364 1365 1366
    /* Couldn't find any matching stable link so give back
     * the original non-stable dev path
     */
1367 1368 1369 1370

    stablepath = strdup(devpath);

    if (stablepath == NULL)
1371
        virReportOOMError();
1372 1373

    return stablepath;
1374 1375
}

D
Daniel P. Berrange 已提交
1376

1377
#ifndef WIN32
1378 1379 1380 1381
/*
 * Run an external program.
 *
 * Read its output and apply a series of regexes to each line
R
Richard W.M. Jones 已提交
1382
 * When the entire set of regexes has matched consecutively
1383 1384 1385
 * then run a callback passing in all the matches
 */
int
1386
virStorageBackendRunProgRegex(virStoragePoolObjPtr pool,
1387
                              const char *const*prog,
1388 1389 1390 1391
                              int nregex,
                              const char **regex,
                              int *nvars,
                              virStorageBackendListVolRegexFunc func,
1392
                              void *data)
1393
{
1394
    int fd = -1, err, ret = -1;
1395 1396 1397 1398 1399 1400 1401
    FILE *list = NULL;
    regex_t *reg;
    regmatch_t *vars = NULL;
    char line[1024];
    int maxReg = 0, i, j;
    int totgroups = 0, ngroup = 0, maxvars = 0;
    char **groups;
1402
    virCommandPtr cmd = NULL;
1403 1404

    /* Compile all regular expressions */
1405
    if (VIR_ALLOC_N(reg, nregex) < 0) {
1406
        virReportOOMError();
1407 1408 1409 1410 1411 1412 1413 1414
        return -1;
    }

    for (i = 0 ; i < nregex ; i++) {
        err = regcomp(&reg[i], regex[i], REG_EXTENDED);
        if (err != 0) {
            char error[100];
            regerror(err, &reg[i], error, sizeof(error));
1415
            virStorageReportError(VIR_ERR_INTERNAL_ERROR,
1416 1417 1418
                                  _("Failed to compile regex %s"), error);
            for (j = 0 ; j <= i ; j++)
                regfree(&reg[j]);
1419
            VIR_FREE(reg);
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
            return -1;
        }

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

    }

    /* Storage for matched variables */
1430
    if (VIR_ALLOC_N(groups, totgroups) < 0) {
1431
        virReportOOMError();
1432 1433
        goto cleanup;
    }
1434
    if (VIR_ALLOC_N(vars, maxvars+1) < 0) {
1435
        virReportOOMError();
1436 1437 1438
        goto cleanup;
    }

1439 1440 1441
    cmd = virCommandNewArgs(prog);
    virCommandSetOutputFD(cmd, &fd);
    if (virCommandRunAsync(cmd, NULL) < 0) {
1442 1443 1444
        goto cleanup;
    }

1445
    if ((list = VIR_FDOPEN(fd, "r")) == NULL) {
1446
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
J
Jim Meyering 已提交
1447
                              "%s", _("cannot read fd"));
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
        goto cleanup;
    }

    while (fgets(line, sizeof(line), list) != NULL) {
        /* Strip trailing newline */
        int len = strlen(line);
        if (len && line[len-1] == '\n')
            line[len-1] = '\0';

        for (i = 0 ; i <= maxReg && i < nregex ; i++) {
            if (regexec(&reg[i], line, nvars[i]+1, vars, 0) == 0) {
                maxReg++;

                if (i == 0)
                    ngroup = 0;

                /* NULL terminate each captured group in the line */
                for (j = 0 ; j < nvars[i] ; j++) {
                    /* NB vars[0] is the full pattern, so we offset j by 1 */
                    line[vars[j+1].rm_eo] = '\0';
                    if ((groups[ngroup++] =
                         strdup(line + vars[j+1].rm_so)) == NULL) {
1470
                        virReportOOMError();
1471 1472 1473 1474 1475 1476
                        goto cleanup;
                    }
                }

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

                    /* Release matches & restart to matching the first regex */
1481
                    for (j = 0 ; j < totgroups ; j++)
1482
                        VIR_FREE(groups[j]);
1483 1484 1485 1486 1487 1488 1489
                    maxReg = 0;
                    ngroup = 0;
                }
            }
        }
    }

1490
    ret = virCommandWait(cmd, NULL);
1491
cleanup:
1492 1493
    if (groups) {
        for (j = 0 ; j < totgroups ; j++)
1494 1495
            VIR_FREE(groups[j]);
        VIR_FREE(groups);
1496
    }
1497
    VIR_FREE(vars);
1498 1499 1500 1501

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

1502
    VIR_FREE(reg);
1503
    virCommandFree(cmd);
1504

1505 1506
    VIR_FORCE_FCLOSE(list);
    VIR_FORCE_CLOSE(fd);
1507

1508
    return ret;
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
}

/*
 * Run an external program and read from its standard output
 * a stream of tokens from IN_STREAM, applying FUNC to
 * each successive sequence of N_COLUMNS tokens.
 * If FUNC returns < 0, stop processing input and return -1.
 * Return -1 if N_COLUMNS == 0.
 * Return -1 upon memory allocation error.
 * If the number of input tokens is not a multiple of N_COLUMNS,
 * then the final FUNC call will specify a number smaller than N_COLUMNS.
 * If there are no input tokens (empty input), call FUNC with N_COLUMNS == 0.
 */
int
1523
virStorageBackendRunProgNul(virStoragePoolObjPtr pool,
1524 1525 1526 1527 1528 1529
                            const char **prog,
                            size_t n_columns,
                            virStorageBackendListVolNulFunc func,
                            void *data)
{
    size_t n_tok = 0;
1530
    int fd = -1;
1531 1532
    FILE *fp = NULL;
    char **v;
1533
    int ret = -1;
1534
    int i;
1535
    virCommandPtr cmd = NULL;
1536 1537 1538 1539

    if (n_columns == 0)
        return -1;

1540
    if (VIR_ALLOC_N(v, n_columns) < 0) {
1541
        virReportOOMError();
1542 1543 1544 1545 1546
        return -1;
    }
    for (i = 0; i < n_columns; i++)
        v[i] = NULL;

1547 1548 1549
    cmd = virCommandNewArgs(prog);
    virCommandSetOutputFD(cmd, &fd);
    if (virCommandRunAsync(cmd, NULL) < 0) {
1550 1551 1552
        goto cleanup;
    }

1553
    if ((fp = VIR_FDOPEN(fd, "r")) == NULL) {
1554
        virStorageReportError(VIR_ERR_INTERNAL_ERROR,
1555
                              "%s", _("cannot open file using fd"));
1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568
        goto cleanup;
    }

    while (1) {
        char *buf = NULL;
        size_t buf_len = 0;
        /* Be careful: even when it returns -1,
           this use of getdelim allocates memory.  */
        ssize_t tok_len = getdelim (&buf, &buf_len, 0, fp);
        v[n_tok] = buf;
        if (tok_len < 0) {
            /* Maybe EOF, maybe an error.
               If n_tok > 0, then we know it's an error.  */
1569
            if (n_tok && func (pool, n_tok, v, data) < 0)
1570 1571 1572 1573 1574
                goto cleanup;
            break;
        }
        ++n_tok;
        if (n_tok == n_columns) {
1575
            if (func (pool, n_tok, v, data) < 0)
1576 1577 1578
                goto cleanup;
            n_tok = 0;
            for (i = 0; i < n_columns; i++) {
1579
                VIR_FREE(v[i]);
1580 1581 1582 1583
            }
        }
    }

1584
    if (feof (fp) < 0) {
1585
        virReportSystemError(errno,
1586
                             _("read error on pipe to '%s'"), prog[0]);
1587 1588
        goto cleanup;
    }
1589

1590
    ret = virCommandWait(cmd, NULL);
1591 1592
 cleanup:
    for (i = 0; i < n_columns; i++)
1593 1594
        VIR_FREE(v[i]);
    VIR_FREE(v);
1595
    virCommandFree(cmd);
1596

1597 1598
    VIR_FORCE_FCLOSE(fp);
    VIR_FORCE_CLOSE(fd);
1599

1600
    return ret;
1601
}
D
Daniel P. Berrange 已提交
1602

1603
#else /* WIN32 */
D
Daniel P. Berrange 已提交
1604 1605 1606 1607 1608 1609 1610 1611 1612

int
virStorageBackendRunProgRegex(virConnectPtr conn,
                              virStoragePoolObjPtr pool ATTRIBUTE_UNUSED,
                              const char *const*prog ATTRIBUTE_UNUSED,
                              int nregex ATTRIBUTE_UNUSED,
                              const char **regex ATTRIBUTE_UNUSED,
                              int *nvars ATTRIBUTE_UNUSED,
                              virStorageBackendListVolRegexFunc func ATTRIBUTE_UNUSED,
1613
                              void *data ATTRIBUTE_UNUSED)
D
Daniel P. Berrange 已提交
1614
{
1615 1616
    virStorageReportError(VIR_ERR_INTERNAL_ERROR,
                          _("%s not implemented on Win32"), __FUNCTION__);
D
Daniel P. Berrange 已提交
1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627
    return -1;
}

int
virStorageBackendRunProgNul(virConnectPtr conn,
                            virStoragePoolObjPtr pool ATTRIBUTE_UNUSED,
                            const char **prog ATTRIBUTE_UNUSED,
                            size_t n_columns ATTRIBUTE_UNUSED,
                            virStorageBackendListVolNulFunc func ATTRIBUTE_UNUSED,
                            void *data ATTRIBUTE_UNUSED)
{
1628
    virStorageReportError(VIR_ERR_INTERNAL_ERROR, _("%s not implemented on Win32"), __FUNCTION__);
D
Daniel P. Berrange 已提交
1629 1630
    return -1;
}
1631
#endif /* WIN32 */