pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 1 | #ifndef BLOCK_H |
| 2 | #define BLOCK_H |
| 3 | |
Paolo Bonzini | 737e150 | 2012-12-17 18:19:44 +0100 | [diff] [blame] | 4 | #include "block/aio.h" |
aliguori | 3b69e4b | 2009-01-22 16:59:24 +0000 | [diff] [blame] | 5 | #include "qemu-common.h" |
Paolo Bonzini | 1de7afc | 2012-12-17 18:20:00 +0100 | [diff] [blame] | 6 | #include "qemu/option.h" |
Paolo Bonzini | 737e150 | 2012-12-17 18:19:44 +0100 | [diff] [blame] | 7 | #include "block/coroutine.h" |
Paolo Bonzini | 7b1b5d1 | 2012-12-17 18:19:43 +0100 | [diff] [blame] | 8 | #include "qapi/qmp/qobject.h" |
Paolo Bonzini | 2f0c9fe | 2012-09-28 17:22:47 +0200 | [diff] [blame] | 9 | #include "qapi-types.h" |
aliguori | a76bab4 | 2008-09-22 19:17:18 +0000 | [diff] [blame] | 10 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 11 | /* block.c */ |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 12 | typedef struct BlockDriver BlockDriver; |
Paolo Bonzini | 2f0c9fe | 2012-09-28 17:22:47 +0200 | [diff] [blame] | 13 | typedef struct BlockJob BlockJob; |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 14 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 15 | typedef struct BlockDriverInfo { |
| 16 | /* in bytes, 0 if irrelevant */ |
| 17 | int cluster_size; |
| 18 | /* offset at which the VM state can be saved (0 if not possible) */ |
| 19 | int64_t vm_state_offset; |
Dong Xu Wang | 64c7916 | 2012-03-15 20:13:33 +0800 | [diff] [blame] | 20 | bool is_dirty; |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 21 | } BlockDriverInfo; |
| 22 | |
Dong Xu Wang | f8111c2 | 2012-03-15 20:13:31 +0800 | [diff] [blame] | 23 | typedef struct BlockFragInfo { |
| 24 | uint64_t allocated_clusters; |
| 25 | uint64_t total_clusters; |
| 26 | uint64_t fragmented_clusters; |
Stefan Hajnoczi | e6439d7 | 2013-02-07 17:15:04 +0100 | [diff] [blame] | 27 | uint64_t compressed_clusters; |
Dong Xu Wang | f8111c2 | 2012-03-15 20:13:31 +0800 | [diff] [blame] | 28 | } BlockFragInfo; |
| 29 | |
Markus Armbruster | 145feb1 | 2011-08-03 15:07:42 +0200 | [diff] [blame] | 30 | /* Callbacks for block device models */ |
Markus Armbruster | 0e49de5 | 2011-08-03 15:07:41 +0200 | [diff] [blame] | 31 | typedef struct BlockDevOps { |
Markus Armbruster | 145feb1 | 2011-08-03 15:07:42 +0200 | [diff] [blame] | 32 | /* |
| 33 | * Runs when virtual media changed (monitor commands eject, change) |
Markus Armbruster | 7d4b4ba | 2011-09-06 18:58:59 +0200 | [diff] [blame] | 34 | * Argument load is true on load and false on eject. |
Markus Armbruster | 145feb1 | 2011-08-03 15:07:42 +0200 | [diff] [blame] | 35 | * Beware: doesn't run when a host device's physical media |
| 36 | * changes. Sure would be useful if it did. |
Markus Armbruster | 2c6942f | 2011-09-06 18:58:51 +0200 | [diff] [blame] | 37 | * Device models with removable media must implement this callback. |
Markus Armbruster | 145feb1 | 2011-08-03 15:07:42 +0200 | [diff] [blame] | 38 | */ |
Markus Armbruster | 7d4b4ba | 2011-09-06 18:58:59 +0200 | [diff] [blame] | 39 | void (*change_media_cb)(void *opaque, bool load); |
Markus Armbruster | 145feb1 | 2011-08-03 15:07:42 +0200 | [diff] [blame] | 40 | /* |
Paolo Bonzini | 025ccaa | 2011-11-07 17:50:13 +0100 | [diff] [blame] | 41 | * Runs when an eject request is issued from the monitor, the tray |
| 42 | * is closed, and the medium is locked. |
| 43 | * Device models that do not implement is_medium_locked will not need |
| 44 | * this callback. Device models that can lock the medium or tray might |
| 45 | * want to implement the callback and unlock the tray when "force" is |
| 46 | * true, even if they do not support eject requests. |
| 47 | */ |
| 48 | void (*eject_request_cb)(void *opaque, bool force); |
| 49 | /* |
Markus Armbruster | e4def80 | 2011-09-06 18:58:53 +0200 | [diff] [blame] | 50 | * Is the virtual tray open? |
| 51 | * Device models implement this only when the device has a tray. |
| 52 | */ |
| 53 | bool (*is_tray_open)(void *opaque); |
| 54 | /* |
Markus Armbruster | f107639 | 2011-09-06 18:58:46 +0200 | [diff] [blame] | 55 | * Is the virtual medium locked into the device? |
| 56 | * Device models implement this only when device has such a lock. |
| 57 | */ |
| 58 | bool (*is_medium_locked)(void *opaque); |
| 59 | /* |
Markus Armbruster | 145feb1 | 2011-08-03 15:07:42 +0200 | [diff] [blame] | 60 | * Runs when the size changed (e.g. monitor command block_resize) |
| 61 | */ |
| 62 | void (*resize_cb)(void *opaque); |
Markus Armbruster | 0e49de5 | 2011-08-03 15:07:41 +0200 | [diff] [blame] | 63 | } BlockDevOps; |
| 64 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 65 | #define BDRV_O_RDWR 0x0002 |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 66 | #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */ |
aliguori | 9f7965c | 2008-10-14 14:42:54 +0000 | [diff] [blame] | 67 | #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */ |
| 68 | #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */ |
Christoph Hellwig | 5c6c3a6 | 2009-08-20 16:58:35 +0200 | [diff] [blame] | 69 | #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */ |
Kevin Wolf | b783e40 | 2010-01-12 12:55:16 +0100 | [diff] [blame] | 70 | #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */ |
Alexander Graf | 016f5cf | 2010-05-26 17:51:49 +0200 | [diff] [blame] | 71 | #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */ |
Stefan Hajnoczi | 53fec9d | 2011-11-28 16:08:47 +0000 | [diff] [blame] | 72 | #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */ |
BenoƮt Canet | ccb1f4a | 2012-03-23 08:36:48 +0100 | [diff] [blame] | 73 | #define BDRV_O_INCOMING 0x0800 /* consistency hint for incoming migration */ |
Stefan Hajnoczi | 058f8f1 | 2012-08-09 13:05:56 +0100 | [diff] [blame] | 74 | #define BDRV_O_CHECK 0x1000 /* open solely for consistency check */ |
Jeff Cody | be028ad | 2012-09-20 15:13:17 -0400 | [diff] [blame] | 75 | #define BDRV_O_ALLOW_RDWR 0x2000 /* allow reopen to change from r/o to r/w */ |
Paolo Bonzini | 9e8f183 | 2013-02-08 14:06:11 +0100 | [diff] [blame] | 76 | #define BDRV_O_UNMAP 0x4000 /* execute guest UNMAP/TRIM operations */ |
aliguori | 9f7965c | 2008-10-14 14:42:54 +0000 | [diff] [blame] | 77 | |
Kevin Wolf | ceb25e5 | 2010-08-31 15:08:03 +0200 | [diff] [blame] | 78 | #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH) |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 79 | |
Jan Kiszka | 6ea4430 | 2009-11-30 18:21:19 +0100 | [diff] [blame] | 80 | #define BDRV_SECTOR_BITS 9 |
Jes Sorensen | c63782c | 2010-05-27 15:46:55 +0200 | [diff] [blame] | 81 | #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS) |
Stefan Hajnoczi | 3abbc4d | 2010-05-01 07:23:32 +0100 | [diff] [blame] | 82 | #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1) |
Jan Kiszka | 6ea4430 | 2009-11-30 18:21:19 +0100 | [diff] [blame] | 83 | |
Luiz Capitulino | 2582bfe | 2010-02-03 12:41:01 -0200 | [diff] [blame] | 84 | typedef enum { |
| 85 | BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP |
Paolo Bonzini | ff06f5f | 2012-09-28 17:22:54 +0200 | [diff] [blame] | 86 | } BlockErrorAction; |
Luiz Capitulino | 2582bfe | 2010-02-03 12:41:01 -0200 | [diff] [blame] | 87 | |
Jeff Cody | e971aa1 | 2012-09-20 15:13:19 -0400 | [diff] [blame] | 88 | typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue; |
| 89 | |
| 90 | typedef struct BDRVReopenState { |
| 91 | BlockDriverState *bs; |
| 92 | int flags; |
| 93 | void *opaque; |
| 94 | } BDRVReopenState; |
| 95 | |
| 96 | |
Luiz Capitulino | 28a7282 | 2011-09-26 17:43:50 -0300 | [diff] [blame] | 97 | void bdrv_iostatus_enable(BlockDriverState *bs); |
| 98 | void bdrv_iostatus_reset(BlockDriverState *bs); |
| 99 | void bdrv_iostatus_disable(BlockDriverState *bs); |
| 100 | bool bdrv_iostatus_is_enabled(const BlockDriverState *bs); |
| 101 | void bdrv_iostatus_set_err(BlockDriverState *bs, int error); |
Luiz Capitulino | d15e546 | 2009-12-10 17:16:06 -0200 | [diff] [blame] | 102 | void bdrv_info_print(Monitor *mon, const QObject *data); |
| 103 | void bdrv_info(Monitor *mon, QObject **ret_data); |
Luiz Capitulino | 218a536 | 2009-12-10 17:16:07 -0200 | [diff] [blame] | 104 | void bdrv_stats_print(Monitor *mon, const QObject *data); |
| 105 | void bdrv_info_stats(Monitor *mon, QObject **ret_data); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 106 | |
Zhi Yong Wu | 0563e19 | 2011-11-03 16:57:25 +0800 | [diff] [blame] | 107 | /* disk I/O throttling */ |
| 108 | void bdrv_io_limits_enable(BlockDriverState *bs); |
Zhi Yong Wu | 98f90db | 2011-11-08 13:00:14 +0800 | [diff] [blame] | 109 | void bdrv_io_limits_disable(BlockDriverState *bs); |
Zhi Yong Wu | 0563e19 | 2011-11-03 16:57:25 +0800 | [diff] [blame] | 110 | bool bdrv_io_limits_enabled(BlockDriverState *bs); |
| 111 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 112 | void bdrv_init(void); |
Markus Armbruster | eb85201 | 2009-10-27 18:41:44 +0100 | [diff] [blame] | 113 | void bdrv_init_with_whitelist(void); |
Kevin Wolf | 9828962 | 2013-07-10 15:47:39 +0200 | [diff] [blame] | 114 | BlockDriver *bdrv_find_protocol(const char *filename, |
| 115 | bool allow_protocol_prefix); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 116 | BlockDriver *bdrv_find_format(const char *format_name); |
Fam Zheng | b64ec4e | 2013-05-29 19:35:40 +0800 | [diff] [blame] | 117 | BlockDriver *bdrv_find_whitelisted_format(const char *format_name, |
| 118 | bool readonly); |
Kevin Wolf | 0e7e198 | 2009-05-18 16:42:10 +0200 | [diff] [blame] | 119 | int bdrv_create(BlockDriver *drv, const char* filename, |
| 120 | QEMUOptionParameter *options); |
Christoph Hellwig | 84a12e6 | 2010-04-07 22:30:24 +0200 | [diff] [blame] | 121 | int bdrv_create_file(const char* filename, QEMUOptionParameter *options); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 122 | BlockDriverState *bdrv_new(const char *device_name); |
Ryan Harper | d22b2f4 | 2011-03-29 20:51:47 -0500 | [diff] [blame] | 123 | void bdrv_make_anon(BlockDriverState *bs); |
Paolo Bonzini | 4ddc07c | 2012-06-14 16:55:02 +0200 | [diff] [blame] | 124 | void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old); |
Jeff Cody | 8802d1f | 2012-02-28 15:54:06 -0500 | [diff] [blame] | 125 | void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 126 | void bdrv_delete(BlockDriverState *bs); |
Stefan Hajnoczi | c3993cd | 2011-08-04 12:26:51 +0100 | [diff] [blame] | 127 | int bdrv_parse_cache_flags(const char *mode, int *flags); |
Paolo Bonzini | 9e8f183 | 2013-02-08 14:06:11 +0100 | [diff] [blame] | 128 | int bdrv_parse_discard_flags(const char *mode, int *flags); |
Kevin Wolf | 787e4a8 | 2013-03-06 11:52:48 +0100 | [diff] [blame] | 129 | int bdrv_file_open(BlockDriverState **pbs, const char *filename, |
| 130 | QDict *options, int flags); |
Kevin Wolf | 31ca6d0 | 2013-03-28 15:29:24 +0100 | [diff] [blame] | 131 | int bdrv_open_backing_file(BlockDriverState *bs, QDict *options); |
Kevin Wolf | de9c0ce | 2013-03-15 10:35:02 +0100 | [diff] [blame] | 132 | int bdrv_open(BlockDriverState *bs, const char *filename, QDict *options, |
| 133 | int flags, BlockDriver *drv); |
Jeff Cody | e971aa1 | 2012-09-20 15:13:19 -0400 | [diff] [blame] | 134 | BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue, |
| 135 | BlockDriverState *bs, int flags); |
| 136 | int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp); |
| 137 | int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp); |
| 138 | int bdrv_reopen_prepare(BDRVReopenState *reopen_state, |
| 139 | BlockReopenQueue *queue, Error **errp); |
| 140 | void bdrv_reopen_commit(BDRVReopenState *reopen_state); |
| 141 | void bdrv_reopen_abort(BDRVReopenState *reopen_state); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 142 | void bdrv_close(BlockDriverState *bs); |
Paolo Bonzini | d7d512f | 2012-08-23 11:20:36 +0200 | [diff] [blame] | 143 | void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify); |
Markus Armbruster | fa879d6 | 2011-08-03 15:07:40 +0200 | [diff] [blame] | 144 | int bdrv_attach_dev(BlockDriverState *bs, void *dev); |
| 145 | void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev); |
| 146 | void bdrv_detach_dev(BlockDriverState *bs, void *dev); |
| 147 | void *bdrv_get_attached_dev(BlockDriverState *bs); |
Markus Armbruster | 0e49de5 | 2011-08-03 15:07:41 +0200 | [diff] [blame] | 148 | void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops, |
| 149 | void *opaque); |
Paolo Bonzini | 025ccaa | 2011-11-07 17:50:13 +0100 | [diff] [blame] | 150 | void bdrv_dev_eject_request(BlockDriverState *bs, bool force); |
Markus Armbruster | 2c6942f | 2011-09-06 18:58:51 +0200 | [diff] [blame] | 151 | bool bdrv_dev_has_removable_media(BlockDriverState *bs); |
Markus Armbruster | e4def80 | 2011-09-06 18:58:53 +0200 | [diff] [blame] | 152 | bool bdrv_dev_is_tray_open(BlockDriverState *bs); |
Markus Armbruster | f107639 | 2011-09-06 18:58:46 +0200 | [diff] [blame] | 153 | bool bdrv_dev_is_medium_locked(BlockDriverState *bs); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 154 | int bdrv_read(BlockDriverState *bs, int64_t sector_num, |
| 155 | uint8_t *buf, int nb_sectors); |
Markus Armbruster | 07d27a4 | 2012-06-29 17:34:29 +0200 | [diff] [blame] | 156 | int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num, |
| 157 | uint8_t *buf, int nb_sectors); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 158 | int bdrv_write(BlockDriverState *bs, int64_t sector_num, |
| 159 | const uint8_t *buf, int nb_sectors); |
Peter Lieven | 4105eaa | 2013-07-11 14:16:22 +0200 | [diff] [blame] | 160 | int bdrv_write_zeroes(BlockDriverState *bs, int64_t sector_num, |
| 161 | int nb_sectors); |
Kevin Wolf | 8d3b1a2 | 2013-04-05 21:27:55 +0200 | [diff] [blame] | 162 | int bdrv_writev(BlockDriverState *bs, int64_t sector_num, QEMUIOVector *qiov); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 163 | int bdrv_pread(BlockDriverState *bs, int64_t offset, |
| 164 | void *buf, int count); |
| 165 | int bdrv_pwrite(BlockDriverState *bs, int64_t offset, |
| 166 | const void *buf, int count); |
Kevin Wolf | 8d3b1a2 | 2013-04-05 21:27:55 +0200 | [diff] [blame] | 167 | int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov); |
Kevin Wolf | f08145f | 2010-06-16 16:38:15 +0200 | [diff] [blame] | 168 | int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset, |
| 169 | const void *buf, int count); |
Kevin Wolf | da1fa91 | 2011-07-14 17:27:13 +0200 | [diff] [blame] | 170 | int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num, |
| 171 | int nb_sectors, QEMUIOVector *qiov); |
Stefan Hajnoczi | 470c050 | 2012-01-18 14:40:42 +0000 | [diff] [blame] | 172 | int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs, |
| 173 | int64_t sector_num, int nb_sectors, QEMUIOVector *qiov); |
Kevin Wolf | da1fa91 | 2011-07-14 17:27:13 +0200 | [diff] [blame] | 174 | int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num, |
| 175 | int nb_sectors, QEMUIOVector *qiov); |
Stefan Hajnoczi | f08f2dd | 2012-02-07 13:27:25 +0000 | [diff] [blame] | 176 | /* |
| 177 | * Efficiently zero a region of the disk image. Note that this is a regular |
| 178 | * I/O request like read or write and should have a reasonable size. This |
| 179 | * function is not suitable for zeroing the entire image in a single request |
| 180 | * because it may allocate memory for the entire region. |
| 181 | */ |
| 182 | int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num, |
| 183 | int nb_sectors); |
Stefan Hajnoczi | 060f51c | 2011-11-14 12:44:26 +0000 | [diff] [blame] | 184 | int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num, |
| 185 | int nb_sectors, int *pnum); |
Paolo Bonzini | 188a7bb | 2012-05-08 16:52:01 +0200 | [diff] [blame] | 186 | int coroutine_fn bdrv_co_is_allocated_above(BlockDriverState *top, |
| 187 | BlockDriverState *base, |
| 188 | int64_t sector_num, |
| 189 | int nb_sectors, int *pnum); |
Marcelo Tosatti | e8a6bb9 | 2012-01-18 14:40:51 +0000 | [diff] [blame] | 190 | BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, |
| 191 | const char *backing_file); |
BenoƮt Canet | f198fd1 | 2012-08-02 10:22:47 +0200 | [diff] [blame] | 192 | int bdrv_get_backing_file_depth(BlockDriverState *bs); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 193 | int bdrv_truncate(BlockDriverState *bs, int64_t offset); |
| 194 | int64_t bdrv_getlength(BlockDriverState *bs); |
Fam Zheng | 4a1d5e1 | 2011-07-12 19:56:39 +0800 | [diff] [blame] | 195 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs); |
ths | 96b8f13 | 2007-12-17 01:35:20 +0000 | [diff] [blame] | 196 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 197 | int bdrv_commit(BlockDriverState *bs); |
Stefan Hajnoczi | e887749 | 2012-03-05 18:10:11 +0000 | [diff] [blame] | 198 | int bdrv_commit_all(void); |
Kevin Wolf | 756e673 | 2010-01-12 12:55:17 +0100 | [diff] [blame] | 199 | int bdrv_change_backing_file(BlockDriverState *bs, |
| 200 | const char *backing_file, const char *backing_fmt); |
Anthony Liguori | 5efa9d5 | 2009-05-09 17:03:42 -0500 | [diff] [blame] | 201 | void bdrv_register(BlockDriver *bdrv); |
Jeff Cody | 6ebdcee | 2012-09-27 13:29:12 -0400 | [diff] [blame] | 202 | int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top, |
| 203 | BlockDriverState *base); |
| 204 | BlockDriverState *bdrv_find_overlay(BlockDriverState *active, |
| 205 | BlockDriverState *bs); |
Jeff Cody | 79fac56 | 2012-09-27 13:29:15 -0400 | [diff] [blame] | 206 | BlockDriverState *bdrv_find_base(BlockDriverState *bs); |
Anthony Liguori | 5efa9d5 | 2009-05-09 17:03:42 -0500 | [diff] [blame] | 207 | |
Kevin Wolf | e076f33 | 2010-06-29 11:43:13 +0200 | [diff] [blame] | 208 | |
| 209 | typedef struct BdrvCheckResult { |
| 210 | int corruptions; |
| 211 | int leaks; |
| 212 | int check_errors; |
Kevin Wolf | ccf3471 | 2012-05-11 18:16:54 +0200 | [diff] [blame] | 213 | int corruptions_fixed; |
| 214 | int leaks_fixed; |
Federico Simoncelli | c6bb9ad | 2013-01-28 06:59:46 -0500 | [diff] [blame] | 215 | int64_t image_end_offset; |
Dong Xu Wang | f8111c2 | 2012-03-15 20:13:31 +0800 | [diff] [blame] | 216 | BlockFragInfo bfi; |
Kevin Wolf | e076f33 | 2010-06-29 11:43:13 +0200 | [diff] [blame] | 217 | } BdrvCheckResult; |
| 218 | |
Kevin Wolf | 4534ff5 | 2012-05-11 16:07:02 +0200 | [diff] [blame] | 219 | typedef enum { |
| 220 | BDRV_FIX_LEAKS = 1, |
| 221 | BDRV_FIX_ERRORS = 2, |
| 222 | } BdrvCheckMode; |
| 223 | |
| 224 | int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix); |
Kevin Wolf | e076f33 | 2010-06-29 11:43:13 +0200 | [diff] [blame] | 225 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 226 | /* async block I/O */ |
lirans@il.ibm.com | 7cd1e32 | 2009-11-02 15:40:41 +0200 | [diff] [blame] | 227 | typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector, |
Devin Nakamura | 39aa9a1 | 2011-06-09 01:06:43 -0400 | [diff] [blame] | 228 | int sector_num); |
aliguori | 3b69e4b | 2009-01-22 16:59:24 +0000 | [diff] [blame] | 229 | BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num, |
| 230 | QEMUIOVector *iov, int nb_sectors, |
| 231 | BlockDriverCompletionFunc *cb, void *opaque); |
| 232 | BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num, |
| 233 | QEMUIOVector *iov, int nb_sectors, |
| 234 | BlockDriverCompletionFunc *cb, void *opaque); |
Christoph Hellwig | b2e12bc | 2009-09-04 19:01:49 +0200 | [diff] [blame] | 235 | BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs, |
Devin Nakamura | 39aa9a1 | 2011-06-09 01:06:43 -0400 | [diff] [blame] | 236 | BlockDriverCompletionFunc *cb, void *opaque); |
Paolo Bonzini | 4265d62 | 2011-10-17 12:32:14 +0200 | [diff] [blame] | 237 | BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs, |
| 238 | int64_t sector_num, int nb_sectors, |
| 239 | BlockDriverCompletionFunc *cb, void *opaque); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 240 | void bdrv_aio_cancel(BlockDriverAIOCB *acb); |
| 241 | |
Kevin Wolf | 40b4f53 | 2009-09-09 17:53:37 +0200 | [diff] [blame] | 242 | typedef struct BlockRequest { |
| 243 | /* Fields to be filled by multiwrite caller */ |
| 244 | int64_t sector; |
| 245 | int nb_sectors; |
| 246 | QEMUIOVector *qiov; |
| 247 | BlockDriverCompletionFunc *cb; |
| 248 | void *opaque; |
| 249 | |
| 250 | /* Filled by multiwrite implementation */ |
| 251 | int error; |
| 252 | } BlockRequest; |
| 253 | |
| 254 | int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, |
| 255 | int num_reqs); |
| 256 | |
aliguori | 7d78066 | 2009-03-12 19:57:08 +0000 | [diff] [blame] | 257 | /* sg packet commands */ |
aliguori | 221f715 | 2009-03-28 17:28:41 +0000 | [diff] [blame] | 258 | int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf); |
| 259 | BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs, |
| 260 | unsigned long int req, void *buf, |
| 261 | BlockDriverCompletionFunc *cb, void *opaque); |
aliguori | 7d78066 | 2009-03-12 19:57:08 +0000 | [diff] [blame] | 262 | |
Anthony Liguori | 0f15423 | 2011-11-14 15:09:45 -0600 | [diff] [blame] | 263 | /* Invalidate any cached metadata used by image formats */ |
| 264 | void bdrv_invalidate_cache(BlockDriverState *bs); |
| 265 | void bdrv_invalidate_cache_all(void); |
| 266 | |
BenoƮt Canet | 0778926 | 2012-03-23 08:36:49 +0100 | [diff] [blame] | 267 | void bdrv_clear_incoming_migration_all(void); |
| 268 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 269 | /* Ensure contents are flushed to disk. */ |
Kevin Wolf | 205ef79 | 2010-10-21 16:43:43 +0200 | [diff] [blame] | 270 | int bdrv_flush(BlockDriverState *bs); |
Paolo Bonzini | 07f0761 | 2011-10-17 12:32:12 +0200 | [diff] [blame] | 271 | int coroutine_fn bdrv_co_flush(BlockDriverState *bs); |
Kevin Wolf | f0f0fdf | 2013-07-05 13:48:01 +0200 | [diff] [blame] | 272 | int bdrv_flush_all(void); |
MORITA Kazutaka | 2bc93fe | 2010-05-28 11:44:57 +0900 | [diff] [blame] | 273 | void bdrv_close_all(void); |
Stefan Hajnoczi | 922453b | 2011-11-30 12:23:43 +0000 | [diff] [blame] | 274 | void bdrv_drain_all(void); |
aliguori | c6ca28d | 2008-10-06 13:55:43 +0000 | [diff] [blame] | 275 | |
Christoph Hellwig | bb8bf76 | 2010-12-16 19:36:31 +0100 | [diff] [blame] | 276 | int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors); |
Paolo Bonzini | 4265d62 | 2011-10-17 12:32:14 +0200 | [diff] [blame] | 277 | int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors); |
Peter Lieven | 3ac2162 | 2013-06-28 12:47:42 +0200 | [diff] [blame] | 278 | int bdrv_has_zero_init_1(BlockDriverState *bs); |
Kevin Wolf | f2feebb | 2010-04-14 17:30:35 +0200 | [diff] [blame] | 279 | int bdrv_has_zero_init(BlockDriverState *bs); |
ths | f58c7b3 | 2008-06-05 21:53:49 +0000 | [diff] [blame] | 280 | int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors, |
Devin Nakamura | 39aa9a1 | 2011-06-09 01:06:43 -0400 | [diff] [blame] | 281 | int *pnum); |
Miroslav Rezanina | b35b2bb | 2013-02-13 09:09:39 +0100 | [diff] [blame] | 282 | int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base, |
| 283 | int64_t sector_num, int nb_sectors, int *pnum); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 284 | |
Paolo Bonzini | ff06f5f | 2012-09-28 17:22:54 +0200 | [diff] [blame] | 285 | void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error, |
| 286 | BlockdevOnError on_write_error); |
Paolo Bonzini | 1ceee0d | 2012-09-28 17:22:56 +0200 | [diff] [blame] | 287 | BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read); |
Paolo Bonzini | 3e1caa5 | 2012-09-28 17:22:57 +0200 | [diff] [blame] | 288 | BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error); |
| 289 | void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action, |
| 290 | bool is_read, int error); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 291 | int bdrv_is_read_only(BlockDriverState *bs); |
ths | 985a03b | 2007-12-24 16:10:43 +0000 | [diff] [blame] | 292 | int bdrv_is_sg(BlockDriverState *bs); |
Christoph Hellwig | e900a7b | 2009-09-04 19:01:15 +0200 | [diff] [blame] | 293 | int bdrv_enable_write_cache(BlockDriverState *bs); |
Paolo Bonzini | 425b014 | 2012-06-06 00:04:52 +0200 | [diff] [blame] | 294 | void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 295 | int bdrv_is_inserted(BlockDriverState *bs); |
| 296 | int bdrv_media_changed(BlockDriverState *bs); |
Markus Armbruster | 025e849 | 2011-09-06 18:58:47 +0200 | [diff] [blame] | 297 | void bdrv_lock_medium(BlockDriverState *bs, bool locked); |
Luiz Capitulino | f36f394 | 2012-02-03 16:24:53 -0200 | [diff] [blame] | 298 | void bdrv_eject(BlockDriverState *bs, bool eject_flag); |
Markus Armbruster | f8d6bba | 2012-06-13 10:11:48 +0200 | [diff] [blame] | 299 | const char *bdrv_get_format_name(BlockDriverState *bs); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 300 | BlockDriverState *bdrv_find(const char *name); |
Markus Armbruster | 2f399b0 | 2010-06-02 18:55:20 +0200 | [diff] [blame] | 301 | BlockDriverState *bdrv_next(BlockDriverState *bs); |
aliguori | 51de976 | 2009-03-05 23:00:43 +0000 | [diff] [blame] | 302 | void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), |
| 303 | void *opaque); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 304 | int bdrv_is_encrypted(BlockDriverState *bs); |
aliguori | c0f4ce7 | 2009-03-05 23:01:01 +0000 | [diff] [blame] | 305 | int bdrv_key_required(BlockDriverState *bs); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 306 | int bdrv_set_key(BlockDriverState *bs, const char *key); |
aliguori | c0f4ce7 | 2009-03-05 23:01:01 +0000 | [diff] [blame] | 307 | int bdrv_query_missing_keys(void); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 308 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
| 309 | void *opaque); |
| 310 | const char *bdrv_get_device_name(BlockDriverState *bs); |
Markus Armbruster | c843328 | 2012-06-05 16:49:24 +0200 | [diff] [blame] | 311 | int bdrv_get_flags(BlockDriverState *bs); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 312 | int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num, |
| 313 | const uint8_t *buf, int nb_sectors); |
| 314 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi); |
Paolo Bonzini | 343bded | 2013-01-21 17:09:42 +0100 | [diff] [blame] | 315 | void bdrv_round_to_clusters(BlockDriverState *bs, |
| 316 | int64_t sector_num, int nb_sectors, |
| 317 | int64_t *cluster_sector_num, |
| 318 | int *cluster_nb_sectors); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 319 | |
aliguori | 045df33 | 2009-03-05 23:00:48 +0000 | [diff] [blame] | 320 | const char *bdrv_get_encrypted_filename(BlockDriverState *bs); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 321 | void bdrv_get_backing_filename(BlockDriverState *bs, |
| 322 | char *filename, int filename_size); |
Paolo Bonzini | dc5a137 | 2012-05-08 16:51:50 +0200 | [diff] [blame] | 323 | void bdrv_get_full_backing_filename(BlockDriverState *bs, |
| 324 | char *dest, size_t sz); |
Blue Swirl | 199630b | 2010-07-25 20:49:34 +0000 | [diff] [blame] | 325 | int bdrv_is_snapshot(BlockDriverState *bs); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 326 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 327 | int path_is_absolute(const char *path); |
| 328 | void path_combine(char *dest, int dest_size, |
| 329 | const char *base_path, |
| 330 | const char *filename); |
| 331 | |
Kevin Wolf | cf8074b | 2013-04-05 21:27:53 +0200 | [diff] [blame] | 332 | int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos); |
Christoph Hellwig | 45566e9 | 2009-07-10 23:11:57 +0200 | [diff] [blame] | 333 | int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf, |
| 334 | int64_t pos, int size); |
aliguori | 178e08a | 2009-04-05 19:10:55 +0000 | [diff] [blame] | 335 | |
Christoph Hellwig | 45566e9 | 2009-07-10 23:11:57 +0200 | [diff] [blame] | 336 | int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf, |
| 337 | int64_t pos, int size); |
aliguori | 178e08a | 2009-04-05 19:10:55 +0000 | [diff] [blame] | 338 | |
Luiz Capitulino | d92ada2 | 2012-11-30 10:52:09 -0200 | [diff] [blame] | 339 | void bdrv_img_create(const char *filename, const char *fmt, |
| 340 | const char *base_filename, const char *base_fmt, |
Miroslav Rezanina | f382d43 | 2013-02-13 09:09:40 +0100 | [diff] [blame] | 341 | char *options, uint64_t img_size, int flags, |
| 342 | Error **errp, bool quiet); |
Jes Sorensen | f88e1a4 | 2010-12-16 13:52:15 +0100 | [diff] [blame] | 343 | |
Markus Armbruster | 7b6f930 | 2011-09-06 18:58:56 +0200 | [diff] [blame] | 344 | void bdrv_set_buffer_alignment(BlockDriverState *bs, int align); |
Markus Armbruster | ba5b7ad | 2011-08-03 15:08:19 +0200 | [diff] [blame] | 345 | void *qemu_blockalign(BlockDriverState *bs, size_t size); |
Stefan Hajnoczi | c53b1c5 | 2013-01-11 16:41:27 +0100 | [diff] [blame] | 346 | bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov); |
Markus Armbruster | ba5b7ad | 2011-08-03 15:08:19 +0200 | [diff] [blame] | 347 | |
Paolo Bonzini | 8f0720e | 2013-01-21 17:09:41 +0100 | [diff] [blame] | 348 | struct HBitmapIter; |
Paolo Bonzini | 50717e9 | 2013-01-21 17:09:45 +0100 | [diff] [blame] | 349 | void bdrv_set_dirty_tracking(BlockDriverState *bs, int granularity); |
lirans@il.ibm.com | 7cd1e32 | 2009-11-02 15:40:41 +0200 | [diff] [blame] | 350 | int bdrv_get_dirty(BlockDriverState *bs, int64_t sector); |
Paolo Bonzini | 1755da1 | 2012-10-18 16:49:18 +0200 | [diff] [blame] | 351 | void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors); |
| 352 | void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors); |
Paolo Bonzini | 8f0720e | 2013-01-21 17:09:41 +0100 | [diff] [blame] | 353 | void bdrv_dirty_iter_init(BlockDriverState *bs, struct HBitmapIter *hbi); |
Liran Schour | aaa0eb7 | 2010-01-26 10:31:48 +0200 | [diff] [blame] | 354 | int64_t bdrv_get_dirty_count(BlockDriverState *bs); |
Kevin Wolf | 8b9b0cc | 2010-03-15 17:27:00 +0100 | [diff] [blame] | 355 | |
Stefan Hajnoczi | 53fec9d | 2011-11-28 16:08:47 +0000 | [diff] [blame] | 356 | void bdrv_enable_copy_on_read(BlockDriverState *bs); |
| 357 | void bdrv_disable_copy_on_read(BlockDriverState *bs); |
| 358 | |
Marcelo Tosatti | db593f2 | 2011-01-26 12:12:34 -0200 | [diff] [blame] | 359 | void bdrv_set_in_use(BlockDriverState *bs, int in_use); |
| 360 | int bdrv_in_use(BlockDriverState *bs); |
Kevin Wolf | 8b9b0cc | 2010-03-15 17:27:00 +0100 | [diff] [blame] | 361 | |
Stefan Hajnoczi | 4065742 | 2012-11-14 11:43:23 +0100 | [diff] [blame] | 362 | #ifdef CONFIG_LINUX_AIO |
| 363 | int raw_get_aio_fd(BlockDriverState *bs); |
| 364 | #else |
| 365 | static inline int raw_get_aio_fd(BlockDriverState *bs) |
| 366 | { |
| 367 | return -ENOTSUP; |
| 368 | } |
| 369 | #endif |
| 370 | |
Christoph Hellwig | a597e79 | 2011-08-25 08:26:01 +0200 | [diff] [blame] | 371 | enum BlockAcctType { |
| 372 | BDRV_ACCT_READ, |
| 373 | BDRV_ACCT_WRITE, |
| 374 | BDRV_ACCT_FLUSH, |
| 375 | BDRV_MAX_IOTYPE, |
| 376 | }; |
| 377 | |
| 378 | typedef struct BlockAcctCookie { |
| 379 | int64_t bytes; |
Christoph Hellwig | c488c7f | 2011-08-25 08:26:10 +0200 | [diff] [blame] | 380 | int64_t start_time_ns; |
Christoph Hellwig | a597e79 | 2011-08-25 08:26:01 +0200 | [diff] [blame] | 381 | enum BlockAcctType type; |
| 382 | } BlockAcctCookie; |
| 383 | |
| 384 | void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie, |
| 385 | int64_t bytes, enum BlockAcctType type); |
| 386 | void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie); |
| 387 | |
Kevin Wolf | 8b9b0cc | 2010-03-15 17:27:00 +0100 | [diff] [blame] | 388 | typedef enum { |
Kevin Wolf | 8252278 | 2010-03-15 17:38:05 +0100 | [diff] [blame] | 389 | BLKDBG_L1_UPDATE, |
| 390 | |
| 391 | BLKDBG_L1_GROW_ALLOC_TABLE, |
| 392 | BLKDBG_L1_GROW_WRITE_TABLE, |
| 393 | BLKDBG_L1_GROW_ACTIVATE_TABLE, |
| 394 | |
| 395 | BLKDBG_L2_LOAD, |
| 396 | BLKDBG_L2_UPDATE, |
| 397 | BLKDBG_L2_UPDATE_COMPRESSED, |
| 398 | BLKDBG_L2_ALLOC_COW_READ, |
| 399 | BLKDBG_L2_ALLOC_WRITE, |
| 400 | |
Kevin Wolf | 8252278 | 2010-03-15 17:38:05 +0100 | [diff] [blame] | 401 | BLKDBG_READ_AIO, |
Kevin Wolf | 8252278 | 2010-03-15 17:38:05 +0100 | [diff] [blame] | 402 | BLKDBG_READ_BACKING_AIO, |
| 403 | BLKDBG_READ_COMPRESSED, |
| 404 | |
| 405 | BLKDBG_WRITE_AIO, |
| 406 | BLKDBG_WRITE_COMPRESSED, |
| 407 | |
| 408 | BLKDBG_VMSTATE_LOAD, |
| 409 | BLKDBG_VMSTATE_SAVE, |
| 410 | |
| 411 | BLKDBG_COW_READ, |
| 412 | BLKDBG_COW_WRITE, |
| 413 | |
| 414 | BLKDBG_REFTABLE_LOAD, |
| 415 | BLKDBG_REFTABLE_GROW, |
| 416 | |
| 417 | BLKDBG_REFBLOCK_LOAD, |
| 418 | BLKDBG_REFBLOCK_UPDATE, |
| 419 | BLKDBG_REFBLOCK_UPDATE_PART, |
| 420 | BLKDBG_REFBLOCK_ALLOC, |
| 421 | BLKDBG_REFBLOCK_ALLOC_HOOKUP, |
| 422 | BLKDBG_REFBLOCK_ALLOC_WRITE, |
| 423 | BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS, |
| 424 | BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE, |
| 425 | BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE, |
| 426 | |
| 427 | BLKDBG_CLUSTER_ALLOC, |
| 428 | BLKDBG_CLUSTER_ALLOC_BYTES, |
| 429 | BLKDBG_CLUSTER_FREE, |
| 430 | |
Kevin Wolf | bf736fe | 2013-06-05 15:17:55 +0200 | [diff] [blame] | 431 | BLKDBG_FLUSH_TO_OS, |
| 432 | BLKDBG_FLUSH_TO_DISK, |
| 433 | |
Kevin Wolf | 8b9b0cc | 2010-03-15 17:27:00 +0100 | [diff] [blame] | 434 | BLKDBG_EVENT_MAX, |
| 435 | } BlkDebugEvent; |
| 436 | |
| 437 | #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt) |
| 438 | void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event); |
| 439 | |
Kevin Wolf | 41c695c | 2012-12-06 14:32:58 +0100 | [diff] [blame] | 440 | int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event, |
| 441 | const char *tag); |
| 442 | int bdrv_debug_resume(BlockDriverState *bs, const char *tag); |
| 443 | bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag); |
| 444 | |
Markus Armbruster | 8a4bc5a | 2012-07-10 11:12:40 +0200 | [diff] [blame] | 445 | #endif |