pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 1 | #ifndef BLOCK_H |
| 2 | #define BLOCK_H |
| 3 | |
aliguori | a76bab4 | 2008-09-22 19:17:18 +0000 | [diff] [blame] | 4 | #include "qemu-aio.h" |
aliguori | 3b69e4b | 2009-01-22 16:59:24 +0000 | [diff] [blame] | 5 | #include "qemu-common.h" |
Kevin Wolf | 0e7e198 | 2009-05-18 16:42:10 +0200 | [diff] [blame] | 6 | #include "qemu-option.h" |
Kevin Wolf | da1fa91 | 2011-07-14 17:27:13 +0200 | [diff] [blame] | 7 | #include "qemu-coroutine.h" |
Luiz Capitulino | d15e546 | 2009-12-10 17:16:06 -0200 | [diff] [blame] | 8 | #include "qobject.h" |
aliguori | a76bab4 | 2008-09-22 19:17:18 +0000 | [diff] [blame] | 9 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 10 | /* block.c */ |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 11 | typedef struct BlockDriver BlockDriver; |
| 12 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 13 | typedef struct BlockDriverInfo { |
| 14 | /* in bytes, 0 if irrelevant */ |
| 15 | int cluster_size; |
| 16 | /* offset at which the VM state can be saved (0 if not possible) */ |
| 17 | int64_t vm_state_offset; |
Dong Xu Wang | 64c7916 | 2012-03-15 20:13:33 +0800 | [diff] [blame] | 18 | bool is_dirty; |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 19 | } BlockDriverInfo; |
| 20 | |
Dong Xu Wang | f8111c2 | 2012-03-15 20:13:31 +0800 | [diff] [blame] | 21 | typedef struct BlockFragInfo { |
| 22 | uint64_t allocated_clusters; |
| 23 | uint64_t total_clusters; |
| 24 | uint64_t fragmented_clusters; |
| 25 | } BlockFragInfo; |
| 26 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 27 | typedef struct QEMUSnapshotInfo { |
| 28 | char id_str[128]; /* unique snapshot id */ |
| 29 | /* the following fields are informative. They are not needed for |
| 30 | the consistency of the snapshot */ |
Stefan Weil | e7d8100 | 2011-12-10 00:19:46 +0100 | [diff] [blame] | 31 | char name[256]; /* user chosen name */ |
Kevin Wolf | c2c9a46 | 2011-11-16 11:35:54 +0100 | [diff] [blame] | 32 | uint64_t vm_state_size; /* VM state info size */ |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 33 | uint32_t date_sec; /* UTC date of the snapshot */ |
| 34 | uint32_t date_nsec; |
| 35 | uint64_t vm_clock_nsec; /* VM clock relative to boot */ |
| 36 | } QEMUSnapshotInfo; |
| 37 | |
Markus Armbruster | 145feb1 | 2011-08-03 15:07:42 +0200 | [diff] [blame] | 38 | /* Callbacks for block device models */ |
Markus Armbruster | 0e49de5 | 2011-08-03 15:07:41 +0200 | [diff] [blame] | 39 | typedef struct BlockDevOps { |
Markus Armbruster | 145feb1 | 2011-08-03 15:07:42 +0200 | [diff] [blame] | 40 | /* |
| 41 | * Runs when virtual media changed (monitor commands eject, change) |
Markus Armbruster | 7d4b4ba | 2011-09-06 18:58:59 +0200 | [diff] [blame] | 42 | * Argument load is true on load and false on eject. |
Markus Armbruster | 145feb1 | 2011-08-03 15:07:42 +0200 | [diff] [blame] | 43 | * Beware: doesn't run when a host device's physical media |
| 44 | * changes. Sure would be useful if it did. |
Markus Armbruster | 2c6942f | 2011-09-06 18:58:51 +0200 | [diff] [blame] | 45 | * Device models with removable media must implement this callback. |
Markus Armbruster | 145feb1 | 2011-08-03 15:07:42 +0200 | [diff] [blame] | 46 | */ |
Markus Armbruster | 7d4b4ba | 2011-09-06 18:58:59 +0200 | [diff] [blame] | 47 | void (*change_media_cb)(void *opaque, bool load); |
Markus Armbruster | 145feb1 | 2011-08-03 15:07:42 +0200 | [diff] [blame] | 48 | /* |
Paolo Bonzini | 025ccaa | 2011-11-07 17:50:13 +0100 | [diff] [blame] | 49 | * Runs when an eject request is issued from the monitor, the tray |
| 50 | * is closed, and the medium is locked. |
| 51 | * Device models that do not implement is_medium_locked will not need |
| 52 | * this callback. Device models that can lock the medium or tray might |
| 53 | * want to implement the callback and unlock the tray when "force" is |
| 54 | * true, even if they do not support eject requests. |
| 55 | */ |
| 56 | void (*eject_request_cb)(void *opaque, bool force); |
| 57 | /* |
Markus Armbruster | e4def80 | 2011-09-06 18:58:53 +0200 | [diff] [blame] | 58 | * Is the virtual tray open? |
| 59 | * Device models implement this only when the device has a tray. |
| 60 | */ |
| 61 | bool (*is_tray_open)(void *opaque); |
| 62 | /* |
Markus Armbruster | f107639 | 2011-09-06 18:58:46 +0200 | [diff] [blame] | 63 | * Is the virtual medium locked into the device? |
| 64 | * Device models implement this only when device has such a lock. |
| 65 | */ |
| 66 | bool (*is_medium_locked)(void *opaque); |
| 67 | /* |
Markus Armbruster | 145feb1 | 2011-08-03 15:07:42 +0200 | [diff] [blame] | 68 | * Runs when the size changed (e.g. monitor command block_resize) |
| 69 | */ |
| 70 | void (*resize_cb)(void *opaque); |
Markus Armbruster | 0e49de5 | 2011-08-03 15:07:41 +0200 | [diff] [blame] | 71 | } BlockDevOps; |
| 72 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 73 | #define BDRV_O_RDWR 0x0002 |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 74 | #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] | 75 | #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */ |
| 76 | #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */ |
Christoph Hellwig | 5c6c3a6 | 2009-08-20 16:58:35 +0200 | [diff] [blame] | 77 | #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] | 78 | #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */ |
Alexander Graf | 016f5cf | 2010-05-26 17:51:49 +0200 | [diff] [blame] | 79 | #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */ |
Stefan Hajnoczi | 53fec9d | 2011-11-28 16:08:47 +0000 | [diff] [blame] | 80 | #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] | 81 | #define BDRV_O_INCOMING 0x0800 /* consistency hint for incoming migration */ |
aliguori | 9f7965c | 2008-10-14 14:42:54 +0000 | [diff] [blame] | 82 | |
Kevin Wolf | ceb25e5 | 2010-08-31 15:08:03 +0200 | [diff] [blame] | 83 | #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] | 84 | |
Jan Kiszka | 6ea4430 | 2009-11-30 18:21:19 +0100 | [diff] [blame] | 85 | #define BDRV_SECTOR_BITS 9 |
Jes Sorensen | c63782c | 2010-05-27 15:46:55 +0200 | [diff] [blame] | 86 | #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS) |
Stefan Hajnoczi | 3abbc4d | 2010-05-01 07:23:32 +0100 | [diff] [blame] | 87 | #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1) |
Jan Kiszka | 6ea4430 | 2009-11-30 18:21:19 +0100 | [diff] [blame] | 88 | |
Luiz Capitulino | 2582bfe | 2010-02-03 12:41:01 -0200 | [diff] [blame] | 89 | typedef enum { |
Markus Armbruster | abd7f68 | 2010-06-02 18:55:17 +0200 | [diff] [blame] | 90 | BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC, |
| 91 | BLOCK_ERR_STOP_ANY |
| 92 | } BlockErrorAction; |
| 93 | |
| 94 | typedef enum { |
Luiz Capitulino | 2582bfe | 2010-02-03 12:41:01 -0200 | [diff] [blame] | 95 | BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP |
Luiz Capitulino | 329c0a4 | 2012-01-25 16:59:43 -0200 | [diff] [blame] | 96 | } BlockQMPEventAction; |
Luiz Capitulino | 2582bfe | 2010-02-03 12:41:01 -0200 | [diff] [blame] | 97 | |
Luiz Capitulino | 28a7282 | 2011-09-26 17:43:50 -0300 | [diff] [blame] | 98 | void bdrv_iostatus_enable(BlockDriverState *bs); |
| 99 | void bdrv_iostatus_reset(BlockDriverState *bs); |
| 100 | void bdrv_iostatus_disable(BlockDriverState *bs); |
| 101 | bool bdrv_iostatus_is_enabled(const BlockDriverState *bs); |
| 102 | void bdrv_iostatus_set_err(BlockDriverState *bs, int error); |
Luiz Capitulino | 329c0a4 | 2012-01-25 16:59:43 -0200 | [diff] [blame] | 103 | void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv, |
| 104 | BlockQMPEventAction action, int is_read); |
Luiz Capitulino | d15e546 | 2009-12-10 17:16:06 -0200 | [diff] [blame] | 105 | void bdrv_info_print(Monitor *mon, const QObject *data); |
| 106 | void bdrv_info(Monitor *mon, QObject **ret_data); |
Luiz Capitulino | 218a536 | 2009-12-10 17:16:07 -0200 | [diff] [blame] | 107 | void bdrv_stats_print(Monitor *mon, const QObject *data); |
| 108 | void bdrv_info_stats(Monitor *mon, QObject **ret_data); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 109 | |
Zhi Yong Wu | 0563e19 | 2011-11-03 16:57:25 +0800 | [diff] [blame] | 110 | /* disk I/O throttling */ |
| 111 | void bdrv_io_limits_enable(BlockDriverState *bs); |
Zhi Yong Wu | 98f90db | 2011-11-08 13:00:14 +0800 | [diff] [blame] | 112 | void bdrv_io_limits_disable(BlockDriverState *bs); |
Zhi Yong Wu | 0563e19 | 2011-11-03 16:57:25 +0800 | [diff] [blame] | 113 | bool bdrv_io_limits_enabled(BlockDriverState *bs); |
| 114 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 115 | void bdrv_init(void); |
Markus Armbruster | eb85201 | 2009-10-27 18:41:44 +0100 | [diff] [blame] | 116 | void bdrv_init_with_whitelist(void); |
MORITA Kazutaka | b50cbab | 2010-05-26 11:35:36 +0900 | [diff] [blame] | 117 | BlockDriver *bdrv_find_protocol(const char *filename); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 118 | BlockDriver *bdrv_find_format(const char *format_name); |
Markus Armbruster | eb85201 | 2009-10-27 18:41:44 +0100 | [diff] [blame] | 119 | BlockDriver *bdrv_find_whitelisted_format(const char *format_name); |
Kevin Wolf | 0e7e198 | 2009-05-18 16:42:10 +0200 | [diff] [blame] | 120 | int bdrv_create(BlockDriver *drv, const char* filename, |
| 121 | QEMUOptionParameter *options); |
Christoph Hellwig | 84a12e6 | 2010-04-07 22:30:24 +0200 | [diff] [blame] | 122 | int bdrv_create_file(const char* filename, QEMUOptionParameter *options); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 123 | BlockDriverState *bdrv_new(const char *device_name); |
Ryan Harper | d22b2f4 | 2011-03-29 20:51:47 -0500 | [diff] [blame] | 124 | void bdrv_make_anon(BlockDriverState *bs); |
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); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 128 | int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags); |
Kevin Wolf | d6e9098 | 2010-03-31 14:40:27 +0200 | [diff] [blame] | 129 | int bdrv_open(BlockDriverState *bs, const char *filename, int flags, |
| 130 | BlockDriver *drv); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 131 | void bdrv_close(BlockDriverState *bs); |
Markus Armbruster | fa879d6 | 2011-08-03 15:07:40 +0200 | [diff] [blame] | 132 | int bdrv_attach_dev(BlockDriverState *bs, void *dev); |
| 133 | void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev); |
| 134 | void bdrv_detach_dev(BlockDriverState *bs, void *dev); |
| 135 | void *bdrv_get_attached_dev(BlockDriverState *bs); |
Markus Armbruster | 0e49de5 | 2011-08-03 15:07:41 +0200 | [diff] [blame] | 136 | void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops, |
| 137 | void *opaque); |
Paolo Bonzini | 025ccaa | 2011-11-07 17:50:13 +0100 | [diff] [blame] | 138 | void bdrv_dev_eject_request(BlockDriverState *bs, bool force); |
Markus Armbruster | 2c6942f | 2011-09-06 18:58:51 +0200 | [diff] [blame] | 139 | bool bdrv_dev_has_removable_media(BlockDriverState *bs); |
Markus Armbruster | e4def80 | 2011-09-06 18:58:53 +0200 | [diff] [blame] | 140 | bool bdrv_dev_is_tray_open(BlockDriverState *bs); |
Markus Armbruster | f107639 | 2011-09-06 18:58:46 +0200 | [diff] [blame] | 141 | bool bdrv_dev_is_medium_locked(BlockDriverState *bs); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 142 | int bdrv_read(BlockDriverState *bs, int64_t sector_num, |
| 143 | uint8_t *buf, int nb_sectors); |
| 144 | int bdrv_write(BlockDriverState *bs, int64_t sector_num, |
| 145 | const uint8_t *buf, int nb_sectors); |
| 146 | int bdrv_pread(BlockDriverState *bs, int64_t offset, |
| 147 | void *buf, int count); |
| 148 | int bdrv_pwrite(BlockDriverState *bs, int64_t offset, |
| 149 | const void *buf, int count); |
Kevin Wolf | f08145f | 2010-06-16 16:38:15 +0200 | [diff] [blame] | 150 | int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset, |
| 151 | const void *buf, int count); |
Kevin Wolf | da1fa91 | 2011-07-14 17:27:13 +0200 | [diff] [blame] | 152 | int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num, |
| 153 | int nb_sectors, QEMUIOVector *qiov); |
Stefan Hajnoczi | 470c050 | 2012-01-18 14:40:42 +0000 | [diff] [blame] | 154 | int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs, |
| 155 | int64_t sector_num, int nb_sectors, QEMUIOVector *qiov); |
Kevin Wolf | da1fa91 | 2011-07-14 17:27:13 +0200 | [diff] [blame] | 156 | int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num, |
| 157 | int nb_sectors, QEMUIOVector *qiov); |
Stefan Hajnoczi | f08f2dd | 2012-02-07 13:27:25 +0000 | [diff] [blame] | 158 | /* |
| 159 | * Efficiently zero a region of the disk image. Note that this is a regular |
| 160 | * I/O request like read or write and should have a reasonable size. This |
| 161 | * function is not suitable for zeroing the entire image in a single request |
| 162 | * because it may allocate memory for the entire region. |
| 163 | */ |
| 164 | int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num, |
| 165 | int nb_sectors); |
Stefan Hajnoczi | 060f51c | 2011-11-14 12:44:26 +0000 | [diff] [blame] | 166 | int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num, |
| 167 | int nb_sectors, int *pnum); |
Paolo Bonzini | 188a7bb | 2012-05-08 16:52:01 +0200 | [diff] [blame] | 168 | int coroutine_fn bdrv_co_is_allocated_above(BlockDriverState *top, |
| 169 | BlockDriverState *base, |
| 170 | int64_t sector_num, |
| 171 | int nb_sectors, int *pnum); |
Marcelo Tosatti | e8a6bb9 | 2012-01-18 14:40:51 +0000 | [diff] [blame] | 172 | BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, |
| 173 | const char *backing_file); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 174 | int bdrv_truncate(BlockDriverState *bs, int64_t offset); |
| 175 | int64_t bdrv_getlength(BlockDriverState *bs); |
Fam Zheng | 4a1d5e1 | 2011-07-12 19:56:39 +0800 | [diff] [blame] | 176 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs); |
ths | 96b8f13 | 2007-12-17 01:35:20 +0000 | [diff] [blame] | 177 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr); |
aliguori | f3d54fc | 2008-11-25 21:50:24 +0000 | [diff] [blame] | 178 | void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 179 | int bdrv_commit(BlockDriverState *bs); |
Stefan Hajnoczi | e887749 | 2012-03-05 18:10:11 +0000 | [diff] [blame] | 180 | int bdrv_commit_all(void); |
Kevin Wolf | 756e673 | 2010-01-12 12:55:17 +0100 | [diff] [blame] | 181 | int bdrv_change_backing_file(BlockDriverState *bs, |
| 182 | const char *backing_file, const char *backing_fmt); |
Anthony Liguori | 5efa9d5 | 2009-05-09 17:03:42 -0500 | [diff] [blame] | 183 | void bdrv_register(BlockDriver *bdrv); |
| 184 | |
Kevin Wolf | e076f33 | 2010-06-29 11:43:13 +0200 | [diff] [blame] | 185 | |
| 186 | typedef struct BdrvCheckResult { |
| 187 | int corruptions; |
| 188 | int leaks; |
| 189 | int check_errors; |
Kevin Wolf | ccf3471 | 2012-05-11 18:16:54 +0200 | [diff] [blame] | 190 | int corruptions_fixed; |
| 191 | int leaks_fixed; |
Dong Xu Wang | f8111c2 | 2012-03-15 20:13:31 +0800 | [diff] [blame] | 192 | BlockFragInfo bfi; |
Kevin Wolf | e076f33 | 2010-06-29 11:43:13 +0200 | [diff] [blame] | 193 | } BdrvCheckResult; |
| 194 | |
Kevin Wolf | 4534ff5 | 2012-05-11 16:07:02 +0200 | [diff] [blame] | 195 | typedef enum { |
| 196 | BDRV_FIX_LEAKS = 1, |
| 197 | BDRV_FIX_ERRORS = 2, |
| 198 | } BdrvCheckMode; |
| 199 | |
| 200 | int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix); |
Kevin Wolf | e076f33 | 2010-06-29 11:43:13 +0200 | [diff] [blame] | 201 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 202 | /* async block I/O */ |
lirans@il.ibm.com | 7cd1e32 | 2009-11-02 15:40:41 +0200 | [diff] [blame] | 203 | typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector, |
Devin Nakamura | 39aa9a1 | 2011-06-09 01:06:43 -0400 | [diff] [blame] | 204 | int sector_num); |
aliguori | 3b69e4b | 2009-01-22 16:59:24 +0000 | [diff] [blame] | 205 | BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num, |
| 206 | QEMUIOVector *iov, int nb_sectors, |
| 207 | BlockDriverCompletionFunc *cb, void *opaque); |
| 208 | BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num, |
| 209 | QEMUIOVector *iov, int nb_sectors, |
| 210 | BlockDriverCompletionFunc *cb, void *opaque); |
Christoph Hellwig | b2e12bc | 2009-09-04 19:01:49 +0200 | [diff] [blame] | 211 | BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs, |
Devin Nakamura | 39aa9a1 | 2011-06-09 01:06:43 -0400 | [diff] [blame] | 212 | BlockDriverCompletionFunc *cb, void *opaque); |
Paolo Bonzini | 4265d62 | 2011-10-17 12:32:14 +0200 | [diff] [blame] | 213 | BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs, |
| 214 | int64_t sector_num, int nb_sectors, |
| 215 | BlockDriverCompletionFunc *cb, void *opaque); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 216 | void bdrv_aio_cancel(BlockDriverAIOCB *acb); |
| 217 | |
Kevin Wolf | 40b4f53 | 2009-09-09 17:53:37 +0200 | [diff] [blame] | 218 | typedef struct BlockRequest { |
| 219 | /* Fields to be filled by multiwrite caller */ |
| 220 | int64_t sector; |
| 221 | int nb_sectors; |
| 222 | QEMUIOVector *qiov; |
| 223 | BlockDriverCompletionFunc *cb; |
| 224 | void *opaque; |
| 225 | |
| 226 | /* Filled by multiwrite implementation */ |
| 227 | int error; |
| 228 | } BlockRequest; |
| 229 | |
| 230 | int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, |
| 231 | int num_reqs); |
| 232 | |
aliguori | 7d78066 | 2009-03-12 19:57:08 +0000 | [diff] [blame] | 233 | /* sg packet commands */ |
aliguori | 221f715 | 2009-03-28 17:28:41 +0000 | [diff] [blame] | 234 | int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf); |
| 235 | BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs, |
| 236 | unsigned long int req, void *buf, |
| 237 | BlockDriverCompletionFunc *cb, void *opaque); |
aliguori | 7d78066 | 2009-03-12 19:57:08 +0000 | [diff] [blame] | 238 | |
Anthony Liguori | 0f15423 | 2011-11-14 15:09:45 -0600 | [diff] [blame] | 239 | /* Invalidate any cached metadata used by image formats */ |
| 240 | void bdrv_invalidate_cache(BlockDriverState *bs); |
| 241 | void bdrv_invalidate_cache_all(void); |
| 242 | |
BenoƮt Canet | 0778926 | 2012-03-23 08:36:49 +0100 | [diff] [blame] | 243 | void bdrv_clear_incoming_migration_all(void); |
| 244 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 245 | /* Ensure contents are flushed to disk. */ |
Kevin Wolf | 205ef79 | 2010-10-21 16:43:43 +0200 | [diff] [blame] | 246 | int bdrv_flush(BlockDriverState *bs); |
Paolo Bonzini | 07f0761 | 2011-10-17 12:32:12 +0200 | [diff] [blame] | 247 | int coroutine_fn bdrv_co_flush(BlockDriverState *bs); |
aliguori | c6ca28d | 2008-10-06 13:55:43 +0000 | [diff] [blame] | 248 | void bdrv_flush_all(void); |
MORITA Kazutaka | 2bc93fe | 2010-05-28 11:44:57 +0900 | [diff] [blame] | 249 | void bdrv_close_all(void); |
Stefan Hajnoczi | 922453b | 2011-11-30 12:23:43 +0000 | [diff] [blame] | 250 | void bdrv_drain_all(void); |
aliguori | c6ca28d | 2008-10-06 13:55:43 +0000 | [diff] [blame] | 251 | |
Christoph Hellwig | bb8bf76 | 2010-12-16 19:36:31 +0100 | [diff] [blame] | 252 | int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors); |
Paolo Bonzini | 4265d62 | 2011-10-17 12:32:14 +0200 | [diff] [blame] | 253 | int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors); |
Kevin Wolf | f2feebb | 2010-04-14 17:30:35 +0200 | [diff] [blame] | 254 | int bdrv_has_zero_init(BlockDriverState *bs); |
ths | f58c7b3 | 2008-06-05 21:53:49 +0000 | [diff] [blame] | 255 | 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] | 256 | int *pnum); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 257 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 258 | #define BIOS_ATA_TRANSLATION_AUTO 0 |
| 259 | #define BIOS_ATA_TRANSLATION_NONE 1 |
| 260 | #define BIOS_ATA_TRANSLATION_LBA 2 |
| 261 | #define BIOS_ATA_TRANSLATION_LARGE 3 |
| 262 | #define BIOS_ATA_TRANSLATION_RECHS 4 |
| 263 | |
| 264 | void bdrv_set_geometry_hint(BlockDriverState *bs, |
| 265 | int cyls, int heads, int secs); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 266 | void bdrv_set_translation_hint(BlockDriverState *bs, int translation); |
| 267 | void bdrv_get_geometry_hint(BlockDriverState *bs, |
| 268 | int *pcyls, int *pheads, int *psecs); |
Blue Swirl | 5bbdbb4 | 2011-02-12 20:43:32 +0000 | [diff] [blame] | 269 | typedef enum FDriveType { |
| 270 | FDRIVE_DRV_144 = 0x00, /* 1.44 MB 3"5 drive */ |
| 271 | FDRIVE_DRV_288 = 0x01, /* 2.88 MB 3"5 drive */ |
| 272 | FDRIVE_DRV_120 = 0x02, /* 1.2 MB 5"25 drive */ |
| 273 | FDRIVE_DRV_NONE = 0x03, /* No drive connected */ |
| 274 | } FDriveType; |
| 275 | |
HervƩ Poussineau | f8d3d12 | 2012-02-06 22:29:07 +0100 | [diff] [blame] | 276 | typedef enum FDriveRate { |
| 277 | FDRIVE_RATE_500K = 0x00, /* 500 Kbps */ |
| 278 | FDRIVE_RATE_300K = 0x01, /* 300 Kbps */ |
| 279 | FDRIVE_RATE_250K = 0x02, /* 250 Kbps */ |
| 280 | FDRIVE_RATE_1M = 0x03, /* 1 Mbps */ |
| 281 | } FDriveRate; |
| 282 | |
Blue Swirl | 5bbdbb4 | 2011-02-12 20:43:32 +0000 | [diff] [blame] | 283 | void bdrv_get_floppy_geometry_hint(BlockDriverState *bs, int *nb_heads, |
| 284 | int *max_track, int *last_sect, |
HervƩ Poussineau | f8d3d12 | 2012-02-06 22:29:07 +0100 | [diff] [blame] | 285 | FDriveType drive_in, FDriveType *drive, |
| 286 | FDriveRate *rate); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 287 | int bdrv_get_translation_hint(BlockDriverState *bs); |
Markus Armbruster | abd7f68 | 2010-06-02 18:55:17 +0200 | [diff] [blame] | 288 | void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error, |
| 289 | BlockErrorAction on_write_error); |
| 290 | BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read); |
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); |
| 315 | |
aliguori | 045df33 | 2009-03-05 23:00:48 +0000 | [diff] [blame] | 316 | const char *bdrv_get_encrypted_filename(BlockDriverState *bs); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 317 | void bdrv_get_backing_filename(BlockDriverState *bs, |
| 318 | char *filename, int filename_size); |
Paolo Bonzini | dc5a137 | 2012-05-08 16:51:50 +0200 | [diff] [blame] | 319 | void bdrv_get_full_backing_filename(BlockDriverState *bs, |
| 320 | char *dest, size_t sz); |
Miguel Di Ciurcio Filho | feeee5a | 2010-06-08 10:40:55 -0300 | [diff] [blame] | 321 | int bdrv_can_snapshot(BlockDriverState *bs); |
Blue Swirl | 199630b | 2010-07-25 20:49:34 +0000 | [diff] [blame] | 322 | int bdrv_is_snapshot(BlockDriverState *bs); |
Markus Armbruster | f9092b1 | 2010-06-25 10:33:39 +0200 | [diff] [blame] | 323 | BlockDriverState *bdrv_snapshots(void); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 324 | int bdrv_snapshot_create(BlockDriverState *bs, |
| 325 | QEMUSnapshotInfo *sn_info); |
| 326 | int bdrv_snapshot_goto(BlockDriverState *bs, |
| 327 | const char *snapshot_id); |
| 328 | int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id); |
| 329 | int bdrv_snapshot_list(BlockDriverState *bs, |
| 330 | QEMUSnapshotInfo **psn_info); |
edison | 51ef672 | 2010-09-21 19:58:41 -0700 | [diff] [blame] | 331 | int bdrv_snapshot_load_tmp(BlockDriverState *bs, |
| 332 | const char *snapshot_name); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 333 | char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn); |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 334 | |
| 335 | char *get_human_readable_size(char *buf, int buf_size, int64_t size); |
| 336 | int path_is_absolute(const char *path); |
| 337 | void path_combine(char *dest, int dest_size, |
| 338 | const char *base_path, |
| 339 | const char *filename); |
| 340 | |
Christoph Hellwig | 45566e9 | 2009-07-10 23:11:57 +0200 | [diff] [blame] | 341 | int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf, |
| 342 | int64_t pos, int size); |
aliguori | 178e08a | 2009-04-05 19:10:55 +0000 | [diff] [blame] | 343 | |
Christoph Hellwig | 45566e9 | 2009-07-10 23:11:57 +0200 | [diff] [blame] | 344 | int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf, |
| 345 | int64_t pos, int size); |
aliguori | 178e08a | 2009-04-05 19:10:55 +0000 | [diff] [blame] | 346 | |
Jes Sorensen | f88e1a4 | 2010-12-16 13:52:15 +0100 | [diff] [blame] | 347 | int bdrv_img_create(const char *filename, const char *fmt, |
| 348 | const char *base_filename, const char *base_fmt, |
| 349 | char *options, uint64_t img_size, int flags); |
| 350 | |
Markus Armbruster | 7b6f930 | 2011-09-06 18:58:56 +0200 | [diff] [blame] | 351 | void bdrv_set_buffer_alignment(BlockDriverState *bs, int align); |
Markus Armbruster | ba5b7ad | 2011-08-03 15:08:19 +0200 | [diff] [blame] | 352 | void *qemu_blockalign(BlockDriverState *bs, size_t size); |
| 353 | |
Jan Kiszka | 23bd90d | 2009-11-30 18:21:22 +0100 | [diff] [blame] | 354 | #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048 |
Jan Kiszka | 6ea4430 | 2009-11-30 18:21:19 +0100 | [diff] [blame] | 355 | |
lirans@il.ibm.com | 7cd1e32 | 2009-11-02 15:40:41 +0200 | [diff] [blame] | 356 | void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable); |
| 357 | int bdrv_get_dirty(BlockDriverState *bs, int64_t sector); |
Jan Kiszka | a55eb92 | 2009-11-30 18:21:19 +0100 | [diff] [blame] | 358 | void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, |
| 359 | int nr_sectors); |
Liran Schour | aaa0eb7 | 2010-01-26 10:31:48 +0200 | [diff] [blame] | 360 | int64_t bdrv_get_dirty_count(BlockDriverState *bs); |
Kevin Wolf | 8b9b0cc | 2010-03-15 17:27:00 +0100 | [diff] [blame] | 361 | |
Stefan Hajnoczi | 53fec9d | 2011-11-28 16:08:47 +0000 | [diff] [blame] | 362 | void bdrv_enable_copy_on_read(BlockDriverState *bs); |
| 363 | void bdrv_disable_copy_on_read(BlockDriverState *bs); |
| 364 | |
Marcelo Tosatti | db593f2 | 2011-01-26 12:12:34 -0200 | [diff] [blame] | 365 | void bdrv_set_in_use(BlockDriverState *bs, int in_use); |
| 366 | int bdrv_in_use(BlockDriverState *bs); |
Kevin Wolf | 8b9b0cc | 2010-03-15 17:27:00 +0100 | [diff] [blame] | 367 | |
Christoph Hellwig | a597e79 | 2011-08-25 08:26:01 +0200 | [diff] [blame] | 368 | enum BlockAcctType { |
| 369 | BDRV_ACCT_READ, |
| 370 | BDRV_ACCT_WRITE, |
| 371 | BDRV_ACCT_FLUSH, |
| 372 | BDRV_MAX_IOTYPE, |
| 373 | }; |
| 374 | |
| 375 | typedef struct BlockAcctCookie { |
| 376 | int64_t bytes; |
Christoph Hellwig | c488c7f | 2011-08-25 08:26:10 +0200 | [diff] [blame] | 377 | int64_t start_time_ns; |
Christoph Hellwig | a597e79 | 2011-08-25 08:26:01 +0200 | [diff] [blame] | 378 | enum BlockAcctType type; |
| 379 | } BlockAcctCookie; |
| 380 | |
| 381 | void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie, |
| 382 | int64_t bytes, enum BlockAcctType type); |
| 383 | void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie); |
| 384 | |
Kevin Wolf | 8b9b0cc | 2010-03-15 17:27:00 +0100 | [diff] [blame] | 385 | typedef enum { |
Kevin Wolf | 8252278 | 2010-03-15 17:38:05 +0100 | [diff] [blame] | 386 | BLKDBG_L1_UPDATE, |
| 387 | |
| 388 | BLKDBG_L1_GROW_ALLOC_TABLE, |
| 389 | BLKDBG_L1_GROW_WRITE_TABLE, |
| 390 | BLKDBG_L1_GROW_ACTIVATE_TABLE, |
| 391 | |
| 392 | BLKDBG_L2_LOAD, |
| 393 | BLKDBG_L2_UPDATE, |
| 394 | BLKDBG_L2_UPDATE_COMPRESSED, |
| 395 | BLKDBG_L2_ALLOC_COW_READ, |
| 396 | BLKDBG_L2_ALLOC_WRITE, |
| 397 | |
| 398 | BLKDBG_READ, |
| 399 | BLKDBG_READ_AIO, |
| 400 | BLKDBG_READ_BACKING, |
| 401 | BLKDBG_READ_BACKING_AIO, |
| 402 | BLKDBG_READ_COMPRESSED, |
| 403 | |
| 404 | BLKDBG_WRITE_AIO, |
| 405 | BLKDBG_WRITE_COMPRESSED, |
| 406 | |
| 407 | BLKDBG_VMSTATE_LOAD, |
| 408 | BLKDBG_VMSTATE_SAVE, |
| 409 | |
| 410 | BLKDBG_COW_READ, |
| 411 | BLKDBG_COW_WRITE, |
| 412 | |
| 413 | BLKDBG_REFTABLE_LOAD, |
| 414 | BLKDBG_REFTABLE_GROW, |
| 415 | |
| 416 | BLKDBG_REFBLOCK_LOAD, |
| 417 | BLKDBG_REFBLOCK_UPDATE, |
| 418 | BLKDBG_REFBLOCK_UPDATE_PART, |
| 419 | BLKDBG_REFBLOCK_ALLOC, |
| 420 | BLKDBG_REFBLOCK_ALLOC_HOOKUP, |
| 421 | BLKDBG_REFBLOCK_ALLOC_WRITE, |
| 422 | BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS, |
| 423 | BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE, |
| 424 | BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE, |
| 425 | |
| 426 | BLKDBG_CLUSTER_ALLOC, |
| 427 | BLKDBG_CLUSTER_ALLOC_BYTES, |
| 428 | BLKDBG_CLUSTER_FREE, |
| 429 | |
Kevin Wolf | 8b9b0cc | 2010-03-15 17:27:00 +0100 | [diff] [blame] | 430 | BLKDBG_EVENT_MAX, |
| 431 | } BlkDebugEvent; |
| 432 | |
| 433 | #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt) |
| 434 | void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event); |
| 435 | |
Markus Armbruster | d1a0739 | 2011-09-06 18:58:54 +0200 | [diff] [blame] | 436 | |
| 437 | /* Convenience for block device models */ |
| 438 | |
| 439 | typedef struct BlockConf { |
| 440 | BlockDriverState *bs; |
| 441 | uint16_t physical_block_size; |
| 442 | uint16_t logical_block_size; |
| 443 | uint16_t min_io_size; |
| 444 | uint32_t opt_io_size; |
| 445 | int32_t bootindex; |
| 446 | uint32_t discard_granularity; |
| 447 | } BlockConf; |
| 448 | |
| 449 | static inline unsigned int get_physical_block_exp(BlockConf *conf) |
| 450 | { |
| 451 | unsigned int exp = 0, size; |
| 452 | |
| 453 | for (size = conf->physical_block_size; |
| 454 | size > conf->logical_block_size; |
| 455 | size >>= 1) { |
| 456 | exp++; |
| 457 | } |
| 458 | |
| 459 | return exp; |
| 460 | } |
| 461 | |
| 462 | #define DEFINE_BLOCK_PROPERTIES(_state, _conf) \ |
| 463 | DEFINE_PROP_DRIVE("drive", _state, _conf.bs), \ |
Stefan Hajnoczi | 1fc86bf | 2012-03-14 15:57:06 +0000 | [diff] [blame] | 464 | DEFINE_PROP_BLOCKSIZE("logical_block_size", _state, \ |
| 465 | _conf.logical_block_size, 512), \ |
| 466 | DEFINE_PROP_BLOCKSIZE("physical_block_size", _state, \ |
| 467 | _conf.physical_block_size, 512), \ |
Markus Armbruster | d1a0739 | 2011-09-06 18:58:54 +0200 | [diff] [blame] | 468 | DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0), \ |
| 469 | DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0), \ |
| 470 | DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1), \ |
| 471 | DEFINE_PROP_UINT32("discard_granularity", _state, \ |
| 472 | _conf.discard_granularity, 0) |
| 473 | |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 474 | #endif |
Christoph Hellwig | a597e79 | 2011-08-25 08:26:01 +0200 | [diff] [blame] | 475 | |