block.c 65.7 KB
Newer Older
B
bellard 已提交
1 2
/*
 * QEMU System Emulator block driver
3
 *
B
bellard 已提交
4
 * Copyright (c) 2003 Fabrice Bellard
5
 *
B
bellard 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
24
#include "config-host.h"
P
pbrook 已提交
25
#include "qemu-common.h"
A
aliguori 已提交
26
#include "monitor.h"
B
bellard 已提交
27
#include "block_int.h"
28
#include "module.h"
29
#include "qemu-objects.h"
B
bellard 已提交
30

J
Juan Quintela 已提交
31
#ifdef CONFIG_BSD
B
bellard 已提交
32 33 34
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/ioctl.h>
B
Blue Swirl 已提交
35
#include <sys/queue.h>
36
#ifndef __DragonFly__
B
bellard 已提交
37 38
#include <sys/disk.h>
#endif
39
#endif
B
bellard 已提交
40

41 42 43 44
#ifdef _WIN32
#include <windows.h>
#endif

45 46
static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
47
        BlockDriverCompletionFunc *cb, void *opaque);
48 49
static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
50
        BlockDriverCompletionFunc *cb, void *opaque);
51 52
static BlockDriverAIOCB *bdrv_aio_flush_em(BlockDriverState *bs,
        BlockDriverCompletionFunc *cb, void *opaque);
53 54
static BlockDriverAIOCB *bdrv_aio_noop_em(BlockDriverState *bs,
        BlockDriverCompletionFunc *cb, void *opaque);
55
static int bdrv_read_em(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
56 57 58
                        uint8_t *buf, int nb_sectors);
static int bdrv_write_em(BlockDriverState *bs, int64_t sector_num,
                         const uint8_t *buf, int nb_sectors);
B
bellard 已提交
59

60 61
static QTAILQ_HEAD(, BlockDriverState) bdrv_states =
    QTAILQ_HEAD_INITIALIZER(bdrv_states);
62

63 64
static QLIST_HEAD(, BlockDriver) bdrv_drivers =
    QLIST_HEAD_INITIALIZER(bdrv_drivers);
B
bellard 已提交
65

66 67 68
/* If non-zero, use only whitelisted block drivers */
static int use_bdrv_whitelist;

B
bellard 已提交
69
int path_is_absolute(const char *path)
70
{
B
bellard 已提交
71
    const char *p;
B
bellard 已提交
72 73 74 75 76
#ifdef _WIN32
    /* specific case for names like: "\\.\d:" */
    if (*path == '/' || *path == '\\')
        return 1;
#endif
B
bellard 已提交
77 78 79 80 81
    p = strchr(path, ':');
    if (p)
        p++;
    else
        p = path;
82 83 84 85 86
#ifdef _WIN32
    return (*p == '/' || *p == '\\');
#else
    return (*p == '/');
#endif
87 88
}

B
bellard 已提交
89 90 91 92 93 94
/* if filename is absolute, just copy it to dest. Otherwise, build a
   path to it by considering it is relative to base_path. URL are
   supported. */
void path_combine(char *dest, int dest_size,
                  const char *base_path,
                  const char *filename)
95
{
B
bellard 已提交
96 97 98 99 100 101 102 103 104 105 106 107 108
    const char *p, *p1;
    int len;

    if (dest_size <= 0)
        return;
    if (path_is_absolute(filename)) {
        pstrcpy(dest, dest_size, filename);
    } else {
        p = strchr(base_path, ':');
        if (p)
            p++;
        else
            p = base_path;
109 110 111 112 113 114 115 116 117
        p1 = strrchr(base_path, '/');
#ifdef _WIN32
        {
            const char *p2;
            p2 = strrchr(base_path, '\\');
            if (!p1 || p2 > p1)
                p1 = p2;
        }
#endif
B
bellard 已提交
118 119 120 121 122 123 124 125 126 127 128 129
        if (p1)
            p1++;
        else
            p1 = base_path;
        if (p1 > p)
            p = p1;
        len = p - base_path;
        if (len > dest_size - 1)
            len = dest_size - 1;
        memcpy(dest, base_path, len);
        dest[len] = '\0';
        pstrcat(dest, dest_size, filename);
130 131 132
    }
}

133
void bdrv_register(BlockDriver *bdrv)
B
bellard 已提交
134
{
135
    if (!bdrv->bdrv_aio_readv) {
B
bellard 已提交
136
        /* add AIO emulation layer */
137 138
        bdrv->bdrv_aio_readv = bdrv_aio_readv_em;
        bdrv->bdrv_aio_writev = bdrv_aio_writev_em;
139
    } else if (!bdrv->bdrv_read) {
B
bellard 已提交
140 141 142 143
        /* add synchronous IO emulation layer */
        bdrv->bdrv_read = bdrv_read_em;
        bdrv->bdrv_write = bdrv_write_em;
    }
144 145 146 147

    if (!bdrv->bdrv_aio_flush)
        bdrv->bdrv_aio_flush = bdrv_aio_flush_em;

148
    QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list);
B
bellard 已提交
149
}
B
bellard 已提交
150 151 152 153

/* create a new block device (by default it is empty) */
BlockDriverState *bdrv_new(const char *device_name)
{
154
    BlockDriverState *bs;
B
bellard 已提交
155 156 157

    bs = qemu_mallocz(sizeof(BlockDriverState));
    pstrcpy(bs->device_name, sizeof(bs->device_name), device_name);
B
bellard 已提交
158
    if (device_name[0] != '\0') {
159
        QTAILQ_INSERT_TAIL(&bdrv_states, bs, list);
B
bellard 已提交
160
    }
B
bellard 已提交
161 162 163
    return bs;
}

B
bellard 已提交
164 165 166
BlockDriver *bdrv_find_format(const char *format_name)
{
    BlockDriver *drv1;
167 168
    QLIST_FOREACH(drv1, &bdrv_drivers, list) {
        if (!strcmp(drv1->format_name, format_name)) {
B
bellard 已提交
169
            return drv1;
170
        }
B
bellard 已提交
171 172 173 174
    }
    return NULL;
}

175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
static int bdrv_is_whitelisted(BlockDriver *drv)
{
    static const char *whitelist[] = {
        CONFIG_BDRV_WHITELIST
    };
    const char **p;

    if (!whitelist[0])
        return 1;               /* no whitelist, anything goes */

    for (p = whitelist; *p; p++) {
        if (!strcmp(drv->format_name, *p)) {
            return 1;
        }
    }
    return 0;
}

BlockDriver *bdrv_find_whitelisted_format(const char *format_name)
{
    BlockDriver *drv = bdrv_find_format(format_name);
    return drv && bdrv_is_whitelisted(drv) ? drv : NULL;
}

199 200
int bdrv_create(BlockDriver *drv, const char* filename,
    QEMUOptionParameter *options)
B
bellard 已提交
201 202 203
{
    if (!drv->bdrv_create)
        return -ENOTSUP;
204 205

    return drv->bdrv_create(filename, options);
B
bellard 已提交
206 207
}

208 209 210 211
int bdrv_create_file(const char* filename, QEMUOptionParameter *options)
{
    BlockDriver *drv;

212
    drv = bdrv_find_protocol(filename);
213 214 215 216 217 218 219
    if (drv == NULL) {
        drv = bdrv_find_format("file");
    }

    return bdrv_create(drv, filename, options);
}

B
bellard 已提交
220
#ifdef _WIN32
221
void get_tmp_filename(char *filename, int size)
B
bellard 已提交
222
{
223
    char temp_dir[MAX_PATH];
224

225 226
    GetTempPath(MAX_PATH, temp_dir);
    GetTempFileName(temp_dir, "qem", 0, filename);
B
bellard 已提交
227 228
}
#else
229
void get_tmp_filename(char *filename, int size)
B
bellard 已提交
230
{
B
bellard 已提交
231
    int fd;
232
    const char *tmpdir;
B
bellard 已提交
233
    /* XXX: race condition possible */
A
aurel32 已提交
234 235 236 237
    tmpdir = getenv("TMPDIR");
    if (!tmpdir)
        tmpdir = "/tmp";
    snprintf(filename, size, "%s/vl.XXXXXX", tmpdir);
B
bellard 已提交
238 239 240
    fd = mkstemp(filename);
    close(fd);
}
B
bellard 已提交
241
#endif
B
bellard 已提交
242

B
bellard 已提交
243
#ifdef _WIN32
B
bellard 已提交
244 245 246 247 248 249
static int is_windows_drive_prefix(const char *filename)
{
    return (((filename[0] >= 'a' && filename[0] <= 'z') ||
             (filename[0] >= 'A' && filename[0] <= 'Z')) &&
            filename[1] == ':');
}
250

251
int is_windows_drive(const char *filename)
B
bellard 已提交
252
{
253
    if (is_windows_drive_prefix(filename) &&
B
bellard 已提交
254
        filename[2] == '\0')
B
bellard 已提交
255 256 257 258 259 260 261 262
        return 1;
    if (strstart(filename, "\\\\.\\", NULL) ||
        strstart(filename, "//./", NULL))
        return 1;
    return 0;
}
#endif

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
/*
 * Detect host devices. By convention, /dev/cdrom[N] is always
 * recognized as a host CDROM.
 */
static BlockDriver *find_hdev_driver(const char *filename)
{
    int score_max = 0, score;
    BlockDriver *drv = NULL, *d;

    QLIST_FOREACH(d, &bdrv_drivers, list) {
        if (d->bdrv_probe_device) {
            score = d->bdrv_probe_device(filename);
            if (score > score_max) {
                score_max = score;
                drv = d;
            }
        }
    }

    return drv;
}

285
BlockDriver *bdrv_find_protocol(const char *filename)
B
bellard 已提交
286 287 288
{
    BlockDriver *drv1;
    char protocol[128];
289
    int len;
B
bellard 已提交
290
    const char *p;
291
    int is_drive;
B
bellard 已提交
292

293 294
    /* TODO Drivers without bdrv_file_open must be specified explicitly */

B
bellard 已提交
295
#ifdef _WIN32
296 297 298 299
    is_drive = is_windows_drive(filename) ||
        is_windows_drive_prefix(filename);
#else
    is_drive = 0;
B
bellard 已提交
300
#endif
301
    p = strchr(filename, ':');
302
    if (!p || is_drive) {
303 304 305 306 307 308
        drv1 = find_hdev_driver(filename);
        if (!drv1) {
            drv1 = bdrv_find_format("file");
        }
        return drv1;
    }
309 310 311 312 313
    len = p - filename;
    if (len > sizeof(protocol) - 1)
        len = sizeof(protocol) - 1;
    memcpy(protocol, filename, len);
    protocol[len] = '\0';
314
    QLIST_FOREACH(drv1, &bdrv_drivers, list) {
315
        if (drv1->protocol_name &&
316
            !strcmp(drv1->protocol_name, protocol)) {
B
bellard 已提交
317
            return drv1;
318
        }
B
bellard 已提交
319 320 321 322
    }
    return NULL;
}

