]> git.proxmox.com Git - qemu.git/blob - block.c
block: Convert bdrv_first to QTAILQ
[qemu.git] / block.c
1 /*
2 * QEMU System Emulator block driver
3 *
4 * Copyright (c) 2003 Fabrice Bellard
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 #include "config-host.h"
25 #include "qemu-common.h"
26 #include "monitor.h"
27 #include "block_int.h"
28 #include "module.h"
29 #include "qemu-objects.h"
30
31 #ifdef CONFIG_BSD
32 #include <sys/types.h>
33 #include <sys/stat.h>
34 #include <sys/ioctl.h>
35 #include <sys/queue.h>
36 #ifndef __DragonFly__
37 #include <sys/disk.h>
38 #endif
39 #endif
40
41 #ifdef _WIN32
42 #include <windows.h>
43 #endif
44
45 static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
46 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
47 BlockDriverCompletionFunc *cb, void *opaque);
48 static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
49 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
50 BlockDriverCompletionFunc *cb, void *opaque);
51 static BlockDriverAIOCB *bdrv_aio_flush_em(BlockDriverState *bs,
52 BlockDriverCompletionFunc *cb, void *opaque);
53 static int bdrv_read_em(BlockDriverState *bs, int64_t sector_num,
54 uint8_t *buf, int nb_sectors);
55 static int bdrv_write_em(BlockDriverState *bs, int64_t sector_num,
56 const uint8_t *buf, int nb_sectors);
57
58 static QTAILQ_HEAD(, BlockDriverState) bdrv_states =
59 QTAILQ_HEAD_INITIALIZER(bdrv_states);
60
61 static BlockDriver *first_drv;
62
63 /* If non-zero, use only whitelisted block drivers */
64 static int use_bdrv_whitelist;
65
66 int path_is_absolute(const char *path)
67 {
68 const char *p;
69 #ifdef _WIN32
70 /* specific case for names like: "\\.\d:" */
71 if (*path == '/' || *path == '\\')
72 return 1;
73 #endif
74 p = strchr(path, ':');
75 if (p)
76 p++;
77 else
78 p = path;
79 #ifdef _WIN32
80 return (*p == '/' || *p == '\\');
81 #else
82 return (*p == '/');
83 #endif
84 }
85
86 /* if filename is absolute, just copy it to dest. Otherwise, build a
87 path to it by considering it is relative to base_path. URL are
88 supported. */
89 void path_combine(char *dest, int dest_size,
90 const char *base_path,
91 const char *filename)
92 {
93 const char *p, *p1;
94 int len;
95
96 if (dest_size <= 0)
97 return;
98 if (path_is_absolute(filename)) {
99 pstrcpy(dest, dest_size, filename);
100 } else {
101 p = strchr(base_path, ':');
102 if (p)
103 p++;
104 else
105 p = base_path;
106 p1 = strrchr(base_path, '/');
107 #ifdef _WIN32
108 {
109 const char *p2;
110 p2 = strrchr(base_path, '\\');
111 if (!p1 || p2 > p1)
112 p1 = p2;
113 }
114 #endif
115 if (p1)
116 p1++;
117 else
118 p1 = base_path;
119 if (p1 > p)
120 p = p1;
121 len = p - base_path;
122 if (len > dest_size - 1)
123 len = dest_size - 1;
124 memcpy(dest, base_path, len);
125 dest[len] = '\0';
126 pstrcat(dest, dest_size, filename);
127 }
128 }
129
130 void bdrv_register(BlockDriver *bdrv)
131 {
132 if (!bdrv->bdrv_aio_readv) {
133 /* add AIO emulation layer */
134 bdrv->bdrv_aio_readv = bdrv_aio_readv_em;
135 bdrv->bdrv_aio_writev = bdrv_aio_writev_em;
136 } else if (!bdrv->bdrv_read) {
137 /* add synchronous IO emulation layer */
138 bdrv->bdrv_read = bdrv_read_em;
139 bdrv->bdrv_write = bdrv_write_em;
140 }
141
142 if (!bdrv->bdrv_aio_flush)
143 bdrv->bdrv_aio_flush = bdrv_aio_flush_em;
144
145 bdrv->next = first_drv;
146 first_drv = bdrv;
147 }
148
149 /* create a new block device (by default it is empty) */
150 BlockDriverState *bdrv_new(const char *device_name)
151 {
152 BlockDriverState *bs;
153
154 bs = qemu_mallocz(sizeof(BlockDriverState));
155 pstrcpy(bs->device_name, sizeof(bs->device_name), device_name);
156 if (device_name[0] != '\0') {
157 QTAILQ_INSERT_TAIL(&bdrv_states, bs, list);
158 }
159 return bs;
160 }
161
162 BlockDriver *bdrv_find_format(const char *format_name)
163 {
164 BlockDriver *drv1;
165 for(drv1 = first_drv; drv1 != NULL; drv1 = drv1->next) {
166 if (!strcmp(drv1->format_name, format_name))
167 return drv1;
168 }
169 return NULL;
170 }
171
172 static int bdrv_is_whitelisted(BlockDriver *drv)
173 {
174 static const char *whitelist[] = {
175 CONFIG_BDRV_WHITELIST
176 };
177 const char **p;
178
179 if (!whitelist[0])
180 return 1; /* no whitelist, anything goes */
181
182 for (p = whitelist; *p; p++) {
183 if (!strcmp(drv->format_name, *p)) {
184 return 1;
185 }
186 }
187 return 0;
188 }
189
190 BlockDriver *bdrv_find_whitelisted_format(const char *format_name)
191 {
192 BlockDriver *drv = bdrv_find_format(format_name);
193 return drv && bdrv_is_whitelisted(drv) ? drv : NULL;
194 }
195
196 int bdrv_create(BlockDriver *drv, const char* filename,
197 QEMUOptionParameter *options)
198 {
199 if (!drv->bdrv_create)
200 return -ENOTSUP;
201
202 return drv->bdrv_create(filename, options);
203 }
204
205 #ifdef _WIN32
206 void get_tmp_filename(char *filename, int size)
207 {
208 char temp_dir[MAX_PATH];
209
210 GetTempPath(MAX_PATH, temp_dir);
211 GetTempFileName(temp_dir, "qem", 0, filename);
212 }
213 #else
214 void get_tmp_filename(char *filename, int size)
215 {
216 int fd;
217 const char *tmpdir;
218 /* XXX: race condition possible */
219 tmpdir = getenv("TMPDIR");
220 if (!tmpdir)
221 tmpdir = "/tmp";
222 snprintf(filename, size, "%s/vl.XXXXXX", tmpdir);
223 fd = mkstemp(filename);
224 close(fd);
225 }
226 #endif
227
228 #ifdef _WIN32
229 static int is_windows_drive_prefix(const char *filename)
230 {
231 return (((filename[0] >= 'a' && filename[0] <= 'z') ||
232 (filename[0] >= 'A' && filename[0] <= 'Z')) &&
233 filename[1] == ':');
234 }
235
236 int is_windows_drive(const char *filename)
237 {
238 if (is_windows_drive_prefix(filename) &&
239 filename[2] == '\0')
240 return 1;
241 if (strstart(filename, "\\\\.\\", NULL) ||
242 strstart(filename, "//./", NULL))
243 return 1;
244 return 0;
245 }
246 #endif
247
248 static BlockDriver *find_protocol(const char *filename)
249 {
250 BlockDriver *drv1;
251 char protocol[128];
252 int len;
253 const char *p;
254
255 #ifdef _WIN32
256 if (is_windows_drive(filename) ||
257 is_windows_drive_prefix(filename))
258 return bdrv_find_format("raw");
259 #endif
260 p = strchr(filename, ':');
261 if (!p)
262 return bdrv_find_format("raw");
263 len = p - filename;
264 if (len > sizeof(protocol) - 1)
265 len = sizeof(protocol) - 1;
266 memcpy(protocol, filename, len);
267 protocol[len] = '\0';
268 for(drv1 = first_drv; drv1 != NULL; drv1 = drv1->next) {
269 if (drv1->protocol_name &&
270 !strcmp(drv1->protocol_name, protocol))
271 return drv1;
272 }
273 return NULL;
274 }
275
276 /*
277 * Detect host devices. By convention, /dev/cdrom[N] is always
278 * recognized as a host CDROM.
279 */
280 static BlockDriver *find_hdev_driver(const char *filename)
281 {
282 int score_max = 0, score;
283 BlockDriver *drv = NULL, *d;
284
285 for (d = first_drv; d; d = d->next) {
286 if (d->bdrv_probe_device) {
287 score = d->bdrv_probe_device(filename);
288 if (score > score_max) {
289 score_max = score;
290 drv = d;
291 }
292 }
293 }
294
295 return drv;
296 }
297
298 static BlockDriver *find_image_format(const char *filename)
299 {
300 int ret, score, score_max;
301 BlockDriver *drv1, *drv;
302 uint8_t buf[2048];
303 BlockDriverState *bs;
304
305 drv = find_protocol(filename);
306 /* no need to test disk image formats for vvfat */
307 if (drv && strcmp(drv->format_name, "vvfat") == 0)
308 return drv;
309
310 ret = bdrv_file_open(&bs, filename, 0);
311 if (ret < 0)
312 return NULL;
313 ret = bdrv_pread(bs, 0, buf, sizeof(buf));
314 bdrv_delete(bs);
315 if (ret < 0) {
316 return NULL;
317 }
318
319 score_max = 0;
320 for(drv1 = first_drv; drv1 != NULL; drv1 = drv1->next) {
321 if (drv1->bdrv_probe) {
322 score = drv1->bdrv_probe(buf, ret, filename);
323 if (score > score_max) {
324 score_max = score;
325 drv = drv1;
326 }
327 }
328 }
329 return drv;
330 }
331
332 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags)
333 {
334 BlockDriverState *bs;
335 BlockDriver *drv;
336 int ret;
337
338 drv = find_protocol(filename);
339 if (!drv) {
340 return -ENOENT;
341 }
342
343 bs = bdrv_new("");
344 ret = bdrv_open(bs, filename, flags, drv);
345 if (ret < 0) {
346 bdrv_delete(bs);
347 return ret;
348 }
349 bs->growable = 1;
350 *pbs = bs;
351 return 0;
352 }
353
354 int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
355 BlockDriver *drv)
356 {
357 int ret, open_flags;
358 char tmp_filename[PATH_MAX];
359 char backing_filename[PATH_MAX];
360
361 bs->is_temporary = 0;
362 bs->encrypted = 0;
363 bs->valid_key = 0;
364 bs->open_flags = flags;
365 /* buffer_alignment defaulted to 512, drivers can change this value */
366 bs->buffer_alignment = 512;
367
368 if (flags & BDRV_O_SNAPSHOT) {
369 BlockDriverState *bs1;
370 int64_t total_size;
371 int is_protocol = 0;
372 BlockDriver *bdrv_qcow2;
373 QEMUOptionParameter *options;
374
375 /* if snapshot, we create a temporary backing file and open it
376 instead of opening 'filename' directly */
377
378 /* if there is a backing file, use it */
379 bs1 = bdrv_new("");
380 ret = bdrv_open(bs1, filename, 0, drv);
381 if (ret < 0) {
382 bdrv_delete(bs1);
383 return ret;
384 }
385 total_size = bdrv_getlength(bs1) >> BDRV_SECTOR_BITS;
386
387 if (bs1->drv && bs1->drv->protocol_name)
388 is_protocol = 1;
389
390 bdrv_delete(bs1);
391
392 get_tmp_filename(tmp_filename, sizeof(tmp_filename));
393
394 /* Real path is meaningless for protocols */
395 if (is_protocol)
396 snprintf(backing_filename, sizeof(backing_filename),
397 "%s", filename);
398 else if (!realpath(filename, backing_filename))
399 return -errno;
400
401 bdrv_qcow2 = bdrv_find_format("qcow2");
402 options = parse_option_parameters("", bdrv_qcow2->create_options, NULL);
403
404 set_option_parameter_int(options, BLOCK_OPT_SIZE, total_size * 512);
405 set_option_parameter(options, BLOCK_OPT_BACKING_FILE, backing_filename);
406 if (drv) {
407 set_option_parameter(options, BLOCK_OPT_BACKING_FMT,
408 drv->format_name);
409 }
410
411 ret = bdrv_create(bdrv_qcow2, tmp_filename, options);
412 if (ret < 0) {
413 return ret;
414 }
415
416 filename = tmp_filename;
417 drv = bdrv_qcow2;
418 bs->is_temporary = 1;
419 }
420
421 pstrcpy(bs->filename, sizeof(bs->filename), filename);
422
423 if (!drv) {
424 drv = find_hdev_driver(filename);
425 if (!drv) {
426 drv = find_image_format(filename);
427 }
428 }
429
430 if (!drv) {
431 ret = -ENOENT;
432 goto unlink_and_fail;
433 }
434 if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv)) {
435 ret = -ENOTSUP;
436 goto unlink_and_fail;
437 }
438
439 bs->drv = drv;
440 bs->opaque = qemu_mallocz(drv->instance_size);
441
442 /*
443 * Yes, BDRV_O_NOCACHE aka O_DIRECT means we have to present a
444 * write cache to the guest. We do need the fdatasync to flush
445 * out transactions for block allocations, and we maybe have a
446 * volatile write cache in our backing device to deal with.
447 */
448 if (flags & (BDRV_O_CACHE_WB|BDRV_O_NOCACHE))
449 bs->enable_write_cache = 1;
450
451 /*
452 * Clear flags that are internal to the block layer before opening the
453 * image.
454 */
455 open_flags = flags & ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
456
457 /*
458 * Snapshots should be writeable.
459 */
460 if (bs->is_temporary) {
461 open_flags |= BDRV_O_RDWR;
462 }
463
464 ret = drv->bdrv_open(bs, filename, open_flags);
465 if (ret < 0) {
466 goto free_and_fail;
467 }
468
469 bs->keep_read_only = bs->read_only = !(open_flags & BDRV_O_RDWR);
470 if (drv->bdrv_getlength) {
471 bs->total_sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
472 }
473 #ifndef _WIN32
474 if (bs->is_temporary) {
475 unlink(filename);
476 }
477 #endif
478 if ((flags & BDRV_O_NO_BACKING) == 0 && bs->backing_file[0] != '\0') {
479 /* if there is a backing file, use it */
480 BlockDriver *back_drv = NULL;
481 bs->backing_hd = bdrv_new("");
482 path_combine(backing_filename, sizeof(backing_filename),
483 filename, bs->backing_file);
484 if (bs->backing_format[0] != '\0')
485 back_drv = bdrv_find_format(bs->backing_format);
486
487 /* backing files always opened read-only */
488 open_flags &= ~BDRV_O_RDWR;
489
490 ret = bdrv_open(bs->backing_hd, backing_filename, open_flags, back_drv);
491 if (ret < 0) {
492 bdrv_close(bs);
493 return ret;
494 }
495 if (bs->is_temporary) {
496 bs->backing_hd->keep_read_only = !(flags & BDRV_O_RDWR);
497 } else {
498 /* base image inherits from "parent" */
499 bs->backing_hd->keep_read_only = bs->keep_read_only;
500 }
501 }
502
503 if (!bdrv_key_required(bs)) {
504 /* call the change callback */
505 bs->media_changed = 1;
506 if (bs->change_cb)
507 bs->change_cb(bs->change_opaque);
508 }
509 return 0;
510
511 free_and_fail:
512 qemu_free(bs->opaque);
513 bs->opaque = NULL;
514 bs->drv = NULL;
515 unlink_and_fail:
516 if (bs->is_temporary)
517 unlink(filename);
518 return ret;
519 }
520
521 void bdrv_close(BlockDriverState *bs)
522 {
523 if (bs->drv) {
524 if (bs->backing_hd)
525 bdrv_delete(bs->backing_hd);
526 bs->drv->bdrv_close(bs);
527 qemu_free(bs->opaque);
528 #ifdef _WIN32
529 if (bs->is_temporary) {
530 unlink(bs->filename);
531 }
532 #endif
533 bs->opaque = NULL;
534 bs->drv = NULL;
535
536 /* call the change callback */
537 bs->media_changed = 1;
538 if (bs->change_cb)
539 bs->change_cb(bs->change_opaque);
540 }
541 }
542
543 void bdrv_delete(BlockDriverState *bs)
544 {
545 /* remove from list, if necessary */
546 if (bs->device_name[0] != '\0') {
547 QTAILQ_REMOVE(&bdrv_states, bs, list);
548 }
549
550 bdrv_close(bs);
551 qemu_free(bs);
552 }
553
554 /*
555 * Run consistency checks on an image
556 *
557 * Returns the number of errors or -errno when an internal error occurs
558 */
559 int bdrv_check(BlockDriverState *bs)
560 {
561 if (bs->drv->bdrv_check == NULL) {
562 return -ENOTSUP;
563 }
564
565 return bs->drv->bdrv_check(bs);
566 }
567
568 /* commit COW file into the raw image */
569 int bdrv_commit(BlockDriverState *bs)
570 {
571 BlockDriver *drv = bs->drv;
572 int64_t i, total_sectors;
573 int n, j, ro, open_flags;
574 int ret = 0, rw_ret = 0;
575 unsigned char sector[512];
576 char filename[1024];
577 BlockDriverState *bs_rw, *bs_ro;
578
579 if (!drv)
580 return -ENOMEDIUM;
581
582 if (!bs->backing_hd) {
583 return -ENOTSUP;
584 }
585
586 if (bs->backing_hd->keep_read_only) {
587 return -EACCES;
588 }
589
590 ro = bs->backing_hd->read_only;
591 strncpy(filename, bs->backing_hd->filename, sizeof(filename));
592 open_flags = bs->backing_hd->open_flags;
593
594 if (ro) {
595 /* re-open as RW */
596 bdrv_delete(bs->backing_hd);
597 bs->backing_hd = NULL;
598 bs_rw = bdrv_new("");
599 rw_ret = bdrv_open(bs_rw, filename, open_flags | BDRV_O_RDWR, NULL);
600 if (rw_ret < 0) {
601 bdrv_delete(bs_rw);
602 /* try to re-open read-only */
603 bs_ro = bdrv_new("");
604 ret = bdrv_open(bs_ro, filename, open_flags & ~BDRV_O_RDWR, NULL);
605 if (ret < 0) {
606 bdrv_delete(bs_ro);
607 /* drive not functional anymore */
608 bs->drv = NULL;
609 return ret;
610 }
611 bs->backing_hd = bs_ro;
612 return rw_ret;
613 }
614 bs->backing_hd = bs_rw;
615 }
616
617 total_sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
618 for (i = 0; i < total_sectors;) {
619 if (drv->bdrv_is_allocated(bs, i, 65536, &n)) {
620 for(j = 0; j < n; j++) {
621 if (bdrv_read(bs, i, sector, 1) != 0) {
622 ret = -EIO;
623 goto ro_cleanup;
624 }
625
626 if (bdrv_write(bs->backing_hd, i, sector, 1) != 0) {
627 ret = -EIO;
628 goto ro_cleanup;
629 }
630 i++;
631 }
632 } else {
633 i += n;
634 }
635 }
636
637 if (drv->bdrv_make_empty) {
638 ret = drv->bdrv_make_empty(bs);
639 bdrv_flush(bs);
640 }
641
642 /*
643 * Make sure all data we wrote to the backing device is actually
644 * stable on disk.
645 */
646 if (bs->backing_hd)
647 bdrv_flush(bs->backing_hd);
648
649 ro_cleanup:
650
651 if (ro) {
652 /* re-open as RO */
653 bdrv_delete(bs->backing_hd);
654 bs->backing_hd = NULL;
655 bs_ro = bdrv_new("");
656 ret = bdrv_open(bs_ro, filename, open_flags & ~BDRV_O_RDWR, NULL);
657 if (ret < 0) {
658 bdrv_delete(bs_ro);
659 /* drive not functional anymore */
660 bs->drv = NULL;
661 return ret;
662 }
663 bs->backing_hd = bs_ro;
664 bs->backing_hd->keep_read_only = 0;
665 }
666
667 return ret;
668 }
669
670 /*
671 * Return values:
672 * 0 - success
673 * -EINVAL - backing format specified, but no file
674 * -ENOSPC - can't update the backing file because no space is left in the
675 * image file header
676 * -ENOTSUP - format driver doesn't support changing the backing file
677 */
678 int bdrv_change_backing_file(BlockDriverState *bs,
679 const char *backing_file, const char *backing_fmt)
680 {
681 BlockDriver *drv = bs->drv;
682
683 if (drv->bdrv_change_backing_file != NULL) {
684 return drv->bdrv_change_backing_file(bs, backing_file, backing_fmt);
685 } else {
686 return -ENOTSUP;
687 }
688 }
689
690 static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset,
691 size_t size)
692 {
693 int64_t len;
694
695 if (!bdrv_is_inserted(bs))
696 return -ENOMEDIUM;
697
698 if (bs->growable)
699 return 0;
700
701 len = bdrv_getlength(bs);
702
703 if (offset < 0)
704 return -EIO;
705
706 if ((offset > len) || (len - offset < size))
707 return -EIO;
708
709 return 0;
710 }
711
712 static int bdrv_check_request(BlockDriverState *bs, int64_t sector_num,
713 int nb_sectors)
714 {
715 return bdrv_check_byte_request(bs, sector_num * 512, nb_sectors * 512);
716 }
717
718 /* return < 0 if error. See bdrv_write() for the return codes */
719 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
720 uint8_t *buf, int nb_sectors)
721 {
722 BlockDriver *drv = bs->drv;
723
724 if (!drv)
725 return -ENOMEDIUM;
726 if (bdrv_check_request(bs, sector_num, nb_sectors))
727 return -EIO;
728
729 return drv->bdrv_read(bs, sector_num, buf, nb_sectors);
730 }
731
732 static void set_dirty_bitmap(BlockDriverState *bs, int64_t sector_num,
733 int nb_sectors, int dirty)
734 {
735 int64_t start, end;
736 unsigned long val, idx, bit;
737
738 start = sector_num / BDRV_SECTORS_PER_DIRTY_CHUNK;
739 end = (sector_num + nb_sectors - 1) / BDRV_SECTORS_PER_DIRTY_CHUNK;
740
741 for (; start <= end; start++) {
742 idx = start / (sizeof(unsigned long) * 8);
743 bit = start % (sizeof(unsigned long) * 8);
744 val = bs->dirty_bitmap[idx];
745 if (dirty) {
746 if (!(val & (1 << bit))) {
747 bs->dirty_count++;
748 val |= 1 << bit;
749 }
750 } else {
751 if (val & (1 << bit)) {
752 bs->dirty_count--;
753 val &= ~(1 << bit);
754 }
755 }
756 bs->dirty_bitmap[idx] = val;
757 }
758 }
759
760 /* Return < 0 if error. Important errors are:
761 -EIO generic I/O error (may happen for all errors)
762 -ENOMEDIUM No media inserted.
763 -EINVAL Invalid sector number or nb_sectors
764 -EACCES Trying to write a read-only device
765 */
766 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
767 const uint8_t *buf, int nb_sectors)
768 {
769 BlockDriver *drv = bs->drv;
770 if (!bs->drv)
771 return -ENOMEDIUM;
772 if (bs->read_only)
773 return -EACCES;
774 if (bdrv_check_request(bs, sector_num, nb_sectors))
775 return -EIO;
776
777 if (bs->dirty_bitmap) {
778 set_dirty_bitmap(bs, sector_num, nb_sectors, 1);
779 }
780
781 return drv->bdrv_write(bs, sector_num, buf, nb_sectors);
782 }
783
784 int bdrv_pread(BlockDriverState *bs, int64_t offset,
785 void *buf, int count1)
786 {
787 uint8_t tmp_buf[BDRV_SECTOR_SIZE];
788 int len, nb_sectors, count;
789 int64_t sector_num;
790 int ret;
791
792 count = count1;
793 /* first read to align to sector start */
794 len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
795 if (len > count)
796 len = count;
797 sector_num = offset >> BDRV_SECTOR_BITS;
798 if (len > 0) {
799 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
800 return ret;
801 memcpy(buf, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), len);
802 count -= len;
803 if (count == 0)
804 return count1;
805 sector_num++;
806 buf += len;
807 }
808
809 /* read the sectors "in place" */
810 nb_sectors = count >> BDRV_SECTOR_BITS;
811 if (nb_sectors > 0) {
812 if ((ret = bdrv_read(bs, sector_num, buf, nb_sectors)) < 0)
813 return ret;
814 sector_num += nb_sectors;
815 len = nb_sectors << BDRV_SECTOR_BITS;
816 buf += len;
817 count -= len;
818 }
819
820 /* add data from the last sector */
821 if (count > 0) {
822 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
823 return ret;
824 memcpy(buf, tmp_buf, count);
825 }
826 return count1;
827 }
828
829 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
830 const void *buf, int count1)
831 {
832 uint8_t tmp_buf[BDRV_SECTOR_SIZE];
833 int len, nb_sectors, count;
834 int64_t sector_num;
835 int ret;
836
837 count = count1;
838 /* first write to align to sector start */
839 len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
840 if (len > count)
841 len = count;
842 sector_num = offset >> BDRV_SECTOR_BITS;
843 if (len > 0) {
844 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
845 return ret;
846 memcpy(tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), buf, len);
847 if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
848 return ret;
849 count -= len;
850 if (count == 0)
851 return count1;
852 sector_num++;
853 buf += len;
854 }
855
856 /* write the sectors "in place" */
857 nb_sectors = count >> BDRV_SECTOR_BITS;
858 if (nb_sectors > 0) {
859 if ((ret = bdrv_write(bs, sector_num, buf, nb_sectors)) < 0)
860 return ret;
861 sector_num += nb_sectors;
862 len = nb_sectors << BDRV_SECTOR_BITS;
863 buf += len;
864 count -= len;
865 }
866
867 /* add data from the last sector */
868 if (count > 0) {
869 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
870 return ret;
871 memcpy(tmp_buf, buf, count);
872 if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
873 return ret;
874 }
875 return count1;
876 }
877
878 /**
879 * Truncate file to 'offset' bytes (needed only for file protocols)
880 */
881 int bdrv_truncate(BlockDriverState *bs, int64_t offset)
882 {
883 BlockDriver *drv = bs->drv;
884 if (!drv)
885 return -ENOMEDIUM;
886 if (!drv->bdrv_truncate)
887 return -ENOTSUP;
888 if (bs->read_only)
889 return -EACCES;
890 return drv->bdrv_truncate(bs, offset);
891 }
892
893 /**
894 * Length of a file in bytes. Return < 0 if error or unknown.
895 */
896 int64_t bdrv_getlength(BlockDriverState *bs)
897 {
898 BlockDriver *drv = bs->drv;
899 if (!drv)
900 return -ENOMEDIUM;
901 if (!drv->bdrv_getlength) {
902 /* legacy mode */
903 return bs->total_sectors * BDRV_SECTOR_SIZE;
904 }
905 return drv->bdrv_getlength(bs);
906 }
907
908 /* return 0 as number of sectors if no device present or error */
909 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr)
910 {
911 int64_t length;
912 length = bdrv_getlength(bs);
913 if (length < 0)
914 length = 0;
915 else
916 length = length >> BDRV_SECTOR_BITS;
917 *nb_sectors_ptr = length;
918 }
919
920 struct partition {
921 uint8_t boot_ind; /* 0x80 - active */
922 uint8_t head; /* starting head */
923 uint8_t sector; /* starting sector */
924 uint8_t cyl; /* starting cylinder */
925 uint8_t sys_ind; /* What partition type */
926 uint8_t end_head; /* end head */
927 uint8_t end_sector; /* end sector */
928 uint8_t end_cyl; /* end cylinder */
929 uint32_t start_sect; /* starting sector counting from 0 */
930 uint32_t nr_sects; /* nr of sectors in partition */
931 } __attribute__((packed));
932
933 /* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
934 static int guess_disk_lchs(BlockDriverState *bs,
935 int *pcylinders, int *pheads, int *psectors)
936 {
937 uint8_t buf[512];
938 int ret, i, heads, sectors, cylinders;
939 struct partition *p;
940 uint32_t nr_sects;
941 uint64_t nb_sectors;
942
943 bdrv_get_geometry(bs, &nb_sectors);
944
945 ret = bdrv_read(bs, 0, buf, 1);
946 if (ret < 0)
947 return -1;
948 /* test msdos magic */
949 if (buf[510] != 0x55 || buf[511] != 0xaa)
950 return -1;
951 for(i = 0; i < 4; i++) {
952 p = ((struct partition *)(buf + 0x1be)) + i;
953 nr_sects = le32_to_cpu(p->nr_sects);
954 if (nr_sects && p->end_head) {
955 /* We make the assumption that the partition terminates on
956 a cylinder boundary */
957 heads = p->end_head + 1;
958 sectors = p->end_sector & 63;
959 if (sectors == 0)
960 continue;
961 cylinders = nb_sectors / (heads * sectors);
962 if (cylinders < 1 || cylinders > 16383)
963 continue;
964 *pheads = heads;
965 *psectors = sectors;
966 *pcylinders = cylinders;
967 #if 0
968 printf("guessed geometry: LCHS=%d %d %d\n",
969 cylinders, heads, sectors);
970 #endif
971 return 0;
972 }
973 }
974 return -1;
975 }
976
977 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs)
978 {
979 int translation, lba_detected = 0;
980 int cylinders, heads, secs;
981 uint64_t nb_sectors;
982
983 /* if a geometry hint is available, use it */
984 bdrv_get_geometry(bs, &nb_sectors);
985 bdrv_get_geometry_hint(bs, &cylinders, &heads, &secs);
986 translation = bdrv_get_translation_hint(bs);
987 if (cylinders != 0) {
988 *pcyls = cylinders;
989 *pheads = heads;
990 *psecs = secs;
991 } else {
992 if (guess_disk_lchs(bs, &cylinders, &heads, &secs) == 0) {
993 if (heads > 16) {
994 /* if heads > 16, it means that a BIOS LBA
995 translation was active, so the default
996 hardware geometry is OK */
997 lba_detected = 1;
998 goto default_geometry;
999 } else {
1000 *pcyls = cylinders;
1001 *pheads = heads;
1002 *psecs = secs;
1003 /* disable any translation to be in sync with
1004 the logical geometry */
1005 if (translation == BIOS_ATA_TRANSLATION_AUTO) {
1006 bdrv_set_translation_hint(bs,
1007 BIOS_ATA_TRANSLATION_NONE);
1008 }
1009 }
1010 } else {
1011 default_geometry:
1012 /* if no geometry, use a standard physical disk geometry */
1013 cylinders = nb_sectors / (16 * 63);
1014
1015 if (cylinders > 16383)
1016 cylinders = 16383;
1017 else if (cylinders < 2)
1018 cylinders = 2;
1019 *pcyls = cylinders;
1020 *pheads = 16;
1021 *psecs = 63;
1022 if ((lba_detected == 1) && (translation == BIOS_ATA_TRANSLATION_AUTO)) {
1023 if ((*pcyls * *pheads) <= 131072) {
1024 bdrv_set_translation_hint(bs,
1025 BIOS_ATA_TRANSLATION_LARGE);
1026 } else {
1027 bdrv_set_translation_hint(bs,
1028 BIOS_ATA_TRANSLATION_LBA);
1029 }
1030 }
1031 }
1032 bdrv_set_geometry_hint(bs, *pcyls, *pheads, *psecs);
1033 }
1034 }
1035
1036 void bdrv_set_geometry_hint(BlockDriverState *bs,
1037 int cyls, int heads, int secs)
1038 {
1039 bs->cyls = cyls;
1040 bs->heads = heads;
1041 bs->secs = secs;
1042 }
1043
1044 void bdrv_set_type_hint(BlockDriverState *bs, int type)
1045 {
1046 bs->type = type;
1047 bs->removable = ((type == BDRV_TYPE_CDROM ||
1048 type == BDRV_TYPE_FLOPPY));
1049 }
1050
1051 void bdrv_set_translation_hint(BlockDriverState *bs, int translation)
1052 {
1053 bs->translation = translation;
1054 }
1055
1056 void bdrv_get_geometry_hint(BlockDriverState *bs,
1057 int *pcyls, int *pheads, int *psecs)
1058 {
1059 *pcyls = bs->cyls;
1060 *pheads = bs->heads;
1061 *psecs = bs->secs;
1062 }
1063
1064 int bdrv_get_type_hint(BlockDriverState *bs)
1065 {
1066 return bs->type;
1067 }
1068
1069 int bdrv_get_translation_hint(BlockDriverState *bs)
1070 {
1071 return bs->translation;
1072 }
1073
1074 int bdrv_is_removable(BlockDriverState *bs)
1075 {
1076 return bs->removable;
1077 }
1078
1079 int bdrv_is_read_only(BlockDriverState *bs)
1080 {
1081 return bs->read_only;
1082 }
1083
1084 int bdrv_is_sg(BlockDriverState *bs)
1085 {
1086 return bs->sg;
1087 }
1088
1089 int bdrv_enable_write_cache(BlockDriverState *bs)
1090 {
1091 return bs->enable_write_cache;
1092 }
1093
1094 /* XXX: no longer used */
1095 void bdrv_set_change_cb(BlockDriverState *bs,
1096 void (*change_cb)(void *opaque), void *opaque)
1097 {
1098 bs->change_cb = change_cb;
1099 bs->change_opaque = opaque;
1100 }
1101
1102 int bdrv_is_encrypted(BlockDriverState *bs)
1103 {
1104 if (bs->backing_hd && bs->backing_hd->encrypted)
1105 return 1;
1106 return bs->encrypted;
1107 }
1108
1109 int bdrv_key_required(BlockDriverState *bs)
1110 {
1111 BlockDriverState *backing_hd = bs->backing_hd;
1112
1113 if (backing_hd && backing_hd->encrypted && !backing_hd->valid_key)
1114 return 1;
1115 return (bs->encrypted && !bs->valid_key);
1116 }
1117
1118 int bdrv_set_key(BlockDriverState *bs, const char *key)
1119 {
1120 int ret;
1121 if (bs->backing_hd && bs->backing_hd->encrypted) {
1122 ret = bdrv_set_key(bs->backing_hd, key);
1123 if (ret < 0)
1124 return ret;
1125 if (!bs->encrypted)
1126 return 0;
1127 }
1128 if (!bs->encrypted) {
1129 return -EINVAL;
1130 } else if (!bs->drv || !bs->drv->bdrv_set_key) {
1131 return -ENOMEDIUM;
1132 }
1133 ret = bs->drv->bdrv_set_key(bs, key);
1134 if (ret < 0) {
1135 bs->valid_key = 0;
1136 } else if (!bs->valid_key) {
1137 bs->valid_key = 1;
1138 /* call the change callback now, we skipped it on open */
1139 bs->media_changed = 1;
1140 if (bs->change_cb)
1141 bs->change_cb(bs->change_opaque);
1142 }
1143 return ret;
1144 }
1145
1146 void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size)
1147 {
1148 if (!bs->drv) {
1149 buf[0] = '\0';
1150 } else {
1151 pstrcpy(buf, buf_size, bs->drv->format_name);
1152 }
1153 }
1154
1155 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
1156 void *opaque)
1157 {
1158 BlockDriver *drv;
1159
1160 for (drv = first_drv; drv != NULL; drv = drv->next) {
1161 it(opaque, drv->format_name);
1162 }
1163 }
1164
1165 BlockDriverState *bdrv_find(const char *name)
1166 {
1167 BlockDriverState *bs;
1168
1169 QTAILQ_FOREACH(bs, &bdrv_states, list) {
1170 if (!strcmp(name, bs->device_name)) {
1171 return bs;
1172 }
1173 }
1174 return NULL;
1175 }
1176
1177 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), void *opaque)
1178 {
1179 BlockDriverState *bs;
1180
1181 QTAILQ_FOREACH(bs, &bdrv_states, list) {
1182 it(opaque, bs);
1183 }
1184 }
1185
1186 const char *bdrv_get_device_name(BlockDriverState *bs)
1187 {
1188 return bs->device_name;
1189 }
1190
1191 void bdrv_flush(BlockDriverState *bs)
1192 {
1193 if (bs->drv && bs->drv->bdrv_flush)
1194 bs->drv->bdrv_flush(bs);
1195 }
1196
1197 void bdrv_flush_all(void)
1198 {
1199 BlockDriverState *bs;
1200
1201 QTAILQ_FOREACH(bs, &bdrv_states, list) {
1202 if (bs->drv && !bdrv_is_read_only(bs) &&
1203 (!bdrv_is_removable(bs) || bdrv_is_inserted(bs))) {
1204 bdrv_flush(bs);
1205 }
1206 }
1207 }
1208
1209 /*
1210 * Returns true iff the specified sector is present in the disk image. Drivers
1211 * not implementing the functionality are assumed to not support backing files,
1212 * hence all their sectors are reported as allocated.
1213 *
1214 * 'pnum' is set to the number of sectors (including and immediately following
1215 * the specified sector) that are known to be in the same
1216 * allocated/unallocated state.
1217 *
1218 * 'nb_sectors' is the max value 'pnum' should be set to.
1219 */
1220 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
1221 int *pnum)
1222 {
1223 int64_t n;
1224 if (!bs->drv->bdrv_is_allocated) {
1225 if (sector_num >= bs->total_sectors) {
1226 *pnum = 0;
1227 return 0;
1228 }
1229 n = bs->total_sectors - sector_num;
1230 *pnum = (n < nb_sectors) ? (n) : (nb_sectors);
1231 return 1;
1232 }
1233 return bs->drv->bdrv_is_allocated(bs, sector_num, nb_sectors, pnum);
1234 }
1235
1236 void bdrv_mon_event(const BlockDriverState *bdrv,
1237 BlockMonEventAction action, int is_read)
1238 {
1239 QObject *data;
1240 const char *action_str;
1241
1242 switch (action) {
1243 case BDRV_ACTION_REPORT:
1244 action_str = "report";
1245 break;
1246 case BDRV_ACTION_IGNORE:
1247 action_str = "ignore";
1248 break;
1249 case BDRV_ACTION_STOP:
1250 action_str = "stop";
1251 break;
1252 default:
1253 abort();
1254 }
1255
1256 data = qobject_from_jsonf("{ 'device': %s, 'action': %s, 'operation': %s }",
1257 bdrv->device_name,
1258 action_str,
1259 is_read ? "read" : "write");
1260 monitor_protocol_event(QEVENT_BLOCK_IO_ERROR, data);
1261
1262 qobject_decref(data);
1263 }
1264
1265 static void bdrv_print_dict(QObject *obj, void *opaque)
1266 {
1267 QDict *bs_dict;
1268 Monitor *mon = opaque;
1269
1270 bs_dict = qobject_to_qdict(obj);
1271
1272 monitor_printf(mon, "%s: type=%s removable=%d",
1273 qdict_get_str(bs_dict, "device"),
1274 qdict_get_str(bs_dict, "type"),
1275 qdict_get_bool(bs_dict, "removable"));
1276
1277 if (qdict_get_bool(bs_dict, "removable")) {
1278 monitor_printf(mon, " locked=%d", qdict_get_bool(bs_dict, "locked"));
1279 }
1280
1281 if (qdict_haskey(bs_dict, "inserted")) {
1282 QDict *qdict = qobject_to_qdict(qdict_get(bs_dict, "inserted"));
1283
1284 monitor_printf(mon, " file=");
1285 monitor_print_filename(mon, qdict_get_str(qdict, "file"));
1286 if (qdict_haskey(qdict, "backing_file")) {
1287 monitor_printf(mon, " backing_file=");
1288 monitor_print_filename(mon, qdict_get_str(qdict, "backing_file"));
1289 }
1290 monitor_printf(mon, " ro=%d drv=%s encrypted=%d",
1291 qdict_get_bool(qdict, "ro"),
1292 qdict_get_str(qdict, "drv"),
1293 qdict_get_bool(qdict, "encrypted"));
1294 } else {
1295 monitor_printf(mon, " [not inserted]");
1296 }
1297
1298 monitor_printf(mon, "\n");
1299 }
1300
1301 void bdrv_info_print(Monitor *mon, const QObject *data)
1302 {
1303 qlist_iter(qobject_to_qlist(data), bdrv_print_dict, mon);
1304 }
1305
1306 /**
1307 * bdrv_info(): Block devices information
1308 *
1309 * Each block device information is stored in a QDict and the
1310 * returned QObject is a QList of all devices.
1311 *
1312 * The QDict contains the following:
1313 *
1314 * - "device": device name
1315 * - "type": device type
1316 * - "removable": true if the device is removable, false otherwise
1317 * - "locked": true if the device is locked, false otherwise
1318 * - "inserted": only present if the device is inserted, it is a QDict
1319 * containing the following:
1320 * - "file": device file name
1321 * - "ro": true if read-only, false otherwise
1322 * - "drv": driver format name
1323 * - "backing_file": backing file name if one is used
1324 * - "encrypted": true if encrypted, false otherwise
1325 *
1326 * Example:
1327 *
1328 * [ { "device": "ide0-hd0", "type": "hd", "removable": false, "locked": false,
1329 * "inserted": { "file": "/tmp/foobar", "ro": false, "drv": "qcow2" } },
1330 * { "device": "floppy0", "type": "floppy", "removable": true,
1331 * "locked": false } ]
1332 */
1333 void bdrv_info(Monitor *mon, QObject **ret_data)
1334 {
1335 QList *bs_list;
1336 BlockDriverState *bs;
1337
1338 bs_list = qlist_new();
1339
1340 QTAILQ_FOREACH(bs, &bdrv_states, list) {
1341 QObject *bs_obj;
1342 const char *type = "unknown";
1343
1344 switch(bs->type) {
1345 case BDRV_TYPE_HD:
1346 type = "hd";
1347 break;
1348 case BDRV_TYPE_CDROM:
1349 type = "cdrom";
1350 break;
1351 case BDRV_TYPE_FLOPPY:
1352 type = "floppy";
1353 break;
1354 }
1355
1356 bs_obj = qobject_from_jsonf("{ 'device': %s, 'type': %s, "
1357 "'removable': %i, 'locked': %i }",
1358 bs->device_name, type, bs->removable,
1359 bs->locked);
1360
1361 if (bs->drv) {
1362 QObject *obj;
1363 QDict *bs_dict = qobject_to_qdict(bs_obj);
1364
1365 obj = qobject_from_jsonf("{ 'file': %s, 'ro': %i, 'drv': %s, "
1366 "'encrypted': %i }",
1367 bs->filename, bs->read_only,
1368 bs->drv->format_name,
1369 bdrv_is_encrypted(bs));
1370 if (bs->backing_file[0] != '\0') {
1371 QDict *qdict = qobject_to_qdict(obj);
1372 qdict_put(qdict, "backing_file",
1373 qstring_from_str(bs->backing_file));
1374 }
1375
1376 qdict_put_obj(bs_dict, "inserted", obj);
1377 }
1378 qlist_append_obj(bs_list, bs_obj);
1379 }
1380
1381 *ret_data = QOBJECT(bs_list);
1382 }
1383
1384 static void bdrv_stats_iter(QObject *data, void *opaque)
1385 {
1386 QDict *qdict;
1387 Monitor *mon = opaque;
1388
1389 qdict = qobject_to_qdict(data);
1390 monitor_printf(mon, "%s:", qdict_get_str(qdict, "device"));
1391
1392 qdict = qobject_to_qdict(qdict_get(qdict, "stats"));
1393 monitor_printf(mon, " rd_bytes=%" PRId64
1394 " wr_bytes=%" PRId64
1395 " rd_operations=%" PRId64
1396 " wr_operations=%" PRId64
1397 "\n",
1398 qdict_get_int(qdict, "rd_bytes"),
1399 qdict_get_int(qdict, "wr_bytes"),
1400 qdict_get_int(qdict, "rd_operations"),
1401 qdict_get_int(qdict, "wr_operations"));
1402 }
1403
1404 void bdrv_stats_print(Monitor *mon, const QObject *data)
1405 {
1406 qlist_iter(qobject_to_qlist(data), bdrv_stats_iter, mon);
1407 }
1408
1409 /**
1410 * bdrv_info_stats(): show block device statistics
1411 *
1412 * Each device statistic information is stored in a QDict and
1413 * the returned QObject is a QList of all devices.
1414 *
1415 * The QDict contains the following:
1416 *
1417 * - "device": device name
1418 * - "stats": A QDict with the statistics information, it contains:
1419 * - "rd_bytes": bytes read
1420 * - "wr_bytes": bytes written
1421 * - "rd_operations": read operations
1422 * - "wr_operations": write operations
1423 *
1424 * Example:
1425 *
1426 * [ { "device": "ide0-hd0",
1427 * "stats": { "rd_bytes": 512,
1428 * "wr_bytes": 0,
1429 * "rd_operations": 1,
1430 * "wr_operations": 0 } },
1431 * { "device": "ide1-cd0",
1432 * "stats": { "rd_bytes": 0,
1433 * "wr_bytes": 0,
1434 * "rd_operations": 0,
1435 * "wr_operations": 0 } } ]
1436 */
1437 void bdrv_info_stats(Monitor *mon, QObject **ret_data)
1438 {
1439 QObject *obj;
1440 QList *devices;
1441 BlockDriverState *bs;
1442
1443 devices = qlist_new();
1444
1445 QTAILQ_FOREACH(bs, &bdrv_states, list) {
1446 obj = qobject_from_jsonf("{ 'device': %s, 'stats': {"
1447 "'rd_bytes': %" PRId64 ","
1448 "'wr_bytes': %" PRId64 ","
1449 "'rd_operations': %" PRId64 ","
1450 "'wr_operations': %" PRId64
1451 "} }",
1452 bs->device_name,
1453 bs->rd_bytes, bs->wr_bytes,
1454 bs->rd_ops, bs->wr_ops);
1455 qlist_append_obj(devices, obj);
1456 }
1457
1458 *ret_data = QOBJECT(devices);
1459 }
1460
1461 const char *bdrv_get_encrypted_filename(BlockDriverState *bs)
1462 {
1463 if (bs->backing_hd && bs->backing_hd->encrypted)
1464 return bs->backing_file;
1465 else if (bs->encrypted)
1466 return bs->filename;
1467 else
1468 return NULL;
1469 }
1470
1471 void bdrv_get_backing_filename(BlockDriverState *bs,
1472 char *filename, int filename_size)
1473 {
1474 if (!bs->backing_file) {
1475 pstrcpy(filename, filename_size, "");
1476 } else {
1477 pstrcpy(filename, filename_size, bs->backing_file);
1478 }
1479 }
1480
1481 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
1482 const uint8_t *buf, int nb_sectors)
1483 {
1484 BlockDriver *drv = bs->drv;
1485 if (!drv)
1486 return -ENOMEDIUM;
1487 if (!drv->bdrv_write_compressed)
1488 return -ENOTSUP;
1489 if (bdrv_check_request(bs, sector_num, nb_sectors))
1490 return -EIO;
1491
1492 if (bs->dirty_bitmap) {
1493 set_dirty_bitmap(bs, sector_num, nb_sectors, 1);
1494 }
1495
1496 return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors);
1497 }
1498
1499 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1500 {
1501 BlockDriver *drv = bs->drv;
1502 if (!drv)
1503 return -ENOMEDIUM;
1504 if (!drv->bdrv_get_info)
1505 return -ENOTSUP;
1506 memset(bdi, 0, sizeof(*bdi));
1507 return drv->bdrv_get_info(bs, bdi);
1508 }
1509
1510 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
1511 int64_t pos, int size)
1512 {
1513 BlockDriver *drv = bs->drv;
1514 if (!drv)
1515 return -ENOMEDIUM;
1516 if (!drv->bdrv_save_vmstate)
1517 return -ENOTSUP;
1518 return drv->bdrv_save_vmstate(bs, buf, pos, size);
1519 }
1520
1521 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
1522 int64_t pos, int size)
1523 {
1524 BlockDriver *drv = bs->drv;
1525 if (!drv)
1526 return -ENOMEDIUM;
1527 if (!drv->bdrv_load_vmstate)
1528 return -ENOTSUP;
1529 return drv->bdrv_load_vmstate(bs, buf, pos, size);
1530 }
1531
1532 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event)
1533 {
1534 BlockDriver *drv = bs->drv;
1535
1536 if (!drv || !drv->bdrv_debug_event) {
1537 return;
1538 }
1539
1540 return drv->bdrv_debug_event(bs, event);
1541
1542 }
1543
1544 /**************************************************************/
1545 /* handling of snapshots */
1546
1547 int bdrv_snapshot_create(BlockDriverState *bs,
1548 QEMUSnapshotInfo *sn_info)
1549 {
1550 BlockDriver *drv = bs->drv;
1551 if (!drv)
1552 return -ENOMEDIUM;
1553 if (!drv->bdrv_snapshot_create)
1554 return -ENOTSUP;
1555 return drv->bdrv_snapshot_create(bs, sn_info);
1556 }
1557
1558 int bdrv_snapshot_goto(BlockDriverState *bs,
1559 const char *snapshot_id)
1560 {
1561 BlockDriver *drv = bs->drv;
1562 if (!drv)
1563 return -ENOMEDIUM;
1564 if (!drv->bdrv_snapshot_goto)
1565 return -ENOTSUP;
1566 return drv->bdrv_snapshot_goto(bs, snapshot_id);
1567 }
1568
1569 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id)
1570 {
1571 BlockDriver *drv = bs->drv;
1572 if (!drv)
1573 return -ENOMEDIUM;
1574 if (!drv->bdrv_snapshot_delete)
1575 return -ENOTSUP;
1576 return drv->bdrv_snapshot_delete(bs, snapshot_id);
1577 }
1578
1579 int bdrv_snapshot_list(BlockDriverState *bs,
1580 QEMUSnapshotInfo **psn_info)
1581 {
1582 BlockDriver *drv = bs->drv;
1583 if (!drv)
1584 return -ENOMEDIUM;
1585 if (!drv->bdrv_snapshot_list)
1586 return -ENOTSUP;
1587 return drv->bdrv_snapshot_list(bs, psn_info);
1588 }
1589
1590 #define NB_SUFFIXES 4
1591
1592 char *get_human_readable_size(char *buf, int buf_size, int64_t size)
1593 {
1594 static const char suffixes[NB_SUFFIXES] = "KMGT";
1595 int64_t base;
1596 int i;
1597
1598 if (size <= 999) {
1599 snprintf(buf, buf_size, "%" PRId64, size);
1600 } else {
1601 base = 1024;
1602 for(i = 0; i < NB_SUFFIXES; i++) {
1603 if (size < (10 * base)) {
1604 snprintf(buf, buf_size, "%0.1f%c",
1605 (double)size / base,
1606 suffixes[i]);
1607 break;
1608 } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
1609 snprintf(buf, buf_size, "%" PRId64 "%c",
1610 ((size + (base >> 1)) / base),
1611 suffixes[i]);
1612 break;
1613 }
1614 base = base * 1024;
1615 }
1616 }
1617 return buf;
1618 }
1619
1620 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn)
1621 {
1622 char buf1[128], date_buf[128], clock_buf[128];
1623 #ifdef _WIN32
1624 struct tm *ptm;
1625 #else
1626 struct tm tm;
1627 #endif
1628 time_t ti;
1629 int64_t secs;
1630
1631 if (!sn) {
1632 snprintf(buf, buf_size,
1633 "%-10s%-20s%7s%20s%15s",
1634 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
1635 } else {
1636 ti = sn->date_sec;
1637 #ifdef _WIN32
1638 ptm = localtime(&ti);
1639 strftime(date_buf, sizeof(date_buf),
1640 "%Y-%m-%d %H:%M:%S", ptm);
1641 #else
1642 localtime_r(&ti, &tm);
1643 strftime(date_buf, sizeof(date_buf),
1644 "%Y-%m-%d %H:%M:%S", &tm);
1645 #endif
1646 secs = sn->vm_clock_nsec / 1000000000;
1647 snprintf(clock_buf, sizeof(clock_buf),
1648 "%02d:%02d:%02d.%03d",
1649 (int)(secs / 3600),
1650 (int)((secs / 60) % 60),
1651 (int)(secs % 60),
1652 (int)((sn->vm_clock_nsec / 1000000) % 1000));
1653 snprintf(buf, buf_size,
1654 "%-10s%-20s%7s%20s%15s",
1655 sn->id_str, sn->name,
1656 get_human_readable_size(buf1, sizeof(buf1), sn->vm_state_size),
1657 date_buf,
1658 clock_buf);
1659 }
1660 return buf;
1661 }
1662
1663
1664 /**************************************************************/
1665 /* async I/Os */
1666
1667 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
1668 QEMUIOVector *qiov, int nb_sectors,
1669 BlockDriverCompletionFunc *cb, void *opaque)
1670 {
1671 BlockDriver *drv = bs->drv;
1672 BlockDriverAIOCB *ret;
1673
1674 if (!drv)
1675 return NULL;
1676 if (bdrv_check_request(bs, sector_num, nb_sectors))
1677 return NULL;
1678
1679 ret = drv->bdrv_aio_readv(bs, sector_num, qiov, nb_sectors,
1680 cb, opaque);
1681
1682 if (ret) {
1683 /* Update stats even though technically transfer has not happened. */
1684 bs->rd_bytes += (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
1685 bs->rd_ops ++;
1686 }
1687
1688 return ret;
1689 }
1690
1691 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
1692 QEMUIOVector *qiov, int nb_sectors,
1693 BlockDriverCompletionFunc *cb, void *opaque)
1694 {
1695 BlockDriver *drv = bs->drv;
1696 BlockDriverAIOCB *ret;
1697
1698 if (!drv)
1699 return NULL;
1700 if (bs->read_only)
1701 return NULL;
1702 if (bdrv_check_request(bs, sector_num, nb_sectors))
1703 return NULL;
1704
1705 if (bs->dirty_bitmap) {
1706 set_dirty_bitmap(bs, sector_num, nb_sectors, 1);
1707 }
1708
1709 ret = drv->bdrv_aio_writev(bs, sector_num, qiov, nb_sectors,
1710 cb, opaque);
1711
1712 if (ret) {
1713 /* Update stats even though technically transfer has not happened. */
1714 bs->wr_bytes += (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
1715 bs->wr_ops ++;
1716 }
1717
1718 return ret;
1719 }
1720
1721
1722 typedef struct MultiwriteCB {
1723 int error;
1724 int num_requests;
1725 int num_callbacks;
1726 struct {
1727 BlockDriverCompletionFunc *cb;
1728 void *opaque;
1729 QEMUIOVector *free_qiov;
1730 void *free_buf;
1731 } callbacks[];
1732 } MultiwriteCB;
1733
1734 static void multiwrite_user_cb(MultiwriteCB *mcb)
1735 {
1736 int i;
1737
1738 for (i = 0; i < mcb->num_callbacks; i++) {
1739 mcb->callbacks[i].cb(mcb->callbacks[i].opaque, mcb->error);
1740 qemu_free(mcb->callbacks[i].free_qiov);
1741 qemu_vfree(mcb->callbacks[i].free_buf);
1742 }
1743 }
1744
1745 static void multiwrite_cb(void *opaque, int ret)
1746 {
1747 MultiwriteCB *mcb = opaque;
1748
1749 if (ret < 0 && !mcb->error) {
1750 mcb->error = ret;
1751 multiwrite_user_cb(mcb);
1752 }
1753
1754 mcb->num_requests--;
1755 if (mcb->num_requests == 0) {
1756 if (mcb->error == 0) {
1757 multiwrite_user_cb(mcb);
1758 }
1759 qemu_free(mcb);
1760 }
1761 }
1762
1763 static int multiwrite_req_compare(const void *a, const void *b)
1764 {
1765 return (((BlockRequest*) a)->sector - ((BlockRequest*) b)->sector);
1766 }
1767
1768 /*
1769 * Takes a bunch of requests and tries to merge them. Returns the number of
1770 * requests that remain after merging.
1771 */
1772 static int multiwrite_merge(BlockDriverState *bs, BlockRequest *reqs,
1773 int num_reqs, MultiwriteCB *mcb)
1774 {
1775 int i, outidx;
1776
1777 // Sort requests by start sector
1778 qsort(reqs, num_reqs, sizeof(*reqs), &multiwrite_req_compare);
1779
1780 // Check if adjacent requests touch the same clusters. If so, combine them,
1781 // filling up gaps with zero sectors.
1782 outidx = 0;
1783 for (i = 1; i < num_reqs; i++) {
1784 int merge = 0;
1785 int64_t oldreq_last = reqs[outidx].sector + reqs[outidx].nb_sectors;
1786
1787 // This handles the cases that are valid for all block drivers, namely
1788 // exactly sequential writes and overlapping writes.
1789 if (reqs[i].sector <= oldreq_last) {
1790 merge = 1;
1791 }
1792
1793 // The block driver may decide that it makes sense to combine requests
1794 // even if there is a gap of some sectors between them. In this case,
1795 // the gap is filled with zeros (therefore only applicable for yet
1796 // unused space in format like qcow2).
1797 if (!merge && bs->drv->bdrv_merge_requests) {
1798 merge = bs->drv->bdrv_merge_requests(bs, &reqs[outidx], &reqs[i]);
1799 }
1800
1801 if (reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1 > IOV_MAX) {
1802 merge = 0;
1803 }
1804
1805 if (merge) {
1806 size_t size;
1807 QEMUIOVector *qiov = qemu_mallocz(sizeof(*qiov));
1808 qemu_iovec_init(qiov,
1809 reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1);
1810
1811 // Add the first request to the merged one. If the requests are
1812 // overlapping, drop the last sectors of the first request.
1813 size = (reqs[i].sector - reqs[outidx].sector) << 9;
1814 qemu_iovec_concat(qiov, reqs[outidx].qiov, size);
1815
1816 // We might need to add some zeros between the two requests
1817 if (reqs[i].sector > oldreq_last) {
1818 size_t zero_bytes = (reqs[i].sector - oldreq_last) << 9;
1819 uint8_t *buf = qemu_blockalign(bs, zero_bytes);
1820 memset(buf, 0, zero_bytes);
1821 qemu_iovec_add(qiov, buf, zero_bytes);
1822 mcb->callbacks[i].free_buf = buf;
1823 }
1824
1825 // Add the second request
1826 qemu_iovec_concat(qiov, reqs[i].qiov, reqs[i].qiov->size);
1827
1828 reqs[outidx].nb_sectors += reqs[i].nb_sectors;
1829 reqs[outidx].qiov = qiov;
1830
1831 mcb->callbacks[i].free_qiov = reqs[outidx].qiov;
1832 } else {
1833 outidx++;
1834 reqs[outidx].sector = reqs[i].sector;
1835 reqs[outidx].nb_sectors = reqs[i].nb_sectors;
1836 reqs[outidx].qiov = reqs[i].qiov;
1837 }
1838 }
1839
1840 return outidx + 1;
1841 }
1842
1843 /*
1844 * Submit multiple AIO write requests at once.
1845 *
1846 * On success, the function returns 0 and all requests in the reqs array have
1847 * been submitted. In error case this function returns -1, and any of the
1848 * requests may or may not be submitted yet. In particular, this means that the
1849 * callback will be called for some of the requests, for others it won't. The
1850 * caller must check the error field of the BlockRequest to wait for the right
1851 * callbacks (if error != 0, no callback will be called).
1852 *
1853 * The implementation may modify the contents of the reqs array, e.g. to merge
1854 * requests. However, the fields opaque and error are left unmodified as they
1855 * are used to signal failure for a single request to the caller.
1856 */
1857 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, int num_reqs)
1858 {
1859 BlockDriverAIOCB *acb;
1860 MultiwriteCB *mcb;
1861 int i;
1862
1863 if (num_reqs == 0) {
1864 return 0;
1865 }
1866
1867 // Create MultiwriteCB structure
1868 mcb = qemu_mallocz(sizeof(*mcb) + num_reqs * sizeof(*mcb->callbacks));
1869 mcb->num_requests = 0;
1870 mcb->num_callbacks = num_reqs;
1871
1872 for (i = 0; i < num_reqs; i++) {
1873 mcb->callbacks[i].cb = reqs[i].cb;
1874 mcb->callbacks[i].opaque = reqs[i].opaque;
1875 }
1876
1877 // Check for mergable requests
1878 num_reqs = multiwrite_merge(bs, reqs, num_reqs, mcb);
1879
1880 // Run the aio requests
1881 for (i = 0; i < num_reqs; i++) {
1882 acb = bdrv_aio_writev(bs, reqs[i].sector, reqs[i].qiov,
1883 reqs[i].nb_sectors, multiwrite_cb, mcb);
1884
1885 if (acb == NULL) {
1886 // We can only fail the whole thing if no request has been
1887 // submitted yet. Otherwise we'll wait for the submitted AIOs to
1888 // complete and report the error in the callback.
1889 if (mcb->num_requests == 0) {
1890 reqs[i].error = -EIO;
1891 goto fail;
1892 } else {
1893 mcb->num_requests++;
1894 multiwrite_cb(mcb, -EIO);
1895 break;
1896 }
1897 } else {
1898 mcb->num_requests++;
1899 }
1900 }
1901
1902 return 0;
1903
1904 fail:
1905 free(mcb);
1906 return -1;
1907 }
1908
1909 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
1910 BlockDriverCompletionFunc *cb, void *opaque)
1911 {
1912 BlockDriver *drv = bs->drv;
1913
1914 if (!drv)
1915 return NULL;
1916 return drv->bdrv_aio_flush(bs, cb, opaque);
1917 }
1918
1919 void bdrv_aio_cancel(BlockDriverAIOCB *acb)
1920 {
1921 acb->pool->cancel(acb);
1922 }
1923
1924
1925 /**************************************************************/
1926 /* async block device emulation */
1927
1928 typedef struct BlockDriverAIOCBSync {
1929 BlockDriverAIOCB common;
1930 QEMUBH *bh;
1931 int ret;
1932 /* vector translation state */
1933 QEMUIOVector *qiov;
1934 uint8_t *bounce;
1935 int is_write;
1936 } BlockDriverAIOCBSync;
1937
1938 static void bdrv_aio_cancel_em(BlockDriverAIOCB *blockacb)
1939 {
1940 BlockDriverAIOCBSync *acb = (BlockDriverAIOCBSync *)blockacb;
1941 qemu_bh_delete(acb->bh);
1942 acb->bh = NULL;
1943 qemu_aio_release(acb);
1944 }
1945
1946 static AIOPool bdrv_em_aio_pool = {
1947 .aiocb_size = sizeof(BlockDriverAIOCBSync),
1948 .cancel = bdrv_aio_cancel_em,
1949 };
1950
1951 static void bdrv_aio_bh_cb(void *opaque)
1952 {
1953 BlockDriverAIOCBSync *acb = opaque;
1954
1955 if (!acb->is_write)
1956 qemu_iovec_from_buffer(acb->qiov, acb->bounce, acb->qiov->size);
1957 qemu_vfree(acb->bounce);
1958 acb->common.cb(acb->common.opaque, acb->ret);
1959 qemu_bh_delete(acb->bh);
1960 acb->bh = NULL;
1961 qemu_aio_release(acb);
1962 }
1963
1964 static BlockDriverAIOCB *bdrv_aio_rw_vector(BlockDriverState *bs,
1965 int64_t sector_num,
1966 QEMUIOVector *qiov,
1967 int nb_sectors,
1968 BlockDriverCompletionFunc *cb,
1969 void *opaque,
1970 int is_write)
1971
1972 {
1973 BlockDriverAIOCBSync *acb;
1974
1975 acb = qemu_aio_get(&bdrv_em_aio_pool, bs, cb, opaque);
1976 acb->is_write = is_write;
1977 acb->qiov = qiov;
1978 acb->bounce = qemu_blockalign(bs, qiov->size);
1979
1980 if (!acb->bh)
1981 acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
1982
1983 if (is_write) {
1984 qemu_iovec_to_buffer(acb->qiov, acb->bounce);
1985 acb->ret = bdrv_write(bs, sector_num, acb->bounce, nb_sectors);
1986 } else {
1987 acb->ret = bdrv_read(bs, sector_num, acb->bounce, nb_sectors);
1988 }
1989
1990 qemu_bh_schedule(acb->bh);
1991
1992 return &acb->common;
1993 }
1994
1995 static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
1996 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
1997 BlockDriverCompletionFunc *cb, void *opaque)
1998 {
1999 return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 0);
2000 }
2001
2002 static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
2003 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
2004 BlockDriverCompletionFunc *cb, void *opaque)
2005 {
2006 return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 1);
2007 }
2008
2009 static BlockDriverAIOCB *bdrv_aio_flush_em(BlockDriverState *bs,
2010 BlockDriverCompletionFunc *cb, void *opaque)
2011 {
2012 BlockDriverAIOCBSync *acb;
2013
2014 acb = qemu_aio_get(&bdrv_em_aio_pool, bs, cb, opaque);
2015 acb->is_write = 1; /* don't bounce in the completion hadler */
2016 acb->qiov = NULL;
2017 acb->bounce = NULL;
2018 acb->ret = 0;
2019
2020 if (!acb->bh)
2021 acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
2022
2023 bdrv_flush(bs);
2024 qemu_bh_schedule(acb->bh);
2025 return &acb->common;
2026 }
2027
2028 /**************************************************************/
2029 /* sync block device emulation */
2030
2031 static void bdrv_rw_em_cb(void *opaque, int ret)
2032 {
2033 *(int *)opaque = ret;
2034 }
2035
2036 #define NOT_DONE 0x7fffffff
2037
2038 static int bdrv_read_em(BlockDriverState *bs, int64_t sector_num,
2039 uint8_t *buf, int nb_sectors)
2040 {
2041 int async_ret;
2042 BlockDriverAIOCB *acb;
2043 struct iovec iov;
2044 QEMUIOVector qiov;
2045
2046 async_context_push();
2047
2048 async_ret = NOT_DONE;
2049 iov.iov_base = (void *)buf;
2050 iov.iov_len = nb_sectors * 512;
2051 qemu_iovec_init_external(&qiov, &iov, 1);
2052 acb = bdrv_aio_readv(bs, sector_num, &qiov, nb_sectors,
2053 bdrv_rw_em_cb, &async_ret);
2054 if (acb == NULL) {
2055 async_ret = -1;
2056 goto fail;
2057 }
2058
2059 while (async_ret == NOT_DONE) {
2060 qemu_aio_wait();
2061 }
2062
2063
2064 fail:
2065 async_context_pop();
2066 return async_ret;
2067 }
2068
2069 static int bdrv_write_em(BlockDriverState *bs, int64_t sector_num,
2070 const uint8_t *buf, int nb_sectors)
2071 {
2072 int async_ret;
2073 BlockDriverAIOCB *acb;
2074 struct iovec iov;
2075 QEMUIOVector qiov;
2076
2077 async_context_push();
2078
2079 async_ret = NOT_DONE;
2080 iov.iov_base = (void *)buf;
2081 iov.iov_len = nb_sectors * 512;
2082 qemu_iovec_init_external(&qiov, &iov, 1);
2083 acb = bdrv_aio_writev(bs, sector_num, &qiov, nb_sectors,
2084 bdrv_rw_em_cb, &async_ret);
2085 if (acb == NULL) {
2086 async_ret = -1;
2087 goto fail;
2088 }
2089 while (async_ret == NOT_DONE) {
2090 qemu_aio_wait();
2091 }
2092
2093 fail:
2094 async_context_pop();
2095 return async_ret;
2096 }
2097
2098 void bdrv_init(void)
2099 {
2100 module_call_init(MODULE_INIT_BLOCK);
2101 }
2102
2103 void bdrv_init_with_whitelist(void)
2104 {
2105 use_bdrv_whitelist = 1;
2106 bdrv_init();
2107 }
2108
2109 void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
2110 BlockDriverCompletionFunc *cb, void *opaque)
2111 {
2112 BlockDriverAIOCB *acb;
2113
2114 if (pool->free_aiocb) {
2115 acb = pool->free_aiocb;
2116 pool->free_aiocb = acb->next;
2117 } else {
2118 acb = qemu_mallocz(pool->aiocb_size);
2119 acb->pool = pool;
2120 }
2121 acb->bs = bs;
2122 acb->cb = cb;
2123 acb->opaque = opaque;
2124 return acb;
2125 }
2126
2127 void qemu_aio_release(void *p)
2128 {
2129 BlockDriverAIOCB *acb = (BlockDriverAIOCB *)p;
2130 AIOPool *pool = acb->pool;
2131 acb->next = pool->free_aiocb;
2132 pool->free_aiocb = acb;
2133 }
2134
2135 /**************************************************************/
2136 /* removable device support */
2137
2138 /**
2139 * Return TRUE if the media is present
2140 */
2141 int bdrv_is_inserted(BlockDriverState *bs)
2142 {
2143 BlockDriver *drv = bs->drv;
2144 int ret;
2145 if (!drv)
2146 return 0;
2147 if (!drv->bdrv_is_inserted)
2148 return 1;
2149 ret = drv->bdrv_is_inserted(bs);
2150 return ret;
2151 }
2152
2153 /**
2154 * Return TRUE if the media changed since the last call to this
2155 * function. It is currently only used for floppy disks
2156 */
2157 int bdrv_media_changed(BlockDriverState *bs)
2158 {
2159 BlockDriver *drv = bs->drv;
2160 int ret;
2161
2162 if (!drv || !drv->bdrv_media_changed)
2163 ret = -ENOTSUP;
2164 else
2165 ret = drv->bdrv_media_changed(bs);
2166 if (ret == -ENOTSUP)
2167 ret = bs->media_changed;
2168 bs->media_changed = 0;
2169 return ret;
2170 }
2171
2172 /**
2173 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
2174 */
2175 int bdrv_eject(BlockDriverState *bs, int eject_flag)
2176 {
2177 BlockDriver *drv = bs->drv;
2178 int ret;
2179
2180 if (bs->locked) {
2181 return -EBUSY;
2182 }
2183
2184 if (!drv || !drv->bdrv_eject) {
2185 ret = -ENOTSUP;
2186 } else {
2187 ret = drv->bdrv_eject(bs, eject_flag);
2188 }
2189 if (ret == -ENOTSUP) {
2190 if (eject_flag)
2191 bdrv_close(bs);
2192 ret = 0;
2193 }
2194
2195 return ret;
2196 }
2197
2198 int bdrv_is_locked(BlockDriverState *bs)
2199 {
2200 return bs->locked;
2201 }
2202
2203 /**
2204 * Lock or unlock the media (if it is locked, the user won't be able
2205 * to eject it manually).
2206 */
2207 void bdrv_set_locked(BlockDriverState *bs, int locked)
2208 {
2209 BlockDriver *drv = bs->drv;
2210
2211 bs->locked = locked;
2212 if (drv && drv->bdrv_set_locked) {
2213 drv->bdrv_set_locked(bs, locked);
2214 }
2215 }
2216
2217 /* needed for generic scsi interface */
2218
2219 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
2220 {
2221 BlockDriver *drv = bs->drv;
2222
2223 if (drv && drv->bdrv_ioctl)
2224 return drv->bdrv_ioctl(bs, req, buf);
2225 return -ENOTSUP;
2226 }
2227
2228 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
2229 unsigned long int req, void *buf,
2230 BlockDriverCompletionFunc *cb, void *opaque)
2231 {
2232 BlockDriver *drv = bs->drv;
2233
2234 if (drv && drv->bdrv_aio_ioctl)
2235 return drv->bdrv_aio_ioctl(bs, req, buf, cb, opaque);
2236 return NULL;
2237 }
2238
2239
2240
2241 void *qemu_blockalign(BlockDriverState *bs, size_t size)
2242 {
2243 return qemu_memalign((bs && bs->buffer_alignment) ? bs->buffer_alignment : 512, size);
2244 }
2245
2246 void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable)
2247 {
2248 int64_t bitmap_size;
2249
2250 bs->dirty_count = 0;
2251 if (enable) {
2252 if (!bs->dirty_bitmap) {
2253 bitmap_size = (bdrv_getlength(bs) >> BDRV_SECTOR_BITS) +
2254 BDRV_SECTORS_PER_DIRTY_CHUNK * 8 - 1;
2255 bitmap_size /= BDRV_SECTORS_PER_DIRTY_CHUNK * 8;
2256
2257 bs->dirty_bitmap = qemu_mallocz(bitmap_size);
2258 }
2259 } else {
2260 if (bs->dirty_bitmap) {
2261 qemu_free(bs->dirty_bitmap);
2262 bs->dirty_bitmap = NULL;
2263 }
2264 }
2265 }
2266
2267 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector)
2268 {
2269 int64_t chunk = sector / (int64_t)BDRV_SECTORS_PER_DIRTY_CHUNK;
2270
2271 if (bs->dirty_bitmap &&
2272 (sector << BDRV_SECTOR_BITS) < bdrv_getlength(bs)) {
2273 return bs->dirty_bitmap[chunk / (sizeof(unsigned long) * 8)] &
2274 (1 << (chunk % (sizeof(unsigned long) * 8)));
2275 } else {
2276 return 0;
2277 }
2278 }
2279
2280 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
2281 int nr_sectors)
2282 {
2283 set_dirty_bitmap(bs, cur_sector, nr_sectors, 0);
2284 }
2285
2286 int64_t bdrv_get_dirty_count(BlockDriverState *bs)
2287 {
2288 return bs->dirty_count;
2289 }