4 * Copyright (C) 2014 Red Hat, Inc.
7 * Markus Armbruster <armbru@redhat.com>,
9 * This work is licensed under the terms of the GNU LGPL, version 2.1
10 * or later. See the COPYING.LIB file in the top-level directory.
13 #include "sysemu/block-backend.h"
14 #include "block/block_int.h"
15 #include "sysemu/blockdev.h"
16 #include "qapi-event.h"
18 /* Number of coroutines to reserve per attached device model */
19 #define COROUTINE_POOL_RESERVATION 64
25 DriveInfo
*legacy_dinfo
; /* null unless created by drive_new() */
26 QTAILQ_ENTRY(BlockBackend
) link
; /* for blk_backends */
28 void *dev
; /* attached device model, if any */
29 /* TODO change to DeviceState when all users are qdevified */
30 const BlockDevOps
*dev_ops
;
34 typedef struct BlockBackendAIOCB
{
40 static const AIOCBInfo block_backend_aiocb_info
= {
41 .aiocb_size
= sizeof(BlockBackendAIOCB
),
44 static void drive_info_del(DriveInfo
*dinfo
);
46 /* All the BlockBackends (except for hidden ones) */
47 static QTAILQ_HEAD(, BlockBackend
) blk_backends
=
48 QTAILQ_HEAD_INITIALIZER(blk_backends
);
51 * Create a new BlockBackend with @name, with a reference count of one.
52 * @name must not be null or empty.
53 * Fail if a BlockBackend with this name already exists.
54 * Store an error through @errp on failure, unless it's null.
55 * Return the new BlockBackend on success, null on failure.
57 BlockBackend
*blk_new(const char *name
, Error
**errp
)
61 assert(name
&& name
[0]);
62 if (!id_wellformed(name
)) {
63 error_setg(errp
, "Invalid device name");
66 if (blk_by_name(name
)) {
67 error_setg(errp
, "Device with id '%s' already exists", name
);
70 if (bdrv_find_node(name
)) {
72 "Device name '%s' conflicts with an existing node name",
77 blk
= g_new0(BlockBackend
, 1);
78 blk
->name
= g_strdup(name
);
80 QTAILQ_INSERT_TAIL(&blk_backends
, blk
, link
);
85 * Create a new BlockBackend with a new BlockDriverState attached.
86 * Otherwise just like blk_new(), which see.
88 BlockBackend
*blk_new_with_bs(const char *name
, Error
**errp
)
93 blk
= blk_new(name
, errp
);
105 * Calls blk_new_with_bs() and then calls bdrv_open() on the BlockDriverState.
107 * Just as with bdrv_open(), after having called this function the reference to
108 * @options belongs to the block layer (even on failure).
110 * TODO: Remove @filename and @flags; it should be possible to specify a whole
111 * BDS tree just by specifying the @options QDict (or @reference,
112 * alternatively). At the time of adding this function, this is not possible,
113 * though, so callers of this function have to be able to specify @filename and
116 BlockBackend
*blk_new_open(const char *name
, const char *filename
,
117 const char *reference
, QDict
*options
, int flags
,
123 blk
= blk_new_with_bs(name
, errp
);
129 ret
= bdrv_open(&blk
->bs
, filename
, reference
, options
, flags
, errp
);
138 static void blk_delete(BlockBackend
*blk
)
140 assert(!blk
->refcnt
);
143 assert(blk
->bs
->blk
== blk
);
148 /* Avoid double-remove after blk_hide_on_behalf_of_hmp_drive_del() */
150 QTAILQ_REMOVE(&blk_backends
, blk
, link
);
153 drive_info_del(blk
->legacy_dinfo
);
157 static void drive_info_del(DriveInfo
*dinfo
)
162 qemu_opts_del(dinfo
->opts
);
163 g_free(dinfo
->serial
);
168 * Increment @blk's reference count.
169 * @blk must not be null.
171 void blk_ref(BlockBackend
*blk
)
177 * Decrement @blk's reference count.
178 * If this drops it to zero, destroy @blk.
179 * For convenience, do nothing if @blk is null.
181 void blk_unref(BlockBackend
*blk
)
184 assert(blk
->refcnt
> 0);
185 if (!--blk
->refcnt
) {
192 * Return the BlockBackend after @blk.
193 * If @blk is null, return the first one.
194 * Else, return @blk's next sibling, which may be null.
196 * To iterate over all BlockBackends, do
197 * for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
201 BlockBackend
*blk_next(BlockBackend
*blk
)
203 return blk
? QTAILQ_NEXT(blk
, link
) : QTAILQ_FIRST(&blk_backends
);
207 * Return @blk's name, a non-null string.
208 * Wart: the name is empty iff @blk has been hidden with
209 * blk_hide_on_behalf_of_hmp_drive_del().
211 const char *blk_name(BlockBackend
*blk
)
217 * Return the BlockBackend with name @name if it exists, else null.
218 * @name must not be null.
220 BlockBackend
*blk_by_name(const char *name
)
225 QTAILQ_FOREACH(blk
, &blk_backends
, link
) {
226 if (!strcmp(name
, blk
->name
)) {
234 * Return the BlockDriverState attached to @blk if any, else null.
236 BlockDriverState
*blk_bs(BlockBackend
*blk
)
242 * Changes the BlockDriverState attached to @blk
244 void blk_set_bs(BlockBackend
*blk
, BlockDriverState
*bs
)
252 assert(bs
->blk
== NULL
);
259 * Return @blk's DriveInfo if any, else null.
261 DriveInfo
*blk_legacy_dinfo(BlockBackend
*blk
)
263 return blk
->legacy_dinfo
;
267 * Set @blk's DriveInfo to @dinfo, and return it.
268 * @blk must not have a DriveInfo set already.
269 * No other BlockBackend may have the same DriveInfo set.
271 DriveInfo
*blk_set_legacy_dinfo(BlockBackend
*blk
, DriveInfo
*dinfo
)
273 assert(!blk
->legacy_dinfo
);
274 return blk
->legacy_dinfo
= dinfo
;
278 * Return the BlockBackend with DriveInfo @dinfo.
281 BlockBackend
*blk_by_legacy_dinfo(DriveInfo
*dinfo
)
285 QTAILQ_FOREACH(blk
, &blk_backends
, link
) {
286 if (blk
->legacy_dinfo
== dinfo
) {
295 * @blk must not have been hidden already.
296 * Make attached BlockDriverState, if any, anonymous.
297 * Once hidden, @blk is invisible to all functions that don't receive
298 * it as argument. For example, blk_by_name() won't return it.
299 * Strictly for use by do_drive_del().
300 * TODO get rid of it!
302 void blk_hide_on_behalf_of_hmp_drive_del(BlockBackend
*blk
)
304 QTAILQ_REMOVE(&blk_backends
, blk
, link
);
307 bdrv_make_anon(blk
->bs
);
312 * Attach device model @dev to @blk.
313 * Return 0 on success, -EBUSY when a device model is attached already.
315 int blk_attach_dev(BlockBackend
*blk
, void *dev
)
316 /* TODO change to DeviceState *dev when all users are qdevified */
323 bdrv_iostatus_reset(blk
->bs
);
328 * Attach device model @dev to @blk.
329 * @blk must not have a device model attached already.
330 * TODO qdevified devices don't use this, remove when devices are qdevified
332 void blk_attach_dev_nofail(BlockBackend
*blk
, void *dev
)
334 if (blk_attach_dev(blk
, dev
) < 0) {
340 * Detach device model @dev from @blk.
341 * @dev must be currently attached to @blk.
343 void blk_detach_dev(BlockBackend
*blk
, void *dev
)
344 /* TODO change to DeviceState *dev when all users are qdevified */
346 assert(blk
->dev
== dev
);
349 blk
->dev_opaque
= NULL
;
350 bdrv_set_guest_block_size(blk
->bs
, 512);
355 * Return the device model attached to @blk if any, else null.
357 void *blk_get_attached_dev(BlockBackend
*blk
)
358 /* TODO change to return DeviceState * when all users are qdevified */
364 * Set @blk's device model callbacks to @ops.
365 * @opaque is the opaque argument to pass to the callbacks.
366 * This is for use by device models.
368 void blk_set_dev_ops(BlockBackend
*blk
, const BlockDevOps
*ops
,
372 blk
->dev_opaque
= opaque
;
376 * Notify @blk's attached device model of media change.
377 * If @load is true, notify of media load.
378 * Else, notify of media eject.
379 * Also send DEVICE_TRAY_MOVED events as appropriate.
381 void blk_dev_change_media_cb(BlockBackend
*blk
, bool load
)
383 if (blk
->dev_ops
&& blk
->dev_ops
->change_media_cb
) {
384 bool tray_was_closed
= !blk_dev_is_tray_open(blk
);
386 blk
->dev_ops
->change_media_cb(blk
->dev_opaque
, load
);
387 if (tray_was_closed
) {
389 qapi_event_send_device_tray_moved(blk_name(blk
),
394 qapi_event_send_device_tray_moved(blk_name(blk
),
395 false, &error_abort
);
401 * Does @blk's attached device model have removable media?
402 * %true if no device model is attached.
404 bool blk_dev_has_removable_media(BlockBackend
*blk
)
406 return !blk
->dev
|| (blk
->dev_ops
&& blk
->dev_ops
->change_media_cb
);
410 * Notify @blk's attached device model of a media eject request.
411 * If @force is true, the medium is about to be yanked out forcefully.
413 void blk_dev_eject_request(BlockBackend
*blk
, bool force
)
415 if (blk
->dev_ops
&& blk
->dev_ops
->eject_request_cb
) {
416 blk
->dev_ops
->eject_request_cb(blk
->dev_opaque
, force
);
421 * Does @blk's attached device model have a tray, and is it open?
423 bool blk_dev_is_tray_open(BlockBackend
*blk
)
425 if (blk
->dev_ops
&& blk
->dev_ops
->is_tray_open
) {
426 return blk
->dev_ops
->is_tray_open(blk
->dev_opaque
);
432 * Does @blk's attached device model have the medium locked?
433 * %false if the device model has no such lock.
435 bool blk_dev_is_medium_locked(BlockBackend
*blk
)
437 if (blk
->dev_ops
&& blk
->dev_ops
->is_medium_locked
) {
438 return blk
->dev_ops
->is_medium_locked(blk
->dev_opaque
);
444 * Notify @blk's attached device model of a backend size change.
446 void blk_dev_resize_cb(BlockBackend
*blk
)
448 if (blk
->dev_ops
&& blk
->dev_ops
->resize_cb
) {
449 blk
->dev_ops
->resize_cb(blk
->dev_opaque
);
453 void blk_iostatus_enable(BlockBackend
*blk
)
455 bdrv_iostatus_enable(blk
->bs
);
458 static int blk_check_byte_request(BlockBackend
*blk
, int64_t offset
,
463 if (size
> INT_MAX
) {
467 if (!blk_is_inserted(blk
)) {
471 len
= blk_getlength(blk
);
480 if (offset
> len
|| len
- offset
< size
) {
487 static int blk_check_request(BlockBackend
*blk
, int64_t sector_num
,
490 if (sector_num
< 0 || sector_num
> INT64_MAX
/ BDRV_SECTOR_SIZE
) {
494 if (nb_sectors
< 0 || nb_sectors
> INT_MAX
/ BDRV_SECTOR_SIZE
) {
498 return blk_check_byte_request(blk
, sector_num
* BDRV_SECTOR_SIZE
,
499 nb_sectors
* BDRV_SECTOR_SIZE
);
502 int blk_read(BlockBackend
*blk
, int64_t sector_num
, uint8_t *buf
,
505 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
510 return bdrv_read(blk
->bs
, sector_num
, buf
, nb_sectors
);
513 int blk_read_unthrottled(BlockBackend
*blk
, int64_t sector_num
, uint8_t *buf
,
516 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
521 return bdrv_read_unthrottled(blk
->bs
, sector_num
, buf
, nb_sectors
);
524 int blk_write(BlockBackend
*blk
, int64_t sector_num
, const uint8_t *buf
,
527 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
532 return bdrv_write(blk
->bs
, sector_num
, buf
, nb_sectors
);
535 int blk_write_zeroes(BlockBackend
*blk
, int64_t sector_num
,
536 int nb_sectors
, BdrvRequestFlags flags
)
538 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
543 return bdrv_write_zeroes(blk
->bs
, sector_num
, nb_sectors
, flags
);
546 static void error_callback_bh(void *opaque
)
548 struct BlockBackendAIOCB
*acb
= opaque
;
549 qemu_bh_delete(acb
->bh
);
550 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
554 static BlockAIOCB
*abort_aio_request(BlockBackend
*blk
, BlockCompletionFunc
*cb
,
555 void *opaque
, int ret
)
557 struct BlockBackendAIOCB
*acb
;
560 acb
= blk_aio_get(&block_backend_aiocb_info
, blk
, cb
, opaque
);
563 bh
= aio_bh_new(blk_get_aio_context(blk
), error_callback_bh
, acb
);
565 qemu_bh_schedule(bh
);
570 BlockAIOCB
*blk_aio_write_zeroes(BlockBackend
*blk
, int64_t sector_num
,
571 int nb_sectors
, BdrvRequestFlags flags
,
572 BlockCompletionFunc
*cb
, void *opaque
)
574 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
576 return abort_aio_request(blk
, cb
, opaque
, ret
);
579 return bdrv_aio_write_zeroes(blk
->bs
, sector_num
, nb_sectors
, flags
,
583 int blk_pread(BlockBackend
*blk
, int64_t offset
, void *buf
, int count
)
585 int ret
= blk_check_byte_request(blk
, offset
, count
);
590 return bdrv_pread(blk
->bs
, offset
, buf
, count
);
593 int blk_pwrite(BlockBackend
*blk
, int64_t offset
, const void *buf
, int count
)
595 int ret
= blk_check_byte_request(blk
, offset
, count
);
600 return bdrv_pwrite(blk
->bs
, offset
, buf
, count
);
603 int64_t blk_getlength(BlockBackend
*blk
)
605 return bdrv_getlength(blk
->bs
);
608 void blk_get_geometry(BlockBackend
*blk
, uint64_t *nb_sectors_ptr
)
610 bdrv_get_geometry(blk
->bs
, nb_sectors_ptr
);
613 int64_t blk_nb_sectors(BlockBackend
*blk
)
615 return bdrv_nb_sectors(blk
->bs
);
618 BlockAIOCB
*blk_aio_readv(BlockBackend
*blk
, int64_t sector_num
,
619 QEMUIOVector
*iov
, int nb_sectors
,
620 BlockCompletionFunc
*cb
, void *opaque
)
622 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
624 return abort_aio_request(blk
, cb
, opaque
, ret
);
627 return bdrv_aio_readv(blk
->bs
, sector_num
, iov
, nb_sectors
, cb
, opaque
);
630 BlockAIOCB
*blk_aio_writev(BlockBackend
*blk
, int64_t sector_num
,
631 QEMUIOVector
*iov
, int nb_sectors
,
632 BlockCompletionFunc
*cb
, void *opaque
)
634 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
636 return abort_aio_request(blk
, cb
, opaque
, ret
);
639 return bdrv_aio_writev(blk
->bs
, sector_num
, iov
, nb_sectors
, cb
, opaque
);
642 BlockAIOCB
*blk_aio_flush(BlockBackend
*blk
,
643 BlockCompletionFunc
*cb
, void *opaque
)
645 return bdrv_aio_flush(blk
->bs
, cb
, opaque
);
648 BlockAIOCB
*blk_aio_discard(BlockBackend
*blk
,
649 int64_t sector_num
, int nb_sectors
,
650 BlockCompletionFunc
*cb
, void *opaque
)
652 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
654 return abort_aio_request(blk
, cb
, opaque
, ret
);
657 return bdrv_aio_discard(blk
->bs
, sector_num
, nb_sectors
, cb
, opaque
);
660 void blk_aio_cancel(BlockAIOCB
*acb
)
662 bdrv_aio_cancel(acb
);
665 void blk_aio_cancel_async(BlockAIOCB
*acb
)
667 bdrv_aio_cancel_async(acb
);
670 int blk_aio_multiwrite(BlockBackend
*blk
, BlockRequest
*reqs
, int num_reqs
)
674 for (i
= 0; i
< num_reqs
; i
++) {
675 ret
= blk_check_request(blk
, reqs
[i
].sector
, reqs
[i
].nb_sectors
);
681 return bdrv_aio_multiwrite(blk
->bs
, reqs
, num_reqs
);
684 int blk_ioctl(BlockBackend
*blk
, unsigned long int req
, void *buf
)
686 return bdrv_ioctl(blk
->bs
, req
, buf
);
689 BlockAIOCB
*blk_aio_ioctl(BlockBackend
*blk
, unsigned long int req
, void *buf
,
690 BlockCompletionFunc
*cb
, void *opaque
)
692 return bdrv_aio_ioctl(blk
->bs
, req
, buf
, cb
, opaque
);
695 int blk_co_discard(BlockBackend
*blk
, int64_t sector_num
, int nb_sectors
)
697 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
702 return bdrv_co_discard(blk
->bs
, sector_num
, nb_sectors
);
705 int blk_co_flush(BlockBackend
*blk
)
707 return bdrv_co_flush(blk
->bs
);
710 int blk_flush(BlockBackend
*blk
)
712 return bdrv_flush(blk
->bs
);
715 int blk_flush_all(void)
717 return bdrv_flush_all();
720 void blk_drain(BlockBackend
*blk
)
725 void blk_drain_all(void)
730 BlockdevOnError
blk_get_on_error(BlockBackend
*blk
, bool is_read
)
732 return bdrv_get_on_error(blk
->bs
, is_read
);
735 BlockErrorAction
blk_get_error_action(BlockBackend
*blk
, bool is_read
,
738 return bdrv_get_error_action(blk
->bs
, is_read
, error
);
741 void blk_error_action(BlockBackend
*blk
, BlockErrorAction action
,
742 bool is_read
, int error
)
744 bdrv_error_action(blk
->bs
, action
, is_read
, error
);
747 int blk_is_read_only(BlockBackend
*blk
)
749 return bdrv_is_read_only(blk
->bs
);
752 int blk_is_sg(BlockBackend
*blk
)
754 return bdrv_is_sg(blk
->bs
);
757 int blk_enable_write_cache(BlockBackend
*blk
)
759 return bdrv_enable_write_cache(blk
->bs
);
762 void blk_set_enable_write_cache(BlockBackend
*blk
, bool wce
)
764 bdrv_set_enable_write_cache(blk
->bs
, wce
);
767 void blk_invalidate_cache(BlockBackend
*blk
, Error
**errp
)
769 bdrv_invalidate_cache(blk
->bs
, errp
);
772 int blk_is_inserted(BlockBackend
*blk
)
774 return bdrv_is_inserted(blk
->bs
);
777 void blk_lock_medium(BlockBackend
*blk
, bool locked
)
779 bdrv_lock_medium(blk
->bs
, locked
);
782 void blk_eject(BlockBackend
*blk
, bool eject_flag
)
784 bdrv_eject(blk
->bs
, eject_flag
);
787 int blk_get_flags(BlockBackend
*blk
)
789 return bdrv_get_flags(blk
->bs
);
792 int blk_get_max_transfer_length(BlockBackend
*blk
)
794 return blk
->bs
->bl
.max_transfer_length
;
797 void blk_set_guest_block_size(BlockBackend
*blk
, int align
)
799 bdrv_set_guest_block_size(blk
->bs
, align
);
802 void *blk_blockalign(BlockBackend
*blk
, size_t size
)
804 return qemu_blockalign(blk
? blk
->bs
: NULL
, size
);
807 bool blk_op_is_blocked(BlockBackend
*blk
, BlockOpType op
, Error
**errp
)
809 return bdrv_op_is_blocked(blk
->bs
, op
, errp
);
812 void blk_op_unblock(BlockBackend
*blk
, BlockOpType op
, Error
*reason
)
814 bdrv_op_unblock(blk
->bs
, op
, reason
);
817 void blk_op_block_all(BlockBackend
*blk
, Error
*reason
)
819 bdrv_op_block_all(blk
->bs
, reason
);
822 void blk_op_unblock_all(BlockBackend
*blk
, Error
*reason
)
824 bdrv_op_unblock_all(blk
->bs
, reason
);
827 AioContext
*blk_get_aio_context(BlockBackend
*blk
)
829 return bdrv_get_aio_context(blk
->bs
);
832 void blk_set_aio_context(BlockBackend
*blk
, AioContext
*new_context
)
834 bdrv_set_aio_context(blk
->bs
, new_context
);
837 void blk_add_aio_context_notifier(BlockBackend
*blk
,
838 void (*attached_aio_context
)(AioContext
*new_context
, void *opaque
),
839 void (*detach_aio_context
)(void *opaque
), void *opaque
)
841 bdrv_add_aio_context_notifier(blk
->bs
, attached_aio_context
,
842 detach_aio_context
, opaque
);
845 void blk_remove_aio_context_notifier(BlockBackend
*blk
,
846 void (*attached_aio_context
)(AioContext
*,
848 void (*detach_aio_context
)(void *),
851 bdrv_remove_aio_context_notifier(blk
->bs
, attached_aio_context
,
852 detach_aio_context
, opaque
);
855 void blk_add_close_notifier(BlockBackend
*blk
, Notifier
*notify
)
857 bdrv_add_close_notifier(blk
->bs
, notify
);
860 void blk_io_plug(BlockBackend
*blk
)
862 bdrv_io_plug(blk
->bs
);
865 void blk_io_unplug(BlockBackend
*blk
)
867 bdrv_io_unplug(blk
->bs
);
870 BlockAcctStats
*blk_get_stats(BlockBackend
*blk
)
872 return bdrv_get_stats(blk
->bs
);
875 void *blk_aio_get(const AIOCBInfo
*aiocb_info
, BlockBackend
*blk
,
876 BlockCompletionFunc
*cb
, void *opaque
)
878 return qemu_aio_get(aiocb_info
, blk_bs(blk
), cb
, opaque
);
881 int coroutine_fn
blk_co_write_zeroes(BlockBackend
*blk
, int64_t sector_num
,
882 int nb_sectors
, BdrvRequestFlags flags
)
884 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
889 return bdrv_co_write_zeroes(blk
->bs
, sector_num
, nb_sectors
, flags
);
892 int blk_write_compressed(BlockBackend
*blk
, int64_t sector_num
,
893 const uint8_t *buf
, int nb_sectors
)
895 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
900 return bdrv_write_compressed(blk
->bs
, sector_num
, buf
, nb_sectors
);
903 int blk_truncate(BlockBackend
*blk
, int64_t offset
)
905 return bdrv_truncate(blk
->bs
, offset
);
908 int blk_discard(BlockBackend
*blk
, int64_t sector_num
, int nb_sectors
)
910 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
915 return bdrv_discard(blk
->bs
, sector_num
, nb_sectors
);
918 int blk_save_vmstate(BlockBackend
*blk
, const uint8_t *buf
,
919 int64_t pos
, int size
)
921 return bdrv_save_vmstate(blk
->bs
, buf
, pos
, size
);
924 int blk_load_vmstate(BlockBackend
*blk
, uint8_t *buf
, int64_t pos
, int size
)
926 return bdrv_load_vmstate(blk
->bs
, buf
, pos
, size
);
929 int blk_probe_blocksizes(BlockBackend
*blk
, BlockSizes
*bsz
)
931 return bdrv_probe_blocksizes(blk
->bs
, bsz
);
934 int blk_probe_geometry(BlockBackend
*blk
, HDGeometry
*geo
)
936 return bdrv_probe_geometry(blk
->bs
, geo
);