323 324 325 326 327 328 329
static BlockDriver *find_image_format(const char *filename)
{
    int ret, score, score_max;
    BlockDriver *drv1, *drv;
    uint8_t buf[2048];
    BlockDriverState *bs;

330
    ret = bdrv_file_open(&bs, filename, 0);
B
bellard 已提交
331 332
    if (ret < 0)
        return NULL;
333

334 335
    /* Return the raw BlockDriver * to scsi-generic devices or empty drives */
    if (bs->sg || !bdrv_is_inserted(bs)) {
336
        bdrv_delete(bs);
337
        return bdrv_find_format("raw");
338
    }
339

B
bellard 已提交
340 341 342 343 344 345
    ret = bdrv_pread(bs, 0, buf, sizeof(buf));
    bdrv_delete(bs);
    if (ret < 0) {
        return NULL;
    }

B
bellard 已提交
346
    score_max = 0;
347
    drv = NULL;
348
    QLIST_FOREACH(drv1, &bdrv_drivers, list) {
B
bellard 已提交
349 350 351 352 353 354
        if (drv1->bdrv_probe) {
            score = drv1->bdrv_probe(buf, ret, filename);
            if (score > score_max) {
                score_max = score;
                drv = drv1;
            }
B
bellard 已提交
355
        }
B
bellard 已提交
356
    }
B
bellard 已提交
357 358 359
    return drv;
}

360 361 362 363 364 365 366
/**
 * Set the current 'total_sectors' value
 */
static int refresh_total_sectors(BlockDriverState *bs, int64_t hint)
{
    BlockDriver *drv = bs->drv;

367 368 369 370
    /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */
    if (bs->sg)
        return 0;

371 372 373 374 375 376 377 378 379 380 381 382 383
    /* query actual device if possible, otherwise just trust the hint */
    if (drv->bdrv_getlength) {
        int64_t length = drv->bdrv_getlength(bs);
        if (length < 0) {
            return length;
        }
        hint = length >> BDRV_SECTOR_BITS;
    }

    bs->total_sectors = hint;
    return 0;
}

384 385 386 387 388 389 390 391 392 393
/*
 * Common part for opening disk images and files
 */
static int bdrv_open_common(BlockDriverState *bs, const char *filename,
    int flags, BlockDriver *drv)
{
    int ret, open_flags;

    assert(drv != NULL);

394
    bs->file = NULL;
395
    bs->total_sectors = 0;
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
    bs->is_temporary = 0;
    bs->encrypted = 0;
    bs->valid_key = 0;
    bs->open_flags = flags;
    /* buffer_alignment defaulted to 512, drivers can change this value */
    bs->buffer_alignment = 512;

    pstrcpy(bs->filename, sizeof(bs->filename), filename);

    if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv)) {
        return -ENOTSUP;
    }

    bs->drv = drv;
    bs->opaque = qemu_mallocz(drv->instance_size);

    /*
     * Yes, BDRV_O_NOCACHE aka O_DIRECT means we have to present a
     * write cache to the guest.  We do need the fdatasync to flush
     * out transactions for block allocations, and we maybe have a
     * volatile write cache in our backing device to deal with.
     */
    if (flags & (BDRV_O_CACHE_WB|BDRV_O_NOCACHE))
        bs->enable_write_cache = 1;

    /*
     * Clear flags that are internal to the block layer before opening the
     * image.
     */
    open_flags = flags & ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);

    /*
     * Snapshots should be writeable.
     */
    if (bs->is_temporary) {
        open_flags |= BDRV_O_RDWR;
    }

434 435 436 437 438 439 440 441 442 443
    /* Open the image, either directly or using a protocol */
    if (drv->bdrv_file_open) {
        ret = drv->bdrv_file_open(bs, filename, open_flags);
    } else {
        ret = bdrv_file_open(&bs->file, filename, open_flags);
        if (ret >= 0) {
            ret = drv->bdrv_open(bs, open_flags);
        }
    }

444 445 446 447 448
    if (ret < 0) {
        goto free_and_fail;
    }

    bs->keep_read_only = bs->read_only = !(open_flags & BDRV_O_RDWR);
449 450 451 452

    ret = refresh_total_sectors(bs, bs->total_sectors);
    if (ret < 0) {
        goto free_and_fail;
453
    }
454

455 456 457 458 459 460 461 462
#ifndef _WIN32
    if (bs->is_temporary) {
        unlink(filename);
    }
#endif
    return 0;

free_and_fail:
463 464 465 466
    if (bs->file) {
        bdrv_delete(bs->file);
        bs->file = NULL;
    }
467 468 469 470 471 472
    qemu_free(bs->opaque);
    bs->opaque = NULL;
    bs->drv = NULL;
    return ret;
}

K
Kevin Wolf 已提交
473 474 475
/*
 * Opens a file using a protocol (file, host_device, nbd, ...)
 */
B
bellard 已提交
476
int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags)
B
bellard 已提交
477
{
B
bellard 已提交
478
    BlockDriverState *bs;
479
    BlockDriver *drv;
B
bellard 已提交
480 481
    int ret;

482
    drv = bdrv_find_protocol(filename);
483 484 485 486
    if (!drv) {
        return -ENOENT;
    }

B
bellard 已提交
487
    bs = bdrv_new("");
K
Kevin Wolf 已提交
488
    ret = bdrv_open_common(bs, filename, flags, drv);
B
bellard 已提交
489 490 491
    if (ret < 0) {
        bdrv_delete(bs);
        return ret;
492
    }
493
    bs->growable = 1;
B
bellard 已提交
494 495 496 497
    *pbs = bs;
    return 0;
}

K
Kevin Wolf 已提交
498 499 500
/*
 * Opens a disk image (raw, qcow2, vmdk, ...)
 */
K
Kevin Wolf 已提交
501 502
int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
              BlockDriver *drv)
B
bellard 已提交
503
{
K
Kevin Wolf 已提交
504
    int ret;
B
bellard 已提交
505

B
bellard 已提交
506
    if (flags & BDRV_O_SNAPSHOT) {
B
bellard 已提交
507 508
        BlockDriverState *bs1;
        int64_t total_size;
A
aliguori 已提交
509
        int is_protocol = 0;
K
Kevin Wolf 已提交
510 511
        BlockDriver *bdrv_qcow2;
        QEMUOptionParameter *options;
K
Kevin Wolf 已提交
512 513
        char tmp_filename[PATH_MAX];
        char backing_filename[PATH_MAX];
514

B
bellard 已提交
515 516
        /* if snapshot, we create a temporary backing file and open it
           instead of opening 'filename' directly */
517

B
bellard 已提交
518 519
        /* if there is a backing file, use it */
        bs1 = bdrv_new("");
K
Kevin Wolf 已提交
520
        ret = bdrv_open(bs1, filename, 0, drv);
521
        if (ret < 0) {
B
bellard 已提交
522
            bdrv_delete(bs1);
523
            return ret;
B
bellard 已提交
524
        }
525
        total_size = bdrv_getlength(bs1) & BDRV_SECTOR_MASK;
A
aliguori 已提交
526 527 528 529

        if (bs1->drv && bs1->drv->protocol_name)
            is_protocol = 1;

B
bellard 已提交
530
        bdrv_delete(bs1);
531

B
bellard 已提交
532
        get_tmp_filename(tmp_filename, sizeof(tmp_filename));
A
aliguori 已提交
533 534 535 536 537

        /* Real path is meaningless for protocols */
        if (is_protocol)
            snprintf(backing_filename, sizeof(backing_filename),
                     "%s", filename);
538 539
        else if (!realpath(filename, backing_filename))
            return -errno;
A
aliguori 已提交
540

K
Kevin Wolf 已提交
541 542 543
        bdrv_qcow2 = bdrv_find_format("qcow2");
        options = parse_option_parameters("", bdrv_qcow2->create_options, NULL);

544
        set_option_parameter_int(options, BLOCK_OPT_SIZE, total_size);
K
Kevin Wolf 已提交
545 546 547 548 549 550 551
        set_option_parameter(options, BLOCK_OPT_BACKING_FILE, backing_filename);
        if (drv) {
            set_option_parameter(options, BLOCK_OPT_BACKING_FMT,
                drv->format_name);
        }

        ret = bdrv_create(bdrv_qcow2, tmp_filename, options);
552
        free_option_parameters(options);
553 554
        if (ret < 0) {
            return ret;
B
bellard 已提交
555
        }
K
Kevin Wolf 已提交
556

B
bellard 已提交
557
        filename = tmp_filename;
K
Kevin Wolf 已提交
558
        drv = bdrv_qcow2;
B
bellard 已提交
559 560
        bs->is_temporary = 1;
    }
B
bellard 已提交
561

K
Kevin Wolf 已提交
562
    /* Find the right image format driver */
563
    if (!drv) {
564
        drv = find_image_format(filename);
565
    }
566

567 568 569
    if (!drv) {
        ret = -ENOENT;
        goto unlink_and_fail;
B
bellard 已提交
570
    }
K
Kevin Wolf 已提交
571 572 573 574

    /* Open the image */
    ret = bdrv_open_common(bs, filename, flags, drv);
    if (ret < 0) {
575 576 577
        goto unlink_and_fail;
    }

K
Kevin Wolf 已提交
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
    /* If there is a backing file, use it */
    if ((flags & BDRV_O_NO_BACKING) == 0 && bs->backing_file[0] != '\0') {
        char backing_filename[PATH_MAX];
        int back_flags;
        BlockDriver *back_drv = NULL;

        bs->backing_hd = bdrv_new("");
        path_combine(backing_filename, sizeof(backing_filename),
                     filename, bs->backing_file);
        if (bs->backing_format[0] != '\0')
            back_drv = bdrv_find_format(bs->backing_format);

        /* backing files always opened read-only */
        back_flags =
            flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);

        ret = bdrv_open(bs->backing_hd, backing_filename, back_flags, back_drv);
        if (ret < 0) {
            bdrv_close(bs);
            return ret;
        }
        if (bs->is_temporary) {
            bs->backing_hd->keep_read_only = !(flags & BDRV_O_RDWR);
        } else {
            /* base image inherits from "parent" */
            bs->backing_hd->keep_read_only = bs->keep_read_only;
        }
    }

    if (!bdrv_key_required(bs)) {
        /* call the change callback */
        bs->media_changed = 1;
        if (bs->change_cb)
            bs->change_cb(bs->change_opaque);
    }

    return 0;

unlink_and_fail:
    if (bs->is_temporary) {
        unlink(filename);
    }
    return ret;
}

B
bellard 已提交
623 624
void bdrv_close(BlockDriverState *bs)
{
B
bellard 已提交
625
    if (bs->drv) {
626
        if (bs->backing_hd) {
B
bellard 已提交
627
            bdrv_delete(bs->backing_hd);
628 629
            bs->backing_hd = NULL;
        }
B
bellard 已提交
630 631 632 633 634 635
        bs->drv->bdrv_close(bs);
        qemu_free(bs->opaque);
#ifdef _WIN32
        if (bs->is_temporary) {
            unlink(bs->filename);
        }
B
bellard 已提交
636
#endif
B
bellard 已提交
637 638
        bs->opaque = NULL;
        bs->drv = NULL;
B
bellard 已提交
639

640 641 642 643
        if (bs->file != NULL) {
            bdrv_close(bs->file);
        }

B
bellard 已提交
644
        /* call the change callback */
B
bellard 已提交
645
        bs->media_changed = 1;
B
bellard 已提交
646 647 648 649 650
        if (bs->change_cb)
            bs->change_cb(bs->change_opaque);
    }
}

651 652 653 654 655 656 657 658 659
void bdrv_close_all(void)
{
    BlockDriverState *bs;

    QTAILQ_FOREACH(bs, &bdrv_states, list) {
        bdrv_close(bs);
    }
}

B
bellard 已提交
660 661
void bdrv_delete(BlockDriverState *bs)
{
662 663 664 665
    /* remove from list, if necessary */
    if (bs->device_name[0] != '\0') {
        QTAILQ_REMOVE(&bdrv_states, bs, list);
    }
666

B
bellard 已提交
667
    bdrv_close(bs);
668 669 670 671
    if (bs->file != NULL) {
        bdrv_delete(bs->file);
    }

B
bellard 已提交
672
    qemu_free(bs);
B
bellard 已提交
673 674
}

A
aliguori 已提交
675 676 677 678 679 680 681 682 683 684 685 686 687 688
/*
 * Run consistency checks on an image
 *
 * Returns the number of errors or -errno when an internal error occurs
 */
int bdrv_check(BlockDriverState *bs)
{
    if (bs->drv->bdrv_check == NULL) {
        return -ENOTSUP;
    }

    return bs->drv->bdrv_check(bs);
}

689 690 691
/* commit COW file into the raw image */
int bdrv_commit(BlockDriverState *bs)
{
B
bellard 已提交
692
    BlockDriver *drv = bs->drv;
B
bellard 已提交
693
    int64_t i, total_sectors;
694 695
    int n, j, ro, open_flags;
    int ret = 0, rw_ret = 0;
696
    unsigned char sector[BDRV_SECTOR_SIZE];
697 698
    char filename[1024];
    BlockDriverState *bs_rw, *bs_ro;
699

B
bellard 已提交
700 701
    if (!drv)
        return -ENOMEDIUM;
702 703 704
    
    if (!bs->backing_hd) {
        return -ENOTSUP;
705 706
    }

707 708 709 710 711 712 713 714 715 716 717 718 719
    if (bs->backing_hd->keep_read_only) {
        return -EACCES;
    }
    
    ro = bs->backing_hd->read_only;
    strncpy(filename, bs->backing_hd->filename, sizeof(filename));
    open_flags =  bs->backing_hd->open_flags;

    if (ro) {
        /* re-open as RW */
        bdrv_delete(bs->backing_hd);
        bs->backing_hd = NULL;
        bs_rw = bdrv_new("");
K
Kevin Wolf 已提交
720
        rw_ret = bdrv_open(bs_rw, filename, open_flags | BDRV_O_RDWR, drv);
721 722 723 724
        if (rw_ret < 0) {
            bdrv_delete(bs_rw);
            /* try to re-open read-only */
            bs_ro = bdrv_new("");
K
Kevin Wolf 已提交
725
            ret = bdrv_open(bs_ro, filename, open_flags & ~BDRV_O_RDWR, drv);
726 727 728 729 730 731 732 733 734 735
            if (ret < 0) {
                bdrv_delete(bs_ro);
                /* drive not functional anymore */
                bs->drv = NULL;
                return ret;
            }
            bs->backing_hd = bs_ro;
            return rw_ret;
        }
        bs->backing_hd = bs_rw;
B
bellard 已提交
736
    }
737

J
Jan Kiszka 已提交
738
    total_sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
B
bellard 已提交
739
    for (i = 0; i < total_sectors;) {
B
bellard 已提交
740
        if (drv->bdrv_is_allocated(bs, i, 65536, &n)) {
B
bellard 已提交
741 742
            for(j = 0; j < n; j++) {
                if (bdrv_read(bs, i, sector, 1) != 0) {
743 744
                    ret = -EIO;
                    goto ro_cleanup;
B
bellard 已提交
745 746 747
                }

                if (bdrv_write(bs->backing_hd, i, sector, 1) != 0) {
748 749
                    ret = -EIO;
                    goto ro_cleanup;
B
bellard 已提交
750 751
                }
                i++;
752
	    }
B
bellard 已提交
753 754 755
	} else {
            i += n;
        }
756
    }
757

758 759 760 761
    if (drv->bdrv_make_empty) {
        ret = drv->bdrv_make_empty(bs);
        bdrv_flush(bs);
    }
762

763 764 765 766 767 768
    /*
     * Make sure all data we wrote to the backing device is actually
     * stable on disk.
     */
    if (bs->backing_hd)
        bdrv_flush(bs->backing_hd);
769 770 771 772 773 774 775 776

ro_cleanup:

    if (ro) {
        /* re-open as RO */
        bdrv_delete(bs->backing_hd);
        bs->backing_hd = NULL;
        bs_ro = bdrv_new("");
K
Kevin Wolf 已提交
777
        ret = bdrv_open(bs_ro, filename, open_flags & ~BDRV_O_RDWR, drv);
778 779 780 781 782 783 784 785 786 787
        if (ret < 0) {
            bdrv_delete(bs_ro);
            /* drive not functional anymore */
            bs->drv = NULL;
            return ret;
        }
        bs->backing_hd = bs_ro;
        bs->backing_hd->keep_read_only = 0;
    }

788
    return ret;
789 790
}

K
Kevin Wolf 已提交
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
/*
 * Return values:
 * 0        - success
 * -EINVAL  - backing format specified, but no file
 * -ENOSPC  - can't update the backing file because no space is left in the
 *            image file header
 * -ENOTSUP - format driver doesn't support changing the backing file
 */
int bdrv_change_backing_file(BlockDriverState *bs,
    const char *backing_file, const char *backing_fmt)
{
    BlockDriver *drv = bs->drv;

    if (drv->bdrv_change_backing_file != NULL) {
        return drv->bdrv_change_backing_file(bs, backing_file, backing_fmt);
    } else {
        return -ENOTSUP;
    }
}

811 812 813 814 815 816 817 818 819 820 821 822 823
static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset,
                                   size_t size)
{
    int64_t len;

    if (!bdrv_is_inserted(bs))
        return -ENOMEDIUM;

    if (bs->growable)
        return 0;

    len = bdrv_getlength(bs);

K
Kevin Wolf 已提交
824 825 826 827
    if (offset < 0)
        return -EIO;

    if ((offset > len) || (len - offset < size))
828 829 830 831 832 833 834 835
        return -EIO;

    return 0;
}

static int bdrv_check_request(BlockDriverState *bs, int64_t sector_num,
                              int nb_sectors)
{
836 837
    return bdrv_check_byte_request(bs, sector_num * BDRV_SECTOR_SIZE,
                                   nb_sectors * BDRV_SECTOR_SIZE);
838 839
}

B
bellard 已提交
840
/* return < 0 if error. See bdrv_write() for the return codes */
841
int bdrv_read(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
842 843
              uint8_t *buf, int nb_sectors)
{
B
bellard 已提交
844 845
    BlockDriver *drv = bs->drv;

B
bellard 已提交
846 847
    if (!drv)
        return -ENOMEDIUM;
848 849
    if (bdrv_check_request(bs, sector_num, nb_sectors))
        return -EIO;
B
bellard 已提交
850

851
    return drv->bdrv_read(bs, sector_num, buf, nb_sectors);
B
bellard 已提交
852 853
}

854
static void set_dirty_bitmap(BlockDriverState *bs, int64_t sector_num,
855
                             int nb_sectors, int dirty)
856 857
{
    int64_t start, end;
858
    unsigned long val, idx, bit;
859

J
Jan Kiszka 已提交
860
    start = sector_num / BDRV_SECTORS_PER_DIRTY_CHUNK;
861
    end = (sector_num + nb_sectors - 1) / BDRV_SECTORS_PER_DIRTY_CHUNK;
862 863

    for (; start <= end; start++) {
864 865 866 867
        idx = start / (sizeof(unsigned long) * 8);
        bit = start % (sizeof(unsigned long) * 8);
        val = bs->dirty_bitmap[idx];
        if (dirty) {
868 869 870 871
            if (!(val & (1 << bit))) {
                bs->dirty_count++;
                val |= 1 << bit;
            }
872
        } else {
873 874 875 876
            if (val & (1 << bit)) {
                bs->dirty_count--;
                val &= ~(1 << bit);
            }
877 878
        }
        bs->dirty_bitmap[idx] = val;
879 880 881
    }
}

882
/* Return < 0 if error. Important errors are:
B
bellard 已提交
883 884 885 886 887
  -EIO         generic I/O error (may happen for all errors)
  -ENOMEDIUM   No media inserted.
  -EINVAL      Invalid sector number or nb_sectors
  -EACCES      Trying to write a read-only device
*/
888
int bdrv_write(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
889 890
               const uint8_t *buf, int nb_sectors)
{
B
bellard 已提交
891
    BlockDriver *drv = bs->drv;
B
bellard 已提交
892 893
    if (!bs->drv)
        return -ENOMEDIUM;
B
bellard 已提交
894
    if (bs->read_only)
B
bellard 已提交
895
        return -EACCES;
896 897
    if (bdrv_check_request(bs, sector_num, nb_sectors))
        return -EIO;
898

899
    if (bs->dirty_bitmap) {
900 901
        set_dirty_bitmap(bs, sector_num, nb_sectors, 1);
    }
902

903 904 905 906
    if (bs->wr_highest_sector < sector_num + nb_sectors - 1) {
        bs->wr_highest_sector = sector_num + nb_sectors - 1;
    }

907
    return drv->bdrv_write(bs, sector_num, buf, nb_sectors);
B
bellard 已提交
908 909
}

910 911
int bdrv_pread(BlockDriverState *bs, int64_t offset,
               void *buf, int count1)
B
bellard 已提交
912
{
J
Jan Kiszka 已提交
913
    uint8_t tmp_buf[BDRV_SECTOR_SIZE];
B
bellard 已提交
914 915
    int len, nb_sectors, count;
    int64_t sector_num;
916
    int ret;
B
bellard 已提交
917 918 919

    count = count1;
    /* first read to align to sector start */
J
Jan Kiszka 已提交
920
    len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
B
bellard 已提交
921 922
    if (len > count)
        len = count;
J
Jan Kiszka 已提交
923
    sector_num = offset >> BDRV_SECTOR_BITS;
B
bellard 已提交
924
    if (len > 0) {
925 926
        if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
            return ret;
J
Jan Kiszka 已提交
927
        memcpy(buf, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), len);
B
bellard 已提交
928 929 930 931 932 933 934 935
        count -= len;
        if (count == 0)
            return count1;
        sector_num++;
        buf += len;
    }

    /* read the sectors "in place" */
J
Jan Kiszka 已提交
936
    nb_sectors = count >> BDRV_SECTOR_BITS;
B
bellard 已提交
937
    if (nb_sectors > 0) {
938 939
        if ((ret = bdrv_read(bs, sector_num, buf, nb_sectors)) < 0)
            return ret;
B
bellard 已提交
940
        sector_num += nb_sectors;
J
Jan Kiszka 已提交
941
        len = nb_sectors << BDRV_SECTOR_BITS;
B
bellard 已提交
942 943 944 945 946 947
        buf += len;
        count -= len;
    }

    /* add data from the last sector */
    if (count > 0) {
948 949
        if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
            return ret;
B
bellard 已提交
950 951 952 953 954
        memcpy(buf, tmp_buf, count);
    }
    return count1;
}

955 956
int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
                const void *buf, int count1)
B
bellard 已提交
957
{
J
Jan Kiszka 已提交
958
    uint8_t tmp_buf[BDRV_SECTOR_SIZE];
B
bellard 已提交
959 960
    int len, nb_sectors, count;
    int64_t sector_num;
961
    int ret;
B
bellard 已提交
962 963 964

    count = count1;
    /* first write to align to sector start */
J
Jan Kiszka 已提交
965
    len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
B
bellard 已提交
966 967
    if (len > count)
        len = count;
J
Jan Kiszka 已提交
968
    sector_num = offset >> BDRV_SECTOR_BITS;
B
bellard 已提交
969
    if (len > 0) {
970 971
        if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
            return ret;
J
Jan Kiszka 已提交
972
        memcpy(tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), buf, len);
973 974
        if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
            return ret;
B
bellard 已提交
975 976 977 978 979 980 981 982
        count -= len;
        if (count == 0)
            return count1;
        sector_num++;
        buf += len;
    }

    /* write the sectors "in place" */
J
Jan Kiszka 已提交
983
    nb_sectors = count >> BDRV_SECTOR_BITS;
B
bellard 已提交
984
    if (nb_sectors > 0) {
985 986
        if ((ret = bdrv_write(bs, sector_num, buf, nb_sectors)) < 0)
            return ret;
B
bellard 已提交
987
        sector_num += nb_sectors;
J
Jan Kiszka 已提交
988
        len = nb_sectors << BDRV_SECTOR_BITS;
B
bellard 已提交
989 990 991 992 993 994
        buf += len;
        count -= len;
    }

    /* add data from the last sector */
    if (count > 0) {
995 996
        if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
            return ret;
B
bellard 已提交
997
        memcpy(tmp_buf, buf, count);
998 999
        if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
            return ret;
B
bellard 已提交
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
    }
    return count1;
}

/**
 * Truncate file to 'offset' bytes (needed only for file protocols)
 */
int bdrv_truncate(BlockDriverState *bs, int64_t offset)
{
    BlockDriver *drv = bs->drv;
1010
    int ret;
B
bellard 已提交
1011
    if (!drv)
B
bellard 已提交
1012
        return -ENOMEDIUM;
B
bellard 已提交
1013 1014
    if (!drv->bdrv_truncate)
        return -ENOTSUP;
1015 1016
    if (bs->read_only)
        return -EACCES;
1017 1018 1019 1020 1021
    ret = drv->bdrv_truncate(bs, offset);
    if (ret == 0) {
        ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS);
    }
    return ret;
B
bellard 已提交
1022 1023 1024 1025 1026 1027 1028 1029 1030
}

/**
 * Length of a file in bytes. Return < 0 if error or unknown.
 */
int64_t bdrv_getlength(BlockDriverState *bs)
{
    BlockDriver *drv = bs->drv;
    if (!drv)
B
bellard 已提交
1031
        return -ENOMEDIUM;
1032 1033 1034 1035 1036 1037

    /* Fixed size devices use the total_sectors value for speed instead of
       issuing a length query (like lseek) on each call.  Also, legacy block
       drivers don't provide a bdrv_getlength function and must use
       total_sectors. */
    if (!bs->growable || !drv->bdrv_getlength) {
J
Jan Kiszka 已提交
1038
        return bs->total_sectors * BDRV_SECTOR_SIZE;
B
bellard 已提交
1039 1040
    }
    return drv->bdrv_getlength(bs);
B
bellard 已提交
1041 1042
}

B
bellard 已提交
1043
/* return 0 as number of sectors if no device present or error */
1044
void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr)
B
bellard 已提交
1045
{
B
bellard 已提交
1046 1047 1048 1049 1050
    int64_t length;
    length = bdrv_getlength(bs);
    if (length < 0)
        length = 0;
    else
J
Jan Kiszka 已提交
1051
        length = length >> BDRV_SECTOR_BITS;
B
bellard 已提交
1052
    *nb_sectors_ptr = length;
B
bellard 已提交
1053
}
B
bellard 已提交
1054

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
struct partition {
        uint8_t boot_ind;           /* 0x80 - active */
        uint8_t head;               /* starting head */
        uint8_t sector;             /* starting sector */
        uint8_t cyl;                /* starting cylinder */
        uint8_t sys_ind;            /* What partition type */
        uint8_t end_head;           /* end head */
        uint8_t end_sector;         /* end sector */
        uint8_t end_cyl;            /* end cylinder */
        uint32_t start_sect;        /* starting sector counting from 0 */
        uint32_t nr_sects;          /* nr of sectors in partition */
} __attribute__((packed));

/* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
static int guess_disk_lchs(BlockDriverState *bs,
                           int *pcylinders, int *pheads, int *psectors)
{
1072
    uint8_t buf[BDRV_SECTOR_SIZE];
1073 1074 1075
    int ret, i, heads, sectors, cylinders;
    struct partition *p;
    uint32_t nr_sects;
B
blueswir1 已提交
1076
    uint64_t nb_sectors;
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115

    bdrv_get_geometry(bs, &nb_sectors);

    ret = bdrv_read(bs, 0, buf, 1);
    if (ret < 0)
        return -1;
    /* test msdos magic */
    if (buf[510] != 0x55 || buf[511] != 0xaa)
        return -1;
    for(i = 0; i < 4; i++) {
        p = ((struct partition *)(buf + 0x1be)) + i;
        nr_sects = le32_to_cpu(p->nr_sects);
        if (nr_sects && p->end_head) {
            /* We make the assumption that the partition terminates on
               a cylinder boundary */
            heads = p->end_head + 1;
            sectors = p->end_sector & 63;
            if (sectors == 0)
                continue;
            cylinders = nb_sectors / (heads * sectors);
            if (cylinders < 1 || cylinders > 16383)
                continue;
            *pheads = heads;
            *psectors = sectors;
            *pcylinders = cylinders;
#if 0
            printf("guessed geometry: LCHS=%d %d %d\n",
                   cylinders, heads, sectors);
#endif
            return 0;
        }
    }
    return -1;
}

void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs)
{
    int translation, lba_detected = 0;
    int cylinders, heads, secs;
B
blueswir1 已提交
1116
    uint64_t nb_sectors;
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170

    /* if a geometry hint is available, use it */
    bdrv_get_geometry(bs, &nb_sectors);
    bdrv_get_geometry_hint(bs, &cylinders, &heads, &secs);
    translation = bdrv_get_translation_hint(bs);
    if (cylinders != 0) {
        *pcyls = cylinders;
        *pheads = heads;
        *psecs = secs;
    } else {
        if (guess_disk_lchs(bs, &cylinders, &heads, &secs) == 0) {
            if (heads > 16) {
                /* if heads > 16, it means that a BIOS LBA
                   translation was active, so the default
                   hardware geometry is OK */
                lba_detected = 1;
                goto default_geometry;
            } else {
                *pcyls = cylinders;
                *pheads = heads;
                *psecs = secs;
                /* disable any translation to be in sync with
                   the logical geometry */
                if (translation == BIOS_ATA_TRANSLATION_AUTO) {
                    bdrv_set_translation_hint(bs,
                                              BIOS_ATA_TRANSLATION_NONE);
                }
            }
        } else {
        default_geometry:
            /* if no geometry, use a standard physical disk geometry */
            cylinders = nb_sectors / (16 * 63);

            if (cylinders > 16383)
                cylinders = 16383;
            else if (cylinders < 2)
                cylinders = 2;
            *pcyls = cylinders;
            *pheads = 16;
            *psecs = 63;
            if ((lba_detected == 1) && (translation == BIOS_ATA_TRANSLATION_AUTO)) {
                if ((*pcyls * *pheads) <= 131072) {
                    bdrv_set_translation_hint(bs,
                                              BIOS_ATA_TRANSLATION_LARGE);
                } else {
                    bdrv_set_translation_hint(bs,
                                              BIOS_ATA_TRANSLATION_LBA);
                }
            }
        }
        bdrv_set_geometry_hint(bs, *pcyls, *pheads, *psecs);
    }
}

1171
void bdrv_set_geometry_hint(BlockDriverState *bs,
B
bellard 已提交
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
                            int cyls, int heads, int secs)
{
    bs->cyls = cyls;
    bs->heads = heads;
    bs->secs = secs;
}

void bdrv_set_type_hint(BlockDriverState *bs, int type)
{
    bs->type = type;
    bs->removable = ((type == BDRV_TYPE_CDROM ||
                      type == BDRV_TYPE_FLOPPY));
}

B
bellard 已提交
1186 1187 1188 1189 1190
void bdrv_set_translation_hint(BlockDriverState *bs, int translation)
{
    bs->translation = translation;
}

1191
void bdrv_get_geometry_hint(BlockDriverState *bs,
B
bellard 已提交
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
                            int *pcyls, int *pheads, int *psecs)
{
    *pcyls = bs->cyls;
    *pheads = bs->heads;
    *psecs = bs->secs;
}

int bdrv_get_type_hint(BlockDriverState *bs)
{
    return bs->type;
}

B
bellard 已提交
1204 1205 1206 1207 1208
int bdrv_get_translation_hint(BlockDriverState *bs)
{
    return bs->translation;
}

B
bellard 已提交
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
int bdrv_is_removable(BlockDriverState *bs)
{
    return bs->removable;
}

int bdrv_is_read_only(BlockDriverState *bs)
{
    return bs->read_only;
}

1219 1220 1221 1222 1223
int bdrv_is_sg(BlockDriverState *bs)
{
    return bs->sg;
}

1224 1225 1226 1227 1228
int bdrv_enable_write_cache(BlockDriverState *bs)
{
    return bs->enable_write_cache;
}

B
bellard 已提交
1229
/* XXX: no longer used */
1230
void bdrv_set_change_cb(BlockDriverState *bs,
B
bellard 已提交
1231 1232 1233 1234 1235 1236
                        void (*change_cb)(void *opaque), void *opaque)
{
    bs->change_cb = change_cb;
    bs->change_opaque = opaque;
}

B
bellard 已提交
1237 1238 1239 1240 1241 1242 1243
int bdrv_is_encrypted(BlockDriverState *bs)
{
    if (bs->backing_hd && bs->backing_hd->encrypted)
        return 1;
    return bs->encrypted;
}

1244 1245 1246 1247 1248 1249 1250 1251 1252
int bdrv_key_required(BlockDriverState *bs)
{
    BlockDriverState *backing_hd = bs->backing_hd;

    if (backing_hd && backing_hd->encrypted && !backing_hd->valid_key)
        return 1;
    return (bs->encrypted && !bs->valid_key);
}

B
bellard 已提交
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
int bdrv_set_key(BlockDriverState *bs, const char *key)
{
    int ret;
    if (bs->backing_hd && bs->backing_hd->encrypted) {
        ret = bdrv_set_key(bs->backing_hd, key);
        if (ret < 0)
            return ret;
        if (!bs->encrypted)
            return 0;
    }
1263 1264 1265 1266 1267
    if (!bs->encrypted) {
        return -EINVAL;
    } else if (!bs->drv || !bs->drv->bdrv_set_key) {
        return -ENOMEDIUM;
    }
1268
    ret = bs->drv->bdrv_set_key(bs, key);
1269 1270 1271 1272 1273 1274 1275 1276 1277
    if (ret < 0) {
        bs->valid_key = 0;
    } else if (!bs->valid_key) {
        bs->valid_key = 1;
        /* call the change callback now, we skipped it on open */
        bs->media_changed = 1;
        if (bs->change_cb)
            bs->change_cb(bs->change_opaque);
    }
1278
    return ret;
B
bellard 已提交
1279 1280 1281 1282
}

void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size)
{
B
bellard 已提交
1283
    if (!bs->drv) {
B
bellard 已提交
1284 1285 1286 1287 1288 1289
        buf[0] = '\0';
    } else {
        pstrcpy(buf, buf_size, bs->drv->format_name);
    }
}

1290
void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
B
bellard 已提交
1291 1292 1293 1294
                         void *opaque)
{
    BlockDriver *drv;

1295
    QLIST_FOREACH(drv, &bdrv_drivers, list) {
B
bellard 已提交
1296 1297 1298 1299
        it(opaque, drv->format_name);
    }
}

B
bellard 已提交
1300 1301 1302 1303
BlockDriverState *bdrv_find(const char *name)
{
    BlockDriverState *bs;

1304 1305
    QTAILQ_FOREACH(bs, &bdrv_states, list) {
        if (!strcmp(name, bs->device_name)) {
B
bellard 已提交
1306
            return bs;
1307
        }
B
bellard 已提交
1308 1309 1310 1311
    }
    return NULL;
}

1312
void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), void *opaque)
B
bellard 已提交
1313 1314 1315
{
    BlockDriverState *bs;

1316
    QTAILQ_FOREACH(bs, &bdrv_states, list) {
1317
        it(opaque, bs);
B
bellard 已提交
1318 1319 1320
    }
}

B
bellard 已提交
1321 1322 1323 1324 1325
const char *bdrv_get_device_name(BlockDriverState *bs)
{
    return bs->device_name;
}

P
pbrook 已提交
1326 1327
void bdrv_flush(BlockDriverState *bs)
{
1328 1329 1330 1331
    if (bs->open_flags & BDRV_O_NO_FLUSH) {
        return;
    }

1332
    if (bs->drv && bs->drv->bdrv_flush)
P
pbrook 已提交
1333 1334 1335
        bs->drv->bdrv_flush(bs);
}

A
aliguori 已提交
1336 1337 1338 1339
void bdrv_flush_all(void)
{
    BlockDriverState *bs;

1340 1341 1342
    QTAILQ_FOREACH(bs, &bdrv_states, list) {
        if (bs->drv && !bdrv_is_read_only(bs) &&
            (!bdrv_is_removable(bs) || bdrv_is_inserted(bs))) {
A
aliguori 已提交
1343
            bdrv_flush(bs);
1344 1345
        }
    }
A
aliguori 已提交
1346 1347
}

K
Kevin Wolf 已提交
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
int bdrv_has_zero_init(BlockDriverState *bs)
{
    assert(bs->drv);

    if (bs->drv->no_zero_init) {
        return 0;
    } else if (bs->file) {
        return bdrv_has_zero_init(bs->file);
    }

    return 1;
}

1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387
/*
 * Returns true iff the specified sector is present in the disk image. Drivers
 * not implementing the functionality are assumed to not support backing files,
 * hence all their sectors are reported as allocated.
 *
 * 'pnum' is set to the number of sectors (including and immediately following
 * the specified sector) that are known to be in the same
 * allocated/unallocated state.
 *
 * 'nb_sectors' is the max value 'pnum' should be set to.
 */
int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
	int *pnum)
{
    int64_t n;
    if (!bs->drv->bdrv_is_allocated) {
        if (sector_num >= bs->total_sectors) {
            *pnum = 0;
            return 0;
        }
        n = bs->total_sectors - sector_num;
        *pnum = (n < nb_sectors) ? (n) : (nb_sectors);
        return 1;
    }
    return bs->drv->bdrv_is_allocated(bs, sector_num, nb_sectors, pnum);
}

1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
void bdrv_mon_event(const BlockDriverState *bdrv,
                    BlockMonEventAction action, int is_read)
{
    QObject *data;
    const char *action_str;

    switch (action) {
    case BDRV_ACTION_REPORT:
        action_str = "report";
        break;
    case BDRV_ACTION_IGNORE:
        action_str = "ignore";
        break;
    case BDRV_ACTION_STOP:
        action_str = "stop";
        break;
    default:
        abort();
    }

    data = qobject_from_jsonf("{ 'device': %s, 'action': %s, 'operation': %s }",
                              bdrv->device_name,
                              action_str,
                              is_read ? "read" : "write");
    monitor_protocol_event(QEVENT_BLOCK_IO_ERROR, data);

    qobject_decref(data);
}

1417
static void bdrv_print_dict(QObject *obj, void *opaque)
B
bellard 已提交
1418
{
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
    QDict *bs_dict;
    Monitor *mon = opaque;

    bs_dict = qobject_to_qdict(obj);

    monitor_printf(mon, "%s: type=%s removable=%d",
                        qdict_get_str(bs_dict, "device"),
                        qdict_get_str(bs_dict, "type"),
                        qdict_get_bool(bs_dict, "removable"));

    if (qdict_get_bool(bs_dict, "removable")) {
        monitor_printf(mon, " locked=%d", qdict_get_bool(bs_dict, "locked"));
    }

    if (qdict_haskey(bs_dict, "inserted")) {
        QDict *qdict = qobject_to_qdict(qdict_get(bs_dict, "inserted"));

        monitor_printf(mon, " file=");
        monitor_print_filename(mon, qdict_get_str(qdict, "file"));
        if (qdict_haskey(qdict, "backing_file")) {
            monitor_printf(mon, " backing_file=");
            monitor_print_filename(mon, qdict_get_str(qdict, "backing_file"));
        }
        monitor_printf(mon, " ro=%d drv=%s encrypted=%d",
                            qdict_get_bool(qdict, "ro"),
                            qdict_get_str(qdict, "drv"),
                            qdict_get_bool(qdict, "encrypted"));
    } else {
        monitor_printf(mon, " [not inserted]");
    }

    monitor_printf(mon, "\n");
}

void bdrv_info_print(Monitor *mon, const QObject *data)
{
    qlist_iter(qobject_to_qlist(data), bdrv_print_dict, mon);
}

void bdrv_info(Monitor *mon, QObject **ret_data)
{
    QList *bs_list;
B
bellard 已提交
1461 1462
    BlockDriverState *bs;

1463 1464
    bs_list = qlist_new();

1465
    QTAILQ_FOREACH(bs, &bdrv_states, list) {
1466 1467 1468
        QObject *bs_obj;
        const char *type = "unknown";

B
bellard 已提交
1469 1470
        switch(bs->type) {
        case BDRV_TYPE_HD:
1471
            type = "hd";
B
bellard 已提交
1472 1473
            break;
        case BDRV_TYPE_CDROM:
1474
            type = "cdrom";
B
bellard 已提交
1475 1476
            break;
        case BDRV_TYPE_FLOPPY:
1477
            type = "floppy";
B
bellard 已提交
1478 1479
            break;
        }
1480 1481 1482 1483 1484 1485

        bs_obj = qobject_from_jsonf("{ 'device': %s, 'type': %s, "
                                    "'removable': %i, 'locked': %i }",
                                    bs->device_name, type, bs->removable,
                                    bs->locked);

B
bellard 已提交
1486
        if (bs->drv) {
1487 1488 1489 1490 1491 1492 1493 1494
            QObject *obj;
            QDict *bs_dict = qobject_to_qdict(bs_obj);

            obj = qobject_from_jsonf("{ 'file': %s, 'ro': %i, 'drv': %s, "
                                     "'encrypted': %i }",
                                     bs->filename, bs->read_only,
                                     bs->drv->format_name,
                                     bdrv_is_encrypted(bs));
1495
            if (bs->backing_file[0] != '\0') {
1496 1497 1498
                QDict *qdict = qobject_to_qdict(obj);
                qdict_put(qdict, "backing_file",
                          qstring_from_str(bs->backing_file));
A
aliguori 已提交
1499
            }
1500 1501

            qdict_put_obj(bs_dict, "inserted", obj);
B
bellard 已提交
1502
        }
1503
        qlist_append_obj(bs_list, bs_obj);
B
bellard 已提交
1504
    }
1505 1506

    *ret_data = QOBJECT(bs_list);
B
bellard 已提交
1507
}
1508

1509
static void bdrv_stats_iter(QObject *data, void *opaque)
1510
{
1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
    QDict *qdict;
    Monitor *mon = opaque;

    qdict = qobject_to_qdict(data);
    monitor_printf(mon, "%s:", qdict_get_str(qdict, "device"));

    qdict = qobject_to_qdict(qdict_get(qdict, "stats"));
    monitor_printf(mon, " rd_bytes=%" PRId64
                        " wr_bytes=%" PRId64
                        " rd_operations=%" PRId64
                        " wr_operations=%" PRId64
                        "\n",
                        qdict_get_int(qdict, "rd_bytes"),
                        qdict_get_int(qdict, "wr_bytes"),
                        qdict_get_int(qdict, "rd_operations"),
                        qdict_get_int(qdict, "wr_operations"));
}

void bdrv_stats_print(Monitor *mon, const QObject *data)
{
    qlist_iter(qobject_to_qlist(data), bdrv_stats_iter, mon);
}

1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
static QObject* bdrv_info_stats_bs(BlockDriverState *bs)
{
    QObject *res;
    QDict *dict;

    res = qobject_from_jsonf("{ 'stats': {"
                             "'rd_bytes': %" PRId64 ","
                             "'wr_bytes': %" PRId64 ","
                             "'rd_operations': %" PRId64 ","
                             "'wr_operations': %" PRId64 ","
                             "'wr_highest_offset': %" PRId64
                             "} }",
                             bs->rd_bytes, bs->wr_bytes,
                             bs->rd_ops, bs->wr_ops,
1548
                             bs->wr_highest_sector * (long)BDRV_SECTOR_SIZE);
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
    dict  = qobject_to_qdict(res);

    if (*bs->device_name) {
        qdict_put(dict, "device", qstring_from_str(bs->device_name));
    }

    if (bs->file) {
        QObject *parent = bdrv_info_stats_bs(bs->file);
        qdict_put_obj(dict, "parent", parent);
    }

    return res;
}

1563 1564 1565 1566
void bdrv_info_stats(Monitor *mon, QObject **ret_data)
{
    QObject *obj;
    QList *devices;
1567 1568
    BlockDriverState *bs;

1569 1570
    devices = qlist_new();

1571
    QTAILQ_FOREACH(bs, &bdrv_states, list) {
1572
        obj = bdrv_info_stats_bs(bs);
1573
        qlist_append_obj(devices, obj);
1574
    }
1575 1576

    *ret_data = QOBJECT(devices);
1577
}
B
bellard 已提交
1578

1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
const char *bdrv_get_encrypted_filename(BlockDriverState *bs)
{
    if (bs->backing_hd && bs->backing_hd->encrypted)
        return bs->backing_file;
    else if (bs->encrypted)
        return bs->filename;
    else
        return NULL;
}

1589
void bdrv_get_backing_filename(BlockDriverState *bs,
B
bellard 已提交
1590 1591
                               char *filename, int filename_size)
{
K
Kevin Wolf 已提交
1592
    if (!bs->backing_file) {
B
bellard 已提交
1593 1594 1595 1596 1597 1598
        pstrcpy(filename, filename_size, "");
    } else {
        pstrcpy(filename, filename_size, bs->backing_file);
    }
}

1599
int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
1600 1601 1602 1603
                          const uint8_t *buf, int nb_sectors)
{
    BlockDriver *drv = bs->drv;
    if (!drv)
B
bellard 已提交
1604
        return -ENOMEDIUM;
B
bellard 已提交
1605 1606
    if (!drv->bdrv_write_compressed)
        return -ENOTSUP;
K
Kevin Wolf 已提交
1607 1608
    if (bdrv_check_request(bs, sector_num, nb_sectors))
        return -EIO;
1609

1610
    if (bs->dirty_bitmap) {
1611 1612
        set_dirty_bitmap(bs, sector_num, nb_sectors, 1);
    }
1613

B
bellard 已提交
1614 1615
    return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors);
}
1616

B
bellard 已提交
1617 1618 1619 1620
int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
{
    BlockDriver *drv = bs->drv;
    if (!drv)
B
bellard 已提交
1621
        return -ENOMEDIUM;
B
bellard 已提交
1622 1623 1624 1625 1626 1627
    if (!drv->bdrv_get_info)
        return -ENOTSUP;
    memset(bdi, 0, sizeof(*bdi));
    return drv->bdrv_get_info(bs, bdi);
}

1628 1629
int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
                      int64_t pos, int size)
1630 1631 1632 1633
{
    BlockDriver *drv = bs->drv;
    if (!drv)
        return -ENOMEDIUM;
1634 1635 1636 1637 1638
    if (drv->bdrv_save_vmstate)
        return drv->bdrv_save_vmstate(bs, buf, pos, size);
    if (bs->file)
        return bdrv_save_vmstate(bs->file, buf, pos, size);
    return -ENOTSUP;
1639 1640
}

1641 1642
int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
                      int64_t pos, int size)
1643 1644 1645 1646
{
    BlockDriver *drv = bs->drv;
    if (!drv)
        return -ENOMEDIUM;
1647 1648 1649 1650 1651
    if (drv->bdrv_load_vmstate)
        return drv->bdrv_load_vmstate(bs, buf, pos, size);
    if (bs->file)
        return bdrv_load_vmstate(bs->file, buf, pos, size);
    return -ENOTSUP;
1652 1653
}

K
Kevin Wolf 已提交
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event)
{
    BlockDriver *drv = bs->drv;

    if (!drv || !drv->bdrv_debug_event) {
        return;
    }

    return drv->bdrv_debug_event(bs, event);

}

B
bellard 已提交
1666 1667 1668
/**************************************************************/
/* handling of snapshots */

1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
int bdrv_can_snapshot(BlockDriverState *bs)
{
    BlockDriver *drv = bs->drv;
    if (!drv || bdrv_is_removable(bs) || bdrv_is_read_only(bs)) {
        return 0;
    }

    if (!drv->bdrv_snapshot_create) {
        if (bs->file != NULL) {
            return bdrv_can_snapshot(bs->file);
        }
        return 0;
    }

    return 1;
}

1686
int bdrv_snapshot_create(BlockDriverState *bs,
B
bellard 已提交
1687 1688 1689 1690
                         QEMUSnapshotInfo *sn_info)
{
    BlockDriver *drv = bs->drv;
    if (!drv)
B
bellard 已提交
1691
        return -ENOMEDIUM;
1692 1693 1694 1695 1696
    if (drv->bdrv_snapshot_create)
        return drv->bdrv_snapshot_create(bs, sn_info);
    if (bs->file)
        return bdrv_snapshot_create(bs->file, sn_info);
    return -ENOTSUP;
B
bellard 已提交
1697 1698
}

1699
int bdrv_snapshot_goto(BlockDriverState *bs,
B
bellard 已提交
1700 1701 1702
                       const char *snapshot_id)
{
    BlockDriver *drv = bs->drv;
1703 1704
    int ret, open_ret;

B
bellard 已提交
1705
    if (!drv)
B
bellard 已提交
1706
        return -ENOMEDIUM;
1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722
    if (drv->bdrv_snapshot_goto)
        return drv->bdrv_snapshot_goto(bs, snapshot_id);

    if (bs->file) {
        drv->bdrv_close(bs);
        ret = bdrv_snapshot_goto(bs->file, snapshot_id);
        open_ret = drv->bdrv_open(bs, bs->open_flags);
        if (open_ret < 0) {
            bdrv_delete(bs->file);
            bs->drv = NULL;
            return open_ret;
        }
        return ret;
    }

    return -ENOTSUP;
B
bellard 已提交
1723 1724 1725 1726 1727 1728
}

int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id)
{
    BlockDriver *drv = bs->drv;
    if (!drv)
B
bellard 已提交
1729
        return -ENOMEDIUM;
1730 1731 1732 1733 1734
    if (drv->bdrv_snapshot_delete)
        return drv->bdrv_snapshot_delete(bs, snapshot_id);
    if (bs->file)
        return bdrv_snapshot_delete(bs->file, snapshot_id);
    return -ENOTSUP;
B
bellard 已提交
1735 1736
}

1737
int bdrv_snapshot_list(BlockDriverState *bs,
B
bellard 已提交
1738 1739 1740 1741
                       QEMUSnapshotInfo **psn_info)
{
    BlockDriver *drv = bs->drv;
    if (!drv)
B
bellard 已提交
1742
        return -ENOMEDIUM;
1743 1744 1745 1746 1747
    if (drv->bdrv_snapshot_list)
        return drv->bdrv_snapshot_list(bs, psn_info);
    if (bs->file)
        return bdrv_snapshot_list(bs->file, psn_info);
    return -ENOTSUP;
B
bellard 已提交
1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
}

#define NB_SUFFIXES 4

char *get_human_readable_size(char *buf, int buf_size, int64_t size)
{
    static const char suffixes[NB_SUFFIXES] = "KMGT";
    int64_t base;
    int i;

    if (size <= 999) {
        snprintf(buf, buf_size, "%" PRId64, size);
    } else {
        base = 1024;
        for(i = 0; i < NB_SUFFIXES; i++) {
            if (size < (10 * base)) {
1764
                snprintf(buf, buf_size, "%0.1f%c",
B
bellard 已提交
1765 1766 1767 1768
                         (double)size / base,
                         suffixes[i]);
                break;
            } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
1769
                snprintf(buf, buf_size, "%" PRId64 "%c",
B
bellard 已提交
1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782
                         ((size + (base >> 1)) / base),
                         suffixes[i]);
                break;
            }
            base = base * 1024;
        }
    }
    return buf;
}

char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn)
{
    char buf1[128], date_buf[128], clock_buf[128];
1783 1784 1785
#ifdef _WIN32
    struct tm *ptm;
#else
B
bellard 已提交
1786
    struct tm tm;
1787
#endif
B
bellard 已提交
1788 1789 1790 1791
    time_t ti;
    int64_t secs;

    if (!sn) {
1792 1793
        snprintf(buf, buf_size,
                 "%-10s%-20s%7s%20s%15s",
B
bellard 已提交
1794 1795 1796
                 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
    } else {
        ti = sn->date_sec;
1797 1798 1799 1800 1801
#ifdef _WIN32
        ptm = localtime(&ti);
        strftime(date_buf, sizeof(date_buf),
                 "%Y-%m-%d %H:%M:%S", ptm);
#else
B
bellard 已提交
1802 1803 1804
        localtime_r(&ti, &tm);
        strftime(date_buf, sizeof(date_buf),
                 "%Y-%m-%d %H:%M:%S", &tm);
1805
#endif
B
bellard 已提交
1806 1807 1808 1809 1810
        secs = sn->vm_clock_nsec / 1000000000;
        snprintf(clock_buf, sizeof(clock_buf),
                 "%02d:%02d:%02d.%03d",
                 (int)(secs / 3600),
                 (int)((secs / 60) % 60),
1811
                 (int)(secs % 60),
B
bellard 已提交
1812 1813
                 (int)((sn->vm_clock_nsec / 1000000) % 1000));
        snprintf(buf, buf_size,
1814
                 "%-10s%-20s%7s%20s%15s",
B
bellard 已提交
1815 1816 1817 1818 1819 1820 1821 1822
                 sn->id_str, sn->name,
                 get_human_readable_size(buf1, sizeof(buf1), sn->vm_state_size),
                 date_buf,
                 clock_buf);
    }
    return buf;
}

B
bellard 已提交
1823

B
bellard 已提交
1824
/**************************************************************/
B
bellard 已提交
1825
/* async I/Os */
B
bellard 已提交
1826

1827
BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
1828
                                 QEMUIOVector *qiov, int nb_sectors,
1829
                                 BlockDriverCompletionFunc *cb, void *opaque)
B
bellard 已提交
1830 1831
{
    BlockDriver *drv = bs->drv;
1832
    BlockDriverAIOCB *ret;
B
bellard 已提交
1833

B
bellard 已提交
1834
    if (!drv)
1835
        return NULL;
1836 1837
    if (bdrv_check_request(bs, sector_num, nb_sectors))
        return NULL;
1838

1839 1840
    ret = drv->bdrv_aio_readv(bs, sector_num, qiov, nb_sectors,
                              cb, opaque);
1841 1842 1843

    if (ret) {
	/* Update stats even though technically transfer has not happened. */
J
Jan Kiszka 已提交
1844
	bs->rd_bytes += (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
1845 1846 1847 1848
	bs->rd_ops ++;
    }

    return ret;
B
bellard 已提交
1849 1850
}

1851 1852 1853
BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
                                  QEMUIOVector *qiov, int nb_sectors,
                                  BlockDriverCompletionFunc *cb, void *opaque)
B
bellard 已提交
1854
{
B
bellard 已提交
1855
    BlockDriver *drv = bs->drv;
1856
    BlockDriverAIOCB *ret;
B
bellard 已提交
1857

B
bellard 已提交
1858
    if (!drv)
1859
        return NULL;
B
bellard 已提交
1860
    if (bs->read_only)
1861
        return NULL;
1862 1863
    if (bdrv_check_request(bs, sector_num, nb_sectors))
        return NULL;
B
bellard 已提交
1864

1865
    if (bs->dirty_bitmap) {
1866 1867
        set_dirty_bitmap(bs, sector_num, nb_sectors, 1);
    }
1868

1869 1870
    ret = drv->bdrv_aio_writev(bs, sector_num, qiov, nb_sectors,
                               cb, opaque);
1871 1872

    if (ret) {
1873 1874 1875 1876 1877 1878
        /* Update stats even though technically transfer has not happened. */
        bs->wr_bytes += (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
        bs->wr_ops ++;
        if (bs->wr_highest_sector < sector_num + nb_sectors - 1) {
            bs->wr_highest_sector = sector_num + nb_sectors - 1;
        }
1879 1880 1881
    }

    return ret;
B
bellard 已提交
1882 1883
}

K
Kevin Wolf 已提交
1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902

typedef struct MultiwriteCB {
    int error;
    int num_requests;
    int num_callbacks;
    struct {
        BlockDriverCompletionFunc *cb;
        void *opaque;
        QEMUIOVector *free_qiov;
        void *free_buf;
    } callbacks[];
} MultiwriteCB;

static void multiwrite_user_cb(MultiwriteCB *mcb)
{
    int i;

    for (i = 0; i < mcb->num_callbacks; i++) {
        mcb->callbacks[i].cb(mcb->callbacks[i].opaque, mcb->error);
1903 1904 1905
        if (mcb->callbacks[i].free_qiov) {
            qemu_iovec_destroy(mcb->callbacks[i].free_qiov);
        }
K
Kevin Wolf 已提交
1906
        qemu_free(mcb->callbacks[i].free_qiov);
1907
        qemu_vfree(mcb->callbacks[i].free_buf);
K
Kevin Wolf 已提交
1908 1909 1910 1911 1912 1913 1914
    }
}

static void multiwrite_cb(void *opaque, int ret)
{
    MultiwriteCB *mcb = opaque;

1915
    if (ret < 0 && !mcb->error) {
K
Kevin Wolf 已提交
1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930
        mcb->error = ret;
        multiwrite_user_cb(mcb);
    }

    mcb->num_requests--;
    if (mcb->num_requests == 0) {
        if (mcb->error == 0) {
            multiwrite_user_cb(mcb);
        }
        qemu_free(mcb);
    }
}

static int multiwrite_req_compare(const void *a, const void *b)
{
1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
    const BlockRequest *req1 = a, *req2 = b;

    /*
     * Note that we can't simply subtract req2->sector from req1->sector
     * here as that could overflow the return value.
     */
    if (req1->sector > req2->sector) {
        return 1;
    } else if (req1->sector < req2->sector) {
        return -1;
    } else {
        return 0;
    }
K
Kevin Wolf 已提交
1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978
}

/*
 * Takes a bunch of requests and tries to merge them. Returns the number of
 * requests that remain after merging.
 */
static int multiwrite_merge(BlockDriverState *bs, BlockRequest *reqs,
    int num_reqs, MultiwriteCB *mcb)
{
    int i, outidx;

    // Sort requests by start sector
    qsort(reqs, num_reqs, sizeof(*reqs), &multiwrite_req_compare);

    // Check if adjacent requests touch the same clusters. If so, combine them,
    // filling up gaps with zero sectors.
    outidx = 0;
    for (i = 1; i < num_reqs; i++) {
        int merge = 0;
        int64_t oldreq_last = reqs[outidx].sector + reqs[outidx].nb_sectors;

        // This handles the cases that are valid for all block drivers, namely
        // exactly sequential writes and overlapping writes.
        if (reqs[i].sector <= oldreq_last) {
            merge = 1;
        }

        // The block driver may decide that it makes sense to combine requests
        // even if there is a gap of some sectors between them. In this case,
        // the gap is filled with zeros (therefore only applicable for yet
        // unused space in format like qcow2).
        if (!merge && bs->drv->bdrv_merge_requests) {
            merge = bs->drv->bdrv_merge_requests(bs, &reqs[outidx], &reqs[i]);
        }

1979 1980 1981 1982
        if (reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1 > IOV_MAX) {
            merge = 0;
        }

K
Kevin Wolf 已提交
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
        if (merge) {
            size_t size;
            QEMUIOVector *qiov = qemu_mallocz(sizeof(*qiov));
            qemu_iovec_init(qiov,
                reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1);

            // Add the first request to the merged one. If the requests are
            // overlapping, drop the last sectors of the first request.
            size = (reqs[i].sector - reqs[outidx].sector) << 9;
            qemu_iovec_concat(qiov, reqs[outidx].qiov, size);

            // We might need to add some zeros between the two requests
            if (reqs[i].sector > oldreq_last) {
                size_t zero_bytes = (reqs[i].sector - oldreq_last) << 9;
                uint8_t *buf = qemu_blockalign(bs, zero_bytes);
                memset(buf, 0, zero_bytes);
                qemu_iovec_add(qiov, buf, zero_bytes);
                mcb->callbacks[i].free_buf = buf;
            }

            // Add the second request
            qemu_iovec_concat(qiov, reqs[i].qiov, reqs[i].qiov->size);

2006
            reqs[outidx].nb_sectors = qiov->size >> 9;
K
Kevin Wolf 已提交
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067
            reqs[outidx].qiov = qiov;

            mcb->callbacks[i].free_qiov = reqs[outidx].qiov;
        } else {
            outidx++;
            reqs[outidx].sector     = reqs[i].sector;
            reqs[outidx].nb_sectors = reqs[i].nb_sectors;
            reqs[outidx].qiov       = reqs[i].qiov;
        }
    }

    return outidx + 1;
}

/*
 * Submit multiple AIO write requests at once.
 *
 * On success, the function returns 0 and all requests in the reqs array have
 * been submitted. In error case this function returns -1, and any of the
 * requests may or may not be submitted yet. In particular, this means that the
 * callback will be called for some of the requests, for others it won't. The
 * caller must check the error field of the BlockRequest to wait for the right
 * callbacks (if error != 0, no callback will be called).
 *
 * The implementation may modify the contents of the reqs array, e.g. to merge
 * requests. However, the fields opaque and error are left unmodified as they
 * are used to signal failure for a single request to the caller.
 */
int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, int num_reqs)
{
    BlockDriverAIOCB *acb;
    MultiwriteCB *mcb;
    int i;

    if (num_reqs == 0) {
        return 0;
    }

    // Create MultiwriteCB structure
    mcb = qemu_mallocz(sizeof(*mcb) + num_reqs * sizeof(*mcb->callbacks));
    mcb->num_requests = 0;
    mcb->num_callbacks = num_reqs;

    for (i = 0; i < num_reqs; i++) {
        mcb->callbacks[i].cb = reqs[i].cb;
        mcb->callbacks[i].opaque = reqs[i].opaque;
    }

    // Check for mergable requests
    num_reqs = multiwrite_merge(bs, reqs, num_reqs, mcb);

    // Run the aio requests
    for (i = 0; i < num_reqs; i++) {
        acb = bdrv_aio_writev(bs, reqs[i].sector, reqs[i].qiov,
            reqs[i].nb_sectors, multiwrite_cb, mcb);

        if (acb == NULL) {
            // We can only fail the whole thing if no request has been
            // submitted yet. Otherwise we'll wait for the submitted AIOs to
            // complete and report the error in the callback.
            if (mcb->num_requests == 0) {
2068
                reqs[i].error = -EIO;
K
Kevin Wolf 已提交
2069 2070
                goto fail;
            } else {
2071 2072
                mcb->num_requests++;
                multiwrite_cb(mcb, -EIO);
K
Kevin Wolf 已提交
2073 2074 2075 2076 2077 2078 2079 2080 2081 2082
                break;
            }
        } else {
            mcb->num_requests++;
        }
    }

    return 0;

fail:
B
Bruce Rogers 已提交
2083
    qemu_free(mcb);
K
Kevin Wolf 已提交
2084 2085 2086
    return -1;
}

2087 2088 2089 2090 2091
BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
        BlockDriverCompletionFunc *cb, void *opaque)
{
    BlockDriver *drv = bs->drv;

2092 2093 2094 2095
    if (bs->open_flags & BDRV_O_NO_FLUSH) {
        return bdrv_aio_noop_em(bs, cb, opaque);
    }

2096 2097 2098 2099 2100
    if (!drv)
        return NULL;
    return drv->bdrv_aio_flush(bs, cb, opaque);
}

B
bellard 已提交
2101 2102
void bdrv_aio_cancel(BlockDriverAIOCB *acb)
{
2103
    acb->pool->cancel(acb);
B
bellard 已提交
2104 2105
}

2106

B
bellard 已提交
2107 2108 2109
/**************************************************************/
/* async block device emulation */

2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121
typedef struct BlockDriverAIOCBSync {
    BlockDriverAIOCB common;
    QEMUBH *bh;
    int ret;
    /* vector translation state */
    QEMUIOVector *qiov;
    uint8_t *bounce;
    int is_write;
} BlockDriverAIOCBSync;

static void bdrv_aio_cancel_em(BlockDriverAIOCB *blockacb)
{
2122 2123
    BlockDriverAIOCBSync *acb =
        container_of(blockacb, BlockDriverAIOCBSync, common);
2124
    qemu_bh_delete(acb->bh);
A
Avi Kivity 已提交
2125
    acb->bh = NULL;
2126 2127 2128 2129 2130 2131 2132 2133
    qemu_aio_release(acb);
}

static AIOPool bdrv_em_aio_pool = {
    .aiocb_size         = sizeof(BlockDriverAIOCBSync),
    .cancel             = bdrv_aio_cancel_em,
};

2134
static void bdrv_aio_bh_cb(void *opaque)
B
bellard 已提交
2135
{
2136
    BlockDriverAIOCBSync *acb = opaque;
2137 2138 2139

    if (!acb->is_write)
        qemu_iovec_from_buffer(acb->qiov, acb->bounce, acb->qiov->size);
2140
    qemu_vfree(acb->bounce);
2141
    acb->common.cb(acb->common.opaque, acb->ret);
2142
    qemu_bh_delete(acb->bh);
A
Avi Kivity 已提交
2143
    acb->bh = NULL;
2144
    qemu_aio_release(acb);
B
bellard 已提交
2145
}
2146

2147 2148 2149 2150 2151 2152 2153 2154
static BlockDriverAIOCB *bdrv_aio_rw_vector(BlockDriverState *bs,
                                            int64_t sector_num,
                                            QEMUIOVector *qiov,
                                            int nb_sectors,
                                            BlockDriverCompletionFunc *cb,
                                            void *opaque,
                                            int is_write)

B
bellard 已提交
2155
{
2156 2157
    BlockDriverAIOCBSync *acb;

2158
    acb = qemu_aio_get(&bdrv_em_aio_pool, bs, cb, opaque);
2159 2160
    acb->is_write = is_write;
    acb->qiov = qiov;
2161
    acb->bounce = qemu_blockalign(bs, qiov->size);
2162

2163 2164
    if (!acb->bh)
        acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
2165 2166 2167 2168 2169 2170 2171 2172

    if (is_write) {
        qemu_iovec_to_buffer(acb->qiov, acb->bounce);
        acb->ret = bdrv_write(bs, sector_num, acb->bounce, nb_sectors);
    } else {
        acb->ret = bdrv_read(bs, sector_num, acb->bounce, nb_sectors);
    }

2173
    qemu_bh_schedule(acb->bh);
2174

2175
    return &acb->common;
2176 2177
}

2178 2179
static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
2180
        BlockDriverCompletionFunc *cb, void *opaque)
2181
{
2182 2183
    return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 0);
}
B
bellard 已提交
2184

2185 2186 2187 2188 2189
static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
        BlockDriverCompletionFunc *cb, void *opaque)
{
    return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 1);
2190 2191
}

2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210
static BlockDriverAIOCB *bdrv_aio_flush_em(BlockDriverState *bs,
        BlockDriverCompletionFunc *cb, void *opaque)
{
    BlockDriverAIOCBSync *acb;

    acb = qemu_aio_get(&bdrv_em_aio_pool, bs, cb, opaque);
    acb->is_write = 1; /* don't bounce in the completion hadler */
    acb->qiov = NULL;
    acb->bounce = NULL;
    acb->ret = 0;

    if (!acb->bh)
        acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);

    bdrv_flush(bs);
    qemu_bh_schedule(acb->bh);
    return &acb->common;
}

2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229
static BlockDriverAIOCB *bdrv_aio_noop_em(BlockDriverState *bs,
        BlockDriverCompletionFunc *cb, void *opaque)
{
    BlockDriverAIOCBSync *acb;

    acb = qemu_aio_get(&bdrv_em_aio_pool, bs, cb, opaque);
    acb->is_write = 1; /* don't bounce in the completion handler */
    acb->qiov = NULL;
    acb->bounce = NULL;
    acb->ret = 0;

    if (!acb->bh) {
        acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
    }

    qemu_bh_schedule(acb->bh);
    return &acb->common;
}

B
bellard 已提交
2230 2231
/**************************************************************/
/* sync block device emulation */
B
bellard 已提交
2232

B
bellard 已提交
2233 2234 2235
static void bdrv_rw_em_cb(void *opaque, int ret)
{
    *(int *)opaque = ret;
B
bellard 已提交
2236 2237
}

B
bellard 已提交
2238 2239
#define NOT_DONE 0x7fffffff

2240
static int bdrv_read_em(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
2241
                        uint8_t *buf, int nb_sectors)
P
pbrook 已提交
2242
{
2243 2244
    int async_ret;
    BlockDriverAIOCB *acb;
2245 2246
    struct iovec iov;
    QEMUIOVector qiov;
B
bellard 已提交
2247

2248 2249
    async_context_push();

B
bellard 已提交
2250
    async_ret = NOT_DONE;
2251
    iov.iov_base = (void *)buf;
2252
    iov.iov_len = nb_sectors * BDRV_SECTOR_SIZE;
2253 2254 2255
    qemu_iovec_init_external(&qiov, &iov, 1);
    acb = bdrv_aio_readv(bs, sector_num, &qiov, nb_sectors,
        bdrv_rw_em_cb, &async_ret);
2256 2257 2258 2259
    if (acb == NULL) {
        async_ret = -1;
        goto fail;
    }
2260

B
bellard 已提交
2261 2262 2263
    while (async_ret == NOT_DONE) {
        qemu_aio_wait();
    }
2264

2265 2266 2267

fail:
    async_context_pop();
B
bellard 已提交
2268
    return async_ret;
P
pbrook 已提交
2269 2270
}

B
bellard 已提交
2271 2272 2273
static int bdrv_write_em(BlockDriverState *bs, int64_t sector_num,
                         const uint8_t *buf, int nb_sectors)
{
2274 2275
    int async_ret;
    BlockDriverAIOCB *acb;
2276 2277
    struct iovec iov;
    QEMUIOVector qiov;
B
bellard 已提交
2278

2279 2280
    async_context_push();

B
bellard 已提交
2281
    async_ret = NOT_DONE;
2282
    iov.iov_base = (void *)buf;
2283
    iov.iov_len = nb_sectors * BDRV_SECTOR_SIZE;
2284 2285 2286
    qemu_iovec_init_external(&qiov, &iov, 1);
    acb = bdrv_aio_writev(bs, sector_num, &qiov, nb_sectors,
        bdrv_rw_em_cb, &async_ret);
2287 2288 2289 2290
    if (acb == NULL) {
        async_ret = -1;
        goto fail;
    }
B
bellard 已提交
2291 2292 2293
    while (async_ret == NOT_DONE) {
        qemu_aio_wait();
    }
2294 2295 2296

fail:
    async_context_pop();
B
bellard 已提交
2297 2298
    return async_ret;
}
B
bellard 已提交
2299 2300 2301

void bdrv_init(void)
{
2302
    module_call_init(MODULE_INIT_BLOCK);
B
bellard 已提交
2303
}
2304

2305 2306 2307 2308 2309 2310
void bdrv_init_with_whitelist(void)
{
    use_bdrv_whitelist = 1;
    bdrv_init();
}

2311 2312
void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
                   BlockDriverCompletionFunc *cb, void *opaque)
2313 2314 2315
{
    BlockDriverAIOCB *acb;

2316 2317 2318
    if (pool->free_aiocb) {
        acb = pool->free_aiocb;
        pool->free_aiocb = acb->next;
2319
    } else {
2320 2321
        acb = qemu_mallocz(pool->aiocb_size);
        acb->pool = pool;
2322 2323 2324 2325 2326 2327 2328 2329 2330
    }
    acb->bs = bs;
    acb->cb = cb;
    acb->opaque = opaque;
    return acb;
}

void qemu_aio_release(void *p)
{
2331 2332 2333 2334
    BlockDriverAIOCB *acb = (BlockDriverAIOCB *)p;
    AIOPool *pool = acb->pool;
    acb->next = pool->free_aiocb;
    pool->free_aiocb = acb;
2335
}
B
bellard 已提交
2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356

/**************************************************************/
/* removable device support */

/**
 * Return TRUE if the media is present
 */
int bdrv_is_inserted(BlockDriverState *bs)
{
    BlockDriver *drv = bs->drv;
    int ret;
    if (!drv)
        return 0;
    if (!drv->bdrv_is_inserted)
        return 1;
    ret = drv->bdrv_is_inserted(bs);
    return ret;
}

/**
 * Return TRUE if the media changed since the last call to this
2357
 * function. It is currently only used for floppy disks
B
bellard 已提交
2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376
 */
int bdrv_media_changed(BlockDriverState *bs)
{
    BlockDriver *drv = bs->drv;
    int ret;

    if (!drv || !drv->bdrv_media_changed)
        ret = -ENOTSUP;
    else
        ret = drv->bdrv_media_changed(bs);
    if (ret == -ENOTSUP)
        ret = bs->media_changed;
    bs->media_changed = 0;
    return ret;
}

/**
 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
 */
2377
int bdrv_eject(BlockDriverState *bs, int eject_flag)
B
bellard 已提交
2378 2379 2380 2381
{
    BlockDriver *drv = bs->drv;
    int ret;

2382 2383 2384 2385
    if (bs->locked) {
        return -EBUSY;
    }

B
bellard 已提交
2386 2387 2388 2389 2390 2391 2392 2393
    if (!drv || !drv->bdrv_eject) {
        ret = -ENOTSUP;
    } else {
        ret = drv->bdrv_eject(bs, eject_flag);
    }
    if (ret == -ENOTSUP) {
        if (eject_flag)
            bdrv_close(bs);
2394
        ret = 0;
B
bellard 已提交
2395
    }
2396 2397

    return ret;
B
bellard 已提交
2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417
}

int bdrv_is_locked(BlockDriverState *bs)
{
    return bs->locked;
}

/**
 * Lock or unlock the media (if it is locked, the user won't be able
 * to eject it manually).
 */
void bdrv_set_locked(BlockDriverState *bs, int locked)
{
    BlockDriver *drv = bs->drv;

    bs->locked = locked;
    if (drv && drv->bdrv_set_locked) {
        drv->bdrv_set_locked(bs, locked);
    }
}
2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428

/* needed for generic scsi interface */

int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
{
    BlockDriver *drv = bs->drv;

    if (drv && drv->bdrv_ioctl)
        return drv->bdrv_ioctl(bs, req, buf);
    return -ENOTSUP;
}
2429

2430 2431 2432
BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
        unsigned long int req, void *buf,
        BlockDriverCompletionFunc *cb, void *opaque)
2433
{
2434
    BlockDriver *drv = bs->drv;
2435

2436 2437 2438
    if (drv && drv->bdrv_aio_ioctl)
        return drv->bdrv_aio_ioctl(bs, req, buf, cb, opaque);
    return NULL;
2439
}
2440

2441 2442


2443 2444 2445 2446
void *qemu_blockalign(BlockDriverState *bs, size_t size)
{
    return qemu_memalign((bs && bs->buffer_alignment) ? bs->buffer_alignment : 512, size);
}
2447 2448 2449 2450

void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable)
{
    int64_t bitmap_size;
2451

2452
    bs->dirty_count = 0;
2453
    if (enable) {
2454 2455 2456 2457
        if (!bs->dirty_bitmap) {
            bitmap_size = (bdrv_getlength(bs) >> BDRV_SECTOR_BITS) +
                    BDRV_SECTORS_PER_DIRTY_CHUNK * 8 - 1;
            bitmap_size /= BDRV_SECTORS_PER_DIRTY_CHUNK * 8;
2458

2459
            bs->dirty_bitmap = qemu_mallocz(bitmap_size);
2460
        }
2461
    } else {
2462
        if (bs->dirty_bitmap) {
2463
            qemu_free(bs->dirty_bitmap);
2464
            bs->dirty_bitmap = NULL;
2465
        }
2466 2467 2468 2469 2470
    }
}

int bdrv_get_dirty(BlockDriverState *bs, int64_t sector)
{
J
Jan Kiszka 已提交
2471
    int64_t chunk = sector / (int64_t)BDRV_SECTORS_PER_DIRTY_CHUNK;
2472

2473 2474 2475 2476
    if (bs->dirty_bitmap &&
        (sector << BDRV_SECTOR_BITS) < bdrv_getlength(bs)) {
        return bs->dirty_bitmap[chunk / (sizeof(unsigned long) * 8)] &
            (1 << (chunk % (sizeof(unsigned long) * 8)));
2477 2478 2479 2480 2481
    } else {
        return 0;
    }
}

2482 2483
void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
                      int nr_sectors)
2484 2485 2486
{
    set_dirty_bitmap(bs, cur_sector, nr_sectors, 0);
}
2487 2488 2489 2490 2491

int64_t bdrv_get_dirty_count(BlockDriverState *bs)
{
    return bs->dirty_count;
